context-onboarding

# Context Onboarding

## When to use this skill

- You're guiding someone new through Clawdy/Clawd and want a quick summary of the personality, operating rules, and per-skill notes.
- You need to remind yourself of the tone preferences or tooling constraints without reading every document top to bottom.

## What it does

- `scripts/context_onboarding.py` reads the key documents (`SOUL.md`, `USER.md`, `AGENTS.md`, `TOOLS.md` by default) and prints the first few lines of each so you can skim character, rules, and tooling notes.
- The CLI supports `--files` to include additional documents, `--lines` to control how many lines are shown per file, and `--brief` to emit only the opening sentence of each section.
- Use `references/context-guidelines.md` when you need more guidance about what newcomers should read next or how to keep the vibe consistent.

## CLI usage

- `python3 skills/context-onboarding/scripts/context_onboarding.py` summarizes the default identity docs and prints the first five lines per file.
- Add `--files docs/PLAYBOOK.md docs/ROLE.md` to weave in extra reference material that onboards the newcomer to cadence notes or release rituals.
- Pair `--lines 2` with `--brief` to emit single-line headlines when you just need the gist.
- `--workspace /path/to/other-workspace` lets you compare multiple workspaces or prepare summaries for a sister repo before pairing.

## Example command

```bash
python3 skills/context-onboarding/scripts/context_onboarding.py --files references/context-guidelines.md HEARTBEAT.md --lines 2
```

This prints the opening two lines for the personality files plus the heartbeat and onboarding guide so you can review vibe, reminders, and cadence expectations without opening every file.

## Options

- `--files <path>`: Accepts extra markdown files (comma/space separated) that the script should include in the output order you provide.
- `--lines <n>`: Controls how many lines from each file are shown (default 5) so you can tighten or loosen...

# Context Onboarding

Context Onboarding gives you a curated summary of the identity docs that define this workspace: the personality (SOUL.md), the user guidance (USER.md), agent rules (AGENTS.md), and tooling notes (TOOLS.md). It is the perfect skill to run when someone joins the community, when you inherit a new workspace, or when you just want a refresher on how to stay in sync.

## Features

- CLI script at `skills/context-onboarding/scripts/context_onboarding.py` that reads the most relevant markdown files and prints the first few lines from each so you can skim key points instantly.
- Optional `--files` flag to include extra docs (e.g., playbooks or onboarding guides) plus `--lines`/`--brief` knobs for longer or shorter outputs.
- Built-in reference guide (`references/context-guidelines.md`) that explains what to highlight during onboarding calls or documentation drops.

## Usage

```bash
python3 skills/context-onboarding/scripts/context_onboarding.py --lines 4
```

Add `--files docs/PLAYBOOK.md` if you want to weave in other material, or `--brief` to limit the output to one sentence per doc.

## Testing

```bash
python3 -m unittest discover skills/context-onboarding/tests
```

## Packaging & release

```bash
python3 $(npm root -g)/openclaw/skills/skill-creator/scripts/package_skill.py skills/context-onboarding
```

## Links

- **GitHub:** https://github.com/CrimsonDevil333333/context-onboarding
- **ClawHub:** https://www.clawhub.ai/skills/context-onboarding