kf onboarding
Drive the persona-led onboarding flow and aha moments.
kf onboarding advance-step
Advance the onboarding state machine from a named current step to a named next step.
Advance the onboarding state machine from a named current step to a named next step. Rejects with ONBOARDING_STEP_MISMATCH if the caller's stepId does not match the row's current_step; idempotent replay when the step is already landed. Emits onboarding.completed when nextStepId=='done'.
| Flag | Required | Description |
|---|---|---|
--tenant <id> | yes | Target tenant id. |
--environment <id> | no | Target environment id; defaults to the active profile environment. |
--actor-type <type> | yes | Actor type (USER, SYSTEM, CONNECTOR, AGENT, SERVICE). |
--actor-id <id> | yes | Actor id. |
--idempotency-key <key> | no | Idempotency key for safe retries. Generated when omitted. |
--expected-version <value> | yes | Expected version. |
--step-id <value> | yes | Step id. |
--next-step-id <value> | yes | Next step id. |
Example
kf onboarding advance-step --tenant tnt_demo --actor-type USER --actor-id usr_sam --expected-version <value> --step-id <value> --next-step-id <value>kf onboarding fire-aha-moment-scenario
Run a deterministic aha-moment scenario against the tenant's seeded sample inventory.
Run a deterministic aha-moment scenario against the tenant's seeded sample inventory. Dispatches three reservations across channels under a shared correlation id so operators see the ATP drop, policy DENY paths, and command/event chain in real time. Composite orchestration: uses existing reservation commands through the shared command envelope and records an onboarding.aha_scenario_completed event on success.
| Flag | Required | Description |
|---|---|---|
--tenant <id> | yes | Target tenant id. |
--environment <id> | no | Target environment id; defaults to the active profile environment. |
--actor-type <type> | yes | Actor type (USER, SYSTEM, CONNECTOR, AGENT, SERVICE). |
--actor-id <id> | yes | Actor id. |
--idempotency-key <key> | no | Idempotency key for safe retries. Generated when omitted. |
--expected-version <value> | yes | Expected version. |
--scenario-id <value> | no | Scenario id. |
Example
kf onboarding fire-aha-moment-scenario --tenant tnt_demo --actor-type USER --actor-id usr_sam --expected-version <value>kf onboarding record-aha-moment
Stamp the first-aha moment (oversell prevented, first agent task approved, first reservation committed).
Stamp the first-aha moment (oversell prevented, first agent task approved, first reservation committed). Only the first firing sets aha_fired_at; subsequent scenarios append to metadata.aha_scenarios so time-to-first-value stays stable across a tenant's lifecycle.
| Flag | Required | Description |
|---|---|---|
--tenant <id> | yes | Target tenant id. |
--environment <id> | no | Target environment id; defaults to the active profile environment. |
--actor-type <type> | yes | Actor type (USER, SYSTEM, CONNECTOR, AGENT, SERVICE). |
--actor-id <id> | yes | Actor id. |
--idempotency-key <key> | no | Idempotency key for safe retries. Generated when omitted. |
--expected-version <value> | yes | Expected version. |
--scenario-id <value> | yes | Scenario id. |
--evidence-correlation-id <value> | yes | Evidence correlation id. |
Example
kf onboarding record-aha-moment --tenant tnt_demo --actor-type USER --actor-id usr_sam --expected-version <value> --scenario-id <value> --evidence-correlation-id <value>kf onboarding reset
Reset the progress row back to 'signup' while preserving started_at and appending to metadata.reset_history.
Reset the progress row back to 'signup' while preserving started_at and appending to metadata.reset_history. Risk class R3; intended for controlled preview support flows, not day-to-day tenant operations. Every reset emits an audit event.
| Flag | Required | Description |
|---|---|---|
--tenant <id> | yes | Target tenant id. |
--environment <id> | no | Target environment id; defaults to the active profile environment. |
--actor-type <type> | yes | Actor type (USER, SYSTEM, CONNECTOR, AGENT, SERVICE). |
--actor-id <id> | yes | Actor id. |
--idempotency-key <key> | no | Idempotency key for safe retries. Generated when omitted. |
--expected-version <value> | yes | Expected version. |
--reason <value> | yes | Reason. |
Example
kf onboarding reset --tenant tnt_demo --actor-type USER --actor-id usr_sam --expected-version <value> --reason <value>kf onboarding set-persona
Record the persona a tenant selects during onboarding.
Record the persona a tenant selects during onboarding. Advances current_step from 'signup' to 'persona' on first selection; subsequent calls update persona in place without re-advancing. Persona drives ConfigureTenantDefaults and downstream playbook selection.
| Flag | Required | Description |
|---|---|---|
--tenant <id> | yes | Target tenant id. |
--environment <id> | no | Target environment id; defaults to the active profile environment. |
--actor-type <type> | yes | Actor type (USER, SYSTEM, CONNECTOR, AGENT, SERVICE). |
--actor-id <id> | yes | Actor id. |
--idempotency-key <key> | no | Idempotency key for safe retries. Generated when omitted. |
--expected-version <value> | yes | Expected version. |
--persona <value> | yes | Persona. |
Example
kf onboarding set-persona --tenant tnt_demo --actor-type USER --actor-id usr_sam --expected-version <value> --persona <value>kf onboarding skip-step
Skip the current onboarding step with a required reason, then advance to nextStepId.
Skip the current onboarding step with a required reason, then advance to nextStepId. The skipped step lands on completed_steps with skipped=true and is also denormalized onto skipped_steps for fast funnel queries.
| Flag | Required | Description |
|---|---|---|
--tenant <id> | yes | Target tenant id. |
--environment <id> | no | Target environment id; defaults to the active profile environment. |
--actor-type <type> | yes | Actor type (USER, SYSTEM, CONNECTOR, AGENT, SERVICE). |
--actor-id <id> | yes | Actor id. |
--idempotency-key <key> | no | Idempotency key for safe retries. Generated when omitted. |
--expected-version <value> | yes | Expected version. |
--step-id <value> | yes | Step id. |
--next-step-id <value> | yes | Next step id. |
--reason <value> | yes | Reason. |
Example
kf onboarding skip-step --tenant tnt_demo --actor-type USER --actor-id usr_sam --expected-version <value> --step-id <value> --next-step-id <value> --reason <value>kf onboarding start
Open the onboarding progress state machine for one (tenant, environment).
Open the onboarding progress state machine for one (tenant, environment). Idempotent; if a row already exists the command returns it with alreadyExisted=true and emits no duplicate onboarding.started event. Current step lands at 'signup' because bootstrapTenant auto-completes signup upstream.
| Flag | Required | Description |
|---|---|---|
--tenant <id> | yes | Target tenant id. |
--environment <id> | no | Target environment id; defaults to the active profile environment. |
--actor-type <type> | yes | Actor type (USER, SYSTEM, CONNECTOR, AGENT, SERVICE). |
--actor-id <id> | yes | Actor id. |
--idempotency-key <key> | no | Idempotency key for safe retries. Generated when omitted. |
--source <value> | no | Source. |
--progress-metadata <value> | no | Progress metadata. |
Example
kf onboarding start --tenant tnt_demo --actor-type USER --actor-id usr_sam