Documentation Protocol v1.0

Installation

Offline demo: npx trigguard demo with no API key / no ~/.trigguard login → Decision: PERMIT · Receipt: VERIFIED. If an API key is present, the demo uses the live gateway and may return DENY (fail-closed). Live authorization: set TRIGGUARD_API_KEY, then authorize() against the Execution Gateway. Root SDK: authorize, verify, receipt, explain, createAgent, createClient - see SDK.

npm install trigguard
npx trigguard demo

pip install trigguard
pip install authgraph
pip install trigguard-litellm
# MCP: npx @trigguard/mcp
# Live: TRIGGUARD_API_KEY + authorize()

• CLInpm install trigguard · npx trigguard demo · live authorize()→
• Verification guideNeed to validate a receipt? Canonical how-to→
• Live gateway authorizationTRIGGUARD_API_KEY · authorize() · PERMIT / DENY / ESCALATE / SILENCE→
• MCPnpx @trigguard/mcp→

How it works

Architecture and decision semantics live on dedicated pages - this hub links into them.

• ArchitectureExecution flow, components, and deployment model→
• Decision modelPERMIT, DENY, ESCALATE, SILENCE semantics and invariants→

Quickstart

Machine path: npm install trigguard then npx trigguard demo. Live path: TRIGGUARD_API_KEY + authorize(). Full walkthrough: quickstart.

Protocol reference

• TG-EXECUTION-AUTH-01 DraftPOST /execute, PERMIT / DENY / ESCALATE / SILENCE, fail-closed semantics→
• TG-RECEIPT-SCHEMAReceipt fields, signature format, expiry semantics→
• TG-KEY-DISCOVERY/.well-known/trigguard-keys.json · key rotation→
• Decision vs enforcementDecisions vs EXECUTED/BLOCKED enforcement layer→
• API referenceEndpoints, parameters, responses, error codes→
• Authorization surfacesdeploy.*, infra.*, data.*, secrets.* taxonomy→
• Receipt verificationCanonical verification guide→

Runtime integration

• GitHub ActionsEnforce PERMIT before deploys and promotions→
• TerraformPre-apply authorization for infrastructure changes→
• REST APIDirect integration · curl, client libraries, webhooks→
• Command lineShell scripts, local development, testing→

Trust & verification

Deterministic authorization boundary - every request yields PERMIT, DENY, ESCALATE, or SILENCE. Report vulnerabilities to [email protected].

• Receipt signatures (Ed25519)Canonical JSON payload · immutable, offline-verifiable→
• Offline verificationFetch keys once, verify forever - no callback required→
• Key transparencyWell-known discovery · rotation · kid on every receipt→
• Security policyResponsible disclosure and key management→

FAQ

Protocol Verification vs Execution Gateway?

Offline verification is live: Ed25519 over receipt JSON using /.well-known/trigguard-keys.json. The Execution Gateway issues PERMIT / DENY / ESCALATE / SILENCE for irreversible actions via authorize() with TRIGGUARD_API_KEY - see TG-EXECUTION-AUTH-01.

API keys for verification?

No. Use published keys with the CLI or /verify.

Canonical quickstart?

/docs/quickstart - offline demo first (npx trigguard demo), then live authorize().

SILENCE vs DENY?

DENY is an explicit refusal. SILENCE withholds authorization without leaking policy signals.