codebase-onboarding

Analyzes unfamiliar codebases and generates onboarding guides with architecture maps and starter CLAUDE.md files.

1|Updated Oct 11, 2025
One-click install
npx skills add https://github.com/ibytechaos/claude --skill codebase-onboarding-ibytechaos
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: codebase-onboarding
Source: https://github.com/ibytechaos/claude/tree/main/plugins/everything-claude-code/skills/codebase-onboarding
Command: npx skills add https://github.com/ibytechaos/claude --skill codebase-onboarding-ibytechaos

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Joining a new project or opening an unfamiliar repository means hours of manually tracing entry points, conventions, and architecture before you can contribute productively. This Skill automates that discovery process and produces structured documentation. ## Core Features & Use Cases - Four-Phase Analysis: Runs reconnaissance (manifests, frameworks, entry points), architecture mapping, convention detection, and artifact generation. - Onboarding Guide Generation: Produces a scannable guide covering tech stack, directory map, request lifecycle, conventions, and common tasks. - CLAUDE.md Generation: Creates or enhances a project-specific CLAUDE.md based on detected conventions, preserving existing content. - Use Case: You clone a new client's Next.js repository and ask to be onboarded. The Skill detects the TypeScript/Prisma stack, maps the API routes and database schema, identifies test and lint commands, and outputs an onboarding guide plus a starter CLAUDE.md. ## Quick Start Ask the assistant to onboard you to this codebase and generate a CLAUDE.md for the project.

Frequently Asked Questions about codebase-onboarding

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate a CLAUDE.md for an existing project?

Ask the assistant to generate a CLAUDE.md for the project. The Skill runs reconnaissance on manifests, frameworks, and configs, detects conventions, then writes a project-specific CLAUDE.md with tech stack, test commands, and code style rules.

How to understand a new codebase quickly with Claude Code?

Request onboarding for the repository. The Skill runs a four-phase workflow: reconnaissance, architecture mapping, convention detection, and artifact generation, producing a scannable onboarding guide covering entry points, data flow, and common tasks.

What languages and frameworks does codebase analysis support?

It detects manifests for JavaScript, Go, Rust, Python, Java, Ruby, PHP, Elixir, and Dart, plus frameworks like Next.js, Nuxt, Angular, Django, Flask, FastAPI, and Rails. Detection is config-driven, so unlisted stacks may need manual review.

Does it overwrite an existing CLAUDE.md file?

No. If a CLAUDE.md already exists, the Skill reads it first and enhances it, preserving existing project-specific instructions and clearly marking what was added or changed rather than replacing the file.

What happens if the repository has no git history?

If the repo has no commits or only a shallow clone, the Skill skips git convention detection and notes that history is unavailable rather than guessing branch naming or commit message styles.