Skip to content

CLI Reference

All commands support --workspace for multi-repo operation across git submodules.

Bootstrap certification in a repository.

Terminal window
certify init [--path <dir>] [--pr] [--workspace]
FlagDescription
--pathRepository root (default: current directory)
--prCreate initialization as a pull request via gh CLI
--workspaceDiscover submodules and initialize each one

Creates:

  • .certification/config.yml
  • .certification/policies/ with auto-detected language policies
  • .github/workflows/ with PR, nightly, and weekly workflows

Discover all certifiable code units.

Terminal window
certify scan [--path <dir>] [--workspace]
FlagDescription
--pathRepository root (default: current directory)
--workspaceScan all configured submodules

Saves discovered units to .certification/index.json.

Evaluate, score, and certify code units.

Terminal window
certify certify [flags]
FlagDescription
--skip-agentDeterministic only, no LLM review
--batch <n>Process n units per run (0 = all)
--reset-queueRebuild work queue from scratch
--target <path>Only certify units under given path(s)
--diff-base <ref>Only certify files changed since git ref
--path <dir>Repository root (default: current directory)
--workspaceCertify all configured submodules

The work queue is persistent — interrupted runs resume where they left off.

Generate certification reports.

Terminal window
certify report [flags]
FlagDescription
--format <fmt>Output format: card (default), full, json, text, site
--badgePrint shields.io badge markdown for your README
--siteGenerate a static HTML site (shorthand for --format site)
--output <file>Write to file instead of stdout
--detailedInclude dimension breakdowns, risk analysis, expiring units
--path <dir>Repository root
--workspaceGenerate workspace-level report across submodules

Every run saves .certification/REPORT_CARD.md and .certification/badge.json.

AI-powered architectural review of your entire codebase.

Terminal window
certify architect [flags]
FlagDescription
--model <id>Override model for all phases
--phase <n>Run only phase n (1–6, default: all)
--output <file>Output file path (default: .certification/ARCHITECT_REVIEW.md)
--verbosePrint full LLM responses
--path <dir>Repository root
--workspaceWorkspace-level review across submodules

Requires an AI provider. See Architect Review →

Mark overdue certifications as expired.

Terminal window
certify expire [--path <dir>] [--workspace]

Checks all records against their expiration dates and updates status to expired where the certification window has elapsed.

List available models from an AI provider.

Terminal window
certify models [flags]
FlagDescription
--provider-url <url>Provider API base URL
--api-key-env <var>Environment variable containing the API key

Auto-detects providers if no URL is specified. Works with any OpenAI-compatible endpoint.

Generate PR review annotation for GitHub Actions.

Terminal window
certify review [--path <dir>]

Formats certification results as a PR comment. Used in CI workflows to post certification summaries on pull requests.

Check setup and diagnose issues.

Terminal window
certify doctor [--path <dir>]

Runs health checks on:

  • Environment — Go compiler, Git
  • Project setup.certification/ directory, config, policies, index, records, report card, badge
  • Configuration — validates config.yml, checks agent provider settings, scope patterns
  • Policy packs — validates all policy YAML files
  • Optional toolsgolangci-lint, ESLint, ruff, cargo/clippy, pytest, gh CLI
  • Analysis tiers — per-language Tier 0/1/2 availability (Go always Tier 2; TS/Py/Rs Tier 2 if LSP server installed)
  • AI providers — auto-detects cloud and local providers

Exits with code 1 if any check fails.

Interactive onboarding guide.

Terminal window
certify onboard [--path <dir>]

Shows a step-by-step checklist for setting up Certify in your project. Checks which steps are already complete and tells you what to do next:

  1. Initialize (certify init)
  2. Discover code units (certify scan)
  3. Run certification (certify certify)
  4. Generate report card (certify report)
  5. Architect review — optional (certify architect)
  6. Add badge to README (certify report —badge)

Re-run at any time to see your progress.

Print version information.

Terminal window
certify version

The --workspace flag enables multi-repo operation across git submodules. When set, commands discover all submodules via git submodule status and operate on each configured one.

Terminal window
certify init --workspace # initialize all submodules
certify scan --workspace # scan all submodules
certify certify --workspace # certify all submodules
certify report --workspace # aggregate workspace report card
certify architect --workspace # holistic architecture review
certify expire --workspace # expire across all submodules

See Workspace Mode →