Start From Your Problem

Common Scenarios

Pick the path that matches what you are actually trying to do. This page is intentionally short and directional.

If you are not sure where to start, start here instead of jumping straight into the reference docs.

I have a Python app

Use primust[auto], set PRIMUST_API_KEY, run the app once, and verify the emitted artifact locally.

pip install "primust[auto]" primust-verify

Go to Quickstart

I need local checks

Use primust-checks if you want bundle-based checks, custom checks, or a lighter local on-ramp before full runtime issuance.

pip install primust-checks

Go to Checks Harness

I’m reviewing a VPEC

Use primust-verify or a bundled verify.html. Reserve the hosted verify site for convenience review.

primust-verify vpec.json

Go to Audit Guide

I’m instrumenting a vendor platform

Use primust-connectors for boundary evidence and choose the connector that matches the platform you actually depend on.

pip install primust-connectors

Go to Connectors

I run a policy or decision engine

Use the direct engine-adapter path when Cedar, Drools, IBM ODM, or OPA is the real governed decision surface.

primust-cedar primust-opa

Go to Policy & Decision Engines

Scenario 1: I Have A Python App

  1. Install primust[auto] and primust-verify
  2. Set PRIMUST_API_KEY
  3. Run the app
  4. Verify the emitted artifact locally
pip install "primust[auto]" primust-verify
export PRIMUST_API_KEY=pk_live_xxx
python my_agent.py
primust-verify vpec.json

Scenario 2: I Need Local Checks

  1. Install primust-checks
  2. Start from a known bundle like ai_agent_general_v1
  3. Add custom checks if needed
  4. Move to the runtime path later if you want emitted credentials
pip install primust-checks

Scenario 3: I’m Reviewing A VPEC

  1. Prefer primust-verify or the pack’s verify.html
  2. Check environment, governance linkage, and open gaps
  3. Use the hosted site only for quick shared-link review
primust-verify vpec.json --trust-root key.pem

Scenario 4: I’m Instrumenting A Vendor Platform

  1. Install primust-connectors
  2. Pick the matching connector or confirm the platform is reference-only
  3. Expect honest boundary evidence, not pretend in-process proof
  4. Link the emitted runtime evidence back to the approved governance chain
pip install primust-connectors

Scenario 5: I Run A Policy Or Decision Engine

  1. Use the matching engine adapter for Cedar, Drools, IBM ODM, or OPA
  2. Complete governance setup first so the runtime evidence links back to the approved plan chain
  3. Wrap the real policy or rule evaluation, not just the surrounding application code
  4. Verify the emitted VPEC locally with primust-verify
pip install primust-verify
Next

If you want the full app workflow after setup, read the User Guide. If your main surface is a rules engine, go to Policy & Decision Engines. If you already know the package name, jump to Package Guides. If you need exact names and endpoints, use the Technical Reference.

Primust Docs · scenario-first docs entry point for average developers and first-time reviewers.