grok-build

xai-org

Grok Build 是 SpaceXAI 开发的终端 AI 编程代理，以全屏 TUI 运行，能够理解代码库、编辑文件、执行 shell 命令、搜索网络并交互式或静默式管理任务。

Stars

20,399

7 天增长

+994

Fork 数

3,720

开放 Issue

开源协议

Apache-2.0

为什么值得关注

它是 x.ai 出品的开源、基于 Rust 的 AI 工具，具备丰富的 TUI、多种交互模式（交互式、静默式、通过 ACP 嵌入编辑器）以及完善的文档，是 AI 辅助开发的实用工具。

适合谁使用

希望在终端中获得 AI 配对编程的开发者
需要静默式 AI 代码自动化的 CI/CD 工程师
希望通过 Agent Client Protocol 集成 AI 的编辑器用户
对大型 Rust CLI/TUI 项目感兴趣的 Rust 爱好者

典型使用场景

通过自然语言指令编辑代码和文件
执行 shell 命令并管理长时间运行的任务
在开发过程中搜索网络信息
在静默模式下自动化脚本或 CI 流程

项目优势

全屏 TUI，支持回滚、提示、模态框和主题定制
多种交互模式：交互式 TUI、静默模式、通过 ACP 嵌入编辑器
基于 Apache 2.0 开源，拥有结构良好的 Rust 代码库
提供详尽的文档，包括用户指南、更新日志和沙箱细节

使用前须知

Windows 构建为尽力而为，当前未在此树中测试
根据 CONTRIBUTING.md，不接受外部贡献
初始身份验证需要打开浏览器，可能不适用于某些静默环境

README 快速开始

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.

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.
protoc — proto codegen resolves bin/protoc (a dotslash 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.

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/](crates/codegen/xai-grok

项目描述

SpaceXAI's coding agent harness and TUI. Fullscreen, mouse interactive, extensible.