codebase-onboarding-generator

Community

Generate project CLAUDE.md from any codebase.

Authortakusaotome
Version1.0.0
Installs0

System Documentation

What problem does it solve?

This Skill solves the problem of onboarding Claude Code to an unfamiliar repository by automatically producing a high-quality CLAUDE.md based on what’s actually in the codebase, reducing guesswork and missed conventions.

Core Features & Use Cases

  • Codebase structure analysis: Detects root files and meaningful directories (e.g., src, tests, docs) while excluding common noise directories like node_modules and virtual environments.
  • Command discovery: Extracts likely install/build/test/lint/format/run commands from common build config files (e.g., pyproject.toml, package.json, Makefile).
  • Framework and convention detection: Infers frameworks (e.g., FastAPI, Django, React) and coding/testing conventions from project files and sampled source code.
  • CLAUDE.md generation: Produces a CLAUDE.md draft with sections including Project Overview, Common Commands, Directory Structure, Architecture, Coding Conventions, Testing, and Environment Variables (when detected).

Quick Start

Run the analyzer on your repository path to generate a CLAUDE.md draft for future Claude Code sessions.

Dependency Matrix

Required Modules

None required

Components

scriptsreferences

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: codebase-onboarding-generator
Download link: https://github.com/takusaotome/claude-skills-library/archive/main.zip#codebase-onboarding-generator

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 471,000+ vetted skills library on demand.