Files
Kigi-CLI/crates/codegen/kigi-tui/docs/user-guide
ZacharyZhang-NY 74b210535e F5: web search/fetch on the Kimi services (kimi-cli parity)
web_search now speaks the Kimi search service (kimi-cli tools/web/search.py,
wire-verified against api.kimi.com):
- POST {coding_base}/search with {text_query, limit 1-20 (default 5),
  enable_page_crawling, timeout_seconds: 30}, OAuth bearer +
  X-Msh-Tool-Call-Id; results render in kimi-cli's Title/Date/URL/Summary
  schema with result URLs as citations.
- The old implementation called the xAI Responses API with a search model;
  that client is fully replaced and the entire model-based config surface
  is excised root-and-branch: web_search_model config keys/env/CLI plumbing,
  resolve_web_search_sampling_config, toolset web_search SamplerConfig,
  RemoteSettings.web_search_model, default_web_search_model.
- Enablement is now purely structural: the service exists only on the Kimi
  Code subscription channel, so OAuth sessions get Enabled and API-key-only
  sessions get Disabled (tool absent) — per PRD F5.

web_fetch gains the Kimi fetch service as its primary path (kimi-cli
tools/web/fetch.py): POST {coding_base}/fetch with {url}, Accept:
text/markdown, OAuth bearer + X-Msh-Tool-Call-Id; the 200 body is the
extracted markdown (still overflow-budgeted). Any service failure falls
back to the existing local pipeline (SSRF guards, cache, extraction).
The tool gate defaults ON now (kimi-cli always offers FetchURL) and the
egress User-Agent no longer claims grok-agent/x.ai.

Verified end-to-end against the scripted mock service: a headless session
drove web_search (limit/crawling/call-id observed on the wire) then
web_fetch (Accept + call-id observed) to completion.
2026-07-17 19:33:19 -04:00
..

Grok Build User Guide

Learn how to install, configure, and extend Grok Build, the terminal-based AI coding assistant from SpaceXAI.


Tier 1: Essential User Docs

Start here. These guides cover what you need on your first day.

# Document Description
1 Getting Started Installation, first launch, authentication, basic interaction, and key concepts
2 Authentication Browser login, API keys, OIDC/SSO, external auth providers, and device-code flow
3 Keyboard Shortcuts Reference for every key binding and mouse action in the TUI
4 Slash Commands Every / command for sessions, models, memory, hooks, and plugins
5 Configuration config.toml, pager.toml, environment variables, and file locations

Tier 2: Core Feature Docs

Customize and extend Grok Build.

# Document Description
6 Theming and Appearance Themes, the /theme command, pager.toml, and color-support detection
7 MCP Servers External tool integrations through the Model Context Protocol
8 Skills Reusable prompt packages in the SKILL.md format
9 Plugins Bundle and share skills, commands, agents, hooks, and MCP servers
10 Hooks Lifecycle scripts and HTTP callbacks for pre- and post-tool-use events
11 Custom Models Bring-your-own-key, Ollama, and OpenAI-compatible endpoints
12 Project Rules (AGENTS.md) Per-directory AGENTS.md instructions and their precedence
13 Memory Cross-session knowledge persistence with /flush, /dream, and hybrid search

Tier 3: Advanced Usage Docs

Automate, script, and integrate Grok Build with other systems.

# Document Description
14 Headless Mode and Scripting grok -p, output formats, CI/CD integration, and piping
15 Agent Mode and IDE Integration ACP stdio transport, WebSocket relay, and SDK integration
16 Subagents and Personas Parallel child sessions, agent types, personas, and capability modes
17 Session Management Save, load, resume, rewind, compact, and the session persistence format
18 Sandbox Mode OS-level filesystem and network isolation profiles
19 Plan Mode Structured planning, plan-file edits, and approval before coding
20 Background Tasks and Monitoring background: true, /loop, monitor, and Ctrl+G to demote
21 Terminal Support and Troubleshooting tmux, SSH, truecolor, clipboard, and OSC 52
22 Permissions and Safety Controls dontAsk mode, auto-approved tools, the safe-bash list, and restrictive PreToolUse hooks (such as git/gh-only)