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

AtomCode 使用指南

住在终端里的 AI 编码助手。给它一个自然语言任务，它会自主读取、编辑、运行并自我验证。本文档带你从零开始，逐步掌握 AtomCode 的每一项能力。

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

三步开始

  1. 安装 —— 一条 curl 命令或者从源码构建，参见 快速开始。
  2. 登录或配置模型 —— AtomGit OAuth 一键登录最省事，也支持任意 OpenAI 兼容 API Key，参见 登录方式 和 配置文件。
  3. 开始提问 —— 在项目目录下运行 atomcode，用自然语言描述你的任务即可。
Tip

如果只是想快速体验，跑一条命令即可：atomcode -p "简要介绍一下这个仓库"，一次性执行并把结果输出到 stdout。

文档导览

快速开始

安装方式、首次运行的 3 步启动向导、完成第一个任务,以及 atomcode uninstall 卸载流程。

配置文件

~/.atomcode/config.toml 字段说明、各家 provider 配置示例,含视觉预处理器(非视觉模型也能问图)。

登录方式

AtomGit OAuth 一键登录(自动持久化)与 API Key 配置对比。

基本使用

如何描述任务、常用 CLI 参数、文件引用、多行输入,以及图片附件 / 截图(Ctrl+V / 拖拽)。

斜杠命令

30+ 个内置斜杠命令参考表,涵盖会话、模型、撤销、Issue、对话模式、扩展生态等操作。

快捷键

输入、导航、选区复制等全部 TUI 快捷键。

内置工具

21 个内置工具:文件/Shell、代码图谱、Web、自动化分类说明。

会话与撤销

持久化会话恢复、/undo 回滚、清空与压缩上下文。

项目指令文件

用 .atomcode.md 给 AtomCode 定制项目级规范。

Skills 扩展

编写用户自定义 skill,扩展斜杠命令生态。

Plugin 系统

从 git 仓库一键安装别人写好的 skill / 命令 / hook 套件,与 Claude Code 生态兼容。

MCP 集成

通过 .mcp.json 接入外部 MCP server,把 GitHub、数据库、Playwright 等生态工具暴露给模型。

常见问题

安装、连不上模型、权限确认、上下文超限等常见疑问解答。

反馈与参与

AtomCode 是开源项目,欢迎提交 issue 或 PR: