skills.rest
mirzadham
mirzadhamCOMMUNITY
Explore all skills by this author →
GitHub

codebase-onboarding

Analyze an unfamiliar codebase and generate an onboarding guide and starter CLAUDE.md.

Updated May 7, 2026
Search Tags:#documentation#onboarding#repository#codebase analysis#claude.md#convention detection#architecture mapping
One-click install
npx skills add https://github.com/mirzadham/trainingroombookingsystem2 --skill codebase-onboarding-mirzadham
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: codebase-onboarding
Source: https://github.com/mirzadham/trainingroombookingsystem2/tree/main/.pi/skills/codebase-onboarding
Command: npx skills add https://github.com/mirzadham/trainingroombookingsystem2 --skill codebase-onboarding-mirzadham

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Joining a new project or opening an unfamiliar repository often means hours of reading files to understand the stack, architecture, and conventions. This Skill automates that discovery process and produces a structured onboarding guide plus a project-specific CLAUDE.md. ## Core Features & Use Cases - Four-Phase Analysis: Runs reconnaissance (manifests, frameworks, entry points, configs), architecture mapping, convention detection, and artifact generation. - Onboarding Guide Generation: Produces a scannable guide covering tech stack, directory map, request lifecycle, conventions, and common commands. - CLAUDE.md Authoring: Creates or enhances a project-specific CLAUDE.md while preserving existing instructions and flagging what changed. - Use Case: A developer clones a Laravel + React booking system and asks to be onboarded; the Skill detects the stack, maps key directories, traces a request lifecycle, and writes a tailored 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 and convention detection, then writes a project-specific CLAUDE.md covering tech stack, code style, testing, build commands, and directory structure.

How do I onboard to a new codebase quickly?▼

Request onboarding for the repository and the Skill runs a four-phase workflow: reconnaissance, architecture mapping, convention detection, and artifact generation. You receive a scannable onboarding guide plus a starter CLAUDE.md.

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.

What project types and languages does codebase analysis support?▼

It detects manifests and configs across many ecosystems, including package.json, go.mod, Cargo.toml, pyproject.toml, pom.xml, Gemfile, composer.json, and framework configs for Next.js, Django, Rails, and others.

What happens when git history is unavailable or too shallow?▼

The Skill skips git convention detection and notes that history is unavailable or too shallow, rather than guessing branch naming or commit message styles.

Related Skills

Explore More Software Engineering Skills→
LAF-USLAF-US

build-mcpb

Package a local MCP server with its runtime into a .mcpb bundle.

Official
Advanced
wildwasserwildwasser
35

test-driven-development

Enforce test-first development with failing tests before minimal code.

Community
Intermediate
jeremyaryjeremyary
7

status

Run linting, type checks, tests, and dependency audits with pass/fail reporting.

Community
Intermediate
TheRealFloatDevTheRealFloatDev

abf

Analyze codebases with AgentsBestFriend MCP commands for structured project overviews.

Community
Advanced