AtomCode

Requirements

- Rust 1.88+ (for building; older Cargo versions cannot parse the current lockfile) - An API key from any supported provider (or an AtomGit account for /login; the free CodingPlan models require an official build — see "About the official CodingPlan" above)

Prerequisites

• Rust 1.88+ — install via rustup
• Git
• A supported LLM provider API key (for runtime testing)

Installation

Official Installation Script (recommended)

For Windows PowerShell users:

irm https://raw.atomgit.com/atomgit_atomcode/atomcode/raw/main/scripts/install.ps1 | iex

For Linux / macOS / WSL / MSYS / Git-Bash / HarmonyOS PC users:

curl -fsSL https://raw.atomgit.com/atomgit_atomcode/atomcode/raw/main/scripts/install.sh | sh

Both scripts download the official prebuilt binary for the latest release (auto-detected from the AtomGit API), install it, and add it to your PATH. As official builds they include the request signer, so /login can claim the free CodingPlan models (see "About the official CodingPlan" below).

Environment variable overrides: ATOMCODE_VERSION pins a release tag, ATOMCODE_PREFIX picks the install directory (see the script headers for details).

`PATH="/c/Program Files/nodejs:$PATH" npm run build`

to use the system-installed Node.js.

npm run build # outputs webui/dist/, embedded by the next Rust build cd ..

Skip this step if you don't use the webui. The release scripts build the
frontend automatically before `cargo build`. After rebuilding the frontend,
force a daemon recompile so the new bundle is re-embedded (`cargo clean -p
atomcode-daemon`) — cargo does not track changes under `webui/dist/`. Then
build and install:

The binary will be generated at `target/release/atomcode` and installed to
`~/.cargo/bin/atomcode` for macOS / Linux / HarmonyOS PC and `$env:USERPROFILE/.cargo/bin/atomcode.exe`
for Windows. Make sure that `~/.cargo/bin` (or `%USERPROFILE%\.cargo\bin` on Windows) is
in your `PATH`.

To compile without installing, run:

Builds only the CLI package (`atomcode`) — skips the standalone

Install using npm

npm install -g @atomgit.com/atomcode

Install using Homebrew

brew install --cask atomcode ```

Uninstall

Remove AtomCode and (optionally) its data:

atomcode uninstall                # interactive: per-group prompts
atomcode uninstall --keep-data    # only remove binary + PATH edit
atomcode uninstall --purge        # remove everything, including ~/.atomcode
atomcode uninstall --dry-run      # show plan, change nothing

If the binary is already broken or missing:

```bash curl -fsSL https://raw.atomgit.com/atomgit_atomcode/atomcode/raw/main/scripts/uninstall.sh | sh

Build from Source

```bash git clone https://atomgit.com/atomgit_atomcode/atomcode.git cd atomcode

Debug build (fast compilation, slower runtime)

cargo build

Release build (slower compilation, optimized binary)

cargo build --release ```

Check compilation without building

cargo check

Build and install to ~/.cargo/bin

cargo install --path crates/atomcode-cli ```

Quick Start

Guidelines

- Follow the project's core principles — especially tech-stack neutrality (no language/framework-specific logic in the core engine; detect via probes like package.json / Cargo.toml / pom.xml and route through adapters) - All tool failures must be graceful — return the error as an observation to the LLM, never panic - Destructive operations must require user approval - Keep the system prompt compact (~1.5K tokens) - Run cargo fmt and cargo clippy before submitting

2. Configuration

Config is stored at ~/.atomcode/config.toml. A minimal single-provider setup looks like this:

default_provider = "deepseek"

[providers.deepseek]
type           = "openai"
api_key        = "sk-..."
model          = "deepseek-chat"
base_url       = "https://api.deepseek.com/v1"
context_window = 64000

You can declare multiple providers and switch between them with /model or /provider. A complete reference covering Claude / OpenAI / OpenAI-compatible endpoints (DeepSeek, GLM, SiliconFlow, OpenRouter...) / Ollama, plus the [datalog] section, lives at docs/config.example.toml — copy and edit the bits you need.

After editing config.toml by hand, run /reload inside atomcode to pick up the changes without restarting.

args: optional

Review all changes in the current git diff. If specific files are given, review only: $ARGUMENTS EOF ```

Run /help commands to list all loaded custom commands.

Priority rule. A custom command cannot shadow a built-in command with the same name. If a built-in /review already exists, a project-level review.md won't appear in completion or dispatch.

Daemon (HTTP API)

cargo run -p atomcode-daemon ```

Package Managers

AtomCode CLI can also be installed via the following package managers:

```bash