CLI Reference
Complete reference for the boringdocs command-line interface.
Commands
boringdocs init
Initialize boringdocs in the current project. Creates boringdocs.yaml with defaults.
boringdocs init [--force]| Flag | Description |
|---|---|
--force | Overwrite existing config |
boringdocs check
Run validation checks against the current codebase and docs.
boringdocs check [--fix] [--staged] [--format text|json|github|gitlab]| Flag | Description |
|---|---|
--fix | Auto-fix issues where possible |
--staged | Only check git-staged files |
--format | Output format (default: text) |
boringdocs diff
Show drift between the current state and the last baseline.
boringdocs diff [--baseline <path>]boringdocs baseline
Manage the validation baseline.
boringdocs baseline [--update] [--show]| Flag | Description |
|---|---|
--update | Update baseline to current state |
--show | Display current baseline |
boringdocs sync
Run doc-code sync. Updates documentation stubs based on code changes.
boringdocs sync [--dry-run]boringdocs version
Print the boringdocs version.
Global Flags
| Flag | Description |
|---|---|
--config <path> | Path to config file (default: boringdocs.yaml) |
--verbose | Verbose output |
--quiet | Suppress all output except errors |
--no-color | Disable colored output |