ZacharyZhang-NY
6f31415ed6
The PRD's first acceptance gate now holds: grep -RinE '\bx\.ai\b|grok' crates/ --include='*.rs' → 0 matches (exempt: NOTICE and third-party license archives, README provenance, and the required 'Based on Grok Build Open Source' attribution, now sourced from version_attribution.txt). Wire-visible renames (both sides in this repo, changed in lockstep): - Auth method id 'grok.com' → 'kimi-code' (AuthMethodKind::KimiCode). - Every x.ai/* and _x.ai/* ACP ext method and meta key → kigi/* / _kigi/* (~200 names; grokShell → kigiShell). Session-file replay keeps a read-side alias for the legacy '_x.ai/session/update' method so existing updates.jsonl histories load; writes emit only the new name (both directions test-pinned). - Agent types grok-build* → kigi* with a documented legacy-prefix alias at resolution time so persisted sessions keep resolving. - ToolNamespace/BuiltinAgentName GrokBuild* → Kigi* (wire snake_case kigi/kigi_concise/kigi_hashline; schema regenerated); grok_build implementation dirs renamed to kigi*. - x-grok-* headers → x-kigi-*, __GROK_* sentinels → __KIGI_*, themes grokday/groknight → kigiday/kiginight (old persisted values fall back to the default theme), web_fetch allowlist xAI hosts → kimi.com + moonshot platforms, changelog CDN → this repo, grok-build changelog archives deleted. - BYOK default endpoint removed: [endpoints] api_base_url is now truly optional with NO default — consumers fail fast with the flag name when unset (no silent x.ai egress). Mock harnesses inject it explicitly. - System-prompt identity fixed: 'released by xAI' → 'an unofficial community CLI for Kimi' (template + regenerated encrypted form). Also repaired pre-existing grok-era test debt found by the sweep: the stale trace_classify default-model pin, the grok-pager UA label test, pty-harness stale-binary reuse and non-hermetic moonshot routing (a PTY test could previously reach the real api.moonshot.cn), and the outdated oauth fixture scope key. Gates: §9 grep 0; fmt clean; workspace check/clippy 0/0 (-D warnings); FULL cargo test --workspace: 234 suites, 21,961 passed, 0 failed; deny advisories ok.
51 lines
2.4 KiB
Markdown
51 lines
2.4 KiB
Markdown
---
|
|
name: help
|
|
description: >
|
|
Kigi documentation and configuration help. Use when users ask about
|
|
setup, configuration, MCP servers, authentication, skills, slash commands,
|
|
keyboard shortcuts, or any Kigi feature. Also use proactively when you
|
|
detect a user is having trouble with setup or onboarding.
|
|
metadata:
|
|
short-description: "Kigi docs — config, MCP, auth, skills, commands"
|
|
---
|
|
|
|
# Kigi Help
|
|
|
|
Answer the user's question about Kigi 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). |