ZacharyZhang-NY
d6c20fc13f
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).
98 lines
3.2 KiB
YAML
98 lines
3.2 KiB
YAML
name: shortcuts-help-detail
|
|
description: >
|
|
End-to-end cheatsheet flow exercising the full shortcuts-help stack: open the
|
|
Keyboard Shortcuts modal from a live session, inline-expand a hint with the
|
|
right arrow and collapse it with the left arrow (directional collapse),
|
|
open the man-style detail screen with Enter (pattern B) showing the action's
|
|
long_help, return to the browse list with Esc (not close), then dismiss the
|
|
modal with the global Ctrl+X close chord.
|
|
|
|
Open/close uses Ctrl+X rather than Ctrl+. : both are bound to ShortcutsHelp
|
|
(When::AgentScreen) and both are the in-modal global-close chord, but Ctrl+X
|
|
has a legacy byte (0x18) the PTY reliably delivers whereas Ctrl+. has no
|
|
Xterm-encodable byte. The prompt ignores Ctrl+X, so it bubbles to the
|
|
AgentScreen binding.
|
|
terminal:
|
|
rows: 40
|
|
cols: 110
|
|
mock:
|
|
response: "MOCK_SHORTCUTS_E2E assistant reply for the cheatsheet scenario."
|
|
steps:
|
|
# Reach a session so ShortcutsHelp (When::AgentScreen) is reachable.
|
|
- action: wait_for_text
|
|
text: Quit
|
|
timeout_ms: 20000
|
|
- action: type_text
|
|
text: "hello cheatsheet"
|
|
- action: keys
|
|
keys: "<Enter>"
|
|
- action: wait_for_text
|
|
text: MOCK_SHORTCUTS_E2E
|
|
timeout_ms: 30000
|
|
# Open the cheatsheet via the reliably-encodable Ctrl+X (== Ctrl+. binding).
|
|
- action: keys
|
|
keys: "<C-x>"
|
|
- action: wait_for_text
|
|
text: Keyboard Shortcuts
|
|
timeout_ms: 15000
|
|
# Browse-mode chrome + shipped affordances (expand / collapse / detail hints).
|
|
- action: assert_contains
|
|
text: Essentials
|
|
- action: assert_contains
|
|
text: Enter details
|
|
- action: assert_contains
|
|
text: collapse
|
|
- action: assert_not_contains
|
|
text: panicked
|
|
# Move selection off the section header onto the CancelTurn hint
|
|
# (Essentials order: send, prompt, scrollback, cancel).
|
|
- action: keys
|
|
keys: "<Down><Down><Down>"
|
|
- action: wait
|
|
millis: 200
|
|
# Inline-expand (right arrow): the action's long_help renders under the row.
|
|
- action: keys
|
|
keys: "<Right>"
|
|
- action: wait_for_text
|
|
text: Interrupts the
|
|
timeout_ms: 15000
|
|
# Collapse the same row with the left arrow (directional left-collapse).
|
|
- action: keys
|
|
keys: "<Left>"
|
|
- action: wait
|
|
millis: 200
|
|
- action: assert_not_contains
|
|
text: Interrupts the
|
|
# Enter opens the in-modal man-style detail screen (pattern B).
|
|
- action: keys
|
|
keys: "<Enter>"
|
|
- action: wait_for_text
|
|
text: Esc back
|
|
timeout_ms: 15000
|
|
- action: assert_contains
|
|
text: Interrupts the
|
|
- action: assert_not_contains
|
|
text: panicked
|
|
# Esc returns to the browse list (must NOT close the modal).
|
|
- action: keys
|
|
keys: "<Esc>"
|
|
- action: wait_for_text
|
|
text: Enter details
|
|
timeout_ms: 15000
|
|
- action: assert_contains
|
|
text: Keyboard Shortcuts
|
|
# Global close: Ctrl+X dismisses the modal and restores the session.
|
|
- action: keys
|
|
keys: "<C-x>"
|
|
- action: wait
|
|
millis: 300
|
|
- action: assert_not_contains
|
|
text: Keyboard Shortcuts
|
|
- action: assert_contains
|
|
text: MOCK_SHORTCUTS_E2E
|
|
- action: assert_not_contains
|
|
text: panicked
|
|
- action: screenshot
|
|
name: shortcuts-help-detail-closed
|
|
note: Cheatsheet inline-expand / detail / collapse flow complete; modal dismissed via Ctrl+X.
|