| Filename | Latest commit message | Latest commit date |
|---|---|---|
98c3b2438a
Changes: - Classify clipboard delivery confidence - Add durable session update append - Scope the xAI session bearer to first-party memory embedding endpoints - Persist subagent outputs to disk and bound long-lived agent state - Add MiniSweAgent:bash for mini-swe-agent parity - Revert taking local sessions off the persistent shell - Contextual tip recommending grok wrap on SSH sessions - Voice STT bearer from model BYOK env_key/api_key - Define exact website policies for sandbox - Gate unsafe shell environments - Shared pin hoist; single require_sha gate for marketplace plugins - Server-signed is-managed claim (closes sidecar-removal downgrade) - Optional require_sha pin for remote plugin installs - Show session title and last exchange in the exit resume hint - Gate shell output redirects - Warn when fail_closed is present but not a boolean - Add canonical text editing core (ratatui-textarea) - Keep execution state out of goal scratch - Add acknowledged persistence primitives - Inherit child network restrictions in sandbox - Fail closed when hook matchers fail to recompile - Add MCP setup preferences for plugin MCPs - Gate sourced shell scripts - Gate file-typed project hooks - grok wrap: restore terminal modes on child death - Harden owner-only permissions on auth and MCP credentials - Create crash dump files with owner-only permissions - Write the agent_id cache owner-only (0600) - SessionMetrics mode skips Mixpanel profile sync - Dashboard: slim live-tail peek - Yank full queued prompt text, not (+N lines) - Defeat clock-rollback on the signed managed-config cache - Stop early session/cancel from overtaking the prompt and wedging the turn slot - Self-heal a diverged agent entrypoint on startup - Add matched inference expectations in test-support - Add AuthSingleFlight cancel/successor gap tests - Remove consumer from external OTEL allowlist and pin scrub coverage - Enable /copy in minimal mode - Surface capacity and API-key detail on 429 errors - Single-flight interactive auth - Fix PageUp/PageDown skipping lines behind sticky prompt header |
||
| .. | ||
| 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) |