clayhewsr/grok-build

Grok Build, called grok on the command line, is a terminal based AI coding assistant made by SpaceXAI. It runs as a full screen interface inside your terminal window that understands the code in your project, can edit files, run shell commands, search the web, and manage tasks that take a while to finish. You can use it interactively by typing in the terminal, run it without any screen for scripting and automated pipelines, or plug it directly into a code editor using something called the Agent Client Protocol. This repository holds the Rust source code for the tool and its underlying agent engine. It is copied over periodically from a larger internal codebase, and a small file at the root of the project records exactly which internal version the code matches. Most people will not build this from source. Prebuilt versions are available for Mac, Linux, and Windows through a simple install command, after which typing grok launches the assistant. Building it yourself requires the Rust programming language toolchain, plus an extra tool called DotSlash that helps download and run some of the project's internal build tools, and a tool called protoc used for code generation. Mac and Linux are the officially supported systems for building from source, while Windows builds are considered experimental. The code is organized into many small Rust packages, called crates, each handling one part of the system, such as the terminal interface itself, the tools the assistant can use like editing files or searching, and how it talks to your computer's file system and version control. Full documentation, covering setup, keyboard shortcuts, configuration, and more advanced features, is hosted online separately from this repository. The project does not accept outside code contributions. The first party code here is released under the Apache License 2.0, though some included third party and copied in source code, including ports of tools from other open source coding assistant projects, keeps its own separate licenses.