codebase-onboarding

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

Updated Mar 18, 2026
One-click install
npx skills add https://github.com/freedom909/real-estate-saas --skill codebase-onboarding-freedom909
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: codebase-onboarding
Source: https://github.com/freedom909/real-estate-saas/tree/main/.trae/skills/codebase-onboarding
Command: npx skills add https://github.com/freedom909/real-estate-saas --skill codebase-onboarding-freedom909

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Joining a new project or opening an unfamiliar repository often means hours of manual exploration to understand the tech stack, architecture, conventions, and entry points. This Skill automates that reconnaissance 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 tasks. - CLAUDE.md Authoring: Creates or enhances a project-specific CLAUDE.md while preserving existing instructions and flagging what changed. - Use Case: A developer joins a team maintaining a GraphQL Federation monorepo and asks to be onboarded; the Skill detects the stack, traces a request from router to database, and outputs both the guide and 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 onboard to a new codebase quickly?▼

Run a structured four-phase analysis: reconnaissance of manifests and configs, architecture mapping, convention detection, and artifact generation. This produces an onboarding guide with the tech stack, directory map, request lifecycle, and common tasks.

How to generate a CLAUDE.md for an existing project?▼

Detect the project's stack, naming conventions, test commands, and build scripts, then write a concise CLAUDE.md summarizing them. If a CLAUDE.md already exists, read it first and enhance it while preserving existing project-specific instructions.

Does codebase analysis work with monorepos and microservices?▼

Yes, the architecture mapping phase identifies whether a project is a monolith, monorepo, microservices, or serverless setup. It also detects the API style such as REST, GraphQL, gRPC, or tRPC from configuration and code signals.

What happens if a repository has no git history?▼

When the repo has no commits or only a shallow history, the git conventions section is skipped and the guide notes that history is unavailable. Other phases like stack detection and architecture mapping still proceed normally.

What are the limitations of automated codebase onboarding?▼

The analysis relies on detectable signals like manifests and configs, so ambiguous conventions are flagged as unknown rather than guessed. It avoids reading every file, which means deep business logic details still require manual exploration.