repo-onboard

name

repo-onboard

description

Trigger skill for rapid repository onboarding. Activates when the user wants to understand an unfamiliar codebase. Trigger phrases include "onboard me to this repo", "what does this codebase do", "give me a map of this repo", "ramp up on this project", "first time in this repo", "help me understand this codebase", "orient me to this project", "I'm new to this codebase", "what should I know about this repo".

Repo Onboard

When to Use

Activate this skill when the user expresses an intent to understand an unfamiliar codebase. The trigger phrases live in the frontmatter description.

Also activate when context makes it clear the user has just cloned or opened a repo they haven't worked in before.

How It Works

This skill delegates all work to the repo-onboarder agent. The agent scans the repository in the current working directory and produces three artifacts automatically — no further input is needed from the user.

Dispatch pattern:

1. Confirm the current working directory is the repo root (or ask the user to confirm)
2. Delegate to the repo-onboarder agent
3. Return the agent's ONBOARDING COMPLETE summary to the user

Do not attempt to do the scanning inline — the repo-onboarder agent owns that logic.

Output Locations

After the agent completes, the user will find:

File	Purpose
.onboarding/architecture.md	Full architecture map — modules, deps, hot paths
.onboarding/key-paths.md	Quick-reference cheatsheet — files and why they matter
CLAUDE.md.draft	Starter rules file for Claude Code, pre-filled from detected stack

The user should review CLAUDE.md.draft and rename it to CLAUDE.md once they're satisfied with the content.

Notes

• The agent does not modify any existing source files.
• If the repo has no detectable structure, the agent prints a clear error and writes nothing.
• Re-running is safe — existing files in .onboarding/ and CLAUDE.md.draft will be overwritten.