Help

Local setup & health

Local checks & health

Practical commands to validate an audit endpoint or the documentation/dashboard workspace from your laptop.

Quick probes#

GovAI try console
requires API key
Try thisCopy and run in your environment

Audit HTTP liveness and readiness

Point GOVAI_AUDIT_BASE_URL at Docker, KIND, or a hosted pilot. Keys optional for /health only.

Environment
export GOVAI_AUDIT_BASE_URL=http://127.0.0.1:8080
Command
curl -fsS "$GOVAI_AUDIT_BASE_URL/health"
Expected output
200 — process started

Next stepAPI reference

Auth smoke (when you have a key)#

GovAI try console
requires API key
Try thisCopy and run in your environment

Authenticated compliance summary

Confirms GOVAI_API_KEY is accepted before debugging BLOCKED/INVALID.

Environment
|
  export GOVAI_AUDIT_BASE_URL=https://audit.example.com
  export GOVAI_API_KEY=your_key
  export GOVAI_RUN_ID=your_run_id
Command
curl -fsS -H "Authorization: Bearer $GOVAI_API_KEY" \
      "$GOVAI_AUDIT_BASE_URL/compliance-summary?run_id=$GOVAI_RUN_ID" | jq '{verdict}'
Expected output
verdict key present (VALID, INVALID, or BLOCKED)

Next stepTroubleshooting

Repository diagnostics#

GovAI try console
local
Try thisCopy and run in your environment

OSS diagnostics and readiness scripts

Matches maintenance targets used before merging governance-sensitive changes.

Command
make oss-diagnostics
Expected output
Reported checks PASS for your area

Next stepContributing

Dashboard build#

GovAI try console
local
Try thisCopy and run in your environment

Build public docs / help dashboard

Run after editing TSX under dashboard/app/help or markdown preprocessors.

Command
cd dashboard
    npm ci
    npm run build
Expected output
Compiled successfully

Next stepIf build fails

Route catalog#

HTTP route catalog

Core audit API surface — normative shapes in OpenAPI.

API

Metadata & readiness

3
  • GET /healthLiveness after successful startup.GET
  • GET /readyPostgres, migrations, ledger writability (503 when not ready).GET
  • GET /statusPolicy version, environment, runtime diagnostics.GET

Ledger & compliance

4
  • POST /evidenceAppend hash-chained evidence event.POST
  • GET /compliance-summaryAuthoritative VALID / INVALID / BLOCKED verdict.GET
  • GET /bundle-hashCI digest gate: events_content_sha256.GET
  • GET /api/export/:run_idMachine-readable audit export.GET

Preview runtime

1
  • POST /v1/runtime/evaluatePreview policy evaluation (does not replace compliance-summary).POST

← Back to home