概览
欢迎使用 ToCodex AI 生产力平台套件。本文档将帮助你快速上手并充分发挥 AI 的能力。
产品定位
让 AI 成为你的超级生产力。
ToCodex 是一个开源的 AI 多Agent 生产力套件,覆盖办公、开发、运维全流程,旨在充分利用最先进的大语言模型,改善工作流节省成本提升效率。它功能强大且开放,用户可自由添加多个API,实现多模型聚合,根据需要无缝切换,不被某家厂商绑定。
ToCodex 利用有效的提示词工程, 缓存命中优化,智能压缩任务循环等技术在长任务连续性,成本管控上表现突出。 其创新的技能生成与自学习让AI更贴近真实工作流更懂工作场景。
ToCodex 致力于成为高质量、可通用的AI平台。如果您想要最好、最自由的 AI 体验,这就是您的选择。
成功理念
掌握几个核心理念,能让你从 ToCodex 中获得数倍的收益。
让规则与流程掌控 AI
把团队约定、操作禁令、输出风格写进记忆与规则(全局规则、项目 rules.md、AGENTS.md),AI 会在每次任务中自动遵循。重要变更先让 AI 产出计划(Plan mode),你确认后再执行——始终让代码与流程由你掌控,AI 负责执行。
复用经验,沉淀为资产
把重复出现的工作流沉淀为 Skills,把项目架构、路径约定、已知问题写进项目记忆。团队经验变成可复用的 AI 能力,新成员与 AI 都能直接继承,越用越懂你的场景。
安全地探索,逐步放大自动化
先在细粒度审批下熟悉 AI 的工作方式,再逐步开启自动批准;大规模重构前手动创建命名检查点,任何不满意都可以一键回滚。安全网越牢,探索就可以越大胆。
保持成本意识
简单任务用轻量模型,复杂推理用旗舰模型;利用缓存命中优化与长任务智能压缩控制成本;同类小问题合并成批处理,一次对话解决。
硬核能力
- 代码能力:深度理解代码库,支持LSP,代码图谱和丰富的工具库调用
- 工程化能力:Plan mode , TODO List, Multi-task , Engineering SOP
- 成本优势:简洁有效的提示词工程 , 高缓存命中优化 , 长任务智能压缩迁移
- 接入能力:自由添加多API,实现模型聚合切换,支持26家模型协议和多平台适配
- 多Agent调度:多Agetnt并行任务,多Agent覆盖办公、开发、运维全流程
- 安全可控:检查点回滚保障安全,细颗粒度审批.
- 扩展能力:实现 Skills / MCP / model 市场支持安装,导入,导出
- 移动端:支持接入飞书 和 Telegram 远程审批与交互
- 自学习自进化:记住偏好/规则, 复用经验, 自优化工作流生成复用skills和批处理
快速开始
只需三步,即可开始使用 ToCodex:
- 选择一种安装方式:安装 Windows/MAC 桌面版,或在 VS Code 扩展市场安装 ToCodex
- 登录账号并配置你的 AI 模型(或使用 ToCodex 托管服务)
- 开始对话式编程、代码补全与多步骤自动执行
常见问题
支持哪些模型?
支持 26 家模型厂商协议:OpenAI 兼容通用协议(/v1/chat/completions)、OpenAI 新协议(/v1/responses)、生图协议、Claude Messages、Gemini 等。在模型列表点 + 号即可添加,绑定 KEY 开箱即用,可自由聚合与切换。
AI 改错了代码怎么办?
ToCodex 在每次文件修改前自动创建检查点(基于 Git 快照,不影响你的版本历史)。在对话面板历史中点击「回滚到此处」即可恢复到任意检查点。
如何保证执行安全?
默认每个操作都需要你确认;可按读取文件、写入文件、终端执行、浏览网页四个维度精细配置自动批准。建议先保持终端执行为手动批准。
人不在电脑前如何跟进任务?
接入飞书或 Telegram IM,即可在手机上接收任务完成通知、报错信息,并远程回复与审批。
一台电脑能跑多个实例吗?
可以。复制安装目录并重命名 exe 即可同时运行多个实例,数据相互隔离、互不影响。
提供 API 吗?
ToCodex 暂不公开提供 API 调用接口,如需 API 请联系客服。
IM 移动端
支持: 飞书 和 Telegram 接入, 独立通道双向交互 (文本消息 / 图片/ 文件 ,<5M)
设计原则 : 消息跟人走,区分会话来源,避免无效信息打扰
IM端收这些消息:IM会话保持,任务完成,审批,报错,从本地会话要求发IM的指令
飞书 (开发者后台)
1.在<飞书开放平台>创建企业自建应用,并准备 App ID 与 App Secret。
2.把 App ID、App Secret 填入下方输入框,点击测试凭据确认可用。
3.添加应用能力,启用机器人能力,权限管理(开通消息/图片/文件 收发等功能),并把机器人加入目标会话。
4.点击生成绑定码,在飞书机器人会话中发送 /bind 绑定码完成绑定。
5.开启 IM 连接总开关并保存,后续接入后即可远程交互,接收通知、回复与审批。
Telegram
1.在 Telegram 通过 @BotFather 创建 Bot,并复制 Bot Token。
2.把 Bot Token 填入下方输入框,点击测试连接确认可用。
3.点击生成绑定码,得到一次性 /bind 命令。
4.在 Telegram 中打开你的 Bot 会话,发送 /bind 绑定码完成绑定。
5.开启 IM 连接总开关并保存,之后即可远程交互,接收通知、回复与审批。
添加模型API
在模型列表上点 + 号图标,支持:26家模型厂商协议
openai 兼容通用协议, /v1/chat/completions
openai 新协议,/v1/responses
openai 生图协议 /v1/images/generations
Claude Messages /v1/messages
gemini 协议
等其它26家模型厂商协议绑定KEY开箱即用.
API
记忆与规则
全局 / 跨项目(影响最大)
全局记忆 GLOBAL_MEMORY.md: 适合用户偏好、通用规则、长期习惯。
用户级通用规则 ~/.tocodex/rules/rules.md:适合全局当前项目规则约定、操作禁令、输出风格等。
项目级(仅当前工作区)
项目记忆 .tocodex/memory/.../MEMORY.md:适合项目架构、路径约定、已知问题和修复记录。
项目通用规则 .tocodex/rules/rules.md 当前项目规则约定、操作禁令
项目 AGENTS.md ,Agent Rules 标准文件,适合提交到仓库并让不同 AI 工具共享项目规则。
生成备忘录,任务完成自动生成备备忘录,作为本地档案库,可在设置里关掉
16 种模式
ToCodex 提供 16 种专属 AI 模式,覆盖从需求设计到部署的完整开发流程。每种模式针对特定场景优化,让 AI 更精准地理解你的意图。
Architect 架构师模式
在编写代码前进行需求分析、技术选型、架构设计与任务拆解。
- 适用场景:新项目启动、功能模块设计、技术方案评审
- 示例:「设计一个支持百万并发的实时聊天系统」
Code 代码模式
直接编写、修改、重构代码,支持批量编辑与智能补全。
- 适用场景:日常编码、功能实现、代码重构
- 示例:「实现用户登录接口,包含 JWT 认证」
SSH Server SSH 服务器开发模式
通过 SSH 管理远程服务器,部署代码、查看日志、诊断服务、管理 Docker 容器与数据库。
- 适用场景:远程服务器运维、服务部署、日志排查、Docker 管理
- 示例:「连接生产服务器,查看 Nginx 日志并重启 Docker 服务」
浏览器自动化
让 AI 自动完成网页操作、互动、分析与办公流程,支持社交互动、电商平台分析、客服对话、短视频平台操作和办公平台自动化。
- 适用场景:网页操作、互动、分析与办公流程,支持社交互动、电商平台分析、客服对话、短视频平台操作和办公平台自动化
- 示例: 发布新闻,微博,填写表单
Image Gen 生图模式
根据文本提示生成图片,或对已有图片进行编辑、增强和风格转换。
- 适用场景:产品配图、营销素材、界面插画、图片增强
- 示例:「生成一张科技感官网 Hero 背景图」
Debug 调试模式
诊断并修复软件问题,定位 Bug 根源、分析报错日志、提供修复方案。
- 适用场景:Bug 修复、性能问题排查、错误日志分析
- 示例:「为什么这个接口返回 500 错误?」
Orchestrator 编排模式
协调多个模式完成复杂任务,自动串联 Architect → Code → Debug 流程。
- 适用场景:复杂功能开发、多步骤任务、端到端实现
- 示例:「从零开始实现一个 RESTful API 服务」
Translate 翻译模式
专门处理国际化(i18n)任务,自动翻译多语言文本、管理本地化资源文件。
- 适用场景:多语言支持、i18n 文件管理、翻译质量检查
- 示例:「将所有中文文案翻译成英文和日文」
Issue Fixer 修复模式
直接对接 GitHub Issues,自动解析问题描述、生成修复代码或实现新功能。
- 适用场景:开源项目维护、Issue 处理、功能请求实现
- 示例:「修复 GitHub Issue #123」
Docs Extractor 文档模式
从代码库中提取功能细节、生成技术文档、验证文档与代码的一致性。
- 适用场景:API 文档生成、架构文档编写、代码注释补充
- 示例:「生成当前项目的 API 文档」
PR Fixer PR 修复模式
分析 Pull Request 的审查反馈,自动修复失败的测试,并解决代码合并冲突。
- 适用场景:PR 审查反馈修复、CI 测试失败修复、合并冲突解决
- 示例:「修复 PR #456 中的所有审查意见」
Merge Resolver 合并冲突模式
智能分析并解决代码合并冲突,理解双方修改意图,生成最优合并结果。
- 适用场景:分支合并冲突、多人协作冲突解决
- 示例:「解决 feature/auth 分支与 main 分支的合并冲突」
Issue Writer Issue 编写模式
根据描述自动生成结构化的 GitHub Issue,包含复现步骤、预期行为、环境信息等。
- 适用场景:Bug 报告、功能请求、改进建议
- 示例:「帮我创建一个关于登录页面无法在 Safari 中正常显示的 Bug 报告」
自定义模式
除内置模式外,ToCodex 支持创建完全自定义的 AI 模式,你可以定义专属的系统提示词、工具权限和行为规则,打造符合团队需求的专属 AI 助手。
创建自定义模式
- 在命令面板输入「ToCodex: 创建自定义模式」
- 填写模式名称、图标和描述
- 编写系统提示词,定义 AI 的角色和行为
- 配置允许的工具权限(文件读写、终端执行等)
- 保存后即可在模式列表中使用
自动批准
默认情况下,ToCodex 在执行每个操作前都会请求你的确认。启用自动批准后,AI 可以在无需人工干预的情况下连续执行操作,大幅提升自动化效率。
启用方式
- 在 AI 对话面板底部点击「自动批准」开关
- 或在设置中配置
tocodex.autoApprove.enabled: true
权限范围配置
你可以精细控制自动批准的范围:
"tocodex.autoApprove.readFiles": true,
"tocodex.autoApprove.writeFiles": true,
"tocodex.autoApprove.executeTerminal": false,
"tocodex.autoApprove.browsWeb": false检查点
ToCodex 在执行重要操作前会自动创建检查点(快照),如果对 AI 的修改不满意,可以一键回滚到任意检查点,无需手动撤销。
使用检查点
- 检查点在每次文件修改前自动创建
- 在 AI 对话面板的历史记录中查看所有检查点
- 点击「回滚到此处」可恢复到任意检查点状态
- 也可手动创建检查点:命令面板输入「ToCodex: 创建检查点」
Skills 技能
Skills 是 ToCodex 的可复用指令模块,将团队编码规范、工作流程、项目约定封装成 AI 可直接执行的技能包,让 AI 在每次对话中自动遵循,无需重复说明。
通过对话安装 Skill
你只需在 AI 对话中描述你的需求,ToCodex 会自动为你创建或安装 Skill:
ToCodex 将自动在项目的 .roo/skills/ 目录中生成对应的 Skill 文件,并立即生效。
工作原理
Skill 本质上是一个 Markdown 文件,存放在项目的 .roo/skills/ 目录下。当 AI 执行任务时,会自动加载匹配的 Skill 作为额外上下文指令。你也可以手动编辑这些文件来精细调整规范。
MCP 服务器
MCP(Model Context Protocol)是 ToCodex 的能力扩展协议。通过接入 MCP 服务器,AI 可以调用外部工具、访问数据库、操作第三方服务,实现无限扩展。
MCP 能做什么
- 查询数据库:让 AI 直接读写 PostgreSQL、MySQL 等数据库
- 操作浏览器:驱动 Playwright/Puppeteer 进行 E2E 测试
- 调用 API:集成 GitHub、Jira、Slack 等服务
- 文件操作:读写本地文件系统的任意位置
- 自定义工具:接入你自己开发的业务工具
通过对话安装 MCP 服务器
无需手动编写配置文件,直接告诉 ToCodex 你想要的能力:
ToCodex 会自动完成 MCP 服务器的下载、配置和注册,配置写入 .roo/mcp.json,重启后即可使用。
在对话中使用 MCP 工具
- 安装完成后,在 AI 对话中直接说明你的需求
- ToCodex 会自动识别并调用对应的 MCP 工具
- 也可明确指定:「使用 GitHub MCP 查看最新 Issues 并自动分类」
端到端自动化
ToCodex 的端到端自动化功能可以从需求输入到代码交付,自动串联设计、编码、测试、打包全流程,实现真正的无人值守开发。
工作原理
端到端模式结合了 Orchestrator 模式的编排能力和其他专业模式的执行能力:
- 需求分析:理解用户输入的自然语言需求
- 架构设计:自动调用 Architect 模式生成技术方案
- 代码实现:切换到 Code 模式编写代码
- 测试验证:生成单元测试并执行
- 问题修复:如发现问题,自动调用 Debug 模式修复
- 文档生成:使用 Docs Extractor 生成技术文档
使用方法
- 切换到 Orchestrator 模式
- 输入完整的功能需求描述
- AI 会自动规划并执行完整流程
- 在每个关键步骤,你可以选择确认或调整
示例场景
ToCodex 将自动完成:
- 生成项目架构设计文档
- 创建前后端项目结构
- 实现所有 CRUD 接口和 UI 组件
- 编写单元测试和集成测试
- 生成 API 文档和使用说明
- 配置构建和部署脚本
最佳实践
- 需求描述越详细,生成的代码质量越高
- 可以在流程中随时介入调整方向
- 建议先在小型项目上尝试,熟悉后再用于大型项目
- 定期检查生成的代码,确保符合团队规范
快捷键
| 操作 | Windows / Linux | macOS |
|---|---|---|
| 打开 AI 对话 | Ctrl+Shift+A | Cmd+Shift+A |
| 内联编辑 | Ctrl+I | Cmd+I |
| 接受补全建议 | Tab | Tab |
| 忽略补全建议 | Esc | Esc |
| 接受下一个词 | Ctrl+→ | Cmd+→ |
| 手动触发审查 | Ctrl+Shift+R | Cmd+Shift+R |
| 切换自动补全 | Ctrl+Shift+T | Cmd+Shift+T |
你可以在 VS Code 的键盘快捷键设置中自定义所有快捷键,搜索 tocodex。
使用模式
ToCodex 的能力是模块化、可组合的。以下是被反复验证有效的使用模式,掌握它们能显著提升交付质量与速度。
| 模式 | 做法 | 收益 |
|---|---|---|
| 任务拆解编排 | 用 Orchestrator / Plan mode 把复杂需求拆成原子步骤,串联 Architect → Code → Debug 流程 | 质量、可控 |
| 渐进自动批准 | 从只读开始,逐步放开写文件、终端执行权限,随信任度提升而放大自动化 | 安全、效率 |
| 检查点安全网 | 大改动前手动创建命名检查点,验证失败立即回滚重试 | 安全 |
| 多 Agent 并行 | 把相互独立的工作包交给多个并行子任务同时推进 | 速度 |
| 技能沉淀 | 把重复流程固化为 Skills,一次编写、处处复用,并可导入导出共享 | 一致性、成本 |
| MCP 扩展 | 接入数据库、浏览器、内部业务工具,扩展 AI 的能力边界 | 能力 |
| IM 远程审批 | 接入飞书 / Telegram,远程接收通知并审批,人不在电脑前也不阻塞 | 响应速度 |
最佳实践
需求描述
- 目标、约束、验收标准写得越具体,产出质量越高
- 给出示例输入/输出或参考文件,减少来回澄清
- 一次对话聚焦一个目标,避免多目标混杂
上下文管理
- 用 @ 精确引用相关文件,而不是把整个仓库丢给 AI
- 利用代码库索引与代码图谱,让 AI 自主定位相关代码
- 长会话及时开新会话,把关键结论写进项目记忆
模型与成本
- 简单任务用轻量模型,架构设计与复杂推理用旗舰模型
- 利用多 API 聚合,按任务特点切换最合适的模型
- 同类小问题合并批处理,利用缓存命中降低成本
安全实践
- 终端执行与生产环境操作保持手动批准
- 大规模重构前手动创建命名检查点
- 密钥、密码等敏感信息不要进入对话内容
迭代节奏
- 小步提交、频繁验证,用 TODO List 跟踪多步骤任务
- 让 AI 先给方案再动手(Plan mode),方向错了及时纠偏
- 把验证过的修复经验写进项目记忆,避免重复踩坑
下一步
从这里继续深入: