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. - INLINECODE13 lets you compare multiple workspaces or prepare summaries for a sister repo before pairing.
Example command
CODEBLOCK0
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. - INLINECODE15 : Controls how many lines from each file are shown (default 5) so you can tighten or loosen the briefing.
- INLINECODE16 : Shrinks each preview to the first sentence (splitting on
., ?, or !). Use this for lightning summaries during sync calls. - INLINECODE20 : Point the CLI at another workspace root; useful for onboarding clones, reviewing experimental docs, or prepping a new repo.
References
- -
references/context-guidelines.md documents onboarding topics, role expectations, cadence notes, and reminders for how this group runs.
Resources
- - GitHub: https://github.com/CrimsonDevil333333/context-onboarding
- ClawHub: https://www.clawhub.ai/skills/context-onboarding
技能名称: context-onboarding
详细描述:
上下文引导
何时使用此技能
- - 当你引导新人了解Clawdy/Clawd时，希望快速获取关于个性特征、操作规则及各技能说明的摘要。
- 当你需要提醒自己语气偏好或工具限制，但不想逐篇通读所有文档时。
功能说明
- - scripts/context_onboarding.py 读取关键文档（默认包括SOUL.md、USER.md、AGENTS.md、TOOLS.md），并打印每个文档的前几行，以便快速浏览角色特征、规则和工具说明。
- 命令行支持--files参数添加额外文档，--lines参数控制每个文件显示的行数，--brief参数仅输出每个章节的开头句子。
- 如需进一步指导新人后续阅读内容或保持风格一致性，可参考references/context-guidelines.md。
命令行用法
- - python3 skills/context-onboarding/scripts/context_onboarding.py 汇总默认身份文档，并打印每个文件的前五行内容。
- 添加--files docs/PLAYBOOK.md docs/ROLE.md 可引入额外参考资料，帮助新人了解工作节奏说明或发布流程。
- 配合--lines 2与--brief参数，仅输出单行标题，适合只需了解要点时使用。
- --workspace /path/to/other-workspace 可比较多个工作区，或在结对编程前为兄弟仓库准备摘要。
示例命令
bash
python3 skills/context-onboarding/scripts/context_onboarding.py --files references/context-guidelines.md HEARTBEAT.md --lines 2
此命令将打印个性文件、心跳文档及引导指南的前两行内容，让你无需打开每个文件即可快速了解风格、提醒事项和节奏预期。
选项
- - --files ：接受额外的Markdown文件（以逗号或空格分隔），脚本将按你提供的顺序包含这些文件。
- --lines ：控制每个文件显示的行数（默认5行），可调整摘要的详细程度。
- --brief：将每个预览缩减为第一句话（按句号、问号或感叹号分割）。适用于同步会议中的快速摘要。
- --workspace ：将命令行指向另一个工作区根目录；适用于引导克隆仓库、审查实验性文档或准备新仓库。
参考资料
- - references/context-guidelines.md 记录了引导主题、角色期望、节奏说明以及该团队运作方式的提醒事项。
资源
- - GitHub: https://github.com/CrimsonDevil333333/context-onboarding
- ClawHub: https://www.clawhub.ai/skills/context-onboarding
