build-workspace-docs
Use when regenerating README.md and WORK_AREAS.md in a managed library workspace. Always dry-run first to preview changes.
它会碰到什么
扫了多少1 个文本文件,2 KB
它会碰到什么不碰外部(只输出文字)
命中总数0 处
命中统计严重 0 · 高 0 · 中 0 · 低 0
这一栏是扫描器报的事实,不是结论。命中多不等于有毒(安全工具、规则库、示例脚本本来就会包含危险写法),命中少也不等于干净。它和你手上的凭据、文件、网络有什么关系,需要你自己看。
技能内容
Build Workspace Docs
Goal
Keep workspace documentation in sync with the skills catalog after adding, removing, or curating skills.
Guardrails
- Always use
--dry-runbefore regenerating docs to preview what will change. - Only run from inside an initialized library workspace (a directory with
.ai-agent-skills/config.json). - Never hand-edit the generated sections of README.md or WORK_AREAS.md. The CLI will overwrite them.
- Use
--format jsonto capture structured results for automation pipelines.
Workflow
- Preview what would change.
npx ai-agent-skills build-docs --dry-run
- Regenerate the docs.
npx ai-agent-skills build-docs
- Verify the output.
npx ai-agent-skills build-docs --dry-run --format json
The JSON output includes currentlyInSync to tell you whether docs were already up to date.
When to Run
- After
add,catalog,vendor, orcuratecommands that change the skills catalog. - After bulk imports from a remote library.
- Before committing workspace changes to git.
Gotchas
- Running outside a workspace will fail with a clear error. Use
init-libraryto create one first. - The generated docs use HTML comment markers (
<!-- GENERATED:...:start/end -->) as boundaries. Do not remove these markers from the template sections.
想直接用这个技能?
本站把开放许可(MIT / Apache 等)的技能按仓库打包整理到网盘,点一下转存到你自己的网盘,不用一个个从 GitHub 拉。许可未声明的技能只给原始仓库链接,不打包。