Skip to main content

prefect flow-run

prefect flow-run [OPTIONS] COMMAND [ARGS]...
Interact with flow runs.

prefect flow-run inspect

prefect flow-run inspect [OPTIONS] ID
View details about a flow run.

Arguments

ID
string
required
[required]

Options

--web
Open the flow run in a web browser.
--output
Specify an output format. Currently supports: json

prefect flow-run ls

prefect flow-run ls [OPTIONS]
View recent flow runs or flow runs for specific flows.Arguments:flow_name: Name of the flowlimit: Maximum number of flow runs to list. Defaults to 15.state: Name of the flow run’s state. Can be provided multiple times. Options are ‘SCHEDULED’, ‘PENDING’, ‘RUNNING’, ‘COMPLETED’, ‘FAILED’, ‘CRASHED’, ‘CANCELLING’, ‘CANCELLED’, ‘PAUSED’, ‘SUSPENDED’, ‘AWAITINGRETRY’, ‘RETRYING’, and ‘LATE’.state_type: Type of the flow run’s state. Can be provided multiple times. Options are ‘SCHEDULED’, ‘PENDING’, ‘RUNNING’, ‘COMPLETED’, ‘FAILED’, ‘CRASHED’, ‘CANCELLING’, ‘CANCELLED’, ‘CRASHED’, and ‘PAUSED’.Examples:$ prefect flow-runs ls —state Running$ prefect flow-runs ls —state Running —state late$ prefect flow-runs ls —state-type RUNNING$ prefect flow-runs ls —state-type RUNNING —state-type FAILED

Options

--flow-name
Name of the flow
--limit
Maximum number of flow runs to list
--state
Name of the flow run’s state
--state-type
Type of the flow run’s state
--output
Specify an output format. Currently supports: json

prefect flow-run delete

prefect flow-run delete [OPTIONS] ID
Delete a flow run by ID.

Arguments

ID
string
required
[required]

prefect flow-run cancel

prefect flow-run cancel [OPTIONS] ID
Cancel a flow run by ID.

Arguments

ID
string
required
[required]

prefect flow-run retry

prefect flow-run retry [OPTIONS] ID_OR_NAME
Retry a failed or completed flow run.The flow run can be specified by either its UUID or its name. If multiple flow runs have the same name, you must use the UUID to disambiguate.If the flow run has an associated deployment, it will be scheduled for retry and a worker will pick it up. If there is no deployment, you must provide an —entrypoint to the flow code, and the flow will execute locally. Examples: $ prefect flow-run retry abc123-def456-7890-… $ prefect flow-run retry my-flow-run-name $ prefect flow-run retry abc123 —entrypoint ./flows/my_flow.py:my_flow

Arguments

ID_OR_NAME
string
required
The flow run ID (UUID) or name to retry. [required]

Options

--entrypoint
The path to a file containing the flow to run, and the name of the flow function, in the format path/to/file.py:flow_function_name. Required if the flow run does not have an associated deployment.

prefect flow-run logs

prefect flow-run logs [OPTIONS] ID
View logs for a flow run.

Arguments

ID
string
required
[required]

Options

--head
Show the first 20 logs instead of all logs.
--num-logs
Number of logs to show when using the —head or —tail flag. If None, defaults to 20.
--reverse
Reverse the logs order to print the most recent logs first
--tail
Show the last 20 logs instead of all logs.

prefect flow-run execute

prefect flow-run execute [OPTIONS] [ID]

Arguments

ID
string
ID of the flow run to execute