audit-library-health

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Audit Library Health

审核技能库健康度

Goal

目标

Verify that a skills library is consistent, up-to-date, and ready to share or install from.
验证技能库具备一致性、时效性,可直接用于共享或安装。

Guardrails

使用规范

  • Always use
    --format json
    for structured output when automating health checks.
  • Always use
    --dry-run
    before running
    build-docs
    to check if docs are already in sync.
  • Never push a library to a shared repo without passing
    validate
    and
    doctor
    first.
  • Use
    --fields
    to limit output when inspecting large catalogs.
  • 自动化执行健康检查时,始终搭配
    --format json
    参数获取结构化输出。
  • 执行
    build-docs
    前始终先使用
    --dry-run
    参数检查文档是否已经同步。
  • 未通过
    validate
    doctor
    检查前,切勿将库推送到共享仓库。
  • 检查大型目录时,使用
    --fields
    参数限制输出内容。

Workflow

工作流程

  1. Run the validation script to check catalog integrity.
bash
npx ai-agent-skills validate
This checks: required fields, folder consistency, frontmatter validity, collection integrity, and generated doc sync.
  1. Run doctor to check installed skills health.
bash
npx ai-agent-skills doctor --format json
  1. Check for skills that may need updates.
bash
npx ai-agent-skills check --format json
  1. Verify generated docs are in sync.
bash
npx ai-agent-skills build-docs --dry-run --format json
If
currentlyInSync
is false, regenerate:
bash
npx ai-agent-skills build-docs
  1. Review the curation queue for skills needing attention.
bash
npx ai-agent-skills curate --review --format json
  1. 运行验证脚本检查目录完整性。
bash
npx ai-agent-skills validate
该命令会检查:必填字段、文件夹一致性、frontmatter有效性、集合完整性,以及生成文档的同步状态。
  1. 运行doctor检查已安装技能的健康状态。
bash
npx ai-agent-skills doctor --format json
  1. 检查可能需要更新的技能。
bash
npx ai-agent-skills check --format json
  1. 验证生成的文档是否同步。
bash
npx ai-agent-skills build-docs --dry-run --format json
如果
currentlyInSync
为false,重新生成文档:
bash
npx ai-agent-skills build-docs
  1. 查看需要处理的技能编排队列。
bash
npx ai-agent-skills curate --review --format json

Health Checklist

健康检查清单

  • validate
    passes with no errors
  • doctor
    reports no broken installs
  • build-docs --dry-run
    shows docs are in sync
  • No skills with empty
    whyHere
    fields
  • All house skills have matching folders in
    skills/
  • skills.json
    total matches actual skill count
  • validate
    运行通过无错误
  • doctor
    无损坏安装的报告
  • build-docs --dry-run
    显示文档已同步
  • 没有
    whyHere
    字段为空的技能
  • 所有内部技能在
    skills/
    目录下都有对应的文件夹
  • skills.json
    统计的总数与实际技能数量一致

Gotchas

注意事项

  • validate
    and
    doctor
    are read-only — they never mutate the library.
  • check
    makes network requests to verify upstream sources. It may be slow or timeout on unreachable repos.
  • The
    curate --review
    queue is derived from missing fields and stale verification dates — it is a heuristic, not a mandate.
  • validate
    doctor
    是只读命令——不会修改库的任何内容。
  • check
    会发起网络请求验证上游源,访问不可达仓库时可能运行缓慢或超时。
  • curate --review
    队列是基于缺失字段和过期验证日期生成的——仅作启发式参考,非强制要求。