CLI

用来初始化和巡检文档的本地命令。

这个 CLI 的边界故意保持很小:初始化文档系统、生成功能包、运行结构巡检,以及检查术语漂移。

vibedocs init

基于 scaffold 初始化文档系统,并回填最基本的占位信息。

npx vibedocs init [target]
  --mode minimal|standard|full
  --project-name "Demo"
  --owner "Berlin"
  --force
  --dry-run

vibedocs feature create

docs/features/<feature>/ 下生成一个功能包。

npx vibedocs feature create focus-mode [target]
  --owner "Berlin"
  --force
  --dry-run

vibedocs audit

运行结构、SSOT、元信息、术语、新鲜度以及 diff 相关检查。

npx vibedocs audit [target]
  --format text|json|markdown
  --changed src/app.js
  --rule-pack rule-packs/team.json
  --output artifacts/audit.json

vibedocs glossary check

在指定路径或配置的术语路径上运行术语一致性检查。

npx vibedocs glossary check [target]
  --path docs/product
  --path docs/features
  --rule-pack rule-packs/team.json
  --format json
配置

支持的本地配置文件

vibedocs.config.json

{
  "projectName": "Demo Project",
  "owner": "Berlin",
  "defaultMode": "standard",
  "featureSlugStyle": "snake",
  "glossaryPaths": ["docs/product", "docs/features"],
  "rulePacks": ["rule-packs/team-defaults.json"]
}

设计约束

配置项故意保持克制。目标是让仓库内配置可读、可维护,而不是再长出一套复杂的规则语言。