快速开始
几分钟内完成安装、首次运行和第一个任务,体验 AtomCode 的完整流程。
系统要求
- 操作系统:macOS (Apple Silicon 或 Intel)、Linux、Windows
- Rust 工具链:1.75+(仅在从源码构建时需要)
- LLM 模型:任一支持的 provider 的 API Key,或一个 AtomGit 账号(用于 OAuth 登录)
安装
方式 1:一键安装(推荐)
在 macOS 或 Linux 终端执行:
curl -fsSL https://atomgit.com/atomgit_atomcode/atomcode-release/releases/download/v4.18.1/install.sh | sh
脚本会自动下载对应平台的预编译二进制,并放置到 ~/.local/bin/atomcode。请确保该目录在 PATH 中。
在 Windows PowerShell 中执行:
irm https://atomgit.com/atomgit_atomcode/atomcode-release/releases/download/v4.18.1/install.ps1 | iex
脚本会自动下载 Windows x64 预编译二进制,并完成 PATH 配置,新开终端即可使用 atomcode 命令。
方式 2:从源码构建
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.15.x (build-id) 的输出。
首次运行
直接在任意目录运行:
atomcode
没有配置时,会进入 TUI 欢迎界面,引导你完成初始化:
┌────────────── Welcome to AtomCode ──────────────┐
│ │
│ Get started: │
│ │
│ ▸ Login with AtomGit OAuth · recommended │
│ Configure manually API Key │
│ Skip for now explore first │
│ │
└──────────────────────────────────────────────────┘
- Login with AtomGit —— 推荐路径,浏览器唤起 OAuth,一键完成登录,自动配置好默认 provider。
- Configure manually —— 手动填写任意 OpenAI 兼容 API 的 Key、model、base URL。
- Skip for now —— 跳过,先进入 TUI 探索。之后随时通过
/login或/provider完成配置。
更详细的选择参见 登录方式。
第一个任务
进入一个你熟悉的项目目录,启动 atomcode,然后直接描述你想做的事:
cd ~/projects/my-web-app
atomcode
> 简要介绍一下这个项目的目录结构和技术栈
AtomCode 会自主地:
- 运行
list_directory、read_file等工具探索代码 - 识别关键描述文件(
package.json/Cargo.toml等) - 给出结构化的总结
Tip
不确定要问什么?试试:"修复 README 里所有的拼写错误"、"把 src/utils.ts 里的函数加上 TypeScript 类型"、"跑一下测试并修复失败用例"。