Watch

REPO-015 · xAI Grok Build upstream source mirror · learning and purification only · not trusted runtime

Rust 99.6%
Python 0.2%
JavaScript 0.1%

Find a file

Repository files (latest commit first)
Filename	Latest commit message	Latest commit date
grokkybara[bot] 98c3b2438a Synced from monorepo 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		2026-07-17 14:19:50 +01:00
.cargo	Publish harness and TUI open-source	2026-07-16 06:46:02 +01:00
bin	Publish harness and TUI open-source	2026-07-16 06:46:02 +01:00
crates	Synced from monorepo	2026-07-17 14:19:50 +01:00
prod/mc/cli-chat-proxy-types	Synced from monorepo	2026-07-17 14:19:50 +01:00
third_party	Publish harness and TUI open-source	2026-07-16 06:46:02 +01:00
.gitignore	Publish harness and TUI open-source	2026-07-16 06:46:02 +01:00
Cargo.lock	Synced from monorepo	2026-07-17 14:19:50 +01:00
Cargo.toml	Publish harness and TUI open-source	2026-07-16 06:46:02 +01:00
clippy.toml	Publish harness and TUI open-source	2026-07-16 06:46:02 +01:00
CONTRIBUTING.md	Publish harness and TUI open-source	2026-07-16 06:46:02 +01:00
LICENSE	Publish harness and TUI open-source	2026-07-16 06:46:02 +01:00
README.md	Synced from monorepo	2026-07-16 20:27:30 +01:00
rust-toolchain.toml	Publish harness and TUI open-source	2026-07-16 06:46:02 +01:00
rustfmt.toml	Publish harness and TUI open-source	2026-07-16 06:46:02 +01:00
SECURITY.md	Publish harness and TUI open-source	2026-07-16 06:46:02 +01:00
SOURCE_REV	Synced from monorepo	2026-07-17 14:19:50 +01:00
THIRD-PARTY-NOTICES	Publish harness and TUI open-source	2026-07-16 06:46:02 +01:00

README.md

Grok Build (`grok`)

Grok Build is SpaceXAI's terminal-based AI coding agent. It runs as a full-screen TUI that understands your codebase, edits files, executes shell commands, searches the web, and manages long-running tasks — interactively, headlessly for scripting/CI, or embedded in editors via the Agent Client Protocol (ACP).

Installing the released binary · Building from source · Documentation · Repository layout · Development · Contributing · License

Learn more about Grok Build at x.ai/cli

This repository contains the Rust source for the grok CLI/TUI and its agent runtime. It is synced periodically from the SpaceXAI monorepo.

A small SOURCE_REV file at the root records the full monorepo commit SHA for the version of the code present in this tree.

Installing the released binary

Prebuilt binaries are published for macOS, Linux, and Windows:

curl -fsSL https://x.ai/cli/install.sh | bash   # macOS / Linux / Git Bash
irm https://x.ai/cli/install.ps1 | iex          # Windows PowerShell
grok --version

See the changelog for the latest fixes, features, and improvements in each release.

Building from source

Requirements:

Rust — the toolchain is pinned by rust-toolchain.toml; rustup installs it automatically on first build.
DotSlash — required so hermetic tools under bin/ (notably bin/protoc) can download and run. Install it and ensure dotslash is on your PATH before building:
```
cargo install dotslash
# or: prebuilt packages — https://dotslash-cli.com/docs/installation/
/usr/bin/env dotslash --help   # sanity check
```
protoc — proto codegen resolves bin/protoc via DotSlash, or falls back to a protoc on PATH / $PROTOC.
macOS and Linux are supported build hosts; Windows builds are best-effort and not currently tested from this tree.

cargo run -p xai-grok-pager-bin              # build + launch the TUI
cargo build -p xai-grok-pager-bin --release  # release binary: target/release/xai-grok-pager
cargo check -p xai-grok-pager-bin            # fast validation

The binary artifact is named xai-grok-pager; official installs ship it as grok. On first launch it opens your browser to authenticate — see the authentication guide.

Documentation

Full online documentation is available at docs.x.ai/build/overview.

The user guide ships with the pager crate: crates/codegen/xai-grok-pager/docs/user-guide/ — getting started, keyboard shortcuts, slash commands, configuration, theming, MCP servers, skills, plugins, hooks, headless mode, sandboxing, and more.

Repository layout

Path	Contents
`crates/codegen/xai-grok-pager-bin`	Composition-root package; builds the `xai-grok-pager` binary
`crates/codegen/xai-grok-pager`	The TUI: scrollback, prompt, modals, rendering
`crates/codegen/xai-grok-shell`	Agent runtime + leader/stdio/headless entry points
`crates/codegen/xai-grok-tools`	Tool implementations (terminal, file edit, search, ...)
`crates/codegen/xai-grok-workspace`	Host filesystem, VCS, execution, checkpoints
`crates/codegen/...`	The rest of the CLI crate closure (config, MCP, markdown, sandbox, ...)
`crates/common/`, `crates/build/`, `prod/mc/`	Small shared leaf crates pulled in by the closure
`third_party/`	Vendored upstream source (Mermaid diagram stack) — see below

Important

The root Cargo.toml (workspace members, dependency versions, lints, profiles) is generated — treat it as read-only. Prefer editing per-crate Cargo.toml files.

Development

cargo check -p <crate>        # always target specific crates; full-workspace builds are slow
cargo test -p xai-grok-config # per-crate tests
cargo clippy -p <crate>       # lint config: clippy.toml at the repo root
cargo fmt --all               # rustfmt.toml at the repo root

Contributing

Note

External contributions are not accepted. See CONTRIBUTING.md.

License

First-party code in this repository is licensed under the Apache License, Version 2.0 — see LICENSE.

Third-party and vendored code remains under its original licenses. See:

THIRD-PARTY-NOTICES — crates.io / git dependencies, bundled UI themes, and in-tree source ports (including openai/codex and sst/opencode tool implementations)
crates/codegen/xai-grok-tools/THIRD_PARTY_NOTICES.md — crate-local notice for the codex and opencode ports (license texts + Apache §4(b) change notice)
third_party/NOTICE — vendored Mermaid-stack index