Skip to content

ToCodex CLI

ToCodex CLI 是面向命令行环境的 ToCodex 使用方式,适合在终端、脚本、远程服务器或自动化流程中调用 AI 编程能力。它延续 ToCodex 的核心理念:让 AI 直接参与代码理解、修改、验证与交付,同时保留命令行工具轻量、可组合、易集成的优势。

使用 npm 全局安装 ToCodex CLI:

Terminal window
npm install -g @tocodex/cli

安装完成后,即可在终端中使用 ToCodex CLI 发起任务、处理代码仓库中的问题,或将它接入已有的开发与运维流程。

ToCodex CLI 更适合以下场景:

  • 终端优先的开发者工作流:习惯在 Shell、PowerShell、Git Bash、WSL 或远程终端中完成开发任务。
  • 远程服务器与无界面环境:在服务器、CI 机器、容器或 SSH 会话中执行代码检查、修复和自动化操作。
  • 脚本化与自动化集成:将 AI 编程能力嵌入现有脚本、发布流程、代码审查流程或定时任务中。
  • 快速处理仓库任务:在当前项目目录中直接描述需求,让 CLI 辅助阅读代码、修改文件、运行验证命令。
  • 轻量使用 ToCodex 能力:不想打开桌面应用或 IDE 时,可以直接在命令行中完成一次性任务。

典型的 ToCodex CLI 工作流如下:

  1. 进入项目目录

    在终端中切换到需要处理的代码仓库目录。

  2. 描述任务目标

    使用自然语言描述你希望 ToCodex 完成的任务,例如修复一个报错、补充文档、重构某个模块或运行测试验证。

  3. 审查执行计划与变更

    对于涉及多文件或核心逻辑的任务,建议先让 ToCodex 分析影响范围、说明修改方案,再执行实际变更。

  4. 运行验证命令

    修改完成后,可以让 CLI 执行相关的测试、构建或 lint 命令,确认变更没有破坏现有功能。

  5. 提交代码

    审查生成的 diff,确认符合预期后再提交到版本控制系统。

这种工作流非常适合与 Git、npm scripts、CI/CD、Docker、SSH 等命令行生态组合使用。

ToCodex CLI、桌面版和 IDE 插件面向的是同一套 ToCodex 能力,但入口和使用体验不同:

  • ToCodex CLI:适合终端、远程环境、自动化脚本和 CI/CD 场景,强调轻量、可组合、易集成。
  • ToCodex 桌面版:适合希望使用独立图形界面管理任务、配置模型、查看执行过程的用户。
  • ToCodex IDE 插件:适合在编辑器中边写代码边调用 AI,能够结合当前打开文件、诊断信息和编辑器上下文进行交互。

三者并不是互相替代的关系,而是互补关系:

  • 在本地开发时,可以使用 IDE 插件获得最自然的编辑器内体验。
  • 在需要集中管理或图形化操作时,可以使用桌面版。
  • 在远程服务器、自动化流水线或终端工作流中,可以使用 ToCodex CLI。

如果你的团队同时使用多种开发环境,可以根据场景选择合适入口,让 ToCodex 在编辑器、桌面应用和命令行之间覆盖完整的软件开发流程。