仓库 →

快速开始

几分钟内完成安装、首次运行和第一个任务,体验 AtomCode 的完整流程。

系统要求

安装

方式 1:一键安装(推荐)

在 macOS 或 Linux 或 HarmonyOS PC 终端执行:

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

脚本会自动下载对应平台的预编译二进制,并放置到 ~/.local/bin/atomcode。请确保该目录在 PATH 中。

在 Windows PowerShell 中执行:

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

脚本会自动下载 Windows x64 预编译二进制,并完成 PATH 配置,新开终端即可使用 atomcode 命令。

方式 2:通过 npm

已安装 Node.js 18+ 时,可以直接走 npm 全局安装:

npm install -g @atomgit.com/atomcode

包会按当前平台从 optionalDependencies 自动解析对应的预编译二进制(macOS x64 / arm64、Linux x64 / arm64、Windows x64、HarmonyOS arm64),一行命令搞定跨平台安装。

方式 3:通过 Homebrew

已安装 Homebrew 时,可以通过 cask 安装(支持 macOS x64 / arm64、Linux x64 / arm64):

brew install --cask atomcode

Homebrew 会自动下载对应平台的预编译二进制并配置 PATH。

方式 4:从源码构建

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

Release 构建编译时间较长,但生成的二进制体积小、运行速度快。开发调试时用 cargo build 即可。

验证安装

atomcode --version

你应该看到类似 atomcode 4.20.x (build-id) 的输出。

首次运行

直接在任意目录运行:

atomcode

第一次启动会自动弹出 3 步首次启动向导(也可以随时用 /welcome 重新打开):

第 1/3 步 · 欢迎

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

  AtomCode
  版本 4.23.3  ·  在终端里运行的 AI 编程代理

  • 多步骤 agent loop · 内置代码图工具
  • 兼容所有 OpenAI 风格 API
  • 通过 CodingPlan 获取免费额度

  按 Enter 继续。   Ctrl+C 可随时退出。

第 2/3 步 · 语言 (Choose your language / 选择语言)

  1. 自动检测 (LC_ALL / LANG)
  2. English
  3. 简体中文 (Simplified Chinese)

  1-3 选择 · Enter 确认 · ← 返回 · Esc 跳过

选完会立即应用,并写回 ~/.atomcode/config.toml 的 locale 字段。之后任意时刻可以用 /language 再改。

第 3/3 步 · 配置 (想怎么开始?)

  1. 用 AtomGit CodingPlan 一键接入  (推荐 · 免费额度 + 自动配 provider)
  2. 手动配置 provider              (已有 API Key)
  3. 跳过,先进 TUI 探索             (之后再 /login 或 /provider)

  1-3 选择 · Enter 确认 · ← 返回 · Esc 跳过

更详细的选择参见 登录方式。任何时候可以用 /welcome 重新打开这个向导。

第一个任务

进入一个你熟悉的项目目录,启动 atomcode,然后直接描述你想做的事:

cd ~/projects/my-web-app
atomcode

> 简要介绍一下这个项目的目录结构和技术栈

AtomCode 会自主地:

  1. 运行 list_directory、read_file 等工具探索代码
  2. 识别关键描述文件(package.json / Cargo.toml 等)
  3. 给出结构化的总结
Tip

不确定要问什么?试试:"修复 README 里所有的拼写错误"、"把 src/utils.ts 里的函数加上 TypeScript 类型"、"跑一下测试并修复失败用例"。

卸载

不再需要 AtomCode 时,用内置的 uninstall 子命令一步清理。它会按组询问你是否删除以下三类内容:二进制本身 + 安装脚本写入的 PATH 编辑、~/.atomcode/auth.toml 等凭据、~/.atomcode/sessions/ 等运行状态。

交互式(推荐)

atomcode uninstall

每个组单独询问 y/N,按当前默认决策(二进制=是、凭据=否、状态=是)预填 — 直接回车也是合理选择。

非交互式

# 全自动:按默认决策走,不弹任何提示
atomcode uninstall --yes

# 一键全清(包括 ~/.atomcode/ 整个目录)
atomcode uninstall --purge

# 只删二进制和 PATH 编辑,~/.atomcode/ 完整保留
atomcode uninstall --keep-data

# 只打印执行计划,什么都不做
atomcode uninstall --dry-run
注意

--purge 会连带删除所有会话历史、记忆、自定义 provider 配置、OAuth token;不可逆。如果以后还可能用 AtomCode,优先用默认交互式或 --keep-data。

下一步