selfdoc v0.37.1 /selfdoc check

Reference for the selfdoc check command — usage, flags, arguments, and examples for the check subcommand of the selfdoc CLI.

#selfdoc check

Check documentation coverage, directive resolution, and lint rules

Effect: mutating

#Flags

Flags
NameShortTypeDefaultEnvDescription
--ignorestrComma-separated SEO codes to suppress (e.g., SEO007,SEO008)
--formatstrtextOutput format for check results: text (human) or json (machine)
--auto-commitboolTrueAutomatically commit updated content hash tracking files to git after checking
--version-overridestrProject version that version-bearing generated content is expected to embed (VER004), instead of the version currently recorded in pyproject.toml/package.json. Pass the same value given to 'selfdoc gen --version-override' so the check runs correctly in the release window between generation and the version bump
Search