# Grok Build

> Source: <https://github.com/xai-org/grok-build>
> Published: 2026-07-15 20:24:58+00:00

**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](#installing-the-released-binary) ·
[Building from source](#building-from-source) ·
[Documentation](#documentation) ·
[Repository layout](#repository-layout) ·
[Development](#development) ·
[Contributing](#contributing) ·
[License](#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.

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](https://x.ai/build/changelog) for the latest fixes,
features, and improvements in each release.

Requirements:

**Rust**— the toolchain is pinned by;`rust-toolchain.toml`

`rustup`

installs it automatically on first build.**protoc**— proto codegen resolves(a`bin/protoc`

[dotslash](https://dotslash-cli.com)launcher) 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](/xai-org/grok-build/blob/main/crates/codegen/xai-grok-pager/docs/user-guide/02-authentication.md).

Full online documentation is available at
[docs.x.ai/build/overview](https://docs.x.ai/build/overview).

The user guide ships with the pager crate:
[ crates/codegen/xai-grok-pager/docs/user-guide/](/xai-org/grok-build/blob/main/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.

| 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.

```
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
```

Note

External contributions are not accepted. See [ CONTRIBUTING.md](/xai-org/grok-build/blob/main/CONTRIBUTING.md).

First-party code in this repository is licensed under the **Apache License,
Version 2.0** — see [ LICENSE](/xai-org/grok-build/blob/main/LICENSE).

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

— crates.io / git dependencies, bundled UI themes, and`THIRD-PARTY-NOTICES`

**in-tree source ports**(including openai/codex and sst/opencode tool implementations)— crate-local notice for the codex and opencode ports (license texts + Apache §4(b) change notice)`crates/codegen/xai-grok-tools/THIRD_PARTY_NOTICES.md`

— vendored Mermaid-stack index`third_party/NOTICE`