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

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.

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

Example:

$ 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

prefect flow-run delete

prefect flow-run delete [OPTIONS] ID

Delete a flow run by ID.

Arguments

ID · string · required

prefect flow-run cancel

prefect flow-run cancel [OPTIONS] ID

Cancel a flow run by ID.

Arguments

ID · string · 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.

Arguments

ID_OR_NAME · string · 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.

Example:

$ 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

prefect flow-run logs

prefect flow-run logs [OPTIONS] ID

View logs for a flow run.

Arguments

ID · string · 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.

--output

Specify an output format. Currently supports: json

prefect flow-run watch

prefect flow-run watch [OPTIONS] ID

Watch a flow run until it reaches a terminal state.

Arguments

ID · string · required

Options

--timeout

Timeout in seconds.

prefect flow-run execute

prefect flow-run execute [OPTIONS] [ID]

Execute a flow run by ID.

Arguments

ID · string