acquire-codebase-knowledge
Use this skill when the user explicitly asks to map, document, or onboard into an existing codebase. Trigger for prompts like "map this codebase", "document this architecture", "onboard me to this repo", or "create codebase docs". Do not trigger for routine feature implementation, bug fixes, or narrow code edits unless the user asks for repository-level discovery.
Best for New team members onboarding…Works with GitHubLow risk
⌘source
- author
@github- language
- Python
★30kstars
3.6kforks
Apr 18, 2026
✦overview.md
Key Features
- ·Generates seven comprehensive codebase documentation files
- ·Supports 25+ programming languages for manifest detection
- ·Detects CI/CD pipelines across 10+ platforms
- ·Identifies container and orchestration configurations
- ·Extracts code metrics by programming language
- ·Finds security and compliance configurations
Use Cases
- →Onboarding new developers to an unfamiliar codebase
- →Creating comprehensive documentation for legacy systems
- →Auditing codebase architecture before major refactoring
- →Preparing technical documentation for handoffs or reviews
- →Mapping dependencies and integrations across complex projects
Best for
- ✓New team members onboarding to existing projects
- ✓Technical leads documenting system architecture
- ✓Teams inheriting legacy or undocumented codebases
Not ideal for
- !Routine feature implementation or bug fixes
- !Narrow code edits without repository-level discovery needs
- !Projects without Python 3.8+ and git available
FAQs
name
acquire-codebase-knowledge
description
Use this skill when the user explicitly asks to map, document, or onboard into an existing codebase. Trigger for prompts like "map this codebase", "document this architecture", "onboard me to this repo", or "create codebase docs". Do not trigger for routine feature implementation, bug fixes, or narrow code edits unless the user asks for repository-level discovery.
license
MIT
compatibility:Cross-platform. Requires Python 3.8+ and git. Run scripts/scan.py from the target project root.
metadata:{"version":"1.3","enhancements":["Multi-language manifest detection (25+ languages supported)","CI/CD pipeline detection (10+ platforms)","Container & orchestration detection","Code metrics by language","Security & compliance config detection","Performance testing markers"]}
argument-hint:Optional: specific area to focus on, e.g. "architecture only", "testing and concerns"
Acquire Codebase Knowledge
Produces seven populated documents in docs/codebase/ covering everything needed to work effectively on the project. Only document what is verifiable from files or terminal output — never infer or assume.
Output Contract (Required)
Before finishing, all of the following must be true:
- Exactly these files exist in
docs/codebase/:STACK.md,STRUCTURE.md,ARCHITECTURE.md,CONVENTIONS.md,INTEGRATIONS.md,TESTING.md,CONCERNS.md. - Every claim is traceable to source files, config, or terminal output.
- Unknowns are marked as
[TODO]; intent-dependent decisions are marked[ASK USER]. - Every document includes a short "evidence" list with concrete file paths.
- Final response includes numbered
[ASK USER]questions and intent-vs-reality divergences.
Workflow
Copy and track this checklist:
- [ ] Phase 1: Run scan, read intent documents
- [ ] Phase 2: Investigate each documentation area
- [ ] Phase 3: Populate all seven docs in docs/codebase/
- [ ] Phase 4: Validate docs, present findings, resolve all [ASK USER] items
Focus Area Mode
$install
1-click copynpx skills add github/awesome-copilot --skill acquire-codebase-knowledgeSafety assessment
★
Clarity score
How clear and easy to understand the SKILL.md instructions are, rated from 1 to 5.
5/ 5
excellentVery clear and well structured, with almost no room for misunderstanding.
◎
Actionability score
How directly an agent can act on the SKILL.md instructions, rated from 1 to 5.
5/ 5
very highHighly actionable with clear, concrete steps that an agent can follow directly.