codebase-onboarding · borghei — Claude Code skill: what it does, how to install
codebase-onboarding — a skill for Claude Code, Codex, Cursor and several other agents that scans a repository and produces onboarding docs: architecture overview, key file map, local setup guide, and debugging reference.
LicenseRef-MIT-Commons-Clause 117 installs ★ 1,183 updated 2026-11-08
npx skills add borghei/Claude-Skills --skill codebase-onboarding -a claude-codeWhat codebase-onboarding does
The skill ships three Python scripts. onboarding_generator.py reads manifests and lockfiles, pulls the stack, entry points, env-var keys, and top-level structure, then writes a draft with > **TODO (owner):** markers wherever the agent cannot answer from the files alone. architecture_mapper.py detects the project pattern — monorepo, microservices, MVC, or layered — and assigns roles to directories. setup_validator.py checks for a README, .env template, lockfile, CI config, linter config, tests, and a license, scores the repo from 0 to 100, and lists what to fix.
Output formats are Markdown, Notion, and Confluence. Depth adjusts by audience: junior developer, senior engineer, or contractor each get a different set of sections. The draft from onboarding_generator.py is a starting point, not a finished document — the skill marks every gap explicitly so nothing silently gets skipped.
A low score from setup_validator.py means the setup guide will have holes, because those gaps are real problems in the repo. Scripts live in scripts/, documentation templates in references/documentation-templates.md. For a stop-by-stop code tour rather than reference docs, the skill points to engineering/code-tour.
What it helps with
- generate a draft onboarding guide after a major refactor
- score a repository's setup completeness before open-sourcing it
- build a key file map that shows entry points and files dangerous to touch alone
- produce a debugging reference with real error messages and fixes
- document a service before a team transition or long leave
Example prompts for the agent
- Analyze the codebase at
/path/to/projectand generate a Markdown onboarding guide for a junior developer - Run
setup_validator.pyon this project and list the gaps that would make the setup guide misleading - Map the key files — entry points, config hubs, shared utilities — and explain why each one matters
How to install codebase-onboarding
1Skills CLI (Vercel)
npx skills add borghei/Claude-Skills --skill codebase-onboarding -a claude-code2Manually: put the files in place
~/.claude/skills/codebase-onboarding/SKILL.mdCopy the whole skill folder; for one project use .claude/skills/codebase-onboarding/
1Skills CLI (Vercel)
npx skills add borghei/Claude-Skills --skill codebase-onboarding -a codex2Manually: put the files in place
.agents/skills/codebase-onboarding/SKILL.mdFor all projects use ~/.agents/skills/
1Skills CLI (Vercel)
npx skills add borghei/Claude-Skills --skill codebase-onboarding -a cursor2Manually: put the files in place
.cursor/skills/codebase-onboarding/SKILL.mdCursor also reads .agents/skills/ and .claude/skills/
1GitHub CLI
gh skill install borghei/Claude-Skills engineering/codebase-onboarding/SKILL.md2Manually: put the files in place
.github/skills/codebase-onboarding/SKILL.md1Skills CLI (Vercel)
npx skills add borghei/Claude-Skills --skill codebase-onboarding -a gemini-cli2Platform CLI
gemini skills install https://github.com/borghei/Claude-Skills --path engineering/codebase-onboardingManually: put the files in place
.devin/skills/codebase-onboarding/SKILL.mdThe legacy .windsurf/skills/ path still works
Skills CLI (Vercel)
npx skills add borghei/Claude-Skills --skill codebase-onboarding -a opencodeClaude.ai
Zip the folder and upload it in Settings → Capabilities → Skills
Step by step, with commands for each platform: How to install skills in Claude Code: five ways
Questions about codebase-onboarding
How do I install codebase-onboarding in Claude Code?
Run npx skills add borghei/Claude-Skills --skill codebase-onboarding -a claude-code. The skill will be available at ~/.claude/skills/codebase-onboarding/SKILL.md.
What does the codebase-onboarding skill actually do?
It runs three Python scripts that gather facts about a project — stack, architecture patterns, entry points, env variables — and assembles them into a draft onboarding document. Sections the scripts cannot fill are left as explicit TODO markers for the author to complete by hand.
Does it work if the repository has no manifest file?
Yes. When no manifest is found, onboarding_generator.py falls back to counting source files by extension to infer the stack. The result will be less precise, and more TODO markers will appear in the draft.
Similar skills
All skills for Writing and docs →codebase-onboarding by other authors comes first.