CLI Reference#

@intended/cli (v0.1.0) is a thin, scriptable client over the Intended authority API. Every command builds a request, sends it to your API base URL with the credentials you configure, and prints the JSON response — so the CLI never makes a decision the API would not. It is built for operators and CI: submit and simulate intents, install Domain LIM packs, approve escalations, query and export the audit chain, verify Authority Tokens offline, and compile OpenShell runtime policy.

Install#

The binary name is intended.

The Intended CLI is in private beta for design partners. It runs against your control plane and is not yet on the public npm registry. Request access↗ — or, if you're working in the monorepo, build it from the workspace:

# from the Intended monorepo workspace
pnpm --filter @intended/cli build
node packages/cli/dist/index.js version    # → 0.1.0

intended help (or intended --help) prints the full command list; intended version prints 0.1.0.

Configure#

Run intended init once in your working directory to drop an intended.config.json next to your project. Any value in this file is the default for every command; matching --flags override it per-invocation.

intended init
# → Initialized <cwd>/intended.config.json

{
  "apiBaseUrl": "https://api.intended.so",
  "environment": "prod",
  "tenantId": "tenant_acme_prod",
  "actorId": "svc-ci-bot",
  "apiKey": "intended_live_…"
}

intended audit-query --tenant tenant_acme_prod --limit 1

Authentication#

The CLI assembles request headers exactly like a hand-written API call, and resolves a credential in a fixed order. The first present source wins:

Customer API keys are prefixed intended_live_… (a legacy mrt_… prefix is still accepted for older staff keys). There is no separate sandbox or test key — any environment label on a key is cosmetic and does not gate authorization. Pass a key with --apikey or store it as apiKey in the config.

Tenant and actor resolution#

Most commands need a tenant scope and many need an actor. The CLI resolves them from (in order) an explicit --tenant / --actor flag, then the tenantId / actorId config keys, and finally — if you pass --session — by calling /amp/auth/session and reading the tenant and user id off the verified portal session. If none resolves, the command exits non-zero with a clear message rather than guessing.

intended intent-submit \
  --apikey "$INTENDED_API_KEY" \
  --tenant tenant_acme_prod \
  --actor svc-ci-bot \
  --action "ci.workflow.dispatch"

Global flags#

These flags apply to most commands (defaults come from intended.config.json):

Command map#

The CLI is a flat client over the authority runtime. The diagram shows where each command family lands in the decision loop the API runs on every call.

intent-submit / simulate feed the loop; escalations-* resolve held decisions; verify / inspect-token operate on the minted token; audit-query / audit-export read the resulting chain.

Command reference#

Every command prints the raw JSON API response to stdout and returns exit code 0 on a 2xx, 1 otherwise (verify returns 2 on an invalid token). Bracketed flags are optional.

Intents and simulation#

# Submit a fully-specified intent from a JSON body
intended intent-submit --apikey "$INTENDED_API_KEY" --tenant tenant_acme_prod \
  --body '{
    "tenantId": "tenant_acme_prod",
    "actor": { "id": "svc-ci-bot", "type": "service" },
    "targetSystem": "acme/platform-api",
    "proposedAction": "dispatch release workflow",
    "riskContext": { "baseRiskScore": 42, "policyCompliant": true,
      "requiresPrivilegedAccess": false, "touchesProduction": false,
      "containsSensitiveData": false }
  }'

POST /intent returns the legacy authority enum — APPROVED (HTTP 200), ESCALATED (202), or DENIED (403) — and, only on APPROVED, an authorityDecisionToken (an Ed25519 JWT, 300-second TTL, single-use). See the Intents API for the full response shape.

Domain LIM packs#

Escalations#

Audit#

Tokens#

# Offline Ed25519 verification with kid pinning — exits 0 if valid, 2 if not
intended verify \
  --token "$DECISION_TOKEN" \
  --key ./tenant-public.pem \
  --kid "tenant_acme_prod-1717700000-ab12cd" \
  --tenant tenant_acme_prod \
  --adapter github

verify calls @intended/verify, which enforces Ed25519, mandatory kid pinning, tenant/adapter/issuer/audience matching, clock-skew tolerance, and the 300-second max TTL. inspect-token only base64-decodes the payload for inspection and performs no verification — never trust its output as proof.

Connectors#

Policy packs#

See Policy commands for the full policy-pack workflow.

Workflows#

Live monitoring#

# Tail high-risk denials for one tenant in real time
intended watch --apikey "$INTENDED_API_KEY" --tenant tenant_acme_prod \
  --decision DENY --min-risk 60

Runtime policy#

See OpenShell commands for the input shape and presets.

Exit codes#

See also#

• Policy commands — install and inspect policy packs from the CLI
• OpenShell commands — compile runtime policy YAML
• API Authentication — credential types and the fail-closed gate
• Intents API — the request/response contract behind intent-submit