prefect.cli.flow_run

Flow run command — native cyclopts implementation.

Interact with flow runs.

Functions

inspect ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/flow_run.py#L107" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

inspect(id: UUID)

View details about a flow run.

ls ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/flow_run.py#L158" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

ls()

View recent flow runs or flow runs for specific flows.

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

delete ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/flow_run.py#L294" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

delete(id: UUID)

Delete a flow run by ID.

cancel ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/flow_run.py#L314" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

cancel(id: UUID)

Cancel a flow run by ID.

retry ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/flow_run.py#L336" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

retry(id_or_name: str)

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

logs ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/flow_run.py#L510" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

logs(id: UUID)

View logs for a flow run.

watch ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/flow_run.py#L685" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

watch(id: UUID)

Watch a flow run until it reaches a terminal state.

execute ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/flow_run.py#L720" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

execute(id: Optional[UUID] = None)

Execute a flow run by ID.