Evidence boundary
Grok Build 1.0.0
Installed recursive help is authoritative for released shell paths. Official docs extend settings and behavior. Unbound source HEAD is preview only; it is never silently promoted to the release.
- Captured release
- 1.0.0 / darwin-arm64
- Source policy
- Installed Grok Build 1.0.0 recursive help is authoritative for released command paths and public options.
Inventory telemetry
- 62
- Shell commands
- 359
- Options
- 66
- TUI slash commands
- 136
- Configuration schema
- 67
- Environment variable names
63 runtime confirmed 237 docs confirmed 31 source preview 0 conditional 0 historical
RELEASE / DOCS / SOURCE
Known drift
docs import ahead
Official docs list grok import, but installed 1.0.0 root help does not expose it; treat it as conditional, not release-confirmed.
grok-runtime-1.0.0 · grok-docs-cli-2026-07-31concise docs
The official CLI page intentionally lists common commands only; release help additionally exposes leader, doctor fix, MCP toggles, plugin tag, trace, and worktree database commands.
grok-runtime-1.0.0 · grok-docs-cli-2026-07-31source unbound
Public source HEAD and SOURCE_REV cannot be bound to installed 1.0.0, so source-only TUI and command surfaces remain preview evidence.
grok-runtime-1.0.0 · grok-source-cli-500129c · grok-source-tui-500129chidden options excluded
The hidden root-level --no-auto-update flag is intentionally excluded because 1.0.0 root --help does not expose it; the distinct public agent leader flag remains in the runtime inventory.
grok-runtime-1.0.0 · grok-docs-cli-2026-07-3101 / SHELL TREE
Shell commands
62 Shell commands / 22 command groups / 359 Options
01 root 1 Shell commands
grok runtime confirmed read only
Launch the Grok Build TUI, run one prompt, or select a subcommand.
grok [OPTIONS] [PROMPT] [COMMAND]| Options | Type | Availability | Risk | Summary |
|---|---|---|---|---|
--agent NAME | string | runtime confirmed | read only | Select an agent name or agent definition file. |
--agents JSON | string | runtime confirmed | review | Provide inline subagent definitions as JSON. |
--allow, --allowedTools RULE | string | runtime confirmed | high impact | Add an explicit permission allow rule for this invocation. |
--always-approve, --yolo, --dangerously-skip-permissions | boolean | runtime confirmed | high impact | Auto-approve tool executions; deny rules, hooks, and the sandbox remain separate controls. |
-c, --continue | boolean | runtime confirmed | read only | Continue the most recent session for the current working directory. |
--cwd CWD | path | runtime confirmed | read only | Set the working directory. |
--debug | boolean | runtime confirmed | review | Enable debug logging. |
--debug-file FILE | path | runtime confirmed | review | Write debug logs to a file; review logs before sharing them. |
--deny, --disallowedTools RULE | string | runtime confirmed | review | Add an explicit permission deny rule for this invocation. |
--disable-web-search | boolean | runtime confirmed | read only | Disable web search and web fetch tools. |
--disallowed-tools TOOLS | array | runtime confirmed | read only | Remove comma-separated built-in tools. |
--experimental-memory | boolean | runtime confirmed | review | Enable cross-session memory. |
--fork-session | boolean | runtime confirmed | read only | Create a new session ID when resuming or continuing. |
--fullscreen | boolean | runtime confirmed | read only | Use the standard fullscreen TUI for this session. |
-h, --help | boolean | runtime confirmed | read only | Print root help. |
--include-partial-messages | boolean | runtime confirmed | read only | Emit incremental stream_event lines alongside whole messages when using streaming-messages-json output. |
--json-schema SCHEMA | string | runtime confirmed | read only | Constrain the response to a JSON Schema and imply JSON output. |
--leader-socket PATH | path | runtime confirmed | read only | Use a custom leader socket path. |
-m, --model MODEL | string | runtime confirmed | read only | Select a model ID. |
--max-turns N | integer | runtime confirmed | read only | Limit the number of agent turns. |
--minimal | boolean | runtime confirmed | read only | Use experimental scrollback-native rendering for this session. |
--no-alt-screen | boolean | runtime confirmed | read only | Run inline without the terminal alternate screen. |
--no-memory | boolean | runtime confirmed | read only | Disable cross-session memory for this session. |
--no-plan | boolean | runtime confirmed | read only | Disable plan mode. |
--no-subagents | boolean | runtime confirmed | read only | Disable subagent spawning. |
--oauth | boolean | runtime confirmed | review | Use OAuth when the welcome screen starts authentication. |
--output-format OUTPUT_FORMAT | enum: plain | json | streaming-json | streaming-messages-json | runtime confirmed | read only | Select the headless output format. |
-p, --single PROMPT | string | runtime confirmed | review | Run a single-turn prompt, print the response, and exit. |
--permission-mode MODE | enum: default | acceptEdits | auto | dontAsk | bypassPermissions | plan | runtime confirmed | high impact | Select the invocation permission mode. |
--prompt-file PATH | path | runtime confirmed | review | Read a single-turn prompt from a file. |
--prompt-json JSON | string | runtime confirmed | review | Provide a single-turn prompt as JSON content blocks. |
-r, --resume SESSION_ID_OR_TITLE | string | runtime confirmed | read only | Resume a session by ID or title, or the most recent session when omitted. |
--reasoning-effort, --effort EFFORT | enum: low | medium | high | runtime confirmed | read only | Select reasoning effort for a supported model. |
--restore-code | boolean | runtime confirmed | high impact | Check out the original session commit while resuming. |
--rules, --append-system-prompt RULES | string | runtime confirmed | review | Append extra rules to the system prompt. |
-s, --session-id SESSION_ID | string | runtime confirmed | read only | Use a specific UUID for a new conversation or a named fork. |
--sandbox PROFILE | enum: off | workspace | devbox | read-only | strict | runtime confirmed | review | Select a filesystem and network sandbox profile. |
--system-prompt-override, --system-prompt PROMPT | string | runtime confirmed | high impact | Replace the system prompt for this invocation. |
--tools TOOLS | array | runtime confirmed | review | Select comma-separated built-in tools. |
-v, --version | boolean | runtime confirmed | read only | Print the release version. |
--verbatim | boolean | runtime confirmed | read only | Send the prompt exactly as supplied. |
-w, --worktree WORKTREE | string | runtime confirmed | review | Start the session in a new git worktree, optionally named. |
--worktree-ref, --ref WORKTREE_REF | string | runtime confirmed | review | Choose the branch, tag, or commit used to create a worktree. |
Examples
grok-runtime-1.0.0 grokgrok -p "Explain this repository"grok -p "List TODOs" --output-format json02 help 1 Shell commands
grok help runtime confirmed read only
Print root or nested command help.
grok help [COMMAND]...No command-specific public options.
Examples
grok-runtime-1.0.0 grok help mcp add03 agent 5 Shell commands
grok agent runtime confirmed review
Run Grok without the interactive TUI.
grok agent [OPTIONS] [COMMAND]| Options | Type | Availability | Risk | Summary |
|---|---|---|---|---|
--reauth, --reauthenticate | boolean | runtime confirmed | review | Authenticate before starting the agent. |
-m, --model MODEL | string | runtime confirmed | read only | Select a model ID. |
--reasoning-effort, --effort EFFORT | enum: low | medium | high | runtime confirmed | read only | Select reasoning effort. |
--always-approve | boolean | runtime confirmed | high impact | Auto-approve tool executions. |
--agent-profile PATH | path | runtime confirmed | review | Load an agent profile file. |
--plugin-dir DIR | path | runtime confirmed | high impact | Load a highest-priority, automatically trusted plugin directory for this process. |
--leader | boolean | runtime confirmed | review | Connect to a shared leader process. |
--no-leader | boolean | runtime confirmed | read only | Start a separate agent even when leader mode is configured. |
--grok-ws-origin GROK_WS_ORIGIN | url | runtime confirmed | review | Override the Grok relay origin. |
--grok-ws-url GROK_WS_URL | url | runtime confirmed | review | Override the Grok relay WebSocket URL. |
--cli-chat-proxy-base-url URL | url | runtime confirmed | review | Override the CLI chat proxy URL. |
--xai-api-base-url URL | url | runtime confirmed | review | Override the public xAI API base URL. |
--debug | boolean | runtime confirmed | review | Enable debug logging. |
--debug-file FILE | path | runtime confirmed | review | Write debug logs to a file; review logs before sharing them. |
-h, --help | boolean | runtime confirmed | read only | Print help for this command. |
--leader-socket PATH | path | runtime confirmed | read only | Use a custom leader socket path. |
Examples
grok-runtime-1.0.0 grok agent stdiogrok agent stdio runtime confirmed review
Run Grok as an ACP agent over standard input and output.
grok agent stdio [OPTIONS]| Options | Type | Availability | Risk | Summary |
|---|---|---|---|---|
--debug | boolean | runtime confirmed | review | Enable debug logging. |
--debug-file FILE | path | runtime confirmed | review | Write debug logs to a file; review logs before sharing them. |
-h, --help | boolean | runtime confirmed | read only | Print help for this command. |
--leader-socket PATH | path | runtime confirmed | read only | Use a custom leader socket path. |
Examples
grok-runtime-1.0.0 grok agent stdiogrok agent headless runtime confirmed review
Run the agent headlessly over the Grok WebSocket relay.
grok agent headless [OPTIONS]| Options | Type | Availability | Risk | Summary |
|---|---|---|---|---|
--grok-ws-origin GROK_WS_ORIGIN | url | runtime confirmed | review | Override the relay origin. |
--grok-ws-url GROK_WS_URL | url | runtime confirmed | review | Override the relay WebSocket URL. |
--debug | boolean | runtime confirmed | review | Enable debug logging. |
--debug-file FILE | path | runtime confirmed | review | Write debug logs to a file; review logs before sharing them. |
-h, --help | boolean | runtime confirmed | read only | Print help for this command. |
--leader-socket PATH | path | runtime confirmed | read only | Use a custom leader socket path. |
grok agent serve runtime confirmed high impact
Run the agent as a WebSocket server.
grok agent serve [OPTIONS]| Options | Type | Availability | Risk | Summary |
|---|---|---|---|---|
--bind BIND | string | runtime confirmed | review | Select the server listen address. |
--secret SECRET | string | runtime confirmed | high impact | Set the client-authentication secret; omit it to auto-generate one. |
--remote REMOTE | url | runtime confirmed | high impact | Select a remote agent URL for proxy mode. |
--grok-ws-origin GROK_WS_ORIGIN | url | runtime confirmed | review | Override the relay origin. |
--grok-ws-url GROK_WS_URL | url | runtime confirmed | review | Override the relay WebSocket URL. |
--debug | boolean | runtime confirmed | review | Enable debug logging. |
--debug-file FILE | path | runtime confirmed | review | Write debug logs to a file; review logs before sharing them. |
-h, --help | boolean | runtime confirmed | read only | Print help for this command. |
--leader-socket PATH | path | runtime confirmed | read only | Use a custom leader socket path. |
grok agent leader runtime confirmed review
Run the shared leader process used by other clients.
grok agent leader [OPTIONS]| Options | Type | Availability | Risk | Summary |
|---|---|---|---|---|
--no-exit-on-disconnect | boolean | runtime confirmed | read only | Keep the leader running after the last client disconnects. |
--relay-on-demand | boolean | runtime confirmed | review | Connect the relay only when a headless IPC client requires it. |
--no-auto-update | boolean | runtime confirmed | read only | Disable periodic update checks for the leader. |
--grok-ws-origin GROK_WS_ORIGIN | url | runtime confirmed | review | Override the relay origin. |
--grok-ws-url GROK_WS_URL | url | runtime confirmed | review | Override the relay WebSocket URL. |
--debug | boolean | runtime confirmed | review | Enable debug logging. |
--debug-file FILE | path | runtime confirmed | review | Write debug logs to a file; review logs before sharing them. |
-h, --help | boolean | runtime confirmed | read only | Print help for this command. |
--leader-socket PATH | path | runtime confirmed | read only | Use a custom leader socket path. |
04 completions 1 Shell commands
grok completions runtime confirmed read only
Generate a shell completion script.
grok completions [OPTIONS] <SHELL>| Options | Type | Availability | Risk | Summary |
|---|---|---|---|---|
--debug | boolean | runtime confirmed | review | Enable debug logging. |
--debug-file FILE | path | runtime confirmed | review | Write debug logs to a file; review logs before sharing them. |
-h, --help | boolean | runtime confirmed | read only | Print help for this command. |
--leader-socket PATH | path | runtime confirmed | read only | Use a custom leader socket path. |
Examples
grok-runtime-1.0.0 grok completions zsh05 dashboard 1 Shell commands
grok dashboard runtime confirmed read only
Open the Agent Dashboard at startup.
grok dashboard [OPTIONS]| Options | Type | Availability | Risk | Summary |
|---|---|---|---|---|
--debug | boolean | runtime confirmed | review | Enable debug logging. |
--debug-file FILE | path | runtime confirmed | review | Write debug logs to a file; review logs before sharing them. |
-h, --help | boolean | runtime confirmed | read only | Print help for this command. |
--leader-socket PATH | path | runtime confirmed | read only | Use a custom leader socket path. |
06 doctor 2 Shell commands
grok doctor runtime confirmed read only
Check terminal, clipboard, color, input, notification, and sandbox support.
grok doctor [OPTIONS]| Options | Type | Availability | Risk | Summary |
|---|---|---|---|---|
--json | boolean | runtime confirmed | read only | Emit machine-readable diagnostics. |
--debug | boolean | runtime confirmed | review | Enable debug logging. |
--debug-file FILE | path | runtime confirmed | review | Write debug logs to a file; review logs before sharing them. |
-h, --help | boolean | runtime confirmed | read only | Print help for this command. |
--leader-socket PATH | path | runtime confirmed | read only | Use a custom leader socket path. |
Examples
grok-runtime-1.0.0 grok doctor --jsongrok doctor fix runtime confirmed review
Apply available automatic terminal fixes.
grok doctor fix [OPTIONS]| Options | Type | Availability | Risk | Summary |
|---|---|---|---|---|
--yes | boolean | runtime confirmed | high impact | Apply fixes without confirmation. |
--debug | boolean | runtime confirmed | review | Enable debug logging. |
--debug-file FILE | path | runtime confirmed | review | Write debug logs to a file; review logs before sharing them. |
-h, --help | boolean | runtime confirmed | read only | Print help for this command. |
--leader-socket PATH | path | runtime confirmed | read only | Use a custom leader socket path. |
Examples
grok-runtime-1.0.0 grok doctor fixgrok doctor fix --yes07 export 1 Shell commands
grok export runtime confirmed review
Export a session transcript as Markdown.
grok export [OPTIONS] <SESSION_ID> [OUTPUT]| Options | Type | Availability | Risk | Summary |
|---|---|---|---|---|
-c, --clipboard | boolean | runtime confirmed | review | Copy the exported transcript to the clipboard. |
--debug | boolean | runtime confirmed | review | Enable debug logging. |
--debug-file FILE | path | runtime confirmed | review | Write debug logs to a file; review logs before sharing them. |
-h, --help | boolean | runtime confirmed | read only | Print help for this command. |
--leader-socket PATH | path | runtime confirmed | read only | Use a custom leader socket path. |
08 inspect 1 Shell commands
grok inspect runtime confirmed review
Show configuration, rules, skills, plugins, hooks, and MCP servers discovered for the directory.
grok inspect [OPTIONS]| Options | Type | Availability | Risk | Summary |
|---|---|---|---|---|
--json | boolean | runtime confirmed | review | Emit the discovered configuration as JSON; review before sharing. |
--debug | boolean | runtime confirmed | review | Enable debug logging. |
--debug-file FILE | path | runtime confirmed | review | Write debug logs to a file; review logs before sharing them. |
-h, --help | boolean | runtime confirmed | read only | Print help for this command. |
--leader-socket PATH | path | runtime confirmed | read only | Use a custom leader socket path. |
Examples
grok-runtime-1.0.0 grok inspectgrok inspect --json09 leader 4 Shell commands
grok leader runtime confirmed review
Manage running leader processes.
grok leader [OPTIONS] <COMMAND>| Options | Type | Availability | Risk | Summary |
|---|---|---|---|---|
--debug | boolean | runtime confirmed | review | Enable debug logging. |
--debug-file FILE | path | runtime confirmed | review | Write debug logs to a file; review logs before sharing them. |
-h, --help | boolean | runtime confirmed | read only | Print help for this command. |
--leader-socket PATH | path | runtime confirmed | read only | Use a custom leader socket path. |
grok leader list runtime confirmed read only
List discovered leader processes.
grok leader list [OPTIONS]| Options | Type | Availability | Risk | Summary |
|---|---|---|---|---|
--json | boolean | runtime confirmed | read only | Emit JSON. |
--debug | boolean | runtime confirmed | review | Enable debug logging. |
--debug-file FILE | path | runtime confirmed | review | Write debug logs to a file; review logs before sharing them. |
-h, --help | boolean | runtime confirmed | read only | Print help for this command. |
--leader-socket PATH | path | runtime confirmed | read only | Use a custom leader socket path. |
grok leader info runtime confirmed read only
Show information about one leader process.
grok leader info [OPTIONS]| Options | Type | Availability | Risk | Summary |
|---|---|---|---|---|
--pid PID | integer | runtime confirmed | read only | Select a leader by process ID. |
--json | boolean | runtime confirmed | read only | Emit JSON. |
--debug | boolean | runtime confirmed | review | Enable debug logging. |
--debug-file FILE | path | runtime confirmed | review | Write debug logs to a file; review logs before sharing them. |
-h, --help | boolean | runtime confirmed | read only | Print help for this command. |
--leader-socket PATH | path | runtime confirmed | read only | Use a custom leader socket path. |
grok leader kill runtime confirmed high impact
Stop a running leader process.
grok leader kill [OPTIONS]| Options | Type | Availability | Risk | Summary |
|---|---|---|---|---|
--debug | boolean | runtime confirmed | review | Enable debug logging. |
--debug-file FILE | path | runtime confirmed | review | Write debug logs to a file; review logs before sharing them. |
-h, --help | boolean | runtime confirmed | read only | Print help for this command. |
--leader-socket PATH | path | runtime confirmed | read only | Use a custom leader socket path. |
10 login 1 Shell commands
grok login runtime confirmed review
Sign in to Grok Build.
grok login [OPTIONS]| Options | Type | Availability | Risk | Summary |
|---|---|---|---|---|
--oauth | boolean | runtime confirmed | review | Use browser OAuth. |
--device-auth | boolean | runtime confirmed | review | Use device-code authentication for remote or headless terminals. |
--debug | boolean | runtime confirmed | review | Enable debug logging. |
--debug-file FILE | path | runtime confirmed | review | Write debug logs to a file; review logs before sharing them. |
-h, --help | boolean | runtime confirmed | read only | Print help for this command. |
--leader-socket PATH | path | runtime confirmed | read only | Use a custom leader socket path. |
Examples
grok-runtime-1.0.0 grok logingrok login --device-auth11 logout 1 Shell commands
grok logout runtime confirmed high impact
Sign out and clear cached credentials.
grok logout [OPTIONS]| Options | Type | Availability | Risk | Summary |
|---|---|---|---|---|
--debug | boolean | runtime confirmed | review | Enable debug logging. |
--debug-file FILE | path | runtime confirmed | review | Write debug logs to a file; review logs before sharing them. |
-h, --help | boolean | runtime confirmed | read only | Print help for this command. |
--leader-socket PATH | path | runtime confirmed | read only | Use a custom leader socket path. |
12 mcp 7 Shell commands
grok mcp runtime confirmed review
Manage MCP server configurations.
grok mcp [OPTIONS] <COMMAND>| Options | Type | Availability | Risk | Summary |
|---|---|---|---|---|
--debug | boolean | runtime confirmed | review | Enable debug logging. |
--debug-file FILE | path | runtime confirmed | review | Write debug logs to a file; review logs before sharing them. |
-h, --help | boolean | runtime confirmed | read only | Print help for this command. |
--leader-socket PATH | path | runtime confirmed | read only | Use a custom leader socket path. |
grok mcp list runtime confirmed read only
List configured MCP servers.
grok mcp list [OPTIONS]| Options | Type | Availability | Risk | Summary |
|---|---|---|---|---|
--json | boolean | runtime confirmed | read only | Emit JSON. |
--debug | boolean | runtime confirmed | review | Enable debug logging. |
--debug-file FILE | path | runtime confirmed | review | Write debug logs to a file; review logs before sharing them. |
-h, --help | boolean | runtime confirmed | read only | Print help for this command. |
--leader-socket PATH | path | runtime confirmed | read only | Use a custom leader socket path. |
Examples
grok-runtime-1.0.0 grok mcp list --jsongrok mcp add runtime confirmed high impact
Add or replace a user- or project-scoped MCP server.
grok mcp add [OPTIONS] <NAME> [COMMAND_OR_URL] [ARGS]...| Options | Type | Availability | Risk | Summary |
|---|---|---|---|---|
-t, --transport TRANSPORT | enum: stdio | http | sse | runtime confirmed | read only | Select stdio, streamable HTTP, or SSE transport. |
-s, --scope SCOPE | enum: user | project | runtime confirmed | review | Write to user or project configuration. |
-e, --env KEY=value | string | runtime confirmed | high impact | Add a process environment entry; avoid literal secret values. |
-H, --header NAME: VALUE | string | runtime confirmed | high impact | Add an HTTP header; prefer environment-backed configuration for secrets. |
--debug | boolean | runtime confirmed | review | Enable debug logging. |
--debug-file FILE | path | runtime confirmed | review | Write debug logs to a file; review logs before sharing them. |
-h, --help | boolean | runtime confirmed | read only | Print help for this command. |
--leader-socket PATH | path | runtime confirmed | read only | Use a custom leader socket path. |
Examples
grok-runtime-1.0.0 grok mcp add filesystem -- npx -y @modelcontextprotocol/server-filesystem /path/to/dirgrok mcp add --transport http docs https://example.invalid/mcpgrok mcp remove runtime confirmed high impact
Remove an MCP server from one configuration scope.
grok mcp remove [OPTIONS] <NAME>| Options | Type | Availability | Risk | Summary |
|---|---|---|---|---|
-s, --scope SCOPE | enum: user | project | runtime confirmed | review | Select the configuration scope. |
--debug | boolean | runtime confirmed | review | Enable debug logging. |
--debug-file FILE | path | runtime confirmed | review | Write debug logs to a file; review logs before sharing them. |
-h, --help | boolean | runtime confirmed | read only | Print help for this command. |
--leader-socket PATH | path | runtime confirmed | read only | Use a custom leader socket path. |
grok mcp enable runtime confirmed review
Enable a configured MCP server.
grok mcp enable [OPTIONS] <NAME>| Options | Type | Availability | Risk | Summary |
|---|---|---|---|---|
--debug | boolean | runtime confirmed | review | Enable debug logging. |
--debug-file FILE | path | runtime confirmed | review | Write debug logs to a file; review logs before sharing them. |
-h, --help | boolean | runtime confirmed | read only | Print help for this command. |
--leader-socket PATH | path | runtime confirmed | read only | Use a custom leader socket path. |
grok mcp disable runtime confirmed review
Disable a configured MCP server.
grok mcp disable [OPTIONS] <NAME>| Options | Type | Availability | Risk | Summary |
|---|---|---|---|---|
--debug | boolean | runtime confirmed | review | Enable debug logging. |
--debug-file FILE | path | runtime confirmed | review | Write debug logs to a file; review logs before sharing them. |
-h, --help | boolean | runtime confirmed | read only | Print help for this command. |
--leader-socket PATH | path | runtime confirmed | read only | Use a custom leader socket path. |
grok mcp doctor runtime confirmed read only
Diagnose MCP configuration and connectivity.
grok mcp doctor [OPTIONS] [NAME]| Options | Type | Availability | Risk | Summary |
|---|---|---|---|---|
--json | boolean | runtime confirmed | read only | Emit JSON diagnostics. |
--debug | boolean | runtime confirmed | review | Enable debug logging. |
--debug-file FILE | path | runtime confirmed | review | Write debug logs to a file; review logs before sharing them. |
-h, --help | boolean | runtime confirmed | read only | Print help for this command. |
--leader-socket PATH | path | runtime confirmed | read only | Use a custom leader socket path. |
Examples
grok-runtime-1.0.0 grok mcp doctor --json13 memory 2 Shell commands
grok memory runtime confirmed review
Manage cross-session memory.
grok memory [OPTIONS] <COMMAND>| Options | Type | Availability | Risk | Summary |
|---|---|---|---|---|
--debug | boolean | runtime confirmed | review | Enable debug logging. |
--debug-file FILE | path | runtime confirmed | review | Write debug logs to a file; review logs before sharing them. |
-h, --help | boolean | runtime confirmed | read only | Print help for this command. |
--leader-socket PATH | path | runtime confirmed | read only | Use a custom leader socket path. |
grok memory clear runtime confirmed high impact
Delete workspace, global, or all memory files.
grok memory clear [OPTIONS]| Options | Type | Availability | Risk | Summary |
|---|---|---|---|---|
--workspace | boolean | runtime confirmed | high impact | Clear workspace memory. |
--global | boolean | runtime confirmed | high impact | Clear global memory. |
--all | boolean | runtime confirmed | high impact | Clear all memory scopes. |
-y, --yes | boolean | runtime confirmed | high impact | Skip confirmation. |
--debug | boolean | runtime confirmed | review | Enable debug logging. |
--debug-file FILE | path | runtime confirmed | review | Write debug logs to a file; review logs before sharing them. |
-h, --help | boolean | runtime confirmed | read only | Print help for this command. |
--leader-socket PATH | path | runtime confirmed | read only | Use a custom leader socket path. |
14 models 1 Shell commands
grok models runtime confirmed read only
List available models and exit.
grok models [OPTIONS]| Options | Type | Availability | Risk | Summary |
|---|---|---|---|---|
--debug | boolean | runtime confirmed | review | Enable debug logging. |
--debug-file FILE | path | runtime confirmed | review | Write debug logs to a file; review logs before sharing them. |
-h, --help | boolean | runtime confirmed | read only | Print help for this command. |
--leader-socket PATH | path | runtime confirmed | read only | Use a custom leader socket path. |
15 plugin 15 Shell commands
grok plugin runtime confirmed review
Manage plugins and marketplace sources.
grok plugin [OPTIONS] <COMMAND>| Options | Type | Availability | Risk | Summary |
|---|---|---|---|---|
--debug | boolean | runtime confirmed | review | Enable debug logging. |
--debug-file FILE | path | runtime confirmed | review | Write debug logs to a file; review logs before sharing them. |
-h, --help | boolean | runtime confirmed | read only | Print help for this command. |
--leader-socket PATH | path | runtime confirmed | read only | Use a custom leader socket path. |
grok plugin list runtime confirmed read only
List installed or available plugins.
grok plugin list [OPTIONS]| Options | Type | Availability | Risk | Summary |
|---|---|---|---|---|
--json | boolean | runtime confirmed | read only | Emit JSON. |
--available | boolean | runtime confirmed | read only | Include available marketplace plugins. |
--debug | boolean | runtime confirmed | review | Enable debug logging. |
--debug-file FILE | path | runtime confirmed | review | Write debug logs to a file; review logs before sharing them. |
-h, --help | boolean | runtime confirmed | read only | Print help for this command. |
--leader-socket PATH | path | runtime confirmed | read only | Use a custom leader socket path. |
grok plugin install runtime confirmed high impact
Install a plugin from a git URL, GitHub shorthand, or local path.
grok plugin install [OPTIONS] <SOURCE>| Options | Type | Availability | Risk | Summary |
|---|---|---|---|---|
--trust | boolean | runtime confirmed | high impact | Trust the plugin immediately and skip confirmation. |
--debug | boolean | runtime confirmed | review | Enable debug logging. |
--debug-file FILE | path | runtime confirmed | review | Write debug logs to a file; review logs before sharing them. |
-h, --help | boolean | runtime confirmed | read only | Print help for this command. |
--leader-socket PATH | path | runtime confirmed | read only | Use a custom leader socket path. |
grok plugin uninstall runtime confirmed high impact
Uninstall an installed plugin.
grok plugin uninstall [OPTIONS] <NAME>| Options | Type | Availability | Risk | Summary |
|---|---|---|---|---|
--confirm | boolean | runtime confirmed | high impact | Skip confirmation for multi-plugin repositories. |
--keep-data | boolean | runtime confirmed | read only | Preserve the plugin data directory. |
--debug | boolean | runtime confirmed | review | Enable debug logging. |
--debug-file FILE | path | runtime confirmed | review | Write debug logs to a file; review logs before sharing them. |
-h, --help | boolean | runtime confirmed | read only | Print help for this command. |
--leader-socket PATH | path | runtime confirmed | read only | Use a custom leader socket path. |
grok plugin update runtime confirmed high impact
Update one plugin or all installed plugins.
grok plugin update [OPTIONS] [NAME]| Options | Type | Availability | Risk | Summary |
|---|---|---|---|---|
--debug | boolean | runtime confirmed | review | Enable debug logging. |
--debug-file FILE | path | runtime confirmed | review | Write debug logs to a file; review logs before sharing them. |
-h, --help | boolean | runtime confirmed | read only | Print help for this command. |
--leader-socket PATH | path | runtime confirmed | read only | Use a custom leader socket path. |
grok plugin enable runtime confirmed review
Enable an installed plugin.
grok plugin enable [OPTIONS] <NAME>| Options | Type | Availability | Risk | Summary |
|---|---|---|---|---|
--debug | boolean | runtime confirmed | review | Enable debug logging. |
--debug-file FILE | path | runtime confirmed | review | Write debug logs to a file; review logs before sharing them. |
-h, --help | boolean | runtime confirmed | read only | Print help for this command. |
--leader-socket PATH | path | runtime confirmed | read only | Use a custom leader socket path. |
grok plugin disable runtime confirmed review
Disable an installed plugin.
grok plugin disable [OPTIONS] <NAME>| Options | Type | Availability | Risk | Summary |
|---|---|---|---|---|
--debug | boolean | runtime confirmed | review | Enable debug logging. |
--debug-file FILE | path | runtime confirmed | review | Write debug logs to a file; review logs before sharing them. |
-h, --help | boolean | runtime confirmed | read only | Print help for this command. |
--leader-socket PATH | path | runtime confirmed | read only | Use a custom leader socket path. |
grok plugin details runtime confirmed read only
Show plugin metadata and capabilities.
grok plugin details [OPTIONS] <NAME>| Options | Type | Availability | Risk | Summary |
|---|---|---|---|---|
--debug | boolean | runtime confirmed | review | Enable debug logging. |
--debug-file FILE | path | runtime confirmed | review | Write debug logs to a file; review logs before sharing them. |
-h, --help | boolean | runtime confirmed | read only | Print help for this command. |
--leader-socket PATH | path | runtime confirmed | read only | Use a custom leader socket path. |
grok plugin validate runtime confirmed read only
Validate a plugin manifest and layout.
grok plugin validate [OPTIONS] [PATH]| Options | Type | Availability | Risk | Summary |
|---|---|---|---|---|
--debug | boolean | runtime confirmed | review | Enable debug logging. |
--debug-file FILE | path | runtime confirmed | review | Write debug logs to a file; review logs before sharing them. |
-h, --help | boolean | runtime confirmed | read only | Print help for this command. |
--leader-socket PATH | path | runtime confirmed | read only | Use a custom leader socket path. |
grok plugin tag runtime confirmed high impact
Create a release git tag from a plugin manifest version.
grok plugin tag [OPTIONS] [PATH]| Options | Type | Availability | Risk | Summary |
|---|---|---|---|---|
--push | boolean | runtime confirmed | high impact | Push the tag to the remote. |
-f, --force | boolean | runtime confirmed | high impact | Tag even when the worktree is dirty or the tag exists. |
--dry-run | boolean | runtime confirmed | read only | Print the proposed tag without creating it. |
--debug | boolean | runtime confirmed | review | Enable debug logging. |
--debug-file FILE | path | runtime confirmed | review | Write debug logs to a file; review logs before sharing them. |
-h, --help | boolean | runtime confirmed | read only | Print help for this command. |
--leader-socket PATH | path | runtime confirmed | read only | Use a custom leader socket path. |
grok plugin marketplace runtime confirmed review
Manage plugin marketplace sources.
grok plugin marketplace [OPTIONS] <COMMAND>| Options | Type | Availability | Risk | Summary |
|---|---|---|---|---|
--debug | boolean | runtime confirmed | review | Enable debug logging. |
--debug-file FILE | path | runtime confirmed | review | Write debug logs to a file; review logs before sharing them. |
-h, --help | boolean | runtime confirmed | read only | Print help for this command. |
--leader-socket PATH | path | runtime confirmed | read only | Use a custom leader socket path. |
grok plugin marketplace list runtime confirmed read only
List configured marketplace sources and their plugins.
grok plugin marketplace list [OPTIONS]| Options | Type | Availability | Risk | Summary |
|---|---|---|---|---|
--json | boolean | runtime confirmed | read only | Emit JSON. |
--debug | boolean | runtime confirmed | review | Enable debug logging. |
--debug-file FILE | path | runtime confirmed | review | Write debug logs to a file; review logs before sharing them. |
-h, --help | boolean | runtime confirmed | read only | Print help for this command. |
--leader-socket PATH | path | runtime confirmed | read only | Use a custom leader socket path. |
grok plugin marketplace add runtime confirmed high impact
Add a marketplace source.
grok plugin marketplace add [OPTIONS] <URL>| Options | Type | Availability | Risk | Summary |
|---|---|---|---|---|
--force | boolean | runtime confirmed | high impact | Replace conflicting marketplace state. |
--debug | boolean | runtime confirmed | review | Enable debug logging. |
--debug-file FILE | path | runtime confirmed | review | Write debug logs to a file; review logs before sharing them. |
-h, --help | boolean | runtime confirmed | read only | Print help for this command. |
--leader-socket PATH | path | runtime confirmed | read only | Use a custom leader socket path. |
grok plugin marketplace remove runtime confirmed high impact
Remove a marketplace source and uninstall its plugins.
grok plugin marketplace remove [OPTIONS] <SOURCE>| Options | Type | Availability | Risk | Summary |
|---|---|---|---|---|
--debug | boolean | runtime confirmed | review | Enable debug logging. |
--debug-file FILE | path | runtime confirmed | review | Write debug logs to a file; review logs before sharing them. |
-h, --help | boolean | runtime confirmed | read only | Print help for this command. |
--leader-socket PATH | path | runtime confirmed | read only | Use a custom leader socket path. |
grok plugin marketplace update runtime confirmed high impact
Refresh marketplace sources and synchronize their git caches.
grok plugin marketplace update [OPTIONS] [NAME]| Options | Type | Availability | Risk | Summary |
|---|---|---|---|---|
--debug | boolean | runtime confirmed | review | Enable debug logging. |
--debug-file FILE | path | runtime confirmed | review | Write debug logs to a file; review logs before sharing them. |
-h, --help | boolean | runtime confirmed | read only | Print help for this command. |
--leader-socket PATH | path | runtime confirmed | read only | Use a custom leader socket path. |
16 sessions 4 Shell commands
grok sessions runtime confirmed review
List, search, or delete sessions.
grok sessions [OPTIONS] <COMMAND>| Options | Type | Availability | Risk | Summary |
|---|---|---|---|---|
--debug | boolean | runtime confirmed | review | Enable debug logging. |
--debug-file FILE | path | runtime confirmed | review | Write debug logs to a file; review logs before sharing them. |
-h, --help | boolean | runtime confirmed | read only | Print help for this command. |
--leader-socket PATH | path | runtime confirmed | read only | Use a custom leader socket path. |
grok sessions list runtime confirmed read only
List recent sessions.
grok sessions list [OPTIONS]| Options | Type | Availability | Risk | Summary |
|---|---|---|---|---|
-n, --limit LIMIT | integer | runtime confirmed | read only | Limit the number of results. |
--debug | boolean | runtime confirmed | review | Enable debug logging. |
--debug-file FILE | path | runtime confirmed | review | Write debug logs to a file; review logs before sharing them. |
-h, --help | boolean | runtime confirmed | read only | Print help for this command. |
--leader-socket PATH | path | runtime confirmed | read only | Use a custom leader socket path. |
grok sessions search runtime confirmed review
Search persisted sessions by keyword.
grok sessions search [OPTIONS] <QUERY>| Options | Type | Availability | Risk | Summary |
|---|---|---|---|---|
-n, --limit LIMIT | integer | runtime confirmed | read only | Limit the number of results. |
--debug | boolean | runtime confirmed | review | Enable debug logging. |
--debug-file FILE | path | runtime confirmed | review | Write debug logs to a file; review logs before sharing them. |
-h, --help | boolean | runtime confirmed | read only | Print help for this command. |
--leader-socket PATH | path | runtime confirmed | read only | Use a custom leader socket path. |
grok sessions delete runtime confirmed high impact
Permanently delete a session from local history.
grok sessions delete [OPTIONS] <ID>| Options | Type | Availability | Risk | Summary |
|---|---|---|---|---|
--debug | boolean | runtime confirmed | review | Enable debug logging. |
--debug-file FILE | path | runtime confirmed | review | Write debug logs to a file; review logs before sharing them. |
-h, --help | boolean | runtime confirmed | read only | Print help for this command. |
--leader-socket PATH | path | runtime confirmed | read only | Use a custom leader socket path. |
17 setup 1 Shell commands
grok setup runtime confirmed high impact
Fetch and install managed configuration.
grok setup [OPTIONS]| Options | Type | Availability | Risk | Summary |
|---|---|---|---|---|
--json | boolean | runtime confirmed | review | Print the served configuration without installing it; review before sharing. |
--debug | boolean | runtime confirmed | review | Enable debug logging. |
--debug-file FILE | path | runtime confirmed | review | Write debug logs to a file; review logs before sharing them. |
-h, --help | boolean | runtime confirmed | read only | Print help for this command. |
--leader-socket PATH | path | runtime confirmed | read only | Use a custom leader socket path. |
18 trace 1 Shell commands
grok trace runtime confirmed high impact
Export or upload session trace data.
grok trace [OPTIONS] <SESSION_ID>| Options | Type | Availability | Risk | Summary |
|---|---|---|---|---|
--local | boolean | runtime confirmed | review | Save locally and skip remote upload. |
-o, --output OUTPUT | path | runtime confirmed | review | Select the local trace archive path. |
--json | boolean | runtime confirmed | read only | Emit JSON status. |
--debug | boolean | runtime confirmed | review | Enable debug logging. |
--debug-file FILE | path | runtime confirmed | review | Write debug logs to a file; review logs before sharing them. |
-h, --help | boolean | runtime confirmed | read only | Print help for this command. |
--leader-socket PATH | path | runtime confirmed | read only | Use a custom leader socket path. |
19 update 1 Shell commands
grok update runtime confirmed high impact
Check for updates or install a selected version or channel.
grok update [OPTIONS]| Options | Type | Availability | Risk | Summary |
|---|---|---|---|---|
--check | boolean | runtime confirmed | read only | Check without installing. |
--json | boolean | runtime confirmed | read only | Emit JSON for an update check. |
--force-reinstall | boolean | runtime confirmed | high impact | Download and reinstall even when already current. |
--version VERSION | string | runtime confirmed | high impact | Install a specific release version. |
--alpha | boolean | runtime confirmed | review | Switch to the faster-moving alpha channel. |
--stable | boolean | runtime confirmed | review | Switch to the stable release channel. |
--debug | boolean | runtime confirmed | review | Enable debug logging. |
--debug-file FILE | path | runtime confirmed | review | Write debug logs to a file; review logs before sharing them. |
-h, --help | boolean | runtime confirmed | read only | Print help for this command. |
--leader-socket PATH | path | runtime confirmed | read only | Use a custom leader socket path. |
Examples
grok-runtime-1.0.0 grok update --check --json20 version 1 Shell commands
grok version runtime confirmed read only
Print detailed version information.
grok version [OPTIONS]| Options | Type | Availability | Risk | Summary |
|---|---|---|---|---|
--json | boolean | runtime confirmed | read only | Emit JSON. |
--debug | boolean | runtime confirmed | review | Enable debug logging. |
--debug-file FILE | path | runtime confirmed | review | Write debug logs to a file; review logs before sharing them. |
-h, --help | boolean | runtime confirmed | read only | Print help for this command. |
--leader-socket PATH | path | runtime confirmed | read only | Use a custom leader socket path. |
Examples
grok-runtime-1.0.0 grok version --json21 worktree 9 Shell commands
grok worktree runtime confirmed review
Manage git worktrees created for sessions.
grok worktree [OPTIONS] <COMMAND>| Options | Type | Availability | Risk | Summary |
|---|---|---|---|---|
--debug | boolean | runtime confirmed | review | Enable debug logging. |
--debug-file FILE | path | runtime confirmed | review | Write debug logs to a file; review logs before sharing them. |
-h, --help | boolean | runtime confirmed | read only | Print help for this command. |
--leader-socket PATH | path | runtime confirmed | read only | Use a custom leader socket path. |
grok worktree list runtime confirmed read only
List tracked worktrees.
grok worktree list [OPTIONS]| Options | Type | Availability | Risk | Summary |
|---|---|---|---|---|
--repo REPO | path | runtime confirmed | read only | Filter by repository. |
--type TYPE | string | runtime confirmed | read only | Filter by worktree type. |
--json | boolean | runtime confirmed | read only | Emit JSON. |
--all | boolean | runtime confirmed | read only | Include all tracked worktrees. |
--debug | boolean | runtime confirmed | review | Enable debug logging. |
--debug-file FILE | path | runtime confirmed | review | Write debug logs to a file; review logs before sharing them. |
-h, --help | boolean | runtime confirmed | read only | Print help for this command. |
--leader-socket PATH | path | runtime confirmed | read only | Use a custom leader socket path. |
grok worktree show runtime confirmed read only
Show details for one worktree.
grok worktree show [OPTIONS] <ID_OR_PATH>| Options | Type | Availability | Risk | Summary |
|---|---|---|---|---|
--debug | boolean | runtime confirmed | review | Enable debug logging. |
--debug-file FILE | path | runtime confirmed | review | Write debug logs to a file; review logs before sharing them. |
-h, --help | boolean | runtime confirmed | read only | Print help for this command. |
--leader-socket PATH | path | runtime confirmed | read only | Use a custom leader socket path. |
grok worktree rm runtime confirmed high impact
Remove one or more tracked worktrees.
grok worktree rm [OPTIONS] <IDS>...| Options | Type | Availability | Risk | Summary |
|---|---|---|---|---|
-f, --force | boolean | runtime confirmed | high impact | Force removal. |
--dry-run | boolean | runtime confirmed | read only | Show what would be removed. |
--debug | boolean | runtime confirmed | review | Enable debug logging. |
--debug-file FILE | path | runtime confirmed | review | Write debug logs to a file; review logs before sharing them. |
-h, --help | boolean | runtime confirmed | read only | Print help for this command. |
--leader-socket PATH | path | runtime confirmed | read only | Use a custom leader socket path. |
Examples
grok-runtime-1.0.0 grok worktree rm --dry-run <id>grok worktree gc runtime confirmed high impact
Garbage-collect orphaned or stale worktrees.
grok worktree gc [OPTIONS]| Options | Type | Availability | Risk | Summary |
|---|---|---|---|---|
--dry-run | boolean | runtime confirmed | read only | Show candidates without removing them. |
--max-age MAX_AGE | string | runtime confirmed | read only | Set the maximum age used for collection. |
-f, --force | boolean | runtime confirmed | high impact | Force garbage collection. |
--debug | boolean | runtime confirmed | review | Enable debug logging. |
--debug-file FILE | path | runtime confirmed | review | Write debug logs to a file; review logs before sharing them. |
-h, --help | boolean | runtime confirmed | read only | Print help for this command. |
--leader-socket PATH | path | runtime confirmed | read only | Use a custom leader socket path. |
Examples
grok-runtime-1.0.0 grok worktree gc --dry-rungrok worktree db runtime confirmed review
Maintain the worktree tracking database.
grok worktree db [OPTIONS] <COMMAND>| Options | Type | Availability | Risk | Summary |
|---|---|---|---|---|
--debug | boolean | runtime confirmed | review | Enable debug logging. |
--debug-file FILE | path | runtime confirmed | review | Write debug logs to a file; review logs before sharing them. |
-h, --help | boolean | runtime confirmed | read only | Print help for this command. |
--leader-socket PATH | path | runtime confirmed | read only | Use a custom leader socket path. |
grok worktree db rebuild runtime confirmed high impact
Rebuild the tracking database from a filesystem scan.
grok worktree db rebuild [OPTIONS]| Options | Type | Availability | Risk | Summary |
|---|---|---|---|---|
--debug | boolean | runtime confirmed | review | Enable debug logging. |
--debug-file FILE | path | runtime confirmed | review | Write debug logs to a file; review logs before sharing them. |
-h, --help | boolean | runtime confirmed | read only | Print help for this command. |
--leader-socket PATH | path | runtime confirmed | read only | Use a custom leader socket path. |
grok worktree db stats runtime confirmed read only
Show worktree database statistics.
grok worktree db stats [OPTIONS]| Options | Type | Availability | Risk | Summary |
|---|---|---|---|---|
--debug | boolean | runtime confirmed | review | Enable debug logging. |
--debug-file FILE | path | runtime confirmed | review | Write debug logs to a file; review logs before sharing them. |
-h, --help | boolean | runtime confirmed | read only | Print help for this command. |
--leader-socket PATH | path | runtime confirmed | read only | Use a custom leader socket path. |
grok worktree db path runtime confirmed read only
Print the worktree database path.
grok worktree db path [OPTIONS]| Options | Type | Availability | Risk | Summary |
|---|---|---|---|---|
--debug | boolean | runtime confirmed | review | Enable debug logging. |
--debug-file FILE | path | runtime confirmed | review | Write debug logs to a file; review logs before sharing them. |
-h, --help | boolean | runtime confirmed | read only | Print help for this command. |
--leader-socket PATH | path | runtime confirmed | read only | Use a custom leader socket path. |
22 wrap 1 Shell commands
grok wrap runtime confirmed review
Run a command in a local PTY that forwards OSC 52 clipboard writes.
grok wrap [OPTIONS] <CMD>...| Options | Type | Availability | Risk | Summary |
|---|---|---|---|---|
--debug | boolean | runtime confirmed | review | Enable debug logging. |
--debug-file FILE | path | runtime confirmed | review | Write debug logs to a file; review logs before sharing them. |
-h, --help | boolean | runtime confirmed | read only | Print help for this command. |
--leader-socket PATH | path | runtime confirmed | read only | Use a custom leader socket path. |
Examples
grok-runtime-1.0.0 grok wrap docker exec -it my-container bash02 / INTERACTIVE
TUI slash commands
Interactive tokens are not shell subcommands. Source-only entries remain marked preview.
/new docs confirmed Start a fresh session.
Aliases: /clear/resume docs confirmed Open the session picker.
/dashboard docs confirmed Open the Agent Dashboard.
Aliases: /agents-dashboard, /sessions/compact docs confirmed Compact conversation history with an optional preservation note.
/context docs confirmed Show context-window usage.
/session-info docs confirmed Show session, authentication, model, turn, and context metadata.
Aliases: /status, /info/fork docs confirmed Branch the current session into a peer agent.
/rewind docs confirmed Roll back to an earlier turn.
/edit-prompt source preview Open an external editor for the prompt in minimal mode.
/copy docs confirmed Copy a recent response.
/export docs confirmed Export the conversation.
/quit docs confirmed Quit Grok Build.
Aliases: /exit/help docs confirmed Browse commands and keyboard shortcuts.
/home docs confirmed Return to the welcome screen.
Aliases: /welcome/delete source preview Delete the current session after confirmation.
/rename docs confirmed Rename the current session.
Aliases: /title/share docs confirmed Share the current session through a URL.
/find docs confirmed Search conversation scrollback.
/transcript docs confirmed Open the transcript in the configured pager.
/model docs confirmed Switch the active model.
Aliases: /m/effort docs confirmed Set reasoning effort.
/always-approve docs confirmed Toggle always-approve permission mode.
/auto docs confirmed Toggle classifier-assisted auto approval when enabled.
/multiline docs confirmed Toggle multiline prompt entry.
Aliases: /ml/history source preview Search prompt history.
/compact-mode docs confirmed Toggle denser rendering.
/vim-mode docs confirmed Toggle vim-style scrollback navigation.
/minimal source preview Switch to scrollback-native rendering.
/fullscreen source preview Switch to fullscreen rendering.
/plan docs confirmed Enter plan mode.
/view-plan docs confirmed Open the saved plan.
Aliases: /show-plan, /plan-view/memory docs confirmed Browse or toggle cross-session memory.
Aliases: /mem/flush docs confirmed Flush conversation knowledge to memory.
/dream docs confirmed Run memory consolidation.
/remember docs confirmed Save a memory note.
/hooks docs confirmed Open the Hooks extensions tab.
/plugins docs confirmed Open the Plugins extensions tab.
/marketplace docs confirmed Open the Marketplace extensions tab.
/skills docs confirmed Open the Skills extensions tab.
/mcps docs confirmed Open the MCP extensions tab.
/imagine docs confirmed Generate an image from a prompt when available.
/imagine-video docs confirmed Generate a video when available.
/loop docs confirmed Schedule a recurring prompt.
/goal source preview Start or inspect a goal workflow.
/deep-research source preview Run a deep-research workflow.
/workflow source preview Manage one background workflow.
/workflows source preview Open the workflow run dashboard.
/tasks docs confirmed List tasks, subagents, and schedules.
/queue docs confirmed List queued prompts.
/theme docs confirmed Select the TUI theme.
Aliases: /t/feedback docs confirmed Send product feedback.
/btw docs confirmed Ask a side question without interrupting the main turn.
/doctor source preview Inspect terminal and sandbox support.
Aliases: /terminal-check, /terminal-info/release-notes docs confirmed Show release notes.
Aliases: /changelog/docs source preview Browse bundled or web documentation.
Aliases: /howto, /guides/tutorial source preview Open the onboarding tutorial.
Aliases: /tour, /onboarding/import-claude docs confirmed Open the compatibility-settings import modal.
/config-agents docs confirmed Manage agent definitions.
Aliases: /agents/personas docs confirmed Manage personas.
/login docs confirmed Sign in.
/logout docs confirmed Sign out.
/usage docs confirmed View usage and billing controls.
/privacy docs confirmed View privacy and retention status.
/settings docs confirmed Open settings.
Aliases: /config/timestamps docs confirmed Toggle message timestamps.
/terminal-setup docs confirmed Inspect terminal and clipboard support.
03 / PUBLIC SCHEMA
Configuration schema
Public key names and value shapes only. No local values are loaded.
| Key | Type | Default | Availability | Summary |
|---|---|---|---|---|
models.default | string | — | docs confirmed | Default model for new sessions. |
models.web_search | string | — | docs confirmed | Model used by client-side web search. |
models.default_reasoning_effort | enum: low | medium | high | — | docs confirmed | Default reasoning effort. |
models.session_summary | string | — | docs confirmed | Model used for session summaries. |
models.image_description | string | — | docs confirmed | Model used for image description. |
models.extra_headers | object | — | docs confirmed | Headers applied to every model. · Sensitive |
models.temperature | number | — | docs confirmed | Global temperature default. |
models.top_p | number | — | docs confirmed | Global top-p default. |
models.max_completion_tokens | integer | — | docs confirmed | Global completion-token limit. |
models.max_retries | integer | — | docs confirmed | Global inference retry limit. |
models.stream_tool_calls | boolean | — | docs confirmed | Stream tool-call request content. |
models.allowed_models | array | — | docs confirmed | Restrict selectable models by glob. |
models.hidden_models | array | — | docs confirmed | Hide models from the picker. |
models.disabled_models | array | — | docs confirmed | Remove models from the catalog. |
model.<id>.model | string | — | docs confirmed | Provider model ID. |
model.<id>.base_url | url | — | docs confirmed | Provider inference endpoint. |
model.<id>.name | string | — | docs confirmed | Model-picker label. |
model.<id>.description | string | — | docs confirmed | Model description. |
model.<id>.api_key | string | — | docs confirmed | Inline API key; prefer env_key. · Sensitive |
model.<id>.env_key | string | — | docs confirmed | Name of the environment variable containing the API key. |
model.<id>.api_backend | enum: chat_completions | responses | messages | — | docs confirmed | Provider protocol. |
model.<id>.temperature | number | — | docs confirmed | Per-model temperature. |
model.<id>.top_p | number | — | docs confirmed | Per-model top-p. |
model.<id>.max_completion_tokens | integer | — | docs confirmed | Per-model completion-token limit. |
model.<id>.context_window | integer | — | docs confirmed | Context-window size. |
model.<id>.extra_headers | object | — | docs confirmed | Per-request headers. · Sensitive |
model.<id>.supports_backend_search | boolean | — | docs confirmed | Whether provider-hosted search is supported. |
model.<id>.supports_reasoning_effort | boolean | — | docs confirmed | Whether reasoning effort is supported. |
model.<id>.reasoning_effort | enum: low | medium | high | — | docs confirmed | Per-model reasoning effort. |
model.<id>.stream_tool_calls | boolean | — | docs confirmed | Per-model tool-call streaming. |
model.<id>.max_retries | integer | — | docs confirmed | Per-model retry limit. |
model.<id>.inference_idle_timeout_secs | integer | — | docs confirmed | Inference idle timeout. |
mcp_servers.<name>.command | string | — | docs confirmed | Executable for a stdio MCP server. |
mcp_servers.<name>.args | array | — | docs confirmed | Arguments for a stdio MCP server. |
mcp_servers.<name>.env | object | — | docs confirmed | Environment for a stdio MCP process. · Sensitive |
mcp_servers.<name>.cwd | path | — | docs confirmed | Working directory for a stdio MCP process. |
mcp_servers.<name>.url | url | — | docs confirmed | Remote MCP URL. |
mcp_servers.<name>.headers | object | — | docs confirmed | Remote MCP headers. · Sensitive |
mcp_servers.<name>.bearer_token_env_var | string | — | docs confirmed | Environment variable used for a bearer token. |
mcp_servers.<name>.enabled | boolean | true | docs confirmed | Enable the MCP server. |
mcp_servers.<name>.startup_timeout_sec | integer | 30 | docs confirmed | Startup handshake timeout. |
mcp_servers.<name>.tool_timeout_sec | integer | 6000 | docs confirmed | Default per-tool timeout. |
mcp_servers.<name>.tool_timeouts | object | — | docs confirmed | Per-tool timeout overrides. |
tools.respect_gitignore | boolean | false | docs confirmed | Skip gitignored files in search and read tools. |
toolset.file_toolset | enum: standard | hashline | standard | docs confirmed | File editing scheme. |
toolset.bash.timeout_secs | integer | 120 | docs confirmed | Foreground bash timeout. |
toolset.bash.output_byte_limit | integer | 20000 | docs confirmed | Maximum captured bash output. |
toolset.bash.max_timeout_secs | integer | 36000 | docs confirmed | Maximum model-requested bash timeout. |
toolset.bash.auto_background_on_timeout | boolean | true | docs confirmed | Background commands that exceed the foreground timeout. |
toolset.web_fetch.proxy_endpoint | url | — | docs confirmed | Egress proxy for web_fetch. |
toolset.web_fetch.allowed_domains | array | — | docs confirmed | Domain allowlist for web_fetch. |
sandbox.profile | enum: off | workspace | devbox | read-only | strict | off | docs confirmed | Active sandbox profile. |
sandbox.auto_allow_bash | boolean | false | docs confirmed | Skip bash prompts inside an active sandbox. |
sandbox.toml.profiles.<name>.extends | enum: workspace | devbox | read-only | strict | workspace | docs confirmed | Built-in profile inherited by a custom profile. |
sandbox.toml.profiles.<name>.restrict_network | boolean | — | docs confirmed | Restrict network access. |
sandbox.toml.profiles.<name>.read_only | array | — | docs confirmed | Additional read-only paths. |
sandbox.toml.profiles.<name>.read_write | array | — | docs confirmed | Additional writable paths. |
sandbox.toml.profiles.<name>.deny | array | — | docs confirmed | Kernel-enforced denied paths or globs. · Sensitive |
session.auto_compact_threshold_percent | integer | 85 | docs confirmed | Context percentage that triggers automatic compaction. |
session.load_envrc | boolean | true | docs confirmed | Inject .envrc variables into bash. · Sensitive |
cli.auto_update | boolean | true | docs confirmed | Check for updates on launch. |
cli.channel | enum: stable | alpha | stable | docs confirmed | Release channel. |
cli.show_tips | boolean | — | docs confirmed | Show startup tips. |
hints.new_session_worktree_mode | enum: ask | always | never | never | docs confirmed | Whether /new offers a worktree. |
hints.fork_worktree_mode | enum: ask | always | never | ask | docs confirmed | Whether /fork offers a worktree. |
ui.compact_mode | boolean | false | docs confirmed | Use denser message padding. |
ui.screen_mode | enum: fullscreen | minimal | fullscreen | docs confirmed | Default TUI render mode. |
ui.show_timestamps | boolean | true | docs confirmed | Show message timestamps. |
ui.show_timeline | boolean | false | docs confirmed | Show a per-turn timeline. |
ui.page_flip_on_send | boolean | true | docs confirmed | Move the sent prompt to the top of the viewport. |
ui.max_thoughts_width | integer | 120 | docs confirmed | Maximum thoughts-panel width. |
ui.combine_queued_prompts | boolean | false | docs confirmed | Merge consecutive queued prompts. |
ui.theme | string | — | docs confirmed | Color theme. |
ui.auto_dark_theme | string | groknight | docs confirmed | Theme used for dark system appearance. |
ui.auto_light_theme | string | grokday | docs confirmed | Theme used for light system appearance. |
ui.simple_mode | boolean | true | docs confirmed | Use readline prompt editing. |
ui.vim_mode | boolean | false | docs confirmed | Use vim keys in scrollback. |
ui.prompt_suggestions | boolean | true | docs confirmed | Show next-prompt suggestions. |
ui.mouse_reporting_toggle | boolean | false | docs confirmed | Allow Ctrl+R to toggle terminal mouse capture. |
ui.keep_text_selection | enum: flash | hold | word_select | flash | docs confirmed | In-app selection behavior. |
ui.cursor_blink | boolean | — | docs confirmed | Override terminal cursor blinking. |
ui.show_thinking_blocks | boolean | true | docs confirmed | Show reasoning blocks. |
ui.group_tool_verbs | boolean | true | docs confirmed | Fold consecutive read/search/list rows. |
ui.collapsed_edit_blocks | boolean | false | docs confirmed | Collapse edit blocks. |
ui.render_mermaid | enum: auto | on | off | auto | docs confirmed | Mermaid rendering mode. |
ui.scroll_speed | integer | 50 | docs confirmed | Mouse and trackpad scroll speed. |
ui.scroll_mode | enum: auto | wheel | trackpad | auto | docs confirmed | Scroll-input interpretation. |
ui.scroll_lines | integer | — | docs confirmed | Lines per scroll event. |
ui.invert_scroll | boolean | false | docs confirmed | Invert vertical scrolling. |
ui.permission_mode | enum: default | ask | auto | always-approve | default | docs confirmed | Default permission mode. |
ui.default_selected_permission | enum: always_allow_all_sessions | allow_command_always | allow_once | reject | always_allow_all_sessions | docs confirmed | Initially selected permission response. |
ui.remember_tool_approvals | boolean | false | docs confirmed | Show persistent per-tool approval choices. |
ui.cancel_subagents_on_turn_cancel | enum: ask | always_stop | always_continue | ask | docs confirmed | Policy for running subagents when cancelling a turn. |
ui.hunk_tracker_mode | enum: agent_only | all_dirty | off | agent_only | docs confirmed | File-change hunk tracking mode. |
ui.fork_secondary_model | string | — | docs confirmed | Model used by the secondary fork agent. |
ui.voice_keybind_enabled | boolean | true | docs confirmed | Enable the voice key binding. |
ui.voice_capture_mode | enum: hold | toggle | hold | docs confirmed | Voice capture interaction. |
ui.voice_stt_language | string | — | docs confirmed | Speech-to-text language. |
ui.display_refresh.auto_cadence_enabled | boolean | false | docs confirmed | Match animation cadence to display refresh. |
ui.contextual_hints.undo | boolean | true | docs confirmed | Show the undo hint. |
ui.contextual_hints.plan_mode | boolean | true | docs confirmed | Show the plan-mode hint. |
ui.contextual_hints.image_input | boolean | true | docs confirmed | Show the image-input hint. |
ui.contextual_hints.send_now | boolean | true | docs confirmed | Show the queued prompt send-now hint. |
ui.contextual_hints.small_screen | boolean | true | docs confirmed | Show the compact-mode hint. |
ui.contextual_hints.word_select | boolean | true | docs confirmed | Show the word-selection hint. |
ui.contextual_hints.ssh_wrap | boolean | true | docs confirmed | Recommend grok wrap when SSH clipboard integration is unavailable. |
permission.allow | array | — | docs confirmed | Compact allow rules. · Sensitive |
permission.deny | array | — | docs confirmed | Compact deny rules. · Sensitive |
permission.ask | array | — | docs confirmed | Compact ask rules. · Sensitive |
permission.rules | array | — | docs confirmed | Structured allow, deny, and ask rules. · Sensitive |
features.web_fetch | boolean | — | docs confirmed | Enable web_fetch. |
features.lsp_tools | boolean | false | docs confirmed | Enable LSP tools. |
features.write_file | boolean | true | docs confirmed | Enable the write tool. |
features.tool_search | boolean | true | docs confirmed | Enable MCP tool discovery. |
subagents.enabled | boolean | — | docs confirmed | Enable subagents. |
subagents.toggle | object | — | docs confirmed | Enable or disable named subagent types. |
subagents.models | object | — | docs confirmed | Select a model for each subagent type. |
memory.enabled | boolean | false | docs confirmed | Enable cross-session memory. · Sensitive |
skills.paths | array | — | docs confirmed | Additional skill directories. |
skills.disabled | array | — | docs confirmed | Discovered skills that must not activate. |
plugins.paths | array | — | docs confirmed | Additional plugin directories. · Sensitive |
plugins.disabled | array | — | docs confirmed | Plugins that must not activate. |
plugins.enabled | array | — | docs confirmed | Explicitly enabled plugins. · Sensitive |
compat.cursor.skills | boolean | true | docs confirmed | Scan cursor skills. · Sensitive |
compat.cursor.rules | boolean | true | docs confirmed | Scan cursor rules. · Sensitive |
compat.cursor.agents | boolean | true | docs confirmed | Scan cursor agents. · Sensitive |
compat.cursor.mcps | boolean | true | docs confirmed | Scan cursor mcps. · Sensitive |
compat.cursor.hooks | boolean | true | docs confirmed | Scan cursor hooks. · Sensitive |
compat.claude.skills | boolean | true | docs confirmed | Scan claude skills. · Sensitive |
compat.claude.rules | boolean | true | docs confirmed | Scan claude rules. · Sensitive |
compat.claude.agents | boolean | true | docs confirmed | Scan claude agents. · Sensitive |
compat.claude.mcps | boolean | true | docs confirmed | Scan claude mcps. · Sensitive |
compat.claude.hooks | boolean | true | docs confirmed | Scan claude hooks. · Sensitive |
dashboard.enabled | boolean | — | source preview | Enable the Agent Dashboard. |
terminal.alt_screen | boolean | — | source preview | Allow alternate-screen rendering. |
mcp.max_output_bytes | integer | — | source preview | Project-scoped MCP tool-result size cap. |
04 / NAMES, NEVER VALUES
Environment variable names
Names and purpose only. Secret-bearing variables are explicitly marked; values are never read.
| Name | Sensitive | Availability | Summary |
|---|---|---|---|
GROK_HOME | no | docs confirmed | Override the Grok home directory. |
XAI_API_KEY | yes | docs confirmed | Authenticate a headless or API-key session. |
GROK_DEFAULT_MODEL | no | docs confirmed | Override the default model. |
GROK_WEB_SEARCH_MODEL | no | docs confirmed | Override the web-search model. |
GROK_MODELS_BASE_URL | no | docs confirmed | Override the inference base URL. |
GROK_MODELS_LIST_URL | no | docs confirmed | Override the model-list URL. |
GROK_XAI_API_BASE_URL | no | docs confirmed | Override the xAI API base URL. |
GROK_DISABLE_AUTOUPDATER | no | docs confirmed | Suppress the process auto-updater. |
GROK_SANDBOX | no | docs confirmed | Select a sandbox profile. |
GROK_SANDBOX_AUTO_ALLOW_BASH | no | docs confirmed | Auto-allow bash inside an active sandbox. |
GROK_RESPECT_GITIGNORE | no | docs confirmed | Override gitignore handling for read and search tools. |
GROK_WEB_FETCH | no | docs confirmed | Enable web_fetch. |
GROK_WEB_FETCH_PROXY | no | docs confirmed | Set the web_fetch egress proxy. |
GROK_MEMORY | yes | docs confirmed | Enable cross-session memory. |
GROK_SUBAGENTS | no | docs confirmed | Enable subagents. |
GROK_AGENT | no | docs confirmed | Select an agent name or definition path. |
GROK_WRITE_FILE | no | docs confirmed | Enable or disable the write tool. |
GROK_TOOL_SEARCH | no | docs confirmed | Enable MCP tool discovery. |
GROK_LSP_TOOLS | no | docs confirmed | Enable LSP tools. |
GROK_THEME | no | docs confirmed | Select the theme. |
GROK_SHOW_THINKING_BLOCKS | yes | docs confirmed | Show or hide reasoning blocks. |
GROK_GROUP_TOOL_VERBS | no | docs confirmed | Group consecutive tool rows. |
GROK_COLLAPSED_EDIT_BLOCKS | no | docs confirmed | Collapse edit blocks. |
GROK_PROMPT_SUGGESTIONS | no | docs confirmed | Enable prompt suggestions. |
GROK_SCROLL_SPEED | no | docs confirmed | Set scroll speed. |
GROK_SCROLL_MODE | no | docs confirmed | Set scroll-input interpretation. |
GROK_SCROLL_LINES | no | docs confirmed | Set lines per scroll event. |
GROK_INVERT_SCROLL | no | docs confirmed | Invert vertical scrolling. |
GROK_DEFAULT_SELECTED_PERMISSION | no | docs confirmed | Select the initial permission response. |
GROK_REMEMBER_TOOL_APPROVALS | no | docs confirmed | Show persistent approval choices. |
GROK_MOUSE_REPORTING_TOGGLE | no | docs confirmed | Enable the mouse-reporting toggle. |
GROK_DISPLAY_REFRESH_AUTO_CADENCE | no | docs confirmed | Match UI cadence to display refresh. |
GROK_MCP_STARTUP_TIMEOUT_SECS | no | docs confirmed | Set the MCP startup timeout in seconds. |
MCP_TIMEOUT | no | docs confirmed | Set the compatibility MCP timeout in milliseconds. |
GROK_LOG_FILE | yes | docs confirmed | Write logs to a selected path. |
RUST_LOG | yes | docs confirmed | Set the runtime log filter. |
GROK_CRASH_HANDLER | yes | docs confirmed | Write crash reports under GROK_HOME. |
HTTPS_PROXY | no | docs confirmed | Set the HTTPS proxy. |
HTTP_PROXY | no | docs confirmed | Set the HTTP proxy. |
NO_PROXY | no | docs confirmed | Set proxy bypass hosts. |
GROK_CURSOR_SKILLS_ENABLED | no | docs confirmed | Enable the cursor skills compatibility scanner. |
GROK_CURSOR_RULES_ENABLED | no | docs confirmed | Enable the cursor rules compatibility scanner. |
GROK_CURSOR_AGENTS_ENABLED | no | docs confirmed | Enable the cursor agents compatibility scanner. |
GROK_CURSOR_MCPS_ENABLED | no | docs confirmed | Enable the cursor mcps compatibility scanner. |
GROK_CURSOR_HOOKS_ENABLED | no | docs confirmed | Enable the cursor hooks compatibility scanner. |
GROK_CLAUDE_SKILLS_ENABLED | no | docs confirmed | Enable the claude skills compatibility scanner. |
GROK_CLAUDE_RULES_ENABLED | no | docs confirmed | Enable the claude rules compatibility scanner. |
GROK_CLAUDE_AGENTS_ENABLED | no | docs confirmed | Enable the claude agents compatibility scanner. |
GROK_CLAUDE_MCPS_ENABLED | no | docs confirmed | Enable the claude mcps compatibility scanner. |
GROK_CLAUDE_HOOKS_ENABLED | no | docs confirmed | Enable the claude hooks compatibility scanner. |
GROK_AGENT_SECRET | yes | runtime confirmed | Authenticate clients of grok agent serve. |
GROK_AUTH_PROVIDER_COMMAND | no | source preview | Select an external authentication helper. |
GROK_AUTH_PROVIDER_LABEL | no | source preview | Label the external authentication provider. |
GROK_AUTH_TOKEN_TTL | no | source preview | Set external token lifetime. |
GROK_AUTH_EARLY_INVALIDATION_SECS | no | source preview | Refresh an external token before expiry. |
GROK_OIDC_ISSUER | no | source preview | Set the OIDC issuer. |
GROK_OIDC_CLIENT_ID | no | source preview | Set the OIDC client ID. |
GROK_CLI_CHAT_PROXY_BASE_URL | no | source preview | Override the CLI chat proxy. |
GROK_WORKFLOWS | no | source preview | Enable background workflows. |
GROK_WEB_FETCH_ALLOW_LOCAL | no | source preview | Permit explicit loopback web_fetch targets. |
GROK_TELEMETRY_ENABLED | no | source preview | Enable telemetry. |
GROK_TELEMETRY_TRACE_UPLOAD | no | source preview | Enable trace upload. |
GROK_TELEMETRY_MIXPANEL_ENABLED | no | source preview | Enable Mixpanel telemetry. |
GROK_EXTERNAL_OTEL | no | source preview | Configure external OpenTelemetry export. |
GROK_FEEDBACK_ENABLED | no | source preview | Enable the feedback system. |
GROK_DEPLOYMENT_KEY | yes | source preview | Authenticate managed configuration setup. |
GROK_AGENT_DASHBOARD | no | source preview | Enable the Agent Dashboard. |
05 / RUNBOOKS
Operational workflows
Copyable sequences built from entities in this same manifest, with a review boundary on mutating or network-facing steps.
Run one bounded prompt
Use -p/--single with a machine-readable format and an explicit turn cap.
- Run a bounded prompt
grok -p "Summarize the changes" --output-format json --max-turns 4The released CLI prints one JSON result and exits.
review
Embed Grok through ACP
Use the stdio agent transport for an ACP-capable editor or host.
- Start the ACP endpoint
grok agent stdioThe process speaks ACP over standard input and output.
review
Run a headless relay or WebSocket server
Choose relay headless mode or a locally bound authenticated WebSocket server.
- Prefer loopback binding
grok agent serve --bind 127.0.0.1:2419Let Grok generate a secret and do not publish it in logs.
high impact
Add and diagnose an MCP server
Add the server at an explicit scope, list it, then run doctor.
- Add a project server
grok mcp add --scope project filesystem -- npx -y @modelcontextprotocol/server-filesystem /path/to/dirProject scope writes .grok/config.toml; review the command and allowed directory.
high impact - Diagnose
grok mcp doctor --jsonUse machine-readable diagnostics without exposing resolved secrets.
review
Inspect before installing a plugin
List sources, validate the plugin, and avoid immediate trust until its code is reviewed.
- Inspect available plugins
grok plugin marketplace list --jsonReview the source and capabilities before installation.
review - Validate a local checkout
grok plugin validate /path/to/pluginValidation is not a security review, but catches structural problems.
review
Find and resume a session
Search local session metadata, then resume by an unambiguous ID or title.
- Search persisted sessions
grok sessions search "migration" --limit 10Search may expose session titles; review captured output before sharing.
review - Resume
grok --resume <session-id>Use --fork-session when the original session must remain unchanged.
review
Review worktrees before cleanup
List and inspect worktrees, then perform a dry-run before removal or garbage collection.
- List worktrees
grok worktree list --jsonConfirm repository and worktree state.
read only - Preview cleanup
grok worktree gc --dry-runDo not use --force until dirty and unpushed work has been reviewed.
review
Diagnose before applying fixes
Capture diagnostics first, then review each automatic fix.
- Collect diagnostics
grok doctor --jsonKeep paths and environment-derived details out of public bug reports.
review - Review available fixes
grok doctor fixAvoid --yes until the proposed local changes are understood.
review
Use source-preview TUI workflows conservatively
The public source guide documents /workflow and /workflows, but they are not release-confirmed shell commands.
- Inspect workflow help in the TUI
/workflow helpAvailability depends on feature and release state; do not invoke it as grok workflow.
review
FIELD MANUAL
Need the operating model, not just flags?
The complete guide connects one-shot prompts, transports, MCP, plugins, sessions, worktrees, diagnostics, configuration, and TUI operation.
06 / PROVENANCE
Evidence ledger
- 01 Grok Build 1.0.0 recursive help runtime-help / release / 1.0.0 / 2026-08-10
- 02 Grok Build CLI reference and headless guide official-docs / reference / reference / 2026-07-31
- 03 Grok Build settings reference official-docs / reference / reference / 2026-07-31
- 04 Grok Build modes and commands official-docs / reference / reference / 2026-07-31
- 05 Grok Build source-preview Clap definitions official-source / preview / 500129c714ad / 2026-07-31
- 06 Grok Build source-preview TUI user guide official-source / preview / 500129c714ad / 2026-07-31