CrabCode 总览
TUI、GUI、App Server、工具、MCP、插件和自动化共同组成的本地 AI 员工环境。
是什么
CrabCode 是一个本地优先的 AI 员工环境。它既可以在终端里以 TUI 运行，也可以在桌面 GUI 里管理项目、会话、插件、浏览器和自动化任务。进入项目目录后运行 crabcode，它会把当前目录当作工作区，读代码、编辑文件、跑命令、调用工具、管理会话，并在需要时把写盘或命令执行交给你审批。
从源码结构看，CrabCode 不是单一 CLI：终端入口、桌面端、App Server、cron daemon、工具注册表、MCP、插件/技能和浏览器自动化是相互配合的一组模块。文档中心按这些模块重新拆分，避免只写 TUI 而漏掉桌面端和后台能力。
运行形态
| 形态 | 入口 | 适合场景 |
|---|---|---|
| 交互式 TUI | crabcode | 在当前仓库里持续对话、读写代码、跑测试、做 Git 工作流 |
| 单次 print 模式 | crabcode -p "..." | 脚本、CI、管道、一次性分析或批处理输出 |
| 桌面 GUI | CrabCode 桌面应用 | 管理项目树、会话列表、审批面板、差异、终端、插件、自动化和浏览器 |
| App Server | crabcode server / crabcode-app-server serve | 给桌面端、IDE、远程客户端或本地集成提供会话与工具协议 |
| 定时自动化 | crabcode cron ... / GUI「自动化」 | 周期任务、一次性提醒、立即触发、查看运行历史 |
| 浏览器自动化 | crabcode browser ... / GUI「浏览器」 / /chrome | 用 Playwright 或 Chrome 扩展执行网页操作 |
模块对照
| 源码模块 | 文档分类 | 你应该看 |
|---|---|---|
| CLI/TUI 入口与参数 | 入门、CLI、会话 | TUI 快速上手、CLI 参考、会话管理 |
| 桌面端 Tauri GUI | GUI、项目、审批、插件、自动化 | GUI 桌面端上手、自动化 |
| 内置工具注册表 | 工具、权限、沙盒 | 工具系统、权限模式、Sandbox |
| MCP 与外部工具 | 自定义与集成 | 接入 MCP、插件与技能 |
| 插件、技能、marketplace | 自定义能力 | 插件与技能、自定义指令 |
| cron daemon 与 GUI 自动化页 | 工作流 | 自动化、CLI 参考 |
| App Server、后台会话、远程控制 | 部署与协作 | 远程控制、多人协作 |
| 浏览器、Chrome 扩展、输入模态 | 自定义与输入 | 浏览器自动化、输入模态 |
| 本地模型、模型路由 | 模型与离线 | 模型路由、离线 / 私有模型 |
一眼看完
| 想做的事 | 怎么做 |
|---|---|
| 安装并跑起终端版 | 看 TUI 快速上手 |
| 打开桌面端 | 看 GUI 桌面端上手 |
| 查全部 CLI 参数 | crabcode --help 或 CLI 参考 |
| 查 TUI 内命令 | 启动后输入 /help 或直接输入 / 看补全 |
| 配置权限 / 沙盒 | 看 权限模式 与 Sandbox |
| 接外部工具 | 看 MCP、插件与技能 |
| 创建定时任务 | 用 crabcode cron add ... 或 GUI「自动化」页 |
| 做浏览器任务 | 用 /chrome、crabcode browser ... 或 GUI「浏览器」页 |
模型与配置
启动时默认走主循环模型。你可以用 /model 切换，也可以在配置文件里指定模型、fallback 模型、权限模式、工具白名单、MCP server、插件目录和额外工作目录。具体模型 ID 由账号、网关和发行版配置决定，文档里不硬写某个供应商字面。
推荐学习路径
- TUI 快速上手：装好、登录、跑第一条指令。
- GUI 桌面端上手：打开项目、看审批、差异、终端和插件/自动化入口。
- CLI 参考：熟悉子命令、
--print、会话恢复、后台会话和 cron。 - 工具系统：知道内置工具、条件工具、MCP 工具和权限边界。
- 按需继续看 MCP、插件与技能、自动化、浏览器自动化。