@cathedral/cli

Command-line interface for Cathedral — derive candidate requirements from pull requests and source code, and run quality gate checks against your requirements knowledge base.

Installation

npm install -g @cathedral/cli
# or use without installing:
npx @cathedral/cli --help

Requires Node.js ≥ 24.8.0.

Commands

cathedral analyze-pr

Fetch a GitHub PR diff and derive candidate requirements via Cathedral.

cathedral analyze-pr \
  --endpoint https://cathedral.example.com \
  --token <cathedral-pat> \
  --repo owner/repo \
  --pr 42 \
  --solution my-solution \
  --github-token <github-pat> \
  --format text

Flag	Env var	Required	Description
--endpoint	CATHEDRAL_ENDPOINT	✓	Cathedral instance URL
--token	CATHEDRAL_TOKEN	✓	Cathedral PAT
--repo	—	✓	GitHub repo in owner/repo format
--pr	—	✓	Pull request number
--solution	—	✓	Cathedral solution slug
--github-token	GITHUB_TOKEN	✓	GitHub token to fetch the diff
--format	—	—	json (default) or text
--post-comment	—	—	Post findings as a PR comment

---

cathedral analyze-code

Analyze source files and derive candidate requirements.

cathedral analyze-code \
  --endpoint https://cathedral.example.com \
  --token <cathedral-pat> \
  --product <product-uuid> \
  --solution my-solution \
  src/auth.ts src/payments.ts

Flag	Env var	Required	Description
--endpoint	CATHEDRAL_ENDPOINT	✓	Cathedral instance URL
--token	CATHEDRAL_TOKEN	✓	Cathedral PAT
--product	—	✓	Cathedral product UUID
--solution	—	✓	Cathedral solution slug
--format	—	—	json (default) or text
[files...]	—	✓	Source files to analyze

---

cathedral check

Run the Cathedral check engine against a solution and exit non-zero on error-severity diagnostics (useful as a CI gate).

cathedral check \
  --endpoint https://cathedral.example.com \
  --token <cathedral-pat> \
  --solution my-solution

Flag	Env var	Required	Description
--endpoint	CATHEDRAL_ENDPOINT	✓	Cathedral instance URL
--token	CATHEDRAL_TOKEN	✓	Cathedral PAT
--solution	—	✓	Cathedral solution slug
--format	—	—	json (default) or text

Exit codes

Code	Meaning
0	Success — findings only, no blocking diagnostics
1	Error-severity diagnostics present (Production enforcement)
2	Authentication or connectivity failure

GitHub Action

For PR-level automation, use the companion GitHub Action:

- uses: final-hill/cathedral-action@v1
  with:
    endpoint: ${{ vars.CATHEDRAL_ENDPOINT }}
    token: ${{ secrets.CATHEDRAL_TOKEN }}
    solution: my-solution
    enforcement-level: Production

See final-hill/cathedral-action for full documentation.

Related

• Cathedral — the requirements knowledge base server
• cathedral-action — GitHub Action wrapper