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:
@@ -0,0 +1,63 @@
|
||||
# kigi-tui
|
||||
|
||||
Terminal UI (TUI) for Grok Build. Provides the interactive full-screen interface
|
||||
including the scrollback view, prompt input, session management, and all modal
|
||||
dialogs.
|
||||
|
||||
## Architecture
|
||||
|
||||
```
|
||||
src/
|
||||
├── app/ # Application state and event handling
|
||||
│ ├── app_view.rs # Top-level state (welcome screen, agents, config)
|
||||
│ ├── agent_view/ # Per-session agent view (struct in mod.rs + per-domain impl modules)
|
||||
│ ├── dispatch/ # Action → Effect dispatcher (router + per-domain modules)
|
||||
│ ├── effects.rs # Async side effects (ACP calls, file I/O)
|
||||
│ └── event_loop.rs # Main event loop (input, ticks, ACP messages)
|
||||
├── views/ # UI components
|
||||
│ ├── prompt_widget.rs # Text editor with file search, slash, history
|
||||
│ ├── welcome/ # Welcome screen (logo, menu, prompt)
|
||||
│ ├── extensions_modal.rs # Extensions modal (hooks, plugins, marketplace, skills, MCP servers)
|
||||
│ ├── file_search/ # @-completion dropdown and line viewer
|
||||
│ ├── slash_dropdown.rs# /command completion dropdown
|
||||
│ └── ... # Scrollback, status bar, panes, etc.
|
||||
├── scrollback/ # Message history rendering
|
||||
├── slash/ # Slash command registry and built-in commands
|
||||
├── appearance/ # Theme and pager.toml config
|
||||
├── acp/ # Agent Communication Protocol client state
|
||||
└── render/ # Low-level rendering helpers (color, wrapping, etc.)
|
||||
```
|
||||
|
||||
## Key Concepts
|
||||
|
||||
- **AppView** — owns the welcome screen, agent sessions, and global config
|
||||
- **AgentView** — one per session; owns the prompt, scrollback, tool panes, and modals
|
||||
- **PromptWidget** — text editor component with file search (`@`), slash commands (`/`), history search, and paste elements
|
||||
- **Action/Effect** — Elm-style architecture: input → Action → dispatch → Effect → state update
|
||||
|
||||
## Keyboard Shortcuts
|
||||
|
||||
| Key | Context | Action |
|
||||
|-----|---------|--------|
|
||||
| `Ctrl+P` or `?` | Agent screen | Open command palette |
|
||||
| `Ctrl+L` | Any (non–VS Code family) | Open plugins/hooks modal; on VS Code / Cursor / Windsurf / Zed use `/plugins` or `/hooks` (`Ctrl+L` is mid-turn interject) |
|
||||
| `Tab` | Prompt | Switch to scrollback |
|
||||
| `Esc` | Turn running | No-op (does not cancel; use `Ctrl+C`) |
|
||||
| `Esc` `Esc` | Idle, non-empty prompt | Clear prompt (within 800ms; first press shows hint) |
|
||||
| `Esc` `Esc` | Idle, empty prompt + messages | Open rewind picker (silent first press) |
|
||||
| `Ctrl+M` | Prompt | Toggle multiline mode |
|
||||
| `Shift+Enter` | Prompt | Insert newline |
|
||||
| `/` | Prompt | Start slash command |
|
||||
| `@` | Prompt | Start file search |
|
||||
| `!` | Prompt (empty) | Enter bash mode |
|
||||
| `Ctrl+C` | Prompt (with text) | Clear prompt (even while turn running) |
|
||||
| `Ctrl+C` | Prompt (empty) + turn running | Cancel running turn |
|
||||
|
||||
## Docs
|
||||
|
||||
- [Terminal Support & Troubleshooting](docs/user-guide/21-terminal-support.md) — tmux/SSH truecolor, clipboard, mouse, diagnostics, /terminal-setup
|
||||
- [Hooks & Plugins Guide](docs/hooks-and-plugins.md) — managing hooks, plugins, and marketplace sources
|
||||
- [Custom Hooks Guide](docs/custom-hooks.md) — creating, configuring, and writing your own hooks
|
||||
- [Hook Examples](../kigi-hooks/examples/README.md) — sample hooks for common workflows
|
||||
- [Hooks Crate (`kigi-hooks`)](../kigi-hooks/) — hook runtime, event types, and execution engine
|
||||
- [Plugin Marketplace Crate (`kigi-plugin-marketplace`)](../kigi-plugin-marketplace/) — marketplace source loading, scanning, and install
|
||||
Reference in New Issue
Block a user