Skip to content

Onboarding 集成

Inspecto 为常见的 AI 编码助手提供了 onboarding 集成,以自动化完成你在项目中的设置。在你的项目根目录安装对应的集成,CLI 将尝试自动在你的宿主 IDE 中拉起 onboarding 流程。

快速开始

最快的使用路径:

  1. 进入你的项目根目录(大多数集成是基于项目的)。
  2. 复制并运行匹配的安装命令

--host-ide 的可选值有:vscode, cursor, trae, trae-cn, codebuddy, codebuddy-cn

bash
npx @inspecto-dev/cli integrations install codex --host-ide vscode
bash
npx @inspecto-dev/cli integrations install claude-code --scope project --host-ide vscode
bash
npx @inspecto-dev/cli integrations install copilot --host-ide vscode
bash
npx @inspecto-dev/cli integrations install cursor --host-ide cursor
bash
npx @inspecto-dev/cli integrations install gemini --host-ide vscode
bash
npx @inspecto-dev/cli integrations install trae --host-ide trae-cn
bash
npx @inspecto-dev/cli integrations install coco --host-ide trae-cn
bash
npx @inspecto-dev/cli integrations install codebuddy --host-ide codebuddy-cn
  1. 跟随 CLI 拉起的 onboarding 流程

当你已经确定宿主 IDE 时,请始终优先显式传递 --host-ide。它能避免在纯终端会话中模糊的 IDE 探测。

如果 onboarding 流程没有自动打开,请手动向 assistant 发送下面这句固定英文口令:

text
Set up Inspecto in this project

Onboarding 之后:日常使用

Onboarding 只负责安装集成并应用项目配置。日常使用取决于你选择的交付路线:

  • IDE route:使用「检查模式」或「标注模式」把 prompt 立即发送到 IDE 助手。
  • MCP route:设置 "delivery.mode": "mcp",在 Agent 中配置 Inspecto MCP server,然后让 Agent 领取 annotation 或 workflow session。
  • 自定义 workflow:在 .inspecto/prompts.json 中添加 kind: "workflow" 条目,例如 Deploy PreviewReview & PR。Inspecto 负责把指令入队;Agent 自己决定调用哪个 skill、MCP server 或 tool。

如果你希望使用浏览器 timeline 和自定义 workflow 自动化,请在 onboarding 后确认 MCP 已经配置好。

安装作用域

根据不同的助手,集成的安装位置可能是你的用户全局目录,或者是当前的项目本地目录。

  • 项目级(在目标项目根目录执行):CopilotCursorGeminiTraeCoco,以及 Claude Code --scope project
  • 用户级(可在任意目录执行):Codex --scope userClaude Code --scope user

重要提示: 如果你在错误的目录中运行了项目级的安装命令,当你向助手寻求帮助时,它是找不到该集成的!

支持的集成列表

这里列出了所有支持的助手及其安装目标。

助手类型安装目标说明
CodexNative skill.agents/skills/~/.agents/skills/用户级或项目级。默认会安装 onboarding skill 和 agent skill。
Claude CodeNative skill.claude/skills/~/.claude/skills/用户级或项目级。
CopilotNative skill.github/skills/inspecto-onboarding/项目级。请在目标项目根目录执行。
CursorNative skill.cursor/skills/inspecto-onboarding/项目级。请在目标项目根目录执行。
GeminiNative skill.gemini/skills/inspecto-onboarding/项目级。请在目标项目根目录执行。
TraeNative skill.trae/skills/inspecto-onboarding/项目级。请在目标项目根目录执行。
CocoNative skill.trae/skills/inspecto-onboarding/项目级。请在目标项目根目录执行。
CodeBuddyNative skill.codebuddy/skills/inspecto-onboarding/项目级。请在目标项目根目录执行。

默认情况下,所有的 onboarding 集成都会将配置写入纯本地的文件(.inspecto/settings.local.json.inspecto/prompts.local.json),保持你的代码仓库干净整洁。

对于 Codex,CLI 会默认安装 onboarding skill 和 inspecto-agent skill;但 MCP server 配置仍需要你单独补上,所以「标注模式」不会默认切换为 Agent 驱动的任务流程。等 MCP 配好,并且 .inspecto/settings.local.json 中使用 "delivery.mode": "mcp" 后,默认的后续指令是:

text
Use $inspecto-agent to claim Inspecto tasks continuously

常见安装命令示例:

bash
npx @inspecto-dev/cli integrations install codex --host-ide vscode
bash
# 项目级
npx @inspecto-dev/cli integrations install claude-code --scope project --host-ide vscode

# 用户级
npx @inspecto-dev/cli integrations install claude-code --scope user --host-ide vscode
bash
npx @inspecto-dev/cli integrations install copilot --host-ide vscode
bash
npx @inspecto-dev/cli integrations install cursor --host-ide cursor
bash
npx @inspecto-dev/cli integrations install gemini --host-ide vscode
bash
npx @inspecto-dev/cli integrations install trae --host-ide trae-cn
bash
npx @inspecto-dev/cli integrations install coco --host-ide trae-cn
bash
npx @inspecto-dev/cli integrations install codebuddy --host-ide codebuddy-cn

仅当你想在运行安装之前检查阻止项,或者需要排查问题时,才使用 npx @inspecto-dev/cli integrations doctor <assistant> --host-ide <ide> --compact

它的底层工作原理

这些集成的工作原理,是将 Inspecto 的结构化 CLI onboarding 协议(contract)暴露给你的助手。当你请求它设置 Inspecto 时,它将执行:

  1. onboard --json:分析项目并返回结构化的计划。
  2. onboard --json --target <candidateId>:如果需要选择目标,先说明这一步是在选择要接入 Inspecto 的本地开发构建目标,再使用上一次返回中的某个 candidate id 重新运行。CLI 也兼容接受返回里的 configPath 作为兜底值。
  3. onboard --json --yes:在获得你的确认后,应用代码变更。
  4. 引导你安装 IDE 插件(如使用 IDE 模式)。
  5. 确认启动 dev server 的命令。

当 onboarding 配置了 delivery.mode: "mcp" 时,结构化 onboarding 结果还可能包含 handoff.dailyUsage。Assistant 集成在引导用户日常使用已安装的 inspecto-agent skill 处理 MCP 标注任务时,应优先使用这个字段,而不是硬编码后续提示语。

这可以保证实际的文件修改,始终由 Inspecto CLI 的解析器安全地完成,而不是依赖助手来手动修改你的配置文件。

关于 inspecto integrations doctor --json 的字段语义和退出状态码,请参阅 packages/cli/README.md

Released under the MIT License.