DocBoring v0.14.2
COMMAND LINE INTERFACE

DocBoring CLI Reference

The docboring binary operates offline with zero network calls during validation and static artifact generation.

Subcommand Matrix

Command Flags Purpose
docboring init --preset <rfc-adr|runbook> Scaffolds docboring.yaml and starter ADR templates in the working directory.
docboring check --strict, --format json Runs frontmatter schema, link graph, and staleness checks without writing output files.
docboring fmt --write, --check Normalizes frontmatter key ordering and ATX heading spacing deterministically.
docboring build --out <dir>, --base-url <url> Compiles validated Markdown into static HTML, CSS, and sitemap.xml.
docboring graph --dot, --mermaid Exports a dependency graph of supersedes and cross-RFC citations.

Exit Status Codes

GitHub Actions CI Integration

Add the following step to reject pull requests containing broken cross-references or missing ownership metadata:

name: docs-verify
on:
  pull_request:
    paths: ["docs/**", "docboring.yaml"]

jobs:
  validate:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Check documentation integrity
        run: |
          docboring fmt --check
          docboring check --strict
          docboring build --out ./dist