Grok Build is open source
TL;DR · AI 摘要
SpaceXAI开源了Grok Build,一个功能强大的终端AI编码代理,支持全屏交互和多种构建方式。
核心要点
- Grok Build支持macOS/Linux/Windows的二进制安装,通过curl命令即可部署
- 项目采用Rust开发,源码结构包含TUI、Agent运行时、工具实现等核心模块
- 提供完整的文档体系,包含用户指南、键盘快捷键、配置说明等12个技术模块
结构提纲
按章节快速跳转。
思维导图
用一张图看清主题之间的关系。
查看大纲文本(无障碍 / 无 JS 友好)
- Grok Build
- 核心功能
- 全屏TUI交互
- 代码编辑
- 命令执行
- 构建方式
- 二进制安装
- 源码构建
- 技术架构
- Rust开发
- 模块化crates
金句 / Highlights
值得收藏与分享的关键句。
跨平台二进制安装命令:curl -fsSL https://x.ai/cli/install.sh | bash
仓库包含6个核心crates,其中xai-grok-pager-bin负责构建TUI二进制文件
文档体系覆盖用户引导、键盘快捷键、沙箱配置等12个技术主题
GitHub - xai-org/grok-build: SpaceXAI 的代码代理工具和终端用户界面(TUI)。全屏显示、鼠标交互、可扩展。 · GitHub
Grok Build (grok)
Grok Build 是 SpaceXAI 的基于终端的 AI 编码代理。它以全屏终端用户界面(TUI)形式运行,能够理解你的代码库、编辑文件、执行 shell 命令、搜索网络并管理长时间运行的任务 —— 可通过交互式模式、无头模式(用于脚本/CI)或通过代理客户端协议(ACP)嵌入到编辑器中。
[安装已发布二进制文件](#installing-the-released-binary) · [从源代码构建](#building-from-source) · [文档](#documentation) · [仓库布局](#repository-layout) · [开发](#development) · [贡献](#contributing) · [许可证](#license)
了解更多关于 Grok Build 的信息,请访问 x.ai/cli
该仓库包含 grok CLI/TUI 及其代理运行时的 Rust 源代码。它会定期从 SpaceXAI 的单体仓库同步更新。
安装已发布二进制文件
为 macOS、Linux 和 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查看更新日志以了解每个版本的最新修复、功能和改进。
从源代码构建
要求:
- Rust — 工具链由 rust-toolchain.toml 文件固定;首次构建时 rustup 会自动安装。
- protoc — proto 代码生成器会解析 bin/protoc(一个点斜线启动器)或回退到 PATH / $PROTOC 中的 protoc。
- 支持 macOS 和 Linux 作为构建主机;Windows 构建为尽力而为,目前未在此分支中进行测试。
cargo run -p xai-grok-pager-bin
#
构建并启动 TUI
cargo build -p xai-grok-pager-bin --release
#
发布二进制文件:target/release/xai-grok-pager
cargo check -p xai-grok-pager-bin
#
快速验证生成的二进制文件名为 xai-grok-pager;官方安装会将其命名为 grok。首次启动时会打开浏览器进行身份验证 —— 请参阅身份验证指南。
文档
完整的在线文档请访问 docs.x.ai/build/overview。
用户指南随 pager crate 一起提供:crates/codegen/xai-grok-pager/docs/user-guide/ —— 包括入门指南、键盘快捷键、斜杠命令、配置、主题、MCP 服务器、技能、插件、钩子、无头模式、沙箱化等。
仓库布局
路径 | 内容
crates/codegen/xai-grok-pager-bin组合根包;构建
xai-grok-pager二进制文件
crates/codegen/xai-grok-pagerTUI:滚动回溯、提示、模态框、渲染
crates/codegen/xai-grok-shell代理运行时 + 主节点/标准输入输出/无头入口点
crates/codegen/xai-grok-tools工具实现(终端、文件编辑、搜索等)
crates/codegen/xai-grok-workspace主机文件系统、VCS、执行、检查点
crates/codegen/...CLI crate 闭包的其余部分(配置、MCP、markdown、沙箱等)
crates/common/,
crates/build/prod/mc/闭包中引入的小型共享叶 crate
third_party/上游源码(Mermaid 图表堆栈)—— 请参见下文
重要
根 Cargo.toml(工作区成员、依赖版本、lint、配置文件)是自动生成的 —— 请将其视为只读文件。建议编辑每个 crate 的 Cargo.toml 文件。
开发
cargo check -p
<
crate
>
#
始终针对特定 crate 进行检查;完整工作区构建速度较慢
cargo
test
-p xai-grok-config
#
按 crate 进行测试
cargo clippy -p
<
crate
>
#
lint 配置:仓库根目录的 clippy.toml
cargo fmt --all
#
rustfmt 配置:仓库根目录的 rustfmt.toml贡献
注意
不接受外部贡献。详见 CONTRIBUTING.md 。
License
本仓库中的第一方代码采用 Apache License, Version 2.0 许可 — 详见 LICENSE
第三方和已打包的代码仍遵循其原始许可证。详见:
- THIRD-PARTY-NOTICES — crates.io / git 依赖项、捆绑的 UI 主题以及树内源码端口(包括 openai/codex 和 sst/opencode 工具实现)
- crates/codegen/xai-grok-tools/THIRD_PARTY_NOTICES.md — codex 和 opencode 端口的 crate 本地声明(许可证文本 + Apache §4(b) 修改声明)
- third_party/NOTICE — 已打包的 Mermaid-stack 索引