onboard-project

Generate onboarding briefings by analyzing codebase stack, architecture, and conventions.

2|Updated Mar 19, 2026
One-click install
npx skills add https://github.com/EvanPluchart/kyomu --skill onboard-project-evanpluchart
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: onboard-project
Source: https://github.com/EvanPluchart/kyomu/tree/main/.claude/skills/onboard-project
Command: npx skills add https://github.com/EvanPluchart/kyomu --skill onboard-project-evanpluchart

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

onboard-project removes the time-consuming guesswork of joining an unfamiliar project by scanning its structure and codebase to produce a ready-to-use context briefing for fast onboarding.

Core Features & Use Cases

  • Stack & architecture detection: Identifies technologies from common config files (e.g., package.json) and analyzes repository structure to determine monolith vs monorepo vs other layouts.
  • Codebase understanding: Explores core elements such as entities/models, routes/endpoints, pages/components, and services/providers to surface how the application works.
  • Patterns and domain mapping: Detects conventions (naming, imports, error handling) and groups logic into business domains/bounded contexts to clarify responsibilities.
  • Context file generation: Produces or updates CLAUDE.md and generates PROJECT_CONTEXT.md plus a one-page project synthesis summary, then recommends additional skills and attention points.

Quick Start

Run onboard-project in full mode on the project path you want to onboard to generate an adapted CLAUDE.md and PROJECT_CONTEXT.md.

Frequently Asked Questions about onboard-project

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

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

You can generate a CLAUDE.md file by scanning config files and repository structures to detect technologies, map architecture, and extract codebase patterns. This produces a ready-to-use context briefing including CLAUDE.md and PROJECT_CONTEXT.md for AI context bootstrapping.

What is the best way to analyze codebase architecture for developer onboarding?

Analyzing codebase architecture for developer onboarding involves scanning repository structures to identify layouts like monorepo or monolith, exploring core elements such as routes and models, and mapping business domains. This surfaces conventions and clarifies responsibilities for new developers.

How does codebase pattern extraction and domain mapping work?

Pattern extraction works by exploring core code elements like entities, routes, and services to detect conventions such as naming and error handling. It groups logic into business domains or bounded contexts, clarifying responsibilities for developer onboarding.

Can I update a pre-existing CLAUDE.md file when bootstrapping AI context?

Yes, you can update a pre-existing CLAUDE.md file during AI context bootstrapping. The process detects technologies from config files and integrates with projects needing an updated CLAUDE.md, generating a PROJECT_CONTEXT.md and a synthesis summary alongside it.

Does stack detection from package.json support monorepo structures?

Yes, stack detection identifies technologies from config files like package.json and analyzes repository structure to determine monolith, monorepo, or other layouts. It supports codebase onboarding by mapping architecture and generating a project synthesis summary.

When should I not use automated codebase onboarding?

Avoid automated codebase onboarding when projects lack standard config files or recognizable repository structures, as stack detection and architecture analysis rely on scanning these elements. It is also less effective if core code elements like routes or models cannot be clearly mapped.