本页译自英文文档。命令、标识符和示例保持原样。运行时 7.24.4 · SDK 2.6.7。 英文原文
AX Code 文档
状态:生效 范围:公开,当前状态 最近审阅:2026-10-09 负责人:AX Code 维护者
AX Code 是面向可审阅、可逆工作的编程代理运行时:每个会话都记录为 带文件快照的结构化事件日志,候选实现可以对照你仓库自己的 检查来验证,并且没有任何东西会自动合并。为什么选择 AX Code 说明它优化的是什么、面向谁, 以及它有意不声称什么。
根目录的 README 是安装并启动 AX Code 的最短路径。当你需要 配置工作流、理解运行时边界,或把 AX Code 与另一个系统集成时,使用这个中心。
内部过程记录(PRD、ADR、规格、路线图、实现计划、竞争审阅和审计
工作文件)位于 .internal/ 下,不在这棵公开树中 — 见下方“文档边界”。这里链接的
页面才是公开页面。
公开网站:ax-code.app/zh-CN/docs/。 对于现有安装,请从 升级与恢复 开始。 源码访问和公开下载是分开的;见 源码访问。
按任务选择
通过外部 MCP 客户端选择加入共享终端导航,见 通过 MCP 共享实时 TUI。
实验性的浏览器桥接(读取页面,可选地点击和填写),见 WebMCP 浏览器桥接。
通过 AX Trust 缓存对所选文件提出独立问题,见 固定上下文提问。
| 我想…… | 从这里开始 |
|---|---|
| 判断 AX Code 是否适合我的工作 | 为什么选择 AX Code |
| 在安装之前理解 AX Code | 从这里开始 |
| 审阅、比较或撤销代理做了什么 | 执行证据 |
| 让多个模型尝试同一项变更 | 已验证的多模型变更 |
| 选择安装或运行时渠道 | 安装与运行时渠道 |
| 连接托管、CLI、自定义或本地提供商 | 支持的提供商与模型 |
| 在 Apple Silicon 上启用托管的本地推理 | AX Engine 模型选择 |
| 阅读当前的 Tiel 与 MTPLX 速度数字 | Tiel 同行摘要(2026 年 9 月 20 日) |
| 用免费层模型 API 试用 AX Code | 免费层 API 快速入门 |
| 在安全的文件系统和网络边界内运行代理 | 沙盒模式 |
| 安全地管理云或网络基础设施 | 云操作模式 |
| 无人值守运行或在 CI 中运行 | 自主模式 |
从脚本或 CI 调用一次性的 ax-code run CLI |
无头 CLI |
| 运行重复提示或安排持久任务 | 循环模式与计划任务 |
| 当运行需要注意时听到声音或语音提醒 | 音频通知 |
| 让计划工作在进程或主机退出后继续运行 | 长时间运行的操作 |
| 选择本地、云端、混合、council 或 arena 执行 | 执行模式 |
| 连接外部工具和数据 | MCP 集成 |
| 让代理通过 WebMCP 在 Chrome 中读取并操作 | WebMCP 浏览器桥接 |
| 把 AX Code 嵌入应用 | @defai-digital/ax-code-sdk |
| 为另一种语言生成客户端 | HTTP 与 OpenAPI 兼容性 |
| 构建桌面或原生宿主 | 原生 SDK 传输 |
入门
-
Standard 与 Business — 开源 Standard、免费商业使用、规划中的专有 Business,以及公开访问状态。
-
为什么选择 AX Code — AX Code 优化什么、预期受众、它有何不同,以及它 不声称什么。
-
从这里开始 — 产品心智模型,以及按用例划分的最短路径。
-
安装与运行时渠道 — 受支持的平台、包、更新,以及 贡献者启动器。
运行时指南
- Wiki 证据可视化 — 打开已记录 Wiki 页面/源关系的本地图,或导出离线 HTML。包含来自 AX Code 自己 wiki 的径向、力导向和页面聚焦截图。
- 对话回顾 — 用
/recap赶上最近的工作,并配置空闲横幅。 - 音频通知 — 当运行需要你注意时的系统声音和选择加入的语音提醒。
- 执行证据 — 图、比较、重放、风险、回滚、分支、跟踪,以及 审计导出。
- 已验证的多模型变更 — 端到端的 council 和 arena 工作流。
- 沙盒模式 — 隔离模式、受保护路径、网络控制和优先级。
- 云操作模式 — 计划/批准/应用工作流、批准令牌,以及
cloudops代理姿态。 - 自主模式 — 无人值守执行、批准、无头使用和防护。
- 无头 CLI — 用于脚本、CI 和代理调用方的一次性
ax-code run命令。 - TUI 语言与设置 — 界面和对话语言,以及首次设置。
- TUI 动画 — 开场与结束配对、终端能力,以及渲染回退。
- 循环模式与计划任务 — 重复提示、持久计划和长时间运行限制。
- 长时间运行的操作 — 受监督的服务示例、恢复语义,以及 操作检查。
- 执行模式 — agent、混合、council 和 arena 行为。
- 多模型路由最佳实践 — 把高价推理和较低成本的支持 工作分开,而不悄然削弱对正确性敏感的任务。
- 模型恢复 — 确切的模型选择、显式回退配置和诊断。
- 自动路由 — 专家路由和可选的复杂度路由。
- 模型努力程度 — 思考级别和提供商专属行为。
- 性能 — 编程工具配置档和本地请求计时诊断。
- 内存用量 — 内存配置档、缓存保留和后台输出限制。
- 本地证据缓存 — 可选的 SQLite 和 RocksDB 证据复用、鉴定和回滚。
- 生命周期钩子 — 钩子事件和捆绑的策略包。
- 运行报告 — 工作区用量、活动、模型/工具分解,以及按会话的报告。
提供商
- 支持的提供商与模型 — 提供商 ID、凭据和模型发现。
- 免费层 API 快速入门 — 兼容的零成本路径、约束和安全评估。
- 自定义与网关提供商 — OpenAI 与 Anthropic 兼容端点。
- MTPLX 与 oMLX 设置 — 源码检出的本地预设、发现、工具和身份验证。
- Tiel 同行摘要(2026 年 9 月 20 日) — 当前 Tiel / Cyber-Tiel 与 MTPLX 的原生 API 数字;完成默认 194.88,峰值解码 249.01。
- AX Code/OpenCode 客户端复测 — 六种客户端/运行时组合、活动 MTP、首次/重复计时,以及代码检查。
- 本地推理测量 — 带计时和可比性限制的、有日期的 AX Code/OpenCode 与运行时测试。
- AX Engine 模型选择 — 本地模型排名和内存指引。
集成
- MCP 集成 — 信任、权限、资源和服务器安全。
- ACP — 面向 IDE 宿主的 Agent Client Protocol 正常路径。
- AX Wiki — 有源代码依据的仓库知识和 CI 工作流。
- VS Code 集成 — 编辑器命令、设置和工作流。从 市场列表 安装。
SDK 与服务边界
@defai-digital/ax-code-sdk— 第一方 TypeScript 和 JavaScript 嵌入。- 原生 SDK 传输 — 面向桌面/原生的 gRPC 形态边界和回退行为。
- HTTP 与 OpenAPI 兼容性 — 服务器模式,以及为其他语言生成的客户端。
- OpenAPI 快照 — 权威的 HTTP 路由和模式契约。
架构与可靠性
参考
-
配置 JSON Schema — 生成的配置输入契约。
-
TypeScript 原生支持 — 源编译器、语言服务、诊断和兼容性。
-
技能与插件目录 — 捆绑技能、项目技能、插件和评估。
-
隔离策略包 — 机器可读的策略示例。
-
发布验证 — 规范的 Minisign 公钥和验证命令。
-
Windows 运行时完整性 — 签名、已安装文件验证和防病毒证据。
-
安全策略 — 威胁模型、凭据存储和受支持的版本。
文档边界
docs/ 包含针对已发布运行时中存在的行为的公开指引。规划材料、发布目标、
实现策略和临时分析不属于这里:
| 内容 | 位置 |
|---|---|
| 架构决策 | .internal/adr/ |
| 产品要求和技术规格 | .internal/prd/ 和 .internal/spec/ |
| 路线图、实现计划、发布目标、审阅和审计 | .internal/reports/ |
| 已发布的行为和公开集成指引 | docs/ |
每个公开 Markdown 页面都应当在靠近顶部的位置声明其状态、范围、最近审阅日期和负责人。优先链接到 生成的契约或实现源,而不是复制路由列表和其他容易漂移的快照。
维护检查清单
在发布或实质性文档变更之前:
- 对照实现核验命令、默认值、标志、提供商 ID 和运行时标签。
- 更新最窄的权威指南,而不是在若干入口页面重复同一行为。
- 运行
pnpm run test:scripts,以发现断开的本地链接、孤立页面和缺失的页面元数据。 - 更新已批准的导出清单并运行
node script/export-public-docs.mjs --website /path/to/ax-code.app, 然后运行网站检查、构建和 Workers 冒烟检查。网站构建使用已提交的快照,并不 需要源码访问。新的公开页面和资产必须在清单中被显式批准。 - 把提案、项目开发笔记、发布目标和历史决策记录放在
.internal/下, 而不是放进公开导航。