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,51 @@
|
||||
---
|
||||
name: help
|
||||
description: >
|
||||
Grok documentation and configuration help. Use when users ask about
|
||||
setup, configuration, MCP servers, authentication, skills, slash commands,
|
||||
keyboard shortcuts, or any Grok feature. Also use proactively when you
|
||||
detect a user is having trouble with setup or onboarding.
|
||||
metadata:
|
||||
short-description: "Grok docs — config, MCP, auth, skills, commands"
|
||||
---
|
||||
|
||||
# Grok Help
|
||||
|
||||
Answer the user's question about Grok setup, configuration, or features.
|
||||
|
||||
## Steps
|
||||
|
||||
1. If the question is about **current config** (what MCP servers, models, or settings are active),
|
||||
read `~/.kigi/config.toml`. MCP servers are under `[mcp_servers.*]` sections.
|
||||
|
||||
2. If the question is about **how to do something** (setup, adding MCP servers, creating skills,
|
||||
authentication, keyboard shortcuts, troubleshooting), first check the user-guide docs at
|
||||
`~/.kigi/docs/user-guide/`. The available guides are:
|
||||
- `01-getting-started.md` -- Installation, first launch, basic interaction
|
||||
- `02-authentication.md` -- Browser login, API keys, OIDC, external auth
|
||||
- `03-keyboard-shortcuts.md` -- Complete key bindings reference
|
||||
- `04-slash-commands.md` -- All / commands
|
||||
- `05-configuration.md` -- config.toml, pager.toml, env vars
|
||||
- `06-theming.md` -- Themes, appearance customization
|
||||
- `07-mcp-servers.md` -- MCP server setup and management
|
||||
- `08-skills.md` -- Creating and using skills
|
||||
- `09-plugins.md` -- Plugin marketplace
|
||||
- `10-hooks.md` -- Lifecycle hooks
|
||||
- `11-custom-models.md` -- BYOK, Ollama, OpenAI endpoints
|
||||
- `12-project-rules.md` -- AGENTS.md project rules
|
||||
- `13-memory.md` -- Cross-session memory
|
||||
- `14-headless-mode.md` -- CLI scripting and CI/CD
|
||||
- `15-agent-mode.md` -- ACP/stdio IDE integration
|
||||
- `16-subagents.md` -- Subagents and personas
|
||||
- `17-sessions.md` -- Session management
|
||||
- `18-sandbox.md` -- Sandbox mode
|
||||
- `19-plan-mode.md` -- Plan mode
|
||||
- `20-background-tasks.md` -- Background tasks and monitoring
|
||||
- `21-terminal-support.md` -- tmux, SSH, truecolor, clipboard, /terminal-setup
|
||||
Read the relevant guide(s) for the user's question. If none match, fall back to
|
||||
`~/.kigi/README.md` for the comprehensive reference.
|
||||
|
||||
3. To **modify config** for the user, edit `~/.kigi/config.toml` with search_replace.
|
||||
|
||||
4. To **create a skill** for the user, create `~/.kigi/skills/<name>/SKILL.md`
|
||||
(read `~/.kigi/docs/user-guide/08-skills.md` for the SKILL.md format).
|
||||
Reference in New Issue
Block a user