SuperAPI AI 工具集

project-onboarding

智能体与模型

查看项目

更新于 10-15 19:57

技能介绍

用途:当智能体首次进入一个陌生代码库时,它没有任何上下文,容易臆造约定、忽略项目模式。本技能通过爬取目标目录自动推断信息,生成结构化的 PROJECT.md,供智能体在该项目后续工作中加载。

主要能力:扫描项目根目录中的 package.json、pyproject.toml、Cargo.toml、go.mod、pom.xml 等以推断技术栈;扫描 Makefile、justfile、scripts/ 推断构建与测试命令;扫描 .github/workflows/ 获取 CI 命令与质量门禁;识别测试文件模式(tests/、spec/、*_test.go)推断测试约定;读取 CONTRIBUTING.md、DEVELOPMENT.md、docs/ 获取显式约定;识别 src/、lib/、app/、internal/ 等目录结构。随后推断关键不变量,例如 API 响应必须包含 requestId、禁止提交密钥、新路由必须有集成测试等,依据现有测试名、CI 检查与 lint 配置推断。

使用方式:在首次处理某代码库、智能体开始对项目结构产生错误假设、或新智能体加入现有项目时调用。流程为:爬取目录、推断不变量、生成 PROJECT.md(写入项目根目录或 ~/.openclaw/workspace/<project-slug>.md,含 Stack、Build & Test Commands、Project Structure、Key Conventions、Things the Agent Must Never Do Here、Known Gotchas 等章节)、向用户展示并确认、在状态中登记项目路径与 PROJECT.md 位置及入职日期。后续会话进入已登记项目时自动读取 PROJECT.md 并跳过前四步,可运行 python3 onboard.py --refresh monthly 检查漂移。配套脚本 python3 onboard.py --scan <path> 执行第一步并输出结构化 JSON 摘要。

限制:资料未提供具体支持的语言范围、推断准确率、依赖要求或收费信息。