Quickstart

From preview access to first receipt in five steps.

Use the tenant id, endpoint, and credential path from your preview invite. The flow runs against hosted KarmanFlow surfaces, then shows the receipt trail through the kf CLI.

Hosted preview

Run the first integration path in order.

Public setup starts with the distributed kf CLI and a hosted preview tenant. Repository setup commands stay out of this path.

1. Request early preview

# Preview access includes the kf installer,
# tenant id, endpoint, and scoped credential path.
kf version --pretty

2. Bind the hosted preview profile

kf login --oauth \
  --endpoint https://api.karmanflow.com/graphql \
  --tenant tnt_acme_apparel \
  --environment sandbox

kf profile show --pretty

3. Confirm the contract and auth state

kf auth status --pretty
kf commands list --pretty
kf commands show CreateReservation --pretty

4. Configure the preview tenant defaults

kf tenant-defaults configure \
  --tenant tnt_acme_apparel \
  --environment sandbox \
  --actor-type USER \
  --actor-id usr_sam \
  --persona specialty-retail \
  --pretty

5. Run a guided scenario and inspect receipts

kf onboarding fire-aha-moment-scenario \
  --tenant tnt_acme_apparel \
  --environment sandbox \
  --actor-type USER \
  --actor-id usr_sam \
  --expected-version <current-version> \
  --pretty

kf receipts list --tenant tnt_acme_apparel --environment sandbox --limit 20 --pretty

Day-0 tenant bootstrap

From empty tenant to a real receipt.

Pick the persona that matches your shape, configure the hosted preview tenant, run the first evidence scenario, and end with a reservation receipt your team can inspect.

1. Start onboarding state

kf onboarding start \
  --tenant tnt_acme_apparel \
  --environment sandbox \
  --actor-type USER \
  --actor-id usr_sam \
  --source preview \
  --pretty

2. Select the operating persona

kf onboarding set-persona \
  --tenant tnt_acme_apparel \
  --environment sandbox \
  --actor-type USER \
  --actor-id usr_sam \
  --expected-version <current-version> \
  --persona specialty-retail \
  --pretty

3. Complete the first evidence run

kf onboarding fire-aha-moment-scenario \
  --tenant tnt_acme_apparel \
  --environment sandbox \
  --actor-type USER \
  --actor-id usr_sam \
  --expected-version <current-version> \
  --scenario-id oversell-prevented \
  --pretty

kf receipts list --tenant tnt_acme_apparel --environment sandbox --status SUCCEEDED --pretty

Sample receipt

What every action leaves behind.

Every command produces a typed receipt. Replay it from the CLI, the GraphQL API, or the operator timeline. The shape stays consistent across surfaces, including AI agents.

{
  "commandId": "cmd_01HZ7GCK6MN1Q9V8P3T7B5XJ4F",
  "commandType": "CreateReservation",
  "tenantId": "tnt_demo",
  "actor": { "type": "user", "id": "usr_sam" },
  "input": {
    "variantId": "var_tshirt_sm",
    "locationId": "loc_edison_nj",
    "inventoryOwnerId": "owner_acme",
    "quantity": 3,
    "reservationType": "ORDER",
    "expectedInventoryLevelVersion": 12
  },
  "result": {
    "status": "accepted",
    "reservationId": "rsv_01HZ7GCK6P2VTYE1WJ5N8K2A0G",
    "version": 12
  },
  "policy": [
    { "rule": "tenant_scope", "outcome": "pass" },
    { "rule": "oversell_strict", "outcome": "pass" }
  ],
  "events": [
    "inventory.reservation.created",
    "inventory.level.changed"
  ],
  "issuedAt": "2026-05-08T17:30:14.221Z"
}

Want a preview tenant?

Request a guided 14-day preview.

Preview tenant, seeded demo data, and the first receipt path. Or bring questions to a working session: the integration shape you have in mind, your approval model, or your CISO checklist.

Privacy choices

This controls app-managed marketing analytics: cookie-free Plausible, optional Cloudflare Web Analytics, and first-party event logs with session-only UTM attribution. The site works without it.

Read the privacy notice