M0: compilable skeleton — Kigi 0.1.0 fork surgery

Hard fork of xai-org/grok-build (Apache-2.0) re-targeted as Kigi, an
unofficial Kimi Code CLI community build.

Rename & identity
- 72 xai-*/xai-grok-* crates -> kigi-* (explicit: xai-grok-pager-bin ->
  kigi-bin [binary `kigi`], xai-grok-pager -> kigi-tui; rest mechanical);
  ptyctl, ptyctl-cli, third_party/ unchanged; proto package
  xai.grok.tools.v1 -> kigi.tools.v1
- Config home ~/.kigi (KIGI_SHARE_DIR override), env prefix GROK_* ->
  KIGI_*, `kigi --version` carries the unofficial-community-build notice
- clap identity, help text, startup banner, prompt templates rebranded
  (templates re-encrypted)

Deletions (PRD removal list #5/#6/#7/#9/#10)
- voice input (xai-grok-voice) and all TUI wiring
- telemetry: Mixpanel client, external OTel stream, Sentry, OTLP layers,
  trace/GCS/S3 upload queues (kigi-file-utils halved), workspace upload
  module & dc_log, heap-profile uploader, auth-diagnostics uploader,
  session-analytics halves of feedback; local zero-egress observability
  preserved in new kigi-log crate (unified log, --debug firehose,
  subsystem file logs, opt-in instrumentation)
- announcements (crate, remote-settings fields, TUI surfaces)
- plugin marketplace (crate, sources/browse/CTA/extensions-modal tab);
  direct plugin install/uninstall/update via kigi-agent git_install kept
- relay/gateway/assets endpoints and features (agent relay, headless
  relay transport, gateway bridge, LeaderEnvUrls); leader IPC socket now
  ~/.kigi/leader.sock + KIGI_LEADER_SOCKET, no ws-url derivation
- functional types rehomed instead of deleted: PermissionMode ->
  kigi-config-types, McpInitStrategy -> kigi-mcp, PrCreationSource ->
  session signals, TerminalDiagnostics -> kigi-pager-render, agent_id ->
  shell util

Endpoints
- kigi-env rewritten: single production KigiEndpoints {coding_api_base_url
  https://api.kimi.com/coding/v1 (KIGI_CODE_BASE_URL), oauth_host
  https://auth.kimi.com (KIGI_OAUTH_HOST), update_base_url (GitHub
  Releases API), upgrade_page_url}; GrokBuildEnvironment enum deleted

Toolchain & workspace hygiene
- Rust 1.97.0 pinned; edition 2024; full cargo update; git2 hoisted to
  workspace at 0.21 (Option->Result API migration), quick-xml 0.41
- Root Cargo.toml hand-maintained (PRD §8.1): version 0.1.0 inherited by
  all members, members sorted, unused deps pruned
- cargo-deny advisories gate (deny.toml with documented transitive
  exceptions); CI workflow (check/clippy/fmt/deny/test, macOS+Linux)
- cross-crate test seams re-gated behind `test-support` cargo feature;
  insta snapshot baselines renamed to the kigi_tui prefix
- clippy --workspace --all-targets: zero warnings; fmt clean

Fixes surfaced by the port
- updater probe/installer divergence (bin/kigi vs bin/grok symlink set)
- idle model-metadata refresh dead under KIGI_CODE_BASE_URL override
  (new is_effective_coding_endpoint_url, loopback+override aware)
- macOS symlinked-TMPDIR fixture canonicalization (foreign_sessions,
  fast-worktree); RSS measurement tests serialized via serial_test

Docs & legal (Apache §4)
- NOTICE added (upstream attribution + change statement); THIRD-PARTY
  notices sustained; kigi-tools ported-code notices extended; README,
  CONTRIBUTING, SECURITY, AGENTS.md rewritten

Out of scope for M0 (tracked): Kimi auth/inference (M1), search/fetch,
command parity, config import (M2), Computer Hub excision & final
brand-token sweep (M2), distribution & self-update rewrite (M3).
This commit is contained in:
2026-07-17 05:31:01 -04:00
commit d6c20fc13f
2612 changed files with 1353757 additions and 0 deletions
@@ -0,0 +1,140 @@
# ratatui-inline
A Rust library for building terminal applications with inline viewports - dynamic UI elements that stay at the bottom of the terminal while preserving scrollback history above them. Perfect for building chat-like interfaces, command prompts, and interactive terminal tools.
## What is this?
This crate provides tools for creating terminal applications where:
- A viewport (UI element) is pinned to the bottom of the terminal
- Content above the viewport becomes part of the terminal's native scrollback
- Users can scroll through history using their terminal's built-in scroll functionality
- Long lines wrap naturally without truncation
- The viewport remains visible and interactive while history accumulates above
Think of applications like:
- Chat interfaces with an input box at the bottom
- Interactive REPLs with command history
- Log viewers with controls at the bottom
- Any TUI that needs to preserve output history
## Key Features
- **Inline viewport** - UI stays at bottom while content flows above into scrollback
- **Natural text flow** - Content is printed normally, leveraging terminal's native behavior
- **Zero-copy text processing** - Efficient ANSI-aware text segmentation without allocations
- **Proper line wrapping** - Handles terminal width boundaries correctly with ANSI sequences
- **Unicode support** - Correct handling of emoji, CJK characters, combining characters
- **Terminal resize handling** - Robust resize support using RIS (Reset to Initial State)
- **Synchronized output** - Flicker-free rendering using DCS protocol
- **Cross-platform** - Works in all terminals and multiplexers (tmux, screen, etc.)
## Usage
See `examples/inline.rs` for a complete working example.
## Architecture
### Text Processing
The library uses a zero-copy approach for ANSI-aware text segmentation:
- **anstyle-parse** - ANSI/SGR-aware segmentation for zero-copy line splitting
- **Zero allocations** - Returns string slices without copying or allocating
- **Single-pass parsing** - Processes input once with proper escape sequence tracking
- **Unicode support** - Correct width calculation for emoji, CJK, combining characters
### Scrollback Implementation
The library uses a "natural flow" approach for scrollback:
1. Position cursor at viewport top
2. Print content, letting terminal handle wrapping naturally
3. Add viewport-height newlines to reserve space
4. Clear and render the viewport
This single implementation works universally across all terminals and multiplexers without special modes or workarounds.
### Line Ending Handling
- **LF (`\n`)** - Standard line ending, moves to next line
- **CRLF (`\r\n`)** - Windows-style line ending, treated as single line break
- **CR (`\r`)** - Carriage return only, resets cursor to line start (overwrites)
## Design Decisions
### Why Fork ratatui's Terminal?
The standard ratatui Terminal API doesn't expose internals needed for inline viewport manipulation:
- **Viewport area access** - Need to know current position and dimensions
- **Direct viewport positioning** - Must be able to set viewport location
- **Buffer management** - Need back buffer reset and previous buffer access
- **Resize calculations** - Require access to buffer state during resize
Our forked Terminal provides these capabilities while maintaining compatibility with ratatui's API.
### Synchronized Output
Flicker-free rendering using the DCS synchronized output protocol:
- All operations between begin/end markers are atomic
- Terminal only updates display once per batch
- Eliminates partial render states
## Performance
- **Colored JSON**: ~186μs per operation
- **Plain text**: ~75μs per operation
- **Zero allocations** in hot path
- **Single-pass parsing** for all text processing
## Testing
Comprehensive test coverage including:
- Text segmentation with ANSI sequences
- Line wrapping and Unicode handling
- All line ending types (LF, CRLF, CR)
- Viewport positioning and resizing
- Terminal resize with history re-rendering
- Mock terminal infrastructure for unit testing
### Terminal Resize Strategy
#### The Problem
When using inline viewports on the main screen (not alternate screen), terminal resize causes issues:
- Terminal reflows content automatically BEFORE the app receives SIGWINCH
- Old viewport borders get reflowed as garbage text
- Built-in `autoresize()` corrupts scrollback history
- Cursor position queries (DSR) have race conditions during rapid resize
- Different terminals handle reflow unpredictably
#### The Solution: RIS (Reset to Initial State)
We use the "nuclear option" - completely reset and re-render:
1. Send RIS (`ESC c`) to clear everything
2. Re-output entire scrollback history
3. Position viewport based on content amount
This approach:
- **Works consistently** across all terminals
- **Preserves scrollback** by re-outputting history
- **Avoids artifacts** from unpredictable reflow
- **No race conditions** from cursor queries
- **Handles all resize types** (horizontal and vertical)
## Dependencies
- `ratatui` - Terminal UI framework (forked Terminal class)
- `crossterm` - Cross-platform terminal manipulation
- `anstyle-parse` - ANSI/SGR-aware line segmentation (production)
- `unicode-width` - Unicode character width calculation
- `termwiz` - **dev-dependency only**; reference splitter for
`tests/segment_differential.rs` (not linked into shipped binaries)
## References
- [anstyle-parse](https://crates.io/crates/anstyle-parse)
- [Ratatui wrapping discussion](https://github.com/ratatui/ratatui/issues/1426)
## License / attribution
This crate includes a forked `Terminal` implementation derived from [ratatui](https://github.com/ratatui/ratatui)
(MIT / Apache-2.0). See `NOTICE` in this directory and the repository root `THIRD-PARTY-NOTICES`.