Grok Build
要約
Grok BuildはSpaceXAIが開発したターミナルベースのAIコーディングエージェントです。コードベースを理解し、ファイルの編集、シェルコマンドの実行、Web検索、タスク管理などを対話式またはスクリプト実行で可能にします。Rustで書かれており、macOS、Linux、Windows向けのバイナリが提供されています。
全文翻訳
Grok Build (grok)
Grok Build はSpaceXAIのターミナルベースAIコーディングエージェントです。コードベースを理解し、ファイルを編集し、シェルコマンドを実行し、Webを検索し、長時間タスクを管理するフルスクリーンのTUIとして動作します。これはインタラクティブに、スクリプティング/CIのためのヘッドレスモードで、またはAgent Client Protocol (ACP) を介してエディタに組み込んで利用できます。
リリースバイナリのインストール · ソースからのビルド · ドキュメント · リポジトリレイアウト · 開発 · コントリビューション · ライセンス
Grok Buildの詳細については、x.ai/cli をご覧ください。
このリポジトリには、grok CLI/TUI およびそのエージェントランタイムの Rust ソースが含まれています。これはSpaceXAIのモノレポから定期的に同期されています。
ルートにある小さな SOURCE_REV ファイルには、このツリーにあるコードバージョンのモノレポコミットSHA全体が記録されています。
リリースバイナリのインストール
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が初回ビルド時に自動的にインストールします。 -
DotSlash —
bin/下のハーメチックツール(特にbin/protoc)がダウンロードおよび実行できるようにするために必要です。インストールし、ビルドする前にdotslashがPATHにあることを確認してください。cargo install dotslash # または: 事前ビルド済みパッケージ — https://dotslash-cli.com/docs/installation/ /usr/bin/env dotslash --help # 健全性チェック -
protoc — proto コード生成は DotSlash を介して
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 クレートに含まれています: crates/codegen/xai-grok-pager/docs/user-guide/ — 始め方、キーボードショートカット、スラッシュコマンド、設定、テーマ、MCPサーバー、スキル、プラグイン、フック、ヘッドレスモード、サンドボックスなど。
リポジトリレイアウト
| パス | 内容 |
|---|---|
crates/codegen/xai-grok-pager-bin | コンポジションルートパッケージ; xai-grok-pager バイナリをビルド |
crates/codegen/xai-grok-pager | TUI: スクロールバック、プロンプト、モーダル、レンダリング |
crates/codegen/xai-grok-shell | エージェントランタイム + リーダー/stdio/ヘッドレスエントリーポイント |
crates/codegen/xai-grok-tools | ツール実装 (ターミナル、ファイル編集、検索、...) |
crates/codegen/xai-grok-workspace | ホストファイルシステム、VCS、実行、チェックポイント |
crates/codegen/... | CLI クレートクロージャの残りの部分 (設定、MCP、Markdown、サンドボックス、...) |
crates/common/, crates/build/, prod/mc/ | クロージャによってプルされる小さな共有リーフクレート |
third_party/ | ベンダーされたアップストリームソース (Mermaid ダイアグラムスタック) — 以下参照 |
重要
ルートの Cargo.toml (ワークスペースメンバー、依存関係バージョン、リンティング、プロファイル) は生成されるものです — 読み取り専用として扱ってください。クレートごとの Cargo.toml ファイルを編集することを推奨します。
開発
cargo check -p <crate> # 常に特定のクレートを対象とする; フルワークスペースビルドは遅い
cargo test -p xai-grok-config # クレートごとのテスト
cargo clippy -p <crate> # リンティング設定: リポジトリルートの clippy.toml
cargo fmt --all # リポジトリルートの rustfmt.toml
コントリビューション
ライセンス
このリポジトリ内のファーストパーティコードは 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 ポートのクレートローカル通知 (ライセンステキスト + Apache §4(b) 変更通知)third_party/NOTICE— ベンダーされた Mermaid-stack インデックス