| Filename | Latest commit message | Latest commit date |
|---|---|---|
a422116582
Synced from monorepo Changes: - Release a shell session's resources in one drop - Make the tools blocking-wait cap client-configurable and self-describing - Recognize API "exceeds budget" errors as context overflow - Retry /btw on model overload - Carry running background tasks and subagents across compaction - Require round-trip time for SDK liveness checks - Background-subagent completion reminders with a selectable delivery surface - Make a PTY shell reap itself until it reaches the registry - Recover the OS error code from a TLS-phase connection reset - Consume the attached-client signal and report why idle is withheld - Treat `.grok/sandbox.toml` edits as protected so auto mode prompts before writing - Surface history/search in the Ctrl+. cheatsheet and keep it working in history view - Delete sessions from the dashboard and welcome list - Release a session's activity record when the session ends - Stop charging auth-retry budget for fail-closed 401s; reset it across suspends - Scope skills watches on project vendor roots - Make [stop] cancel in-flight compaction - Make the leader soak measure the leader, not its harness Source-Revision: 8d69c91f02bcacf01e98d5aebbf2f92547c45738 |
||
| .. | ||
| 01-getting-started.md | ||
| 02-authentication.md | ||
| 03-keyboard-shortcuts.md | ||
| 04-slash-commands.md | ||
| 05-configuration.md | ||
| 06-theming.md | ||
| 07-mcp-servers.md | ||
| 08-skills.md | ||
| 09-plugins.md | ||
| 10-hooks.md | ||
| 11-custom-models.md | ||
| 12-project-rules.md | ||
| 13-memory.md | ||
| 14-headless-mode.md | ||
| 15-agent-mode.md | ||
| 16-subagents.md | ||
| 17-sessions.md | ||
| 18-sandbox.md | ||
| 19-plan-mode.md | ||
| 20-background-tasks.md | ||
| 21-terminal-support.md | ||
| 22-permissions-and-safety.md | ||
| 23-dashboard.md | ||
| 24-monitoring-usage.md | ||
| README.md | ||
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, including goals, deep research, and workflow run management |
| 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; install from, author, and govern marketplaces (organization controls) |
| 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+B to demote |
| 21 | Terminal Support and Troubleshooting | tmux, SSH, truecolor, clipboard, and OSC 52 |
| 22 | Permissions and Safety | Modes (always-approve, auto, ask), rules, matching, hooks, and examples |
| 23 | Agent Dashboard | Central overview of local sessions and forks |
| 24 | Monitoring Usage (External OpenTelemetry) | Customer OTEL export |