trigguard — canonical product SDK

Install: npm install trigguard

Official TrigGuard product SDK — one install for authorization, verification, attestation, audit, and coaching. Internal kernel packages (trigguard-sdk-core, @trigguard/execution-sdk, adapters) stay implementation details.

Quick start

npm install trigguard

import { createTrigGuard, withExecute } from "trigguard";

const tg = createTrigGuard({
  gatewayUrl: process.env.TRIGGUARD_GATEWAY_URL!,
  apiKey: process.env.TRIGGUARD_API_KEY,
});

const result = await tg.authorize({
  surface: "deploy.release",
  actor: "ci-bot",
  context: { environment: "production" },
});

if (result.decision === "PERMIT" && result.receipt) {
  const trusted = await tg.verify(result.receipt);
  console.log(trusted ? "receipt verified" : "receipt failed verification");
}

Offline demo: examples/quickstart-node/.

API surface

| Method | Purpose | |--------|---------| | authorize | POST /execute — returns CustomerDecisionResult | | verify | Offline receipt signature verification | | explain | Human-readable decision summary | | attest | Record an attestation via authorize | | audit | Query workspace audit entries | | coach | Advisory outcome preview (non-binding) |

Integration helpers re-exported from scoped packages:

• @trigguard/execution-sdk — withExecute, attemptExecute (deprecated direct install — use trigguard)
• @trigguard/proxy — Express proxy, LangChain protectAgent

Policy simulation (advisory, separate install):

npm install @trigguard/simulator

Migrating from legacy packages

| Legacy | Status | Use instead | |--------|--------|-------------| | @trigguard/execution-sdk | Supported, deprecated | npm install trigguard | | sdk/node (@trigguard/decision) | Supported, deprecated (Rail B) | createTrigGuard().authorize() | | trigguard-js | Legacy | createTrigGuard() |

Guide: docs/adoption/MIGRATE_TO_TRIGGUARD_SDK.md.

Python

HOLD until verb parity with Node — see output/PYTHON_PUBLISH_HOLD.md.
Development: pip install -e sdk/python · examples/quickstart-python/

Monorepo development

npm run build -w trigguard
npm run test -w trigguard

See docs/FIRST_10_MINUTES_V2.md for onboarding.