CLI

Commands for initializing and checking docs.

The CLI stays intentionally small: initialize a docs system, create feature packages, audit structure and metadata, and check terminology drift.

vibedocs init

Create a docs system from the scaffold with hydrated placeholders.

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

vibedocs feature create

Create a feature package under docs/features/<feature>/.

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

vibedocs audit

Run structure, SSOT, metadata, terminology, freshness, and diff checks.

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

Run terminology checks on selected paths or configured glossary scopes.

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

Supported local config files

vibedocs.config.json

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

Design constraint

Configuration is intentionally small. Keep it readable and repository-local instead of turning it into a second policy system.