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 profile to be used for connecting with QruiseOS tenant. This can be achieved either by specifying the default profile in the global configuration.yaml file or in the .QKB.json file in the flow directory. If you want to use the latter, make sure it contains the following:

{
    "profile": "PROFILE_NAME"
}

where PROFILE_NAME is the name of the profile you wish to use. Also note that the file might contain other fields besides 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.