(整理自完整版 commands/onboard.md 实测文本与 /onboard 公开 Gist,非本次新实测;/onboard 不在 Lite 免费版、只在完整版。)
刚 clone 一个仓库,README 只有两行;接手别人的项目,不知道先看哪个文件——最容易踩的坑是从第一行开始硬读,读了半天还不知道这个项目是干什么的。/onboard 只做一件事:当导游,不当卫星地图——讲路线,不讲每块砖,10 分钟讲清它是干什么的、代码怎么组织、从哪开始改。
调用方式:/onboard <项目路径,可附你的角色:开发/运维/只想用>。
5 条:
- 先给一句话定位,再画地图。先看 README、package.json/pyproject 等,回答“这个项目是干什么的、给谁用的”,一句话说清。然后列出核心目录/模块,每个一句话说明职责,并标出入口文件(main/cli/app 入口在哪)。没有入口标注的地图,等于没画。
- 关键路径 5 步以内讲清。挑一条最核心的调用链(如“请求进来→处理→返回”),用 5 步以内讲清数据怎么流的。示例(实测文本里的小模块):load_orders → batch_settle → summarize。超过 5 步还没讲清,说明挑错了链——换一条更核心的。
- 上手三步必须是可复制的命令。“跑起来”的最小步骤:安装→配置→跑一个例子,每步是可复制的命令,不是“大概装一下”“配置一下”这种描述。示例:
python -c "from orders import ..."——能直接粘贴跑通,才算一步。 - 第一刀砍在哪,要精确到文件和函数。回答“如果我要加一个小功能,第一刀砍在哪”:指出最可能要改的 1–2 个文件和函数,并说明为什么是这里。示例:batch_settle 的 level 取值处(已知健壮性问题)。只说“改核心模块”等于没说。
- 没看懂就标
[没看懂],不编。没看懂的部分明确标[没看懂],不编造业务逻辑。超过 200 个文件的项目,先说“这是局部导游,建议按模块再问”。
输出长什么样(取自 onboard.md 的格式):一句话、地图(每个目录一句话职责+入口标注)、关键路径(1. xxx → 2. xxx → …)、上手三步(可复制的命令)、第一刀砍在哪(文件+函数+原因)、没看懂的([没看懂] 项)。
什么时候不要用:项目就一个文件——自己读,比导游快;想让它讲“每一行代码”——导游讲路线,不讲每块砖;仓库有 10 万行——先指定一个子目录;完全没文档也没注释的祖传代码——先接受“导游只能带你看结构”,读不懂的业务逻辑得问人。
免费先试:Lite 免费版含 /review、/commit、/test 三条命令,双兼容 Claude Code 与 Codex CLI,见 Lite 仓。
完整版含 /onboard 在内的 10 条命令,早鸟 ¥9.90(限前 100 份)/正式 ¥19.90,付款后 12 小时内私信交付,7 天无理由退款。国内账号风控提示:优先用 Codex。
链接(文末三链接):
