Skip to main content
skill CX Codex

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

Install into Claude Code · Skills CLI (Vercel) All methods and platforms ↓
npx skills add borghei/Claude-Skills --skill codebase-onboarding -a claude-code
Open on GitHub

What 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/project and generate a Markdown onboarding guide for a junior developer
  • Run setup_validator.py on 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-code

2Manually: put the files in place

~/.claude/skills/codebase-onboarding/SKILL.md

Copy the whole skill folder; for one project use .claude/skills/codebase-onboarding/

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.

codebase-onboarding affaan-m The codebase-onboarding skill examines an unfamiliar repository and creates an onboarding guide plus a starter CLAUDE.md. Use it when joining a project or setting up Claude Code in an existing repo. CX Codex +1 7,300installs codebase-onboarding Alireza Rezvani codebase-onboarding is a Claude Code skill that examines a repository and helps assemble project onboarding material. It runs for new-engineer introductions and architecture briefs. CX Codex +1 698installs codebase-onboarding spencerpauly codebase-onboarding — a skill for Claude Code, Cursor, Codex, GitHub Copilot, and Gemini CLI that fires five subagents in parallel and writes their findings into a single ONBOARDING.md. CX Codex +1 527installs codebase-documenter mhattingpete codebase-documenter — a skill for Claude Code and Cursor that walks a repository and writes documentation covering architecture, key components, data flow, and development guidelines. CX Codex +1 595installs wiki-onboarding Microsoft wiki-onboarding is a Claude Code skill that builds four role-specific onboarding guides for a codebase. It activates when someone requests onboarding documentation for a project. CX Codex +1 5installs codebase-summarizer patricio0312rev codebase-summarizer scans your repository and writes ARCHITECTURE.md: entry points, module relationships, Mermaid diagrams and where-to-edit guides. CX Codex +1 411installs c4-codebase-architecture lmammino c4-codebase-architecture — a skill that walks an agent through a repository and writes C4 architecture docs: system context, containers, components. Handy for onboarding or picking up someone else's code. CX Codex +1 ★ 24repo stars Documentation Architect amo-tech-ai The Documentation Architect skill reads a codebase and builds technical docs for architecture, APIs, feature plans, and developer onboarding. CX Codex +1 1installs architecture owainlewis Writes or updates the root ARCHITECTURE.md file from a fixed template. It locks in system boundaries, data flow diagrams, and architectural rules. CX Codex +1 331installs

From the same set120

The whole set →
social-media-manager social-media-manager — a skill to build sustainable social presence: platform selection, content pillars, editorial calendars, and community workflows. For marketers and product leaders scaling SaaS social channels. CX Codex +1 118installs pr-review-expert pr-review-expert — a skill for Claude Code and Codex that analyzes pull request blast radius before merging. It checks downstream imports, security weaknesses, and breaking API schema changes. CX Codex +1 118installs sample-text-processor sample-text-processor — a basic reference skill for word counting, character metrics, and batch case changes in plain text files. Built as a structural template for skill testing. CX Codex +1 118installs infrastructure-compliance-auditor infrastructure-compliance-auditor audits cloud, network, and CI/CD security from infrastructure configuration, then maps findings to compliance frameworks. Use it for posture reviews and control checks. CX Codex +1 118installs stripe-integration-expert stripe-integration-expert is a Claude Code skill for building Stripe billing integrations for SaaS, covering subscriptions, webhooks, and local testing with Stripe CLI. CX Codex +1 116installs summarize-meeting summarize-meeting — a skill for Claude Code and Codex that turns meeting transcripts into action items and logged decisions. Flags missing assignees or dates instead of inventing them. CX Codex +1 114installs executive-mentor executive-mentor challenges strategic plans, exposes blind spots, and prepares founders for tough board inquiries. CX Codex +1 113installs copy-editing copy-editing — a skill for Claude Code, Codex, Cursor and other agents that runs text through seven sequential editorial passes: clarity, voice, benefit framing, proof, specificity, emotional pull, and CTA friction removal. CX Codex +1 113installs

Project sponsors

Companies that keep this analytics open