Skip to content

qruise flow

Run and manage flows.

Syntax

qruise flow [OPTIONS] COMMAND [ARGS]...

Description

The qruise flow command is the base command for managing flows in QruiseOS. You can read more about workflows in the Running a workflow page.

Options

Option Description
--help Show a help message and exit.

Configuration files

Subcommands of the qruise flow command require the user to specify the QPU to be used for connecting to the QruiseOS tenant. This is done by specifying the profile field in the .QKB.json file inside the flow directory:

.QKB.json
{
    "profile": "QPU_NAME"
}

where QPU_NAME is the name of the QPU you wish to use (see here for how to create a QPU). Also note that the file might contain other fields besides just profile.

Subcommands

Name Description
init Initialise directory structure for a Qruise flow.
list List all scheduled flows.
remove Remove a scheduled flow.
run Run a flow locally.
schedule Submit a flow for scheduled execution.