CLI command reference

Run ivk <group> --help for arguments and options on the installed version.

Account and workspace selection

Command	Purpose
`ivk init`	Create an account and first workspace
`ivk login`	Sign in through device authorization
`ivk logout`	Remove the saved CLI session
`ivk whoami`	Show the current user, role, and workspace
`ivk workspaces list`	List accessible workspaces
`ivk ws switch <organization-id>`	Select another accessible workspace
`ivk status`, `ivk st`	Show readiness and the next action
`ivk config list`	Show saved configuration
`ivk config set <key> <value>`	Set `endpoint`, `client-id`, or `app-url`

Catalog

ivk catalog: list, get, connect, connections, discovery, create-surface, archive-surface, import, activate, save-action, archive-action, discover, sync, credential, insights, audit, save-relationship, remove-relationship, record-context.

ivk catalog connect \
  --name "Commerce API" \
  --owner mbr_example \
  --repository acme/commerce \
  --wait

ivk catalog connect \
  --name "Commerce API" \
  --owner mbr_example \
  --file ./invokeable.yaml

JSON output includes excludedActionCount when Invokeable leaves out OpenAPI operations with credential fields.

Agents

ivk agents: list, ensure-managed, connect, activate, pause, restore, archive, bindings, provisioning, conformance.

Journeys

ivk journeys, alias ivk j: list, get, create, update, run, undo, submit, assertions, save-assertion, approve-assertion, suites, save-variation, save-suite, prepare-suite, publish-suite, save-coverage, coverage, suggest-coverage, review-coverage, baselines, baseline, save-baseline, submit-baseline, review-baseline.

Runs

ivk runs, alias ivk r: list, get, progress, cancel, stop, plan, start, planner, preview, trials, export, export-part.

Findings and fixes

ivk findings, alias ivk f: list, get, fix, plan-fix, start-fix, cancel-fix, connect-github.

Setup and safety

ivk setup: show, create-environment, archive-environment.

ivk safety: status, rules, save-rule, submit-rule, kill-switch, stop, verify-quarantine, release-quarantine, side-effects, verification.

Notifications

ivk notifications: list, read, preferences, set-preference, set-delivery, health, set-routing, retry.

Members and profile

ivk members: list, invitations, invite, revoke-invitation, change-role, suspend, restore, remove.

ivk profile: get, update, refresh, begin-email-change, confirm-email-change, delete.

Workspace and billing

ivk workspace: get, update, deletion, deactivate, request-deletion, cancel-deletion, retry-deletion.

ivk billing: get, checkout, trial, portal, cancel, resume, refresh.

Data and evidence access

ivk data: get, resources, publish-policy, set-consent, place-hold, release-hold, preview-deletion, schedule-deletion, cancel-deletion, request-export, revoke-export, download-export, evidence-access, save-restriction, save-grant, revoke-grant, revoke-restriction.

ivk completion zsh
ivk completion bash

Command defaults

catalog, agents, journeys, runs, and findings default to their list command. Prefer the explicit subcommand in automation.