All Flow commands¶
This page lists every command in openadapt-flow 2.1.0, the release
on PyPI, read from its argument parser. openadapt flow COMMAND and
openadapt-flow COMMAND are the same command. Run any command with
--help for its arguments. For what the commands do and how they fit
together, see the command reference.
admit¶
Read the published release-admission ledger. Does not sign or issue an admission.
| Command | Long options |
|---|---|
openadapt flow admit |
|
openadapt flow admit status |
--check, --json, --ledger |
admit status: Print admitted vs not-admitted for Flow from the public ledger. Never mints a signature.
approve¶
Record an authenticated approval (approver / resolution / bundle version) authorizing a durably-paused run to resume
| Command | Long options |
|---|---|
openadapt flow approve |
--approver, --authorize-uncertain-retry, --resolution |
approve-sanitized¶
Approve and freeze the exact reviewed derivative as an immutable archive
| Command | Long options |
|---|---|
openadapt flow approve-sanitized |
--original, --reviewer |
attach-seal¶
Attach Cloud's signed Execute receipt (the Seal) to a VERIFIED run report
| Command | Long options |
|---|---|
openadapt flow attach-seal |
--cloud-url, --execution-id |
bench¶
Replay a bundle N times against MockMed and aggregate
| Command | Long options |
|---|---|
openadapt flow bench |
--drift, --headed, --n, --param, --run-root |
benchmark¶
Benchmark compiled replay vs. a Claude computer-use agent on the MockMed triage task (agent arm needs an Anthropic API key and costs real money)
| Command | Long options |
|---|---|
openadapt flow benchmark |
--headed, --n-agent, --n-compiled, --note-text, --out |
bind-record-checks¶
Attach reviewed record checks (system-of-record effect contracts) to a compiled program's save step, in a new bundle; reports which entered fields they compare
| Command | Long options |
|---|---|
openadapt flow bind-record-checks |
--binding, --check, --json, --out |
business-decisions¶
Customer-runner typed-decision relay; it never resumes or acts.
| Command | Long options |
|---|---|
openadapt flow business-decisions |
|
openadapt flow business-decisions serve |
--cloud-origin, --once, --poll-wait-seconds, --profile, --runner-config, --runs |
business-decisions serve: Serve the outbound-only non-actuating relay
certify¶
Enforce a policy on a bundle (exits nonzero + reports if it fails); passing means the bundle meets that policy's rules, not that it is safe to run
| Command | Long options |
|---|---|
openadapt flow certify |
--config, --policy |
compile¶
Compile a recording into a workflow bundle
| Command | Long options |
|---|---|
openadapt flow compile |
--accept-params, --name, --no-confirm-params, --out, --params-from |
compose¶
Author a parent sequencer from named compiled child bundles and a handoff contract. Each child stays bound to its recorded surface. certify/run the output directory.
| Command | Long options |
|---|---|
openadapt flow compose |
--after, --allow-halt, --child, --handoff, --name, --out |
connect¶
Claim a one-time browser pairing and store the workspace credential in the OS keychain
| Command | Long options |
|---|---|
openadapt flow connect |
--destination-kind, --device-name, --host, --pairing, --trusted-host, --uri |
connector¶
BYOC connector: enroll this machine with OpenAdapt Cloud and run governed jobs LOCALLY (customer owns the data boundary; PHI stays on this side)
| Command | Long options |
|---|---|
openadapt flow connector |
|
openadapt flow connector enroll |
--control-plane-url, --enrollment-secret, --name, --org-id, --policy, --profile, --storage-backend, --storage-root |
openadapt flow connector run |
--control-plane-url, --once, --org-id, --policy, --poll-wait, --profile, --storage-backend, --storage-root, --token |
connector enroll: Enroll against a mock/development control plane and persist its tokenconnector run: Poll the control plane and run governed jobs until interrupted
console¶
Serve the operator console: a localhost-only web UI over compiled bundles, run reports/halt evidence, and skill-library lineage. Read-only unless --allow-actions; needs pip install 'openadapt-flow[console]'
| Command | Long options |
|---|---|
openadapt flow console |
--agent-url, --allow-actions, --allow-model-grounding, --allow-surface-override, --api-actuator, --api-base-url, --attend, --backend, --bundles, --config, --durable, --effects-base-url, --effects-kind, --effects-root, --headed, --linux-allow-physical-input, --linux-app, --linux-window-title, --macos-app, --macos-window-title, --port, --rdp-host, --rdp-readiness-text, --rdp-window, --rdp-window-title, --remote-decision-host, --remote-decisions, --runs, --skills, --url |
demo¶
See the proof in one command: a checked run and a run where the app lies, side by side on one page (fake clinic data, no AI calls)
| Command | Long options |
|---|---|
openadapt flow demo |
--headed, --no-open, --out, --verbose |
demo-record¶
Serve MockMed and record the canonical triage demo
| Command | Long options |
|---|---|
openadapt flow demo-record |
--drift, --headed, --note-text, --out, --param-name, --record-video |
disambiguate¶
Surface compile-time multiple-choice questions for an ambiguous demo and apply the answers as guards/params (ask, don't guess)
| Command | Long options |
|---|---|
openadapt flow disambiguate |
--answers, --interactive, --write |
emit-mcp¶
Emit a standalone MCP server.py for a bundle
| Command | Long options |
|---|---|
openadapt flow emit-mcp |
--out |
emit-skill¶
Emit an Agent Skills folder for a bundle
| Command | Long options |
|---|---|
openadapt flow emit-skill |
--out |
explain¶
Plain-language read of a completed run dir: what happened, why the outcome is the safe one, and the next suggested command (read-only)
| Command | Long options |
|---|---|
openadapt flow explain |
for-each¶
Author a DATA-DRIVEN LOOP bundle: wrap an existing single-demonstration bundle's linear body in a LOOP that runs once per record of a worklist (CSV/JSON), binding each record's columns to the workflow's parameters. Emits a program:true bundle the runtime executes bounded, $0, identity-gated and effect-verified per record
| Command | Long options |
|---|---|
openadapt flow for-each |
--loop-var, --map, --max-iterations, --name, --out, --records, --relation |
induce¶
Induce a parameterized PROGRAM bundle from MULTIPLE recordings (multi-trace induction: infer params / loops / branches). REFUSES (nonzero exit, no bundle) when intent is underdetermined, printing a record-next worklist of missing demonstrations
| Command | Long options |
|---|---|
openadapt flow induce |
--held-out, --name, --out |
intake¶
Fill a workflow's parameters from a referral PDF, fax image, or email
| Command | Long options |
|---|---|
openadapt flow intake |
--accept, --agent-request, --agent-response, --alias, --no-input, --out, --threshold |
item-approval¶
List, approve or decline the per-item approval requests a run is waiting on (Desktop's Run it)
| Command | Long options |
|---|---|
openadapt flow item-approval |
|
openadapt flow item-approval approve |
--approver-id, --auth-method, --decided-by, --request-id, --request-sha256, --route, --unauthenticated |
openadapt flow item-approval decline |
--approver-id, --auth-method, --decided-by, --reason, --request-id, --request-sha256, --route, --unauthenticated |
openadapt flow item-approval show |
--all |
item-approval approve: Approve one save a person checked in Desktop's Run ititem-approval decline: Don't save: decline one save with a closed reasonitem-approval show: Print the run's approval requests as JSON
lint¶
Report a bundle's coverage gaps (unarmed clicks, vacuous postconditions, under-classified risk); exits nonzero by severity
| Command | Long options |
|---|---|
openadapt flow lint |
--strict |
login¶
Validate an ingest token against the hosted control plane and store it in the OS keychain
| Command | Long options |
|---|---|
openadapt flow login |
--allow-plaintext-token, --destination-kind, --host, --no-save, --token, --trusted-host |
materialize-approved¶
Rebuild an approved derivative from its archive and approval record
| Command | Long options |
|---|---|
openadapt flow materialize-approved |
--approval, --archive, --expect-archive-sha256, --out |
process¶
Author a ProcessContract parent from independently admitted capabilities. Each --child needs a --admission envelope. certify/run the output directory; replay refuses it.
| Command | Long options |
|---|---|
openadapt flow process |
--admission, --after, --allow-halt, --child, --handoff, --input, --name, --out, --spec |
propose-qualification¶
Draft a production-shaped qualification contract from a compiled demo. Alias of qualify propose.
| Command | Long options |
|---|---|
openadapt flow propose-qualification |
--out, --policy-pack, --proposer, --recording |
push¶
Upload the exact approved sanitized archive to /api/ingest; raw input is sanitized locally and paused for review
| Command | Long options |
|---|---|
openadapt flow push |
--attest-non-phi, --auto-approve, --deployment-kind, --destination-kind, --host, --json, --kind, --name, --resolves-run-id, --sanitized-out, --token, --trusted-host, --validation-attestation, --workflow-id |
qualify¶
Create, edit, test, explain, and certify the versioned qualification project sealed into a workflow bundle
| Command | Long options |
|---|---|
openadapt flow qualify |
|
openadapt flow qualify accept |
--admit-local, --out, --proposal, --refuse-pin, --replace |
openadapt flow qualify add-case |
--case-id, --description, --expected-outcome, --input-ref, --kind, --optional |
openadapt flow qualify add-requalification |
--description, --kind |
openadapt flow qualify admit-local |
--out, --proposal |
openadapt flow qualify business-decision |
--check, --input |
openadapt flow qualify certify |
--evidence-root, --json, --policy, --profile |
openadapt flow qualify drills |
--from-case, --json, --save-step |
openadapt flow qualify explain |
--evidence-root, --json, --policy |
openadapt flow qualify from-demo |
--admit-local, --out, --policy-pack, --proposer, --recording |
openadapt flow qualify init |
--application, --application-version, --environment-digest, --minimum-tier, --replace, --require-capability, --runtime-version, --target |
openadapt flow qualify inspect |
--evidence-root, --json, --policy |
openadapt flow qualify judgment-cases |
--check, --input |
openadapt flow qualify label |
|
openadapt flow qualify label list |
|
openadapt flow qualify label remove |
--step |
openadapt flow qualify label set |
--fallback, --label, --step |
openadapt flow qualify propose |
--out, --policy-pack, --proposer, --recording |
openadapt flow qualify report |
--evidence-root, --json, --policy |
openadapt flow qualify run |
--evidence-root, --results |
openadapt flow qualify run-case |
--agent-url, --allow-surface-override, --api-actuator, --api-base-url, --approval-mode, --approval-wait, --backend, --browser-cdp-endpoint, --browser-page-url, --campaign-id, --case-id, --config, --dry-run, --durable, --effects-base-url, --effects-kind, --effects-root, --fault-driver, --headed, --inputs, --linux-allow-physical-input, --linux-app, --linux-window-title, --macos-app, --macos-window-title, --qualification-campaign-authority-file, --rdp-host, --rdp-readiness-text, --rdp-window, --rdp-window-title, --run-dir, --run-id, --save-healed-to, --url |
openadapt flow qualify schema |
|
openadapt flow qualify set-effect |
--effect-index, --path, --step, --tier |
openadapt flow qualify set-identity |
--canonical-ladder, --quorum, --signal, --signal-expected, --signal-extract, --signal-param, --signal-region, --step |
openadapt flow qualify set-risk |
--classification, --explanation, --step |
openadapt flow qualify trust-runner |
--key-id, --public-key |
qualify accept: Confirm every proposed pin in one command after the proposed oracle catches a --break-it fault. Refusing a pin HALTs.qualify add-case: Add a representative or fault casequalify add-requalification: Add a condition that requires this workflow to be requalifiedqualify admit-local: Sign a local-dev admission for an accepted proposal. The signer cannot enter a production trust map.qualify business-decision: Add, update, or inspect one reviewed finite business decision without editing the workflow manifestqualify certify: Persist a combined qualification and existing-policy decisionqualify drills: Add the five readiness drills for the practice case's save and trust this computer's local drill key (a local campaign)qualify explain: Explain qualification coveragequalify from-demo: Propose pins from the demo, accept them, and optionally sign a local-dev admission. After record and compile.qualify init: Initialize a bundle's qualification projectqualify inspect: Inspect qualification coveragequalify judgment-cases: Store or check reviewed local judgment cases; this command never synthesizes an executable rule from examplesqualify label: Optionally set, remove, or list presentation-only entity labelsqualify label list: List qualification-owned entity labelsqualify label remove: Remove a step entity labelqualify label set: Set an optional presentation label for one qualified stepqualify propose: Draft application, environment, identity, and effect pins from the compiled demo. Missing pins HALT; nothing is guessed. Runs the proposed oracle against a --break-it fault.qualify report: Report qualification coveragequalify run: Import case results produced by the Desktop/local/customer-controlled qualification runnerqualify run-case: Run one current qualification case (the practice item or a readiness drill) with Flow-owned Standard authorizationqualify schema: Print the qualification-project JSON Schemaqualify set-effect: Assign verification-strength tier to an existing effectqualify set-identity: Set exact/normalized identity fields and their quorumqualify set-risk: Confirm an action's reviewed business-risk classificationqualify trust-runner: Trust an Ed25519 qualification-runner public key
record¶
Record YOUR workflow interactively: a headed browser (--backend web --url), or the operator's real local desktop input through openadapt-capture (--backend windows/macos/linux/rdp/citrix)
| Command | Long options |
|---|---|
openadapt flow record |
--agent-url, --allow-surface-override, --backend, --browser-cdp-endpoint, --browser-page-url, --headless, --identifier, --linux-allow-physical-input, --linux-app, --linux-window-title, --macos-app, --macos-window-title, --out, --param, --profile, --rdp-host, --rdp-readiness-text, --rdp-window, --rdp-window-title, --secret, --task, --until-cmd, --url, --window, --window-title |
repair¶
Governed repair promotion lifecycle: register a proposed (healed or taught) bundle as a CANDIDATE, review its diff, run the replay and fault campaigns, approve (human), stage, canary, and roll back. A proposed bundle NEVER becomes active without this lifecycle. See docs/REPAIR_LIFECYCLE.md
| Command | Long options |
|---|---|
openadapt flow repair |
|
openadapt flow repair approve |
--approved-by, --non-interactive, --store |
openadapt flow repair campaign |
--kind, --store |
openadapt flow repair canary |
--max-runs, --store |
openadapt flow repair canary-record |
--run-dir, --store |
openadapt flow repair list |
--store |
openadapt flow repair register |
--evidence, --prior, --source, --store |
openadapt flow repair review |
--reviewed-by, --store |
openadapt flow repair rollback |
--by, --candidate-id, --store |
openadapt flow repair show |
--json, --store |
openadapt flow repair stage |
--store |
openadapt flow repair status |
--store |
repair approve: HUMAN approval gating promotion; refuses unless the diff was reviewed and BOTH campaigns passed. Binds the exact bundle hashesrepair campaign: Run a campaign against the candidate's evidence frames: 'replay' (healthy drift battery must all pass) or 'fault' (ambiguity / wrong-entity / stale-target / dialog / verifier-failure frames must all be REFUSED)repair canary: Atomically activate the staged bundle in CANARY mode: a bounded first-N-runs window with per-run verification before full activerepair canary-record: Record one canary run from its run directory; any silent-incorrect or verification regression auto-reverts to the prior bundlerepair list: List candidates and their lifecycle statesrepair register: Register a (prior, proposed) bundle pair as a repair candidate; refuses (fail closed) any contract weakening without a new qualification revisionrepair review: Record a human review of the candidate's diffrepair rollback: One-command rollback: restore the prior bundle hash as the active pointerrepair show: Show a candidate's reviewable diff, campaigns, and staterepair stage: Copy BOTH bundles into the store by content hash and re-verify them byte-exact (prior too, so rollback is always local)repair status: Show the atomic active-bundle pointer and its lineage
replay¶
Replay a bundle (serves the bundled MockMed demo app when no --url is given)
| Command | Long options |
|---|---|
openadapt flow replay |
--agent-url, --allow-model-grounding, --allow-surface-override, --api-actuator, --api-base-url, --attest-audit-log, --attest-contract, --attest-pre-state, --attest-sign-key, --backend, --browser-cdp-endpoint, --browser-page-url, --config, --drift, --durable, --effects-base-url, --effects-kind, --effects-root, --headed, --linux-allow-physical-input, --linux-app, --linux-window-title, --macos-app, --macos-window-title, --param, --params-file, --rdp-host, --rdp-readiness-text, --rdp-window, --rdp-window-title, --record-video, --run-dir, --save-healed-to, --url, --worklist |
report-break¶
Emit a PHI-free break diagnostic from a halted run's report.json to /api/runs/ingest-report (the recording stays local)
| Command | Long options |
|---|---|
openadapt flow report-break |
--deployment-kind, --destination-kind, --host, --org-id, --token, --trusted-host, --workflow-id |
report-run¶
Emit a PHI-free SUCCESS summary from a completed run's report.json to /api/runs/ingest-report (bounded counts, duration, and exact pushed-bundle identity — the recording stays local)
| Command | Long options |
|---|---|
openadapt flow report-run |
--backend, --deployment-kind, --destination-kind, --host, --org-id, --production, --receipt, --token, --trusted-host, --workflow-id |
resume¶
Resume a durably-paused run from its last verified checkpoint (never re-running an already-confirmed write)
| Command | Long options |
|---|---|
openadapt flow resume |
--agent-url, --allow-surface-override, --api-actuator, --api-base-url, --approval-mode, --approval-wait, --attest-audit-log, --attest-contract, --attest-pre-state, --attest-sign-key, --backend, --browser-cdp-endpoint, --browser-page-url, --config, --durable, --effects-base-url, --effects-kind, --effects-root, --headed, --linux-allow-physical-input, --linux-app, --linux-window-title, --macos-app, --macos-window-title, --managed-dispatch-file, --param, --params-file, --qualification-authority-file, --qualification-campaign-authority-file, --rdp-host, --rdp-readiness-text, --rdp-window, --rdp-window-title, --report, --require-approval, --url |
review-sanitized¶
Review original vs sanitized content in a loopback-only local viewer
| Command | Long options |
|---|---|
openadapt flow review-sanitized |
--no-open, --original, --port |
run¶
Execute a bundle under a deployment config (--config): the replay path wired for a real deployment (backend / effects / actuation / durable / policy) instead of the demo
| Command | Long options |
|---|---|
openadapt flow run |
--agent-url, --allow-model-grounding, --allow-surface-override, --allow-trusted-code, --allow-unencrypted, --api-actuator, --api-base-url, --approval-mode, --approval-wait, --approve-unverified-writes, --attest-audit-log, --attest-contract, --attest-pre-state, --attest-sign-key, --backend, --browser-cdp-endpoint, --browser-page-url, --cloud-execution-id, --code-runtime-environment-digest, --code-trust, --config, --dry-run, --durable, --effects-base-url, --effects-kind, --effects-root, --execute-environment-id, --execute-token, --execute-url, --explain, --headed, --hold-on-halt, --linux-allow-physical-input, --linux-app, --linux-window-title, --macos-app, --macos-window-title, --managed-dispatch-file, --param, --params-file, --pin-digest, --pin-version, --policy, --process-environment-id, --process-receipt-issuer-key-id, --process-receipt-private-key, --process-runner-id, --profile, --qualification-authority-file, --qualification-trust, --rdp-host, --rdp-readiness-text, --rdp-window, --rdp-window-title, --record-video, --report, --run-dir, --save-healed-to, --strict-templates, --url, --worklist |
sanitize¶
Create a verified PHI-scrubbed derivative without modifying the original
| Command | Long options |
|---|---|
openadapt flow sanitize |
--kind, --out, --overwrite, --redactions |
scaffold-verifier¶
Draft an effect-oracle contract (effect_contract.yaml) from a recording or bundle's write-shaped steps. The output is a DRAFT requiring human edit; refuses demonstrations with no consequential (write) step
| Command | Long options |
|---|---|
openadapt flow scaffold-verifier |
--out |
seal¶
Copy a bundle to a new path, encrypt its workflow and template evidence with OPENADAPT_BUNDLE_KEY, verify integrity, and publish it atomically
| Command | Long options |
|---|---|
openadapt flow seal |
--out |
serve-execute¶
Host the public Execute v1 HTTP+MCP contract locally. Receipts are self-signed with a local key. They are not OpenAdapt production Seals. Needs pip install 'openadapt-flow[execute]'
| Command | Long options |
|---|---|
openadapt flow serve-execute |
--data-dir, --host, --port, --seed-mockmed, --token |
serve-reward¶
Score training episodes by reading the system of record through an independent oracle. Receipts are self-signed reward receipts, not Execute Seals. Needs pip install 'openadapt-flow[reward]'
| Command | Long options |
|---|---|
openadapt flow serve-reward |
--contract, --data-dir, --host, --port, --seed-mockmed, --token |
teach¶
Self-serve HALT -> LEARN: resolve a halted run from a fix demonstration. Induces the correction as a guarded exception branch, gates + validates it, and writes an updated bundle ONLY if it passes (governed refusal otherwise; nonzero exit)
| Command | Long options |
|---|---|
openadapt flow teach |
--bundle, --fix, --library, --out, --skill-id |
teach-branch¶
Learn a guarded branch from two or more halts resolved the same way. The branch keys on the screen text they share (narrowed by an enum parameter when normal runs show that text too) and is written as a repair candidate that needs approval
| Command | Long options |
|---|---|
openadapt flow teach-branch |
--bundle, --example, --library, --normal-run, --out, --skill-id |
tutorial¶
Run the bundled tutorial end to end against a real local system of record: record, compile, certify, govern, and VERIFY the write out of band, then write a shareable local receipt
| Command | Long options |
|---|---|
openadapt flow tutorial |
--break-it, --guided, --headed, --interactive-record, --name, --no-receipt, --out, --presentation-delay |
validate-hosted¶
Bind strict lint, policy certification, and a successful local replay to an expiring Cloud challenge and exact approved artifacts. Standard and Regulated activation also binds the sealed governed authorization template.
| Command | Long options |
|---|---|
openadapt flow validate-hosted |
--allowed-host, --bundle, --compiler-config, --destination-kind, --environment, --host, --out, --policy, --recording, --risk-class, --run-dir, --target-kind, --target-url, --token, --trusted-host |
visualize¶
See what a demonstration compiled INTO: emit a program-graph view of a bundle or a composed parent (child bundles, --after DAG, effect-bound handoffs) as self-contained HTML, Mermaid, or the shared JSON graph spec
| Command | Long options |
|---|---|
openadapt flow visualize |
--format, --out, --profile |