codebase-onboarding

Analyze a codebase and generate an onboarding guide with a CLAUDE.md.

Updated Mar 17, 2026
One-click install
npx skills add https://github.com/Blake-John/agent-config --skill codebase-onboarding-blake-john
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: codebase-onboarding
Source: https://github.com/Blake-John/agent-config/tree/main/.agents/skill_spec/codebase-onboarding
Command: npx skills add https://github.com/Blake-John/agent-config --skill codebase-onboarding-blake-john

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Analyze an unfamiliar codebase and generate a structured onboarding guide with architecture map, key entry points, conventions, and a starter CLAUDE.md. Use when joining a new project or setting up Claude Code for the first time in a repo.

Core Features & Use Cases

  • Reconnaissance and architecture mapping across a new repo
  • Automated entry-point and convention discovery to speed onboarding
  • Generate a starter CLAUDE.md with tailored instructions for the project

Quick Start

Run Phase 1–4 on a repository to generate an Onboarding Guide and 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 analyze an unfamiliar codebase and map its architecture for onboarding?

To analyze an unfamiliar codebase for onboarding, this Skill runs a phased workflow that gathers repository signals, identifies the tech stack, maps entry points, and generates a structured onboarding guide. It automates architecture discovery to speed up the process.

Can I generate a CLAUDE.md file for my project automatically?

Yes, you can generate a starter CLAUDE.md file automatically. The Skill creates tailored instructions for the project based on detected patterns and conventions, while preserving an existing CLAUDE.md if one is already present in the repository.

What is the best way to discover entry points and conventions in a new repo?

The best way to discover entry points and conventions is through automated reconnaissance. This Skill scans the repository to detect architectural patterns and key entry points, then documents them in an actionable onboarding guide for developers.

Does the codebase onboarding workflow work without external dependencies?

Yes, the codebase onboarding workflow operates without external dependencies. It applies an internal phased workflow to map the tech stack and generate guidance, requiring no additional packages or components to run.

How do I document unknowns and safety patterns when setting up Claude Code?

To document unknowns and safety patterns when setting up Claude Code, the Skill explicitly highlights detected conventions and unknowns during analysis. It preserves safety by including these observations in the generated onboarding guide and CLAUDE.md.

What are the limitations of automated codebase analysis for developer onboarding?

A limitation of automated codebase analysis is that it highlights unknowns rather than resolving them. The Skill maps architecture and entry points to ease onboarding, but developers must manually investigate the documented unknowns to fully understand the project.