blake-john/agent-config/codebase-onboarding
Claude Code and agent skill by blake-john/agent-config
- community
Checking that the SKILL.md file is still in the repository.
快速分析不熟悉的代码库,生成结构化的入门指南和 AGENTS.md。使用 codegraph 进行代码分析,支持项目侦察、架构映射、约定检测。触发词:入门项目、理解代码库、生成 AGENTS.md、onboard me、walk me through。
Install
npx vskill@latest install blake-john/agent-config/codebase-onboardingSKILL.md
代码库入门
快速分析不熟悉的代码库,生成结构化的入门指南。
使用场景
- 第一次打开项目
- 加入新团队或仓库
- 生成 AGENTS.md
- 用户说"onboard me"或"walk me through this repo"
依赖
本 skill 依赖 codegraph skill 进行代码分析。请确保:
- 已安装 codegraph CLI
- 已初始化项目(
codegraph init) - 已加载 codegraph skill
工作流程
阶段 1: 项目侦察
使用 codegraph 快速获取项目信息:
阶段 2: 架构映射
使用 codegraph 分析架构:
阶段 3: 约定检测
使用 codegraph 检测代码约定:
阶段 4: 生成入门文档
基于侦察数据,生成:
- 入门指南 - 项目概述、技术栈、架构、关键目录
- AGENTS.md - 项目特定的指令
输出格式
入门指南
AGENTS.md
最佳实践
- 不要读取所有文件 - 侦察阶段使用 codegraph,不要读取每个文件
- 验证,不要猜测 - 如果从配置检测到框架但实际代码使用不同的东西,以代码为准
- 尊重现有的 AGENTS.md - 如果已存在,增强它而不是替换它
- 保持简洁 - 入门指南应该能在 2 分钟内浏览完
- 标记未知 - 如果无法确定某个约定,说出来而不是猜测
反模式
- 生成超过 100 行的 AGENTS.md - 保持聚焦
- 列出每个依赖 - 只突出影响代码编写方式的依赖
- 描述明显的目录名 -
src/不需要解释 - 复制 README - 入门指南添加 README 缺少的结构洞察
示例
示例 1: 第一次进入新仓库
用户: "Onboard me to this codebase" 操作: 运行完整的 4 阶段工作流 → 生成入门指南 + AGENTS.md 输出: 入门指南直接打印到对话中,AGENTS.md 写入项目根目录
示例 2: 为现有项目生成 AGENTS.md
用户: "Generate an AGENTS.md for this project" 操作: 运行阶段 1-3,跳过入门指南,只生成 AGENTS.md 输出: 项目特定的 AGENTS.md
示例 3: 增强现有的 AGENTS.md
用户: "Update the AGENTS.md with current project conventions" 操作: 读取现有的 AGENTS.md,运行阶段 1-3,合并新发现 输出: 更新后的 AGENTS.md,新增内容明确标记
Security
- Security scanPassed, 90 of 100Pattern checks on the skill's files.
- Model reviewPassed
Quality evaluation
- Task evaluationNot runNo evaluation yet. Run one in Skill Studio.
Source
- SKILL.md in the repositoryCheckingopencode/skills/codebase-onboarding/SKILL.md
Popularity
- 7-day trend score
- 0
Not refreshed yet.
Works with
Any agent vskill installs to: 56 targets in all. These 39 have a page on this site.
- Claude Code
- Cursor
- GitHub Copilot
- Windsurf
- Codex
- Gemini CLI
- Cline
- Amp
- Roo Code
- Goose
- Continue
- Kilo Code
- Junie
- Trae
- OpenHands
- Qwen Code
- AI Agent
- Tabnine Chat
- Sourcegraph Cody
- Amazon Q
- Firebase Genkit
- Sweep
- Devin
- Phind
- Mentat
- Claude Desktop
- Aider
- GPT Pilot
- Plandex
- bolt.new
- v0
- Replit Agent
- Anse
- TypingMind
- BetterChatGPT
- LibreChat
- Warp AI
- Pieces
- Fig AI
Embed badge
[](https://verified-skill.com/skills/blake-john/agent-config/codebase-onboarding)