qruise flow deployment¶

List and manage flow deployments.

Syntax¶

qruise flow deployment COMMAND [OPTIONS]

Description¶

The qruise flow deployment commands manage deployments registered for a QPU. Use them to inspect deployments, trigger manual runs, delete deployments, and manage schedules without editing the original flow file.

The QPU is resolved from the current .QKB.json profile by default. Pass --qpu QPU_NAME to target a different QPU explicitly. All commands return human-readable output by default and support --json for automation.

Commands¶

Command	Description
`list`	List deployments for a QPU.
`run`	Trigger a deployment run.
`delete`	Delete a deployment.
`schedule list`	List schedules for one deployment.
`schedule add`	Add a cron, interval, or RRule schedule to a deployment.
`schedule remove`	Remove one deployment schedule by ID or slug.
`schedule clear`	Remove all schedules from a deployment.

Listing Deployments¶

qruise flow deployment list [--qpu QPU_NAME] [--json]

The table output includes the deployment ID, name, default parameters, schedules, and whether the current user can run the deployment. Deployments are sorted by name.

Use --json to return the raw API response, including enriched schedules, schedule_summary, and parameters_summary fields.

Example output:

┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━┓
┃ Deployment ID                        ┃ Name                ┃ Parameters  ┃ Schedules          ┃ Can Run ┃
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━┩
│ 7f2270db-5ab6-48e2-9f04-06da534745d7 │ nightly-calibration │ branch=main │ cron=0 1 * * * UTC │ yes     │
│ 82a92f16-3682-4d59-b20a-3aeba50a1136 │ onboarding-flow     │             │                    │ yes     │
└──────────────────────────────────────┴─────────────────────┴─────────────┴────────────────────┴─────────┘

Triggering a Deployment Run¶

qruise flow deployment run DEPLOYMENT_ID [OPTIONS]

Supported run parameter overrides:

Option	Description
`--qpu QPU_NAME`	Target QPU. Defaults to the current `.QKB.json` profile.
`-b, --branch BRANCH`	Knowledge base branch for this run.
`-m, --no-merge`	Do not merge results to the integration branch.
`-q, --qubits Q1,Q2`	Limit the run to specific qubits.
`--flags FLAG1,FLAG2`	Pass flags to the run.
`-s, --start N`	Start at notebook ordinal `N`.
`-e, --end N`	End at notebook ordinal `N`.
`--json`	Output the raw API response.

Example:

qruise flow deployment run 7f2270db-5ab6-48e2-9f04-06da534745d7 --qubits Q1,Q4 --start 15 --end 75

Successful human-readable output contains the triggered flow run ID and workflow ID.

Example output:

Triggered flow run 019c95b6-a25a-7945-8bcc-db4899f2556c for workflow 019c95b6-a25a-7945-8bcc-db4899f2556d

Deleting a Deployment¶

qruise flow deployment delete DEPLOYMENT_ID [--qpu QPU_NAME] [--json]

Deleting a deployment removes it from the QPU deployment list. It does not delete historical workflow runs or experiment data created by earlier runs.

Listing Schedules¶

qruise flow deployment schedule list DEPLOYMENT_ID [--qpu QPU_NAME] [--json]

The table output includes the schedule ID, schedule type, expression, timezone, and active state. The schedule slug is not shown in the table, but it is accepted by schedule remove when you already know the slug from the API.

Example output:

┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━┓
┃ Schedule ID                          ┃ Type ┃ Expression ┃ Timezone ┃ Active ┃
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━┩
│ 4c5d6e7f-8a9b-4c0d-1e2f-3a4b5c6d7e8f │ cron │ 0 1 * * *  │ UTC      │ yes    │
└──────────────────────────────────────┴──────┴────────────┴──────────┴────────┘

Adding Schedules¶

qruise flow deployment schedule add DEPLOYMENT_ID [OPTIONS]

Specify exactly one schedule type:

Option	Description
`--cron CRON`	Add a cron schedule.
`--interval-seconds SECONDS`	Add an interval schedule.
`--rrule RRULE`	Add an RRule schedule.

Additional options:

Option	Description
`--time-zone TIME_ZONE`	Time zone for the schedule.
`--active / --no-active`	Whether the schedule is active when created.
`--qpu QPU_NAME`	Target QPU. Defaults to the current `.QKB.json` profile.
`--json`	Output the raw API response.

Example:

qruise flow deployment schedule add 7f2270db-5ab6-48e2-9f04-06da534745d7 --cron "0 1 * * *" --time-zone Europe/Berlin

Example output:

Added 1 schedule to deployment 7f2270db-5ab6-48e2-9f04-06da534745d7

Removing Schedules¶

Remove one schedule by schedule ID or slug:

qruise flow deployment schedule remove DEPLOYMENT_ID SCHEDULE_REF [--qpu QPU_NAME] [--json]

Remove all schedules from a deployment:

qruise flow deployment schedule clear DEPLOYMENT_ID [--qpu QPU_NAME] [--json]