| Filename | Latest commit message | Latest commit date |
|---|---|---|
7cfcb20d2b
Changes: - Gate session-lifecycle heap steady state with a dhat soak - Unbreak merge lifecycle e2e after default model → grok-4.5 - Scan home-scope rules dirs at <root>/rules - Complete text-input paste and terminal parity - Gate project roles and personas - Use canonical editing in dialogs - Use canonical editing in search bars - Reject ambiguous MCP tool IDs - Harden Git operands for plugins - Simplify queue drain API - Pass RFC 9207 iss through MCP OAuth token exchange - Show leader roster when local agents map is empty - Use canonical editing in Persona views - Remove marketplace default-skills auto-install and purge old installs - Use canonical editing in extension forms - Add canonical dashboard text editing - Use canonical editing in settings - Add /summarize as a /recap alias - Restore previous agent when exiting dashboard - Use tool_choice auto for compaction - Settings toggle for snap-prompt-to-top on send - Update default models to grok-4.5 - Source login shell once for local bash (env + alias/function snapshot) - Template hardcoded param names in server-native tool descriptions - Fix System-Reminder XML tag injection in CLAUDE.md via agents_md - Fix remote workspace-server hardcoding LSP trust (repo code execution risk) - Clear orphaned tool-call updates at turn end - Suppress task wake after cancel - Send x-grok-client-identifier on direct API tool calls - Harden dashboard peek lease transitions - Host /btw side panel in live region (minimal mode) - Bound scroll presentation latency - Highlight multi-line constructs correctly in diffs and the file viewer - Block web_fetch non-public IPs; local opt-in is explicit-host only - Seed coding_data_retention_opt_out=false for OAuth e2es in pty-harness - Follow up clipboard delivery feedback - Use canonical editing in pickers - Route TextArea through canonical editor - Persistent "watching" status row; quieter turn markers - Gate sensitive edit targets - Expose agent registry counts and gate session churn on them - Default coding data sharing to opt-out until server preference applies - Wire chat attachment ids through gateway prompts - On auth refresh failure, issue retry - Forward preview provenance and computer lifecycle state - Document independent privacy controls and scope /privacy output - Strip SamplingError Display prefix on rate-limit UI copy - Stop dumping Cloudflare HTML into Retry failed - Disable in-place prompt edit (scroll jank on enter) - Strip forced ANSI color from gh pr view JSON - Plumb bash tool description onto ToolUsageCard wire |
||
| .. | ||
| 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 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; install from marketplace sources |
| 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) |
| 23 | Agent Dashboard | Central overview of local sessions and forks |
| 24 | Monitoring Usage (External OpenTelemetry) | Customer OTEL export |