Codebase Knowledge Graph Q&A
Egonex-AI/Understand-Anything
Answers questions about a codebase by searching a prebuilt knowledge graph of its files, functions, classes and dependencies, not by rereading every source file.
Analyze a codebase and generate onboarding documentation for engineers, tech leads, and contractors.
Install Codebase Onboarding
$ npx skills add alirezarezvani/claude-skills --skill codebase-onboarding -a claude-codeProject install by default; add -g for ~/.claude/skills/.
$ gh skill install alirezarezvani/claude-skills codebase-onboarding --agent claude-codeProject scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).
$ git clone --depth 1 https://github.com/alirezarezvani/claude-skills.git skills-src && mkdir -p .claude/skills && cp -r skills-src/engineering/skills/codebase-onboarding .claude/skills/codebase-onboarding && rm -rf skills-srcUse ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.
Claude Code skills documentation · loads skills from .claude/skills/
Install the "codebase-onboarding" agent skill from https://github.com/alirezarezvani/claude-skills/tree/main/engineering/skills/codebase-onboarding into .claude/skills/codebase-onboarding/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "codebase-onboarding", then confirm the skill loads.Claude Code copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$skill-installer install https://github.com/alirezarezvani/claude-skills/tree/main/engineering/skills/codebase-onboardingType this inside Codex. $skill-installer <name> installs a curated skill from openai/skills. The installer writes to $CODEX_HOME/skills (default ~/.codex/skills). Restart Codex if the skill does not show up.
$ npx skills add alirezarezvani/claude-skills --skill codebase-onboarding -a codexProject install goes to .agents/skills/; add -g for ~/.codex/skills/.
$ gh skill install alirezarezvani/claude-skills codebase-onboarding --agent codexProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/alirezarezvani/claude-skills.git skills-src && mkdir -p .agents/skills && cp -r skills-src/engineering/skills/codebase-onboarding .agents/skills/codebase-onboarding && rm -rf skills-srcUse ~/.agents/skills/ instead of .agents/skills for a personal install.
Codex skills documentation · loads skills from .agents/skills/
Install the "codebase-onboarding" agent skill from https://github.com/alirezarezvani/claude-skills/tree/main/engineering/skills/codebase-onboarding into .agents/skills/codebase-onboarding/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "codebase-onboarding", then confirm the skill loads.Codex copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ npx skills add alirezarezvani/claude-skills --skill codebase-onboarding -a cursorProject install goes to .agents/skills/; add -g for ~/.cursor/skills/.
$ gh skill install alirezarezvani/claude-skills codebase-onboarding --agent cursorProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/alirezarezvani/claude-skills.git skills-src && mkdir -p .cursor/skills && cp -r skills-src/engineering/skills/codebase-onboarding .cursor/skills/codebase-onboarding && rm -rf skills-srcUse ~/.cursor/skills/ instead of .cursor/skills for a personal install.
Cursor skills documentation · loads skills from .cursor/skills/, .agents/skills/, .claude/skills/, .codex/skills/
Install the "codebase-onboarding" agent skill from https://github.com/alirezarezvani/claude-skills/tree/main/engineering/skills/codebase-onboarding into .cursor/skills/codebase-onboarding/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "codebase-onboarding", then confirm the skill loads.Cursor copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ gemini skills install https://github.com/alirezarezvani/claude-skills.git --path engineering/skills/codebase-onboarding--scope user (default) or --scope workspace; --path is the subfolder of the repo that holds the skill; --consent skips the security confirmation prompt.
$ npx skills add alirezarezvani/claude-skills --skill codebase-onboarding -a gemini-cliProject install goes to .agents/skills/; add -g for ~/.gemini/skills/.
$ gh skill install alirezarezvani/claude-skills codebase-onboarding --agent gemini-cliProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/alirezarezvani/claude-skills.git skills-src && mkdir -p .gemini/skills && cp -r skills-src/engineering/skills/codebase-onboarding .gemini/skills/codebase-onboarding && rm -rf skills-srcUse ~/.gemini/skills/ instead of .gemini/skills for a personal install, then run /skills reload.
Gemini CLI skills documentation · loads skills from .gemini/skills/, .agents/skills/
Install the "codebase-onboarding" agent skill from https://github.com/alirezarezvani/claude-skills/tree/main/engineering/skills/codebase-onboarding into .gemini/skills/codebase-onboarding/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "codebase-onboarding", then confirm the skill loads.Gemini CLI copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ gh skill install alirezarezvani/claude-skills codebase-onboardingInstalls for Copilot at project scope by default; add --scope user for a personal install. Preview a skill first with gh skill preview. Needs GitHub CLI 2.90.0 or later (public preview).
$ npx skills add alirezarezvani/claude-skills --skill codebase-onboarding -a github-copilotProject install goes to .agents/skills/; add -g for ~/.copilot/skills/.
$ git clone --depth 1 https://github.com/alirezarezvani/claude-skills.git skills-src && mkdir -p .github/skills && cp -r skills-src/engineering/skills/codebase-onboarding .github/skills/codebase-onboarding && rm -rf skills-srcUse ~/.copilot/skills/ instead of .github/skills for a personal install. Commit .github/skills so cloud agent and code review can use it.
GitHub Copilot skills documentation · loads skills from .github/skills/, .claude/skills/, .agents/skills/
Install the "codebase-onboarding" agent skill from https://github.com/alirezarezvani/claude-skills/tree/main/engineering/skills/codebase-onboarding into .github/skills/codebase-onboarding/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "codebase-onboarding", then confirm the skill loads.GitHub Copilot copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ npx skills add alirezarezvani/claude-skills --skill codebase-onboarding -a opencodeOpenCode documents no install command of its own. Project install goes to .agents/skills/; add -g for ~/.config/opencode/skills/.
$ gh skill install alirezarezvani/claude-skills codebase-onboarding --agent opencodeProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/alirezarezvani/claude-skills.git skills-src && mkdir -p .opencode/skills && cp -r skills-src/engineering/skills/codebase-onboarding .opencode/skills/codebase-onboarding && rm -rf skills-srcUse ~/.config/opencode/skills/ instead of .opencode/skills for a personal install.
OpenCode skills documentation · loads skills from .opencode/skills/, .claude/skills/, .agents/skills/
Install the "codebase-onboarding" agent skill from https://github.com/alirezarezvani/claude-skills/tree/main/engineering/skills/codebase-onboarding into .opencode/skills/codebase-onboarding/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "codebase-onboarding", then confirm the skill loads.OpenCode copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
Facts
- Skill name
codebase-onboarding- GitHub stars
- 28k
- Token cost
- ~652 tokens
- SKILL.md length
- 223 words
- Files
- 4 (incl. scripts, references)
- Skills in repo
- 342
- Repo updated
- First seen
- Licence
- MIT
At a glance
Analyze a codebase and generate onboarding documentation for engineers, tech leads, and contractors.
- Works in 4 steps: Run scripts/codebase_analyzer.py against… → Capture key signals: file counts,… → Fill the onboarding template in… → …
- Onboarding a new engineer
- SKILL.md covers Overview, Core Capabilities, When to Use and Quick Start, plus 4 more sections
- Runs Python scripts from its folder; calls python3
What it does
Codebase Onboarding is an agent skill from alirezarezvani/claude-skills. Analyze a codebase and generate onboarding documentation for engineers, tech leads, and contractors. Fast fact-gathering and repeatable onboarding outputs. Use when onboarding a new engineer, writing architecture-overview docs for a new project, or producing tech-lead briefings for unfamiliar repos.
Its SKILL.md is about 650 tokens, which your agent loads only when the skill is triggered. The skill folder holds 5 other files, including scripts and reference files (for example `references/onboarding-template.md`, `references/output-format-templates.md` and `scripts/codebase_analyzer.py`).
It sits in Development, covering Codebase onboarding. The repository describes itself as: 380 Claude Code skills & agent skills & plugins (30+ Agents, 70+ custom commands, 380+ skills, customizable references, scripts)for Claude Code, Codex, Gemini CLI, Cursor, and 8… The licence is MIT.
When your agent uses it
- Onboarding a new engineer
- Writing architecture-overview docs for a new project
- Producing tech-lead briefings for unfamiliar repos
Example prompts
- “/codebase-onboarding”
Requirements
- Python 3
Workflow steps
4 steps, taken from the first numbered list in SKILL.md.
- Run scripts/codebase_analyzer.py against the target repository.
- Capture key signals: file counts, detected languages, config files, top-level structure.
- Fill the onboarding template in references/onboarding-template.md.
- Tailor output depth by audience
What it can do on your machine
Read from SKILL.md and the folder at commit 19392f7. It shows what the files ask for, not the result of running them.
Tool permissions
Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.
From allowed-tools in the SKILL.md frontmatter.
Runs code
Ships 1 file in scripts/ (Python), which the agent can run.
Shell commands in SKILL.md call:
python3
From the folder's file list and the shell code blocks in SKILL.md.
Network
No URLs in SKILL.md.
From URLs in SKILL.md, links to its own repository left out.
Credentials
Names no API keys, tokens, secrets or passwords.
From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.
Context cost
Codebase Onboarding loads about 652 tokens when it runs, and up to ~1.8k if it reads all its reference files. Until then it costs about 80 tokens; SKILL.md has 223 words of instructions outside code blocks.
Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.
Safety
Auto-check passed
The automated check found no risky patterns in SKILL.md.
Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); the scripts in this folder are not scanned.
SKILL.md
The full file from alirezarezvani/claude-skills at commit 19392f7, republished under its MIT licence (© alirezarezvani). 223 words, ~652 tokens.
Download SKILL.mdSave it as
.claude/skills/codebase-onboarding/SKILL.md (or your agent's skills folder). This skill also uses 3 other files; get the full folder from GitHub.- name
- codebase-onboarding
- description
- Analyze a codebase and generate onboarding documentation for engineers, tech leads, and contractors. Fast fact-gathering and repeatable onboarding outputs. Use when onboarding a new engineer, writing architecture-overview docs for a new project, or producing tech-lead briefings for unfamiliar repos.
Codebase Onboarding
Tier: POWERFUL
Category: Engineering
Domain: Documentation / Developer Experience
Overview
Analyze a codebase and generate onboarding documentation for engineers, tech leads, and contractors. This skill is optimized for fast fact-gathering and repeatable onboarding outputs.
Core Capabilities
- Architecture and stack discovery from repository signals
- Key file and config inventory for new contributors
- Local setup and common-task guidance generation
- Audience-aware documentation framing
- Debugging and contribution checklist scaffolding
When to Use
- Onboarding a new team member or contractor
- Rebuilding stale project docs after large refactors
- Preparing internal handoff documentation
- Creating a standardized onboarding packet for services
Quick Start
# 1) Gather codebase facts
python3 scripts/codebase_analyzer.py /path/to/repo
# 2) Export machine-readable output
python3 scripts/codebase_analyzer.py /path/to/repo --json
# 3) Use the template to draft onboarding docs
# See references/onboarding-template.mdRecommended Workflow
- Run
scripts/codebase_analyzer.pyagainst the target repository. - Capture key signals: file counts, detected languages, config files, top-level structure.
- Fill the onboarding template in
references/onboarding-template.md. - Tailor output depth by audience:
- Junior: setup + guardrails
- Senior: architecture + operational concerns
- Contractor: scoped ownership + integration boundaries
Onboarding Document Template
Detailed template and section examples live in:
references/onboarding-template.mdreferences/output-format-templates.md
Common Pitfalls
- Writing docs without validating setup commands on a clean environment
- Mixing architecture deep-dives into contractor-oriented docs
- Omitting troubleshooting and verification steps
- Letting onboarding docs drift from current repo state
Best Practices
- Keep setup instructions executable and time-bounded.
- Document the "why" for key architectural decisions.
- Update docs in the same PR as behavior changes.
- Treat onboarding docs as living operational assets, not one-time deliverables.
© alirezarezvani, MIT. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file
Files
SKILL.md and 3 other files (scripts, references) in engineering/skills/codebase-onboarding of alirezarezvani/claude-skills.
- SKILL.md
- references/onboarding-template.md
- references/output-format-templates.md
- scripts/codebase_analyzer.py
Open the folder on GitHubat commit 19392f7
Compare with similar skills
Codebase Onboarding next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.
| Skill | Stars | Used in | Tokens | Auto-check | Licence | Repo updated |
|---|---|---|---|---|---|---|
| Codebase Onboarding this skillalirezarezvani/claude-skills | 28k | — | ~652 | Automated safety check: Pass | MIT | |
| Codebase Knowledge Graph Q&AEgonex-AI/Understand-Anything | 85k | 1 repos | ~1.2k | Automated safety check: Pass | MIT | |
| Understand ExplainEgonex-AI/Understand-Anything | 85k | 1 repos | ~1.3k | Automated safety check: Pass | MIT | |
| Repomix Codebase Exploreryamadashy/repomix | 29k | 1 repos | ~2.7k | Automated safety check: Pass | MIT | |
| Project Onboarding Guide from Knowledge GraphEgonex-AI/Understand-Anything | 85k | — | ~1.2k | Automated safety check: Pass | MIT | |
| Deepwiki Rssopaco/deepwiki-rs | 3.1k | — | ~748 | Automated safety check: Pass | MIT |
Similar skills
Understand Explain
Egonex-AI/Understand-Anything
Gives an in-depth explanation of one file, function or module by reading the project's knowledge graph and checking that the graph is still fresh.
Repomix Codebase Explorer
yamadashy/repomix
Packs a local or remote repository into a single AI-friendly file with the Repomix CLI, then reads and searches that output to explain structure, find patterns or report metrics.
Project Onboarding Guide from Knowledge Graph
Egonex-AI/Understand-Anything
Writes an onboarding guide for new team members from a project's existing knowledge graph, after checking that the graph still matches the current commit.
Deepwiki Rs
sopaco/deepwiki-rs
AI-powered Rust documentation generation engine for comprehensive codebase analysis, C4 architecture diagrams, and automated technical documentation.
GitDiagram Repository Overview
ahmedkhaleel2004/gitdiagram
Explains the architecture of a public GitHub repository through GitDiagram: how the code is organized, the main components with paths, and a Mermaid diagram.
More from alirezarezvani/claude-skills
All 342 skills in this repoAgile Product Owner
alirezarezvani/claude-skills
Writes INVEST-checked user stories with acceptance criteria, splits epics, plans sprints from velocity and ranks the backlog with a weighted score.
Product Strategist
alirezarezvani/claude-skills
OKR cascade toolkit for product leaders: generates aligned company-to-team OKRs from five strategy types and scores how well they line up.
App Store Optimization
alirezarezvani/claude-skills
App Store Optimization (ASO) toolkit for researching keywords, analyzing competitor rankings, generating metadata suggestions, and improving app visibility on Apple App Store and Google Play Store.
AWS Solution Architect
alirezarezvani/claude-skills
Design AWS architectures for startups using serverless patterns and IaC templates.
Campaign Analytics
alirezarezvani/claude-skills
Calculates attribution, funnel and ROI figures for marketing campaigns with three Python scripts that need only the standard library.
Code to PRD
alirezarezvani/claude-skills
Reverse-engineers a frontend, backend or fullstack codebase into a product requirements document with per-page docs, an enum dictionary and an API inventory.
Related
Categories
Questions about Codebase Onboarding
What does Codebase Onboarding do?
Analyze a codebase and generate onboarding documentation for engineers, tech leads, and contractors. Codebase Onboarding is an agent skill from alirezarezvani/claude-skills. Analyze a codebase and generate onboarding documentation for engineers, tech leads, and contractors.
When should I use Codebase Onboarding?
Codebase Onboarding fits situations like: onboarding a new engineer; writing architecture-overview docs for a new project; producing tech-lead briefings for unfamiliar repos.
How do I install Codebase Onboarding in Claude Code?
Run `npx skills add alirezarezvani/claude-skills --skill codebase-onboarding -a claude-code`. Or copy the skill folder (engineering/skills/codebase-onboarding in alirezarezvani/claude-skills) into .claude/skills/codebase-onboarding in your project. Claude Code loads it when a task matches its description.
How do I install Codebase Onboarding in Codex?
Run `npx skills add alirezarezvani/claude-skills --skill codebase-onboarding -a codex`. Or copy the skill folder (engineering/skills/codebase-onboarding in alirezarezvani/claude-skills) into .agents/skills/codebase-onboarding in your project. Codex loads it when a task matches its description.
Can I use Codebase Onboarding in Cursor, Gemini CLI or GitHub Copilot?
Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add alirezarezvani/claude-skills --skill codebase-onboarding -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/codebase-onboarding, .gemini/skills/codebase-onboarding, .github/skills/codebase-onboarding and .opencode/skills/codebase-onboarding in your project.
What does Codebase Onboarding need to run?
Going by SKILL.md and its folder, Codebase Onboarding needs Python for the scripts in its folder and the command-line tools its instructions call (python3). Our summary lists: Python 3.
Does Codebase Onboarding access the network?
SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. This is read from the text; nothing was executed.
Is Codebase Onboarding safe to install?
Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. The check reads SKILL.md only: the scripts in the folder are not scanned, so read them before running anything.
What licence does Codebase Onboarding use?
Codebase Onboarding is published under the MIT licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.
How many tokens does Codebase Onboarding use?
About 652 tokens (SKILL.md is roughly 2.6k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full. Its references folder adds about 1.1k tokens, read only when the agent opens those files.
What are the alternatives to Codebase Onboarding?
Skills that share tags, products or a category with Codebase Onboarding: Codebase Knowledge Graph Q&A (Egonex-AI/Understand-Anything, 85k stars), Understand Explain (Egonex-AI/Understand-Anything, 85k stars), Repomix Codebase Explorer (yamadashy/repomix, 29k stars) and Project Onboarding Guide from Knowledge Graph (Egonex-AI/Understand-Anything, 85k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.
Who maintains Codebase Onboarding?
alirezarezvani (a GitHub user) maintains it in alirezarezvani/claude-skills, which has 27,788 GitHub stars. The repository holds 342 skills in this directory. The repository was last updated on August 30, 2026.
Source: alirezarezvani/claude-skills on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.