Skip to main content
Version: v1.1.0
This Quickstart documents the v1.1.0 contract (requirements + design). Final API names may evolve, but the flow and guarantees described here are the target behavior.

​
Quickstart (v1.1.0)

​
What you’ll build

In 5–10 minutes, you’ll add TealTiger to an “agent-like” flow that:
  • Blocks a dangerous tool (file_delete) in ENFORCE
  • Allows a safe tool (customer_data_read)
  • Emits redaction-safe audit events (no raw prompts/responses by default)
  • Correlates everything using correlation_id (and optional trace_id)
✅ Success criteria: you see a deterministic Decision and an AuditEvent with the same correlation_id.

​
Architecture (1-minute mental model)

TealTiger v1.1.0 is SDK-only. You don’t need a server-side control plane to start enforcing policies and producing audit trails.

​
Prerequisites

  • Node.js (TypeScript) or Python runtime
  • A place to write audit logs (console or file)

​
Install

npm install tealtiger
# or
pnpm add tealtiger

✅ Installation completed

​
Step-by-step integration

​
Optional: Record cost metadata

If you compute or receive cost information, store it under metadata.cost.*. 
{
  "metadata": {
    "cost": {
      "estimated": 1.2,
      "actual": 1.0,
      "currency": "USD",
      "budget_scope": "request"
    }
  }
}

​
Troubleshooting

​
“I see missing pages / 404 for a page”

  • Ensure docs.json navigation paths match .mdx file paths exactly (case-sensitive).

​
“My logs contain sensitive content”

  • Ensure debug_mode is false and redaction levels are HASH or stronger.
  • Keep detect_pii enabled.

​
“Everything is ALLOW even in ENFORCE”

  • Confirm the policy is being evaluated for your action/tool.
  • Ensure the effective mode is ENFORCE (policy override or default).

​
Next steps

  • Decision Model: concepts/decision-model
  • Policy Modes: concepts/policy-modes
  • Audit & Redaction: concepts/audit-and-redaction
  • AuditEvent Schema: audit/audit-event-schema