Quickstart

Install AtomCode, run the first-time wizard, and complete your first task in a few minutes.

Requirements

• OS: macOS (Apple Silicon or Intel), Linux, Windows, or HarmonyOS PC
• Rust toolchain: 1.75+ (only required when building from source)
• LLM: an API key for any supported provider, or an AtomGit account (for OAuth login)

Install

Option 1: one-click install (recommended)

On macOS, Linux, or HarmonyOS PC:

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

The script downloads the prebuilt binary for your platform and places it at ~/.local/bin/atomcode. Make sure that directory is on your PATH.

On Windows PowerShell:

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

It downloads the Windows x64 prebuilt binary and updates PATH; open a fresh terminal to use the atomcode command.

Option 2: install using npm

If you already have Node.js 18+ installed, install globally with npm:

npm install -g @atomgit.com/atomcode

The package uses optionalDependencies to pull the prebuilt binary for your platform (macOS x64 / arm64, Linux x64 / arm64, Windows x64, HarmonyOS arm64) — one command, cross-platform.

Option 3: install using Homebrew

If you have Homebrew installed, install the cask (macOS x64 / arm64, Linux x64 / arm64):

brew install --cask atomcode

The cask downloads the prebuilt binary for your platform and links it to your PATH automatically.

Option 4: build from source

git clone https://atomgit.com/atomgit_atomcode/atomcode.git
cd atomcode
cargo build --release
cp target/release/atomcode ~/.local/bin/

Release builds take longer to compile but produce a small, fast binary. For day-to-day development a plain cargo build is fine.

Verify the install

atomcode --version

You should see something like atomcode 4.20.x (build-id).

First run

Just run:

atomcode

The first launch shows a 3-step onboarding wizard (you can re-open it any time with /welcome):

Step 1/3 · Welcome

             ███  █████  ███  █     █  ████  ███  ████  █████
            █   █   █   █   █ ██   ██ █     █   █ █   █ █
            █████   █   █   █ █ █ █ █ █     █   █ █   █ ████
            █   █   █   █   █ █  █  █ █     █   █ █   █ █
            █   █   █    ███  █     █  ████  ███  ████  █████

  AtomCode
  Version 4.23.3  ·  AI coding agent in your terminal

  • Multi-step agent loop · built-in code-graph tools
  • Compatible with any OpenAI-style API
  • Free tokens via CodingPlan

  Press Enter to continue.   Ctrl+C exits at any point.

Step 2/3 · Language (Choose your language / 选择语言)

  1. Auto-detect (LC_ALL / LANG)
  2. English
  3. 简体中文 (Simplified Chinese)

  1-3 select · Enter confirm · ← back · Esc skip

Your choice takes effect immediately and is written to the locale field of ~/.atomcode/config.toml. Run /language later to change it.

Step 3/3 · Setup (how would you like to start?)

  1. One-click with AtomGit CodingPlan  (recommended · free tokens + auto-configured provider)
  2. Configure a provider manually      (you have an API key)
  3. Skip and explore the TUI first     (run /login or /provider later)

  1-3 select · Enter confirm · ← back · Esc skip

• CodingPlan — the recommended path; equivalent to running /login inside the TUI. The browser opens AtomGit OAuth; after you log in, free tokens are claimed automatically and the granted model list is written as a provider config.
• Configure manually — equivalent to /provider: open the provider manager to fill in key / base URL / model.
• Skip — jump straight into the TUI and run /login or /provider later.

For a deeper breakdown see Login Methods. You can re-open the wizard any time with /welcome.

Your first task

cd into a project you know, launch atomcode, and just describe what you want:

cd ~/projects/my-web-app
atomcode

> give me a brief overview of this project's directory layout and tech stack

AtomCode autonomously:

1. Runs list_directory, read_file, and similar tools to explore the code;
2. Identifies key descriptor files (package.json / Cargo.toml / …);
3. Returns a structured summary.

Uninstall

When you're done with AtomCode, the built-in uninstall subcommand cleans up in one shot. It asks group-by-group whether to delete: the binary plus the PATH edits the installer made, credentials such as ~/.atomcode/auth.toml, and runtime state such as ~/.atomcode/sessions/.

Interactive (recommended)

atomcode uninstall

Each group prompts y/N with a sensible default (binary = yes, credentials = no, state = yes) — pressing Enter is a reasonable choice.

Non-interactive

# Fully automatic: take the default decisions, no prompts
atomcode uninstall --yes

# Wipe everything (including the entire ~/.atomcode/ directory)
atomcode uninstall --purge

# Only remove the binary and PATH edits; keep ~/.atomcode/ intact
atomcode uninstall --keep-data

# Just print the plan; do nothing
atomcode uninstall --dry-run

Next steps

• Configuration — manage multiple providers and models.
• Basic Usage — CLI flags and best practices for phrasing tasks.
• Slash Commands — get fluent with /resume, /undo, /diff, and friends.