| name | superclaw-onboard |
| description | SuperClaw Phase 0: 项目上下文扫描。首次使用时自动扫描项目,生成 project-context.md。
使用场景:首次在项目中使用 SuperClaw,或用户要求重新扫描。
终态:project-context.md 生成完毕。
|
SuperClaw: Onboard
Phase 0 — 项目上下文扫描
扫描项目关键信息,生成 .superclaw/context/project-context.md,供后续所有 phase 使用。
宣告: "我在用 superclaw:onboard 扫描项目上下文。"
触发条件
以下任一条件满足时触发:
.superclaw/context/project-context.md 不存在
- 用户明确要求重新扫描(如 "重新扫描项目")
流程
检查 .superclaw/context/project-context.md 是否存在
→ 不存在 or 用户要求重新扫描?
├─ no → 跳过,不做任何操作
└─ yes → 执行扫描
→ 读取项目信息:
├─ README.md / README(如有)
├─ CLAUDE.md(如有)
├─ package.json / Cargo.toml / go.mod / pyproject.toml / Makefile(检测项目类型)
├─ git log --oneline -20(最近活动)
└─ 目录结构(顶层 + src/ 一级子目录)
→ 生成 project-context.md
→ 完成
扫描内容
1. 项目基本信息
从 package.json / Cargo.toml / go.mod / pyproject.toml 等提取:
2. 目录结构
列出顶层目录结构 + 源码目录的一级子目录。不递归深入,保持简洁。
3. 关键命令
从项目配置中推断:
- Build 命令
- Test 命令
- Lint 命令
- 启动命令
如果无法推断,标记为 "未检测到,请手动补充"。
4. 最近活动
git log --oneline -20 的输出摘要。
5. 架构笔记
从 README.md 和 CLAUDE.md 中提取的关键架构信息(如果有)。
输出格式
写入 .superclaw/context/project-context.md:
# Project Context
> Auto-generated by SuperClaw Phase 0
> Last updated: YYYY-MM-DD
## Project
- Name: xxx
- Language: TypeScript
- Framework: Next.js
- Package Manager: pnpm
## Structure
- Source: src/
- Tests: tests/
- Config: .config/
## Key Commands
- Build: pnpm build
- Test: pnpm test
- Lint: pnpm lint
## Recent Activity
- [最近 commit 的单行摘要]
## Architecture Notes
- [从 README/CLAUDE.md 提取的关键架构信息]
约束
- 不涉及 board 操作(Phase 0 不创建任务)
- 生成的文件保持简洁(< 100 行)
- 不修改项目代码
- 不安装依赖
集成
align skill 在开始时检查 project-context.md 是否存在,不存在则先触发 onboard:
align 开始
→ project-context.md 存在?
├─ yes → 读取,继续 align 流程
└─ no → 先执行 onboard → 再继续 align
Anti-Pattern
❌ 递归扫描整个代码库 — 只看顶层和关键配置
❌ 把所有文件内容都塞进 context — 只提取结构和关键信息
❌ 每次 align 都重新扫描 — 只在首次或用户要求时扫描