Run in CI · Specistry Docs

.github/workflows/docs.yml

name: docs
on: [push, pull_request]
jobs:
  docs:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-node@v4
        with: { node-version: 24 }
      - run: npm ci
      - run: npx specistry validate
      - run: npx specistry build
      - run: npx specistry check --json > quality.json

Exit codes

Code	Meaning	CI should
`0`	Success	Continue
`2`	Validation or project-policy error	Fail — fix sources
`3`	Quality-gate failure	Fail — fix or suppress with a reason
`64`	Usage error	Fix the command
`70`	Internal failure	Retry, then report
`130`	Cancelled	Retry

TipMachine output

With --json, stdout holds exactly one JSON result and stderr stays empty. Consume codes and fields, never message prose.