prefect.cli.cloud

Cloud command — authenticate and interact with Prefect Cloud.

Functions

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

login()

Log in to Prefect Cloud. Creates a new profile configured to use the specified PREFECT_API_KEY. Uses a previously configured profile if it exists.

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

logout()

Logout the current workspace. Reset PREFECT_API_KEY and PREFECT_API_URL to default.

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

workspace_ls()

List available workspaces.

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

workspace_set()

Set current workspace. Shows a workspace picker if no workspace is specified.