xai-org/grok-build: SpaceXAI's coding agent harness and TUI

Grok Build is an advanced terminal-based AI coding assistant developed by SpaceXAI that provides a full-screen, interactive environment for software development. It enables developers to edit code, run shell commands, and manage complex tasks through a mouse-interactive Text User Interface (TUI). The tool is highly extensible, supporting integration with external editors and various plugins to streamline the coding workflow.

---

1. Introduction to Grok Build

Grok Build is designed as a powerful "harness" for SpaceXAI's coding agent. Unlike simple chat interfaces, it functions as a complete terminal environment that understands the context of your entire codebase. It isn't just for chatting; it can actively modify files, perform web searches to solve problems, and execute long-running background tasks. 🚀

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.

The system is flexible enough to be used in three primary ways:

• Interactively: Using the full-screen TUI for active development.
• Headless: For automated scripting or Continuous Integration (CI) pipelines.
• Embedded: Integrated into other editors using the Agent Client Protocol (ACP).

---

2. Getting Started and Installation

Getting Grok Build up and running is straightforward, with prebuilt binaries available for major operating systems including macOS, Linux, and Windows.

Quick Installation

You can install the CLI using simple terminal commands:

• macOS / Linux / Git Bash: curl -fsSL https://x.ai/cli/install.sh | bash
• Windows PowerShell: irm https://x.ai/cli/install.ps1 | iex

Building from Source

For those who prefer to build the tool themselves, Grok Build is written in Rust. The repository requires a few specific tools to compile correctly:

• Rust Toolchain: Automatically managed by rustup.
• DotSlash: A utility used to handle hermetic tools (tools that run in isolated environments).
• protoc: Used for protocol buffer code generation.

While macOS and Linux are fully supported build environments, the developers note that Windows builds from the source tree are currently "best-effort" and not strictly tested. 🛠️

---

3. Repository Structure and Development

The Grok Build codebase is organized into several specific crates (Rust packages), each handling a different part of the agent's functionality. This modular design makes the system highly extensible.

Key Components

• xai-grok-pager: Manages the TUI, including the scrollback, prompt, and rendering.
• xai-grok-shell: The core agent runtime and entry points for different modes.
• xai-grok-tools: Contains the actual tools the AI uses, such as file editors and search functions.
• xai-grok-workspace: Handles the filesystem, version control systems (VCS), and execution checkpoints.

The root Cargo.toml (workspace members, dependency versions, lints, profiles) is generated — treat it as read-only. Prefer editing per-crate Cargo.toml files.

Developers working on the project are encouraged to target specific crates during builds (using -p <crate>) because full-workspace builds can be quite slow.

---

4. Licensing and Contributions

SpaceXAI has released the first-party code for Grok Build under the Apache License, Version 2.0, which is a permissive license that allows for broad use and modification. ⚖️

First-party code in this repository is licensed under the Apache License, Version 2.0.

However, users should be aware that the repository also contains third-party and vendored code (such as the Mermaid diagram stack and certain tool implementations like OpenAI Codex ports). These components remain under their original licenses, and detailed notices are provided within the repository to ensure compliance.

---

Conclusion

Grok Build represents a significant step forward in AI-assisted development by moving the agent directly into the terminal environment. By combining a rich TUI with deep codebase awareness and a suite of powerful tools, it offers a high-performance workspace for modern developers. Whether you are looking to automate repetitive tasks or navigate a complex new repository, Grok Build provides the necessary infrastructure to do so efficiently.