selfdoc v0.37.1 /selfdoc CLI Reference
On this page

CLI reference for selfdoc -- all commands (init, build, serve, deploy, check, gen, gen-data, quality), the baseline group, and the framework flags.

#selfdoc CLI Reference

Code-aware static site generator with directive-based content extraction

Version: unknown

#Commands

  • init -- Initialize selfdoc configuration and starter docs template
  • build -- Build the documentation site from templates and source code
  • serve -- Serve the documentation site locally with live reload
  • deploy -- Deploy the built documentation site to the configured provider
  • check -- Check documentation coverage, directive resolution, and lint rules
  • gen -- Auto-generate documentation pages from project structure
  • gen-data -- Generate data files by running sandboxed scripts via bwrap
  • spell-corpus -- Spell-check the docs of every selfdoc project beside this one, using the same engine 'selfdoc check' runs (SPELL001) and the shared accept list. Read-only over every project it visits
  • quality -- Show documentation quality tier and metrics for the current project

#Command Groups

  • baseline -- Manage the content and description hash baselines that drive staleness (STALE001) and source-drift (DRIFT001) detection during selfdoc check

#Framework flags

These flags are owned by the strictcli framework, not by the app. No command may declare a flag with one of these names, and each is recognized anywhere on the command line.

Framework flags
FlagEffect
--dry-runPreview mode: no mutation runs. The framework prints a log of every effect the command would have performed.
--approve-consequentialSkips the confirmation prompt a consequential command shows before it runs.
--quietHides informational output. Warnings, errors, structured data and the dry-run log are never suppressed.
--verboseShows debug output. --quiet wins when both are passed.
Search