context-onboarding_skill

Overview

This skill gives new contributors a fast, focused tour of a workspace's identity and onboarding files (SOUL.md, USER.md, AGENTS.md, TOOLS.md by default). It prints short previews so newcomers and reviewers can grasp personality, rules, and tooling without opening every document. Use it to prepare quick syncs, onboarding checklists, or cross-workspace comparisons.

How this skill works

The script reads each identity or onboarding file and prints the opening lines so you can skim tone, rules, and tooling notes. CLI flags let you include extra files, set how many lines to show, emit a single-sentence brief, or point the tool at another workspace root. Output is meant for rapid inspection rather than full reading.

When to use it

• Onboarding a new contributor who needs the workspace voice, rules, and tooling highlights.
• Preparing a short briefing before a pairing session or sync meeting.
• Comparing identity files across sibling workspaces or forks.
• Checking tone, operating rules, or tool notes without reading full documents.
• Creating a quick handoff or review summary for maintainers.

Best practices

• Run the tool from the workspace root so default files are found automatically.
• Use --files to include role guides, playbooks, or cadence notes relevant to the new contributor.
• Set --lines low (e.g., 2) or use --brief for lightning summaries in meetings.
• Point --workspace at a clone or sibling repo to validate consistency before merging changes.
• Keep identity files concise and front-load important reminders to maximize preview value.

Example use cases

• Summarize SOUL.md and USER.md before a newcomer’s first day so you can coach tone and expectations.
• Emit two-line previews of AGENTS.md and TOOLS.md during a tooling orientation call.
• Scan multiple workspaces to verify that onboarding guidance and cadence notes match.
• Add PLAYBOOK.md and ROLE.md via --files to create a single briefing that covers rituals and responsibilities.
• Use --brief during standups to surface one-line mission statements or safety rules.