仓库 →
AtomCode · 开源终端 AI 编码助手

AtomCode Documentation

An AI coding agent that lives in your terminal. Hand it a natural-language task and it will autonomously read, edit, run, and self-verify. These docs walk you from a fresh install to every feature AtomCode offers.

v4.25.0 许可证 MIT 语言 Rust 1.88+ 平台 macOS · Linux · HarmonyOS PC · Windows 100% AI 生成

Three steps to start

  1. Install — one curl command or build from source. See Quickstart.
  2. Log in or configure a model — AtomGit OAuth is the easiest path; any OpenAI-compatible API key also works. See Login Methods and Configuration.
  3. Ask away — run atomcode inside any project directory and describe your task in natural language.
Tip

For a quick taste, run a single command: atomcode -p "give me a brief overview of this repo" — one-shot execution with the result piped to stdout.

Documentation map

Quickstart

Install paths, the 3-step first-run wizard, your first task, and the atomcode uninstall flow.

Configuration

Every ~/.atomcode/config.toml field, per-provider examples, plus the vision preprocessor (so non-vision models can still answer about images).

Login Methods

AtomGit OAuth one-click login (auto-persisted) versus API key setup, side by side.

Basic Usage

How to phrase tasks, common CLI flags, file references, multiline input, and image attachments / screenshots (Ctrl+V / drag-and-drop).

Slash Commands

Reference table for the 30+ built-in slash commands: sessions, models, undo, issues, conversation modes, and the extension ecosystem.

Keybindings

Every TUI keybinding: input, navigation, selection, copy, and more.

Built-in Tools

All 21 built-in tools categorised: filesystem/shell, code graph, web, and automation.

Sessions & Undo

Persistent session restore, /undo rollback, and clearing or compacting context.

Project Instructions

Use .atomcode.md to give AtomCode project-level conventions to follow.

Skills

Write your own skills to extend the slash-command ecosystem.

Plugin System

One-click install other people's skill / command / hook packs from any git repo — Claude Code ecosystem compatible.

MCP Integration

Plug external MCP servers in via .mcp.json — expose GitHub, databases, Playwright, and more to your model.

FAQ

Install issues, model connectivity, permission prompts, context overflows, and other common questions.

Feedback & contributing

AtomCode is open source — issues and pull requests welcome: