{"id":51712337,"url":"https://github.com/xai-org/grok-build","last_synced_at":"2026-07-24T14:31:00.136Z","repository":{"id":371622587,"uuid":"1300902838","full_name":"xai-org/grok-build","owner":"xai-org","description":"SpaceXAI's coding agent harness and TUI. Fullscreen, mouse interactive, extensible.","archived":false,"fork":false,"pushed_at":"2026-07-15T22:48:00.000Z","size":10855,"stargazers_count":2310,"open_issues_count":0,"forks_count":331,"subscribers_count":23,"default_branch":"main","last_synced_at":"2026-07-16T00:26:40.594Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Rust","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/xai-org.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-07-14T20:04:23.000Z","updated_at":"2026-07-16T00:26:31.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/xai-org/grok-build","commit_stats":null,"previous_names":["xai-org/grok-build"],"tags_count":null,"template":false,"template_full_name":null,"purl":"pkg:github/xai-org/grok-build","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xai-org%2Fgrok-build","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xai-org%2Fgrok-build/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xai-org%2Fgrok-build/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xai-org%2Fgrok-build/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/xai-org","download_url":"https://codeload.github.com/xai-org/grok-build/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xai-org%2Fgrok-build/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":35742300,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-07-20T02:08:10.276Z","status":"online","status_checked_at":"2026-07-21T02:00:06.728Z","response_time":109,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2026-07-16T23:00:35.483Z","updated_at":"2026-07-24T14:31:00.129Z","avatar_url":"https://github.com/xai-org.png","language":"Rust","funding_links":[],"categories":["未分类","Rust","Reference Implementations","🗓️ What's New This Week","Terminal \u0026 CLI Agents","Ranked AI Coding Agents","Terminal-native coding agents"],"sub_categories":["Demo Harnesses","🆕 New \u0026 Updated This Week","Open Source"],"readme":"\u003cdiv align=\"center\"\u003e\n\n\u003ch1\u003e\n  \u003cpicture\u003e\n    \u003csource media=\"(prefers-color-scheme: dark)\" srcset=\"https://media.x.ai/v1/website/spacexai-symbol-white-transparent-0c31957f.png\"\u003e\n    \u003csource media=\"(prefers-color-scheme: light)\" srcset=\"https://media.x.ai/v1/website/spacexai-symbol-black-transparent-6435cf42.png\"\u003e\n    \u003cimg alt=\"SpaceXAI logo\" src=\"https://media.x.ai/v1/website/spacexai-symbol-black-transparent-6435cf42.png\" width=\"96\"\u003e\n  \u003c/picture\u003e\n  \u003cbr\u003e\n  Grok Build (\u003ccode\u003egrok\u003c/code\u003e)\n\u003c/h1\u003e\n\n**Grok Build** is SpaceXAI's terminal-based AI coding agent. It runs as a\nfull-screen TUI that understands your codebase, edits files, executes shell\ncommands, searches the web, and manages long-running tasks — interactively,\nheadlessly for scripting/CI, or embedded in editors via the Agent Client\nProtocol (ACP).\n\n[Installing the released binary](#installing-the-released-binary) ·\n[Building from source](#building-from-source) ·\n[Documentation](#documentation) ·\n[Repository layout](#repository-layout) ·\n[Development](#development) ·\n[Contributing](#contributing) ·\n[License](#license)\n\n![Grok Build TUI](https://media.x.ai/v1/website/universe-tui-screenshot-6f7a0837.png)\n\n**Learn more about Grok Build at [x.ai/cli](https://x.ai/cli)**\n\nThis repository contains the Rust source for the `grok` CLI/TUI and its agent\nruntime. It is synced periodically from the SpaceXAI monorepo.\n\nA small `SOURCE_REV` file at the root records the full monorepo commit SHA\nfor the version of the code present in this tree.\n\n\u003c/div\u003e\n\n---\n\n## Installing the released binary\n\nPrebuilt binaries are published for macOS, Linux, and Windows:\n\n```sh\ncurl -fsSL https://x.ai/cli/install.sh | bash   # macOS / Linux / Git Bash\nirm https://x.ai/cli/install.ps1 | iex          # Windows PowerShell\ngrok --version\n```\n\nSee the [changelog](https://x.ai/build/changelog) for the latest fixes,\nfeatures, and improvements in each release.\n\n## Building from source\n\nRequirements:\n\n- **Rust** — the toolchain is pinned by [`rust-toolchain.toml`](rust-toolchain.toml);\n  `rustup` installs it automatically on first build.\n- **[DotSlash](https://dotslash-cli.com)** — required so hermetic tools under\n  [`bin/`](bin/) (notably [`bin/protoc`](bin/protoc)) can download and run.\n  Install it and ensure `dotslash` is on your `PATH` **before** building:\n\n  ```sh\n  cargo install dotslash\n  # or: prebuilt packages — https://dotslash-cli.com/docs/installation/\n  /usr/bin/env dotslash --help   # sanity check\n  ```\n\n- **protoc** — proto codegen resolves [`bin/protoc`](bin/protoc) via DotSlash,\n  or falls back to a `protoc` on `PATH` / `$PROTOC`.\n- macOS and Linux are supported build hosts; Windows builds are best-effort\n  and not currently tested from this tree.\n\n```sh\ncargo run -p xai-grok-pager-bin              # build + launch the TUI\ncargo build -p xai-grok-pager-bin --release  # release binary: target/release/xai-grok-pager\ncargo check -p xai-grok-pager-bin            # fast validation\n```\n\nThe binary artifact is named `xai-grok-pager`; official installs ship it as\n`grok`. On first launch it opens your browser to authenticate — see the\n[authentication guide](crates/codegen/xai-grok-pager/docs/user-guide/02-authentication.md).\n\n## Documentation\n\nFull online documentation is available at\n[docs.x.ai/build/overview](https://docs.x.ai/build/overview).\n\nThe user guide ships with the pager crate:\n[`crates/codegen/xai-grok-pager/docs/user-guide/`](crates/codegen/xai-grok-pager/docs/user-guide/)\n— getting started, keyboard shortcuts, slash commands, configuration, theming,\nMCP servers, skills, plugins, hooks, headless mode, sandboxing, and more.\n\n## Repository layout\n\n| Path | Contents |\n|------|----------|\n| `crates/codegen/xai-grok-pager-bin` | Composition-root package; builds the `xai-grok-pager` binary |\n| `crates/codegen/xai-grok-pager` | The TUI: scrollback, prompt, modals, rendering |\n| `crates/codegen/xai-grok-shell` | Agent runtime + leader/stdio/headless entry points |\n| `crates/codegen/xai-grok-tools` | Tool implementations (terminal, file edit, search, ...) |\n| `crates/codegen/xai-grok-workspace` | Host filesystem, VCS, execution, checkpoints |\n| `crates/codegen/...` | The rest of the CLI crate closure (config, MCP, markdown, sandbox, ...) |\n| `crates/common/`, `crates/build/`, `prod/mc/` | Small shared leaf crates pulled in by the closure |\n| `third_party/` | Vendored upstream source (Mermaid diagram stack) — see below |\n\n\u003e [!IMPORTANT]\n\u003e The root `Cargo.toml` (workspace members, dependency versions, lints,\n\u003e profiles) is **generated** — treat it as read-only. Prefer editing per-crate\n\u003e `Cargo.toml` files.\n\n## Development\n\n```sh\ncargo check -p \u003ccrate\u003e        # always target specific crates; full-workspace builds are slow\ncargo test -p xai-grok-config # per-crate tests\ncargo clippy -p \u003ccrate\u003e       # lint config: clippy.toml at the repo root\ncargo fmt --all               # rustfmt.toml at the repo root\n```\n\n## Contributing\n\n\u003e [!NOTE]\n\u003e External contributions are not accepted. See [`CONTRIBUTING.md`](CONTRIBUTING.md).\n\n## License\n\nFirst-party code in this repository is licensed under the **Apache License,\nVersion 2.0** — see [`LICENSE`](LICENSE).\n\nThird-party and vendored code remains under its original licenses. See:\n\n- [`THIRD-PARTY-NOTICES`](THIRD-PARTY-NOTICES) — crates.io / git dependencies,\n  bundled UI themes, and **in-tree source ports** (including openai/codex and\n  sst/opencode tool implementations)\n- [`crates/codegen/xai-grok-tools/THIRD_PARTY_NOTICES.md`](crates/codegen/xai-grok-tools/THIRD_PARTY_NOTICES.md)\n  — crate-local notice for the codex and opencode ports (license texts +\n  Apache §4(b) change notice)\n- [`third_party/NOTICE`](third_party/NOTICE) — vendored Mermaid-stack index\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxai-org%2Fgrok-build","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fxai-org%2Fgrok-build","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxai-org%2Fgrok-build/lists"}