SuperAPI AI 工具集

onboard

编程与开发

查看项目

更新于 10-16 07:51

技能介绍

用途

Onboard 用于分析既有(brownfield)代码库,并创建初始的连续性台账(continuity ledger)。它适合在以下情况使用:

  • 第一次在一个已有项目中工作
  • 用户说出“onboard”“analyze this project”“get familiar with codebase”等指令

主要能力

该技能通过启动一个 onboard 子代理来完成项目探索与台账创建。其流程包括:

  • 创建所需目录(如果不存在):mkdir -p thoughts/shared/handoffs/ .claude
  • 使用可用工具探索代码库:
    • 尝试:tldr tree . && tldr structure .
    • 回退方案:find . -type f -name ".py" -o -name ".ts" -o -name "*.js" | head -50
  • 检测技术栈(查找 package.json、requirements.txt、Cargo.toml、go.mod 等文件)
  • 通过 AskUserQuestion 询问用户的目标
  • 在 thoughts/shared/handoffs/<project>/onboard-<date>.yaml 创建 YAML 交接文件,内容结构如下:
date: <date>
type: onboard
status: active

goal: <user's stated goal>
now: Start working on <...>
tech_stack: [list of detected technologies]
key_files:
  - path: <...>
    purpose: <...>
architecture: <...>
next:
  - <...>

使用方式

使用 Task 工具,指定 subagent_type: "onboard",并传入提示:

Onboard me to this project at $CLAUDE_PROJECT_DIR.

随后按照上述流程执行目录创建、代码库探索、技术栈检测、目标询问和交接文件生成。

为什么使用代理

Onboard 过程需要多个探索步骤,且不应将代码库的大量内容污染主上下文。代理会返回一份干净的摘要并创建交接文件。

输出

  • 创建的目录:thoughts/shared/handoffs/<project>/、.claude/
  • 创建的 YAML 交接文件(在会话启动时自动加载)
  • 用户获得清晰的起始上下文
  • 准备好带着完整的项目认知开始工作

适用场景与限制

  • 该技能面向既有代码的 brownfield 项目。
  • 对于全新项目(greenfield),应改用 /create_plan。
  • 交接文件可随时通过 /create_handoff 更新。

暂未提供的信息

关于该技能的收费、价格、平台支持、具体效果等事实,资料中暂未提供。