Onboard
Generate a personalized reading tour and verified architecture spine for any codebase.
npx -y skills add ahmedbutt2015/spine --skill onboardAssembled from the repository path, not quoted from the project. Check it against their README if it does not work.
One thing to look at
- 8 stars8 stars. Stars are a popularity signal and not a quality one, but at this level it is likely that nobody has read this closely except its author, and you would be relying on your own review.
SKILL.md
1.5 KB, as published. Nobody here has run it
/onboard
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.mdinto 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:
/mapshows the verified architecture preview/onboardwrites the full guide.claude/REPO_CONTEXT.mdkeeps future Claude sessions grounded in the repo