Acquire Codebase Knowledge
Use when the user asks to map, document, or onboard into an existing codebase and needs evidence-backed architecture, structure, conventions, integrations, testing, and concerns documentation.
Install
npx skills add sandbaseai/workbuddy-skill --skill acquire-codebase-knowledgegit clone --depth 1 https://github.com/sandbaseai/workbuddy-skill.git /tmp/workbuddy-skill
mkdir -p ~/.claude/skills
cp -r /tmp/workbuddy-skill/skills/acquire-codebase-knowledge ~/.claude/skills/acquire-codebase-knowledgePersonal skills live in ~/.claude/skills. Use .claude/skills in a project folder to share a skill with your team.
From the SKILL.md
# Acquire Codebase Knowledge 将陌生代码库转换为可上手、可评审、可排障的证据地图。默认只读检查源码、配置、Git 历史和测试入口,输出结构、技术栈、架构、约定、集成、测试和风险;不把 README 中的意图当成当前事实。 ## 输出契约 默认输出 `docs/codebase/` 下七份文档:`STACK.md`、`STRUCTURE.md`、`ARCHITECTURE.md`、`CONVENTIONS.md`、`INTEGRATIONS.md`、`TESTING.md`、`CONCERNS.md`。每份文档必须包含: - 结论与适用范围; - 可复核的证据清单(具体文件、配置键、命令输出或提交); - 未能确认的事项标记 `[TODO]`; - 需要团队意图才能决定的事项标记 `[ASK USER]`; - 事实、推导和假设的明确区分。 如果用户只要求某个领域,仍建立其他文档的最小骨架并标记未知项,不伪造完整分析。 ## 安全与授权边界 - 扫描前确认仓库路径、提交/分支、允许读取的目录和输出位置;不默认读取父目录、私有密钥目录或外部挂载。 - 不执行项目安装脚本、应用启动脚本、迁移、部署、网络请求或任意源码;如确需命令,先列出命令及副作用并使用最小授权。 - 排除 `.git` 内部对象、`dist`、`build`、`generated`、`.next`、`out`、缓存和虚拟环境,除非用户明确要求审计生成物。 - 不将 `.env`、凭据、客户数据、授权头或完整日志写入文档;只记录变量名、脱敏摘要和证据路径。 - 文档写入、提交、发布和外部分享是独立动作;交付分析不等于自动发布。 ## 阶段一:扫描和读取意图 先记录仓库提交、目录清单、语言文件、包管理清单、CI/CD、容器/编排、测试配置和安全策略。再读取 README、PRD、设计、路线图、规范和贡献指南,并将其中的“应该如此”与源码中的“实际如此”分开。 建立发现表:`area`、`source`、`observed`、`confidence`、`unknowns`。不因目录命名或变量名推断框架、数据库、部署平台或业务意图。 ## 阶段二:分域调查 按以下问题调查并保留证据: - STACK:生产依赖与开发工具分别是什么?运行时和入口在哪里? - STRUCTURE:源码、测试、脚本、配置和生成物边界如何?有哪些入口? - ARCHITECTURE:调用流、层次、模块边界、状态/数据所有权能由哪些文件证明? - CONVENTIONS:命名、导入、错误处理、日志、格式化和分支约定实际是什么? - INTEGRATIONS:外部 API、数据库、身份、队列、监控和配置入口在哪里?失败边界是什么? - TESTING:测试框架、组织方式、fixture/mock、覆盖缺口和可安全运行的命令是什么? - CONCERNS:高变更文件、陈旧文档、TODO、依赖/安全/性能风险分别有什么证据? 使用 Git 历史只作为变更频率和演进线索,不能把提交信息当成当前行为证明。大型仓库按模块分批调查,记录未覆盖范围。 ## 阶段三:生成和校验 文档中的每个非平凡结论至少链接一个具体证据。若证据冲突,保留冲突并写出“意图 vs 现实”差异;若没有证据,使用 `[TODO]` 而不是补全常识。校验:七个文件齐全、必需章节非空、路径存在、命令不会隐式产生副作用、敏感值已脱敏。 ## 交付格式
Details
- Skill name
acquire-codebase-knowledge- Repository
- sandbaseai/workbuddy-skill
- Path
skills/acquire-codebase-knowledge/SKILL.md- License
- MIT
- Repo updated
- 8 September 2026
FAQ
What does the Acquire Codebase Knowledge skill do?
Use when the user asks to map, document, or onboard into an existing codebase and needs evidence-backed architecture, structure, conventions, integrations, testing, and concerns documentation.
How do I install the Acquire Codebase Knowledge skill?
skills CLI (Claude Code, Cursor, Codex and more): npx skills add sandbaseai/workbuddy-skill --skill acquire-codebase-knowledge. Skills go in ~/.claude/skills (personal) or .claude/skills (project), and Claude loads them automatically when a task matches the description.
Is Acquire Codebase Knowledge popular?
It lives in sandbaseai/workbuddy-skill, which has 9 GitHub stars and 3 forks.
Related skills
Access Control Security Best Practices
9sandbaseai/workbuddy-skill
Design, review, implement, and verify least-privilege access controls across users, services, tenants, resources, and administrative workflows.
Accessibility Review
9sandbaseai/workbuddy-skill
Use when reviewing a web interface or interaction for semantic, keyboard, focus, screen-reader, ARIA, and contrast accessibility risks.
Ad Campaign Analyzer
9sandbaseai/workbuddy-skill
Use this skill when the user shares ad campaign performance data and asks what to cut, scale, or test. Trigger for prompts like "analyze my ad campaigns", "where am I wasting ad spend", "reallocate my ad budget", "which ads are actually working", or "ROAS analysis". Do not trigger for campaign planning or creative generation without performance data.
API Design Principles
9sandbaseai/workbuddy-skill
Use when designing, reviewing, documenting, versioning, or migrating REST or GraphQL APIs and their client, security, performance, and compatibility contracts.
Spec Review Local
5adelrioj/claude-skills
Use when a brainstorming design spec has been written and needs adversarial review before implementation planning, using a local model served by LMStudio (via the pi CLI) as the independent reviewer. Works offline — no hosted API needed. Triggers on: spec review local, local spec review, review spec locally, lmstudio review, review spec, spec review.
API Documentation
9sandbaseai/workbuddy-skill
Use when creating, editing, restructuring, or reviewing a service API document; keep operations, requests, responses, errors, types, routes, examples, and conventions precise and aligned with the authoritative contract.
Browse the most popular Claude skills, all software development skills, or write your own with the skills generator.