Use this skill from a repository root to generate an onboarding tour for an unfamiliar codebase.
Current workflow
Run the deterministic scanner to detect repo shape and entry points.
Extract a verified spine from supported local language relationships.
Generate and validate a Mermaid diagram from the verified spine.
Cluster the remaining files into heuristic subsystems.
Build a synthesis prompt that only contains verified structure and short code signatures.
When running as Claude Code skill: Write prompt to file, ask Claude to synthesize JSON, then read JSON back to generate ONBOARDING.md.
Write ONBOARDING.md into the target repo root.
Local command
npm run onboard -- .
Optional token-free preview first:
npm run map -- .
Optional prompt export:
npm run onboard -- . --prompt-out .onboard-prompt.txt
Optional synthesis input (for Claude Code skill flow):
npm run onboard -- . --synthesis-input .onboard-response.json
Optional external synthesis command:
npm run onboard -- . --synthesis-command "your-command-here"
Product contract
Repo brand: spine
User-facing Claude Code command: /onboard
Companion map-only command: /map
Diagram rule: verified edges only, never guessed
Output target: ONBOARDING.md
Launch positioning
The clearest user story is:
/map shows the verified architecture preview
/onboard writes the full guide
.claude/REPO_CONTEXT.md keeps future Claude sessions grounded in the repo
1---2name: onboard3description: Onboard4---5# /onboard67Use this skill from a repository root to generate an onboarding tour for an unfamiliar codebase.89## Current workflow10111. Run the deterministic scanner to detect repo shape and entry points.122. Extract a verified spine from supported local language relationships.133. Generate and validate a Mermaid diagram from the verified spine.144. Cluster the remaining files into heuristic subsystems.155. Build a synthesis prompt that only contains verified structure and short code signatures.166. **When running as Claude Code skill**: Write prompt to file, ask Claude to synthesize JSON, then read JSON back to generate `ONBOARDING.md`.177. Write `ONBOARDING.md` into the target repo root.1819## Local command2021```bash22npm run onboard -- .23```2425Optional token-free preview first:2627```bash28npm run map -- .29```3031Optional prompt export:3233```bash34npm run onboard -- . --prompt-out .onboard-prompt.txt35```3637Optional synthesis input (for Claude Code skill flow):3839```bash40npm run onboard -- . --synthesis-input .onboard-response.json41```4243Optional external synthesis command:4445```bash46npm run onboard -- . --synthesis-command "your-command-here"47```4849## Product contract5051- Repo brand: `spine`52- User-facing Claude Code command: `/onboard`53- Companion map-only command: `/map`54- Diagram rule: verified edges only, never guessed55- Output target: `ONBOARDING.md`5657## Launch positioning5859The clearest user story is:60611. `/map` shows the verified architecture preview622. `/onboard` writes the full guide633. `.claude/REPO_CONTEXT.md` keeps future Claude sessions grounded in the repo
Run npx skillmds@latest add ahmedbutt2015/onboard in your terminal (requires Node.js), paste this page's agent-chat prompt into Claude, Cursor, or any MCP-connected agent, or download the SKILL.md file and copy it into your agent's skills directory.
Onboard It is listed under Coding & Dev Tools on SkillMD.
This skill has not completed SkillMD's automated safety review yet. SkillMD never runs a skill's scripts for you; review the SKILL.md before installing.
This skill is tagged as working with Claude Code, Claude.ai, OpenAI Codex. SKILL.md is an open format, so most agents that read a skills directory can load it too.
Yes. Installing skills from SkillMD is free, and the skill stays under its author's original license.
ahmedbutt2015 (@ahmedbutt2015) published this skill. Their other Agent Skills are listed on their SkillMD profile.
ahmedbutt2015