Overview
Settings reference
REST API
CLI Reference
Python SDK Reference
- artifacts
- automations
- cache_policies
- context
- engine
- exceptions
- filesystems
- flow_engine
- flow_runs
- flows
- futures
- main
- plugins
- results
- schedules
- serializers
- states
- task_engine
- task_runners
- task_runs
- task_worker
- tasks
- transactions
- variables
- prefect.assets
- prefect.blocks
- prefect.cli
  - __init__
  - artifact
  - block
  - cloud
    - __init__
    - ip_allowlist
    - webhook
  - concurrency_limit
  - config
  - dashboard
  - Prefect cli deploy
  - deployment
  - dev
  - events
  - flow
  - flow_run
  - global_concurrency_limit
  - profile
  - root
  - server
  - shell
  - task
  - task_run
  - Prefect cli transfer
  - variable
  - work_pool
  - work_queue
  - worker
- prefect.client
- prefect.concurrency
- prefect.deployments
- prefect.docker
- prefect.events
- prefect.infrastructure
- prefect.input
- prefect.locking
- prefect.logging
- prefect.runner
- prefect.runtime
- prefect.server
- prefect.settings
- prefect.telemetry
- prefect.testing
- prefect.types
- prefect.utilities
- prefect.workers

On this page

prefect.cli.cloud
Functions
set_login_api_ready_event
lifespan
receive_login
receive_failure
serve_login_api
confirm_logged_in
get_current_workspace
prompt_select_from_list
login_with_browser
check_key_is_valid_for_login
login
logout
open
ls
set
Classes
LoginSuccess
LoginFailed
LoginResult
ServerExit

`prefect.cli.cloud`

Command line interface for interacting with Prefect Cloud

Functions

set_login_api_ready_event() -> None

`lifespan`

lifespan(app: FastAPI)

receive_login(payload: LoginSuccess) -> None

`receive_failure`

receive_failure(payload: LoginFailed) -> None

serve_login_api(cancel_scope: anyio.CancelScope, task_status: anyio.abc.TaskStatus[uvicorn.Server]) -> None

`confirm_logged_in`

confirm_logged_in() -> None

`get_current_workspace`

get_current_workspace(workspaces: Iterable[Workspace]) -> Workspace | None

`prompt_select_from_list`

prompt_select_from_list(console: Console, prompt: str, options: list[str] | list[tuple[T, str]]) -> str | T

Given a list of options, display the values to user in a table and prompt them to select one. Args:

options: A list of options to present to the user. A list of tuples can be passed as key value pairs. If a value is chosen, the key will be returned.

Returns:

the selected option

login_with_browser() -> str

Perform login using the browser. On failure, this function will exit the process. On success, it will return an API key.

check_key_is_valid_for_login(key: str) -> bool

Attempt to use a key to see if it is valid

login(key: Optional[str] = typer.Option(None, '--key', '-k', help='API Key to authenticate with Prefect'), workspace_handle: Optional[str] = typer.Option(None, '--workspace', '-w', help="Full handle of workspace, in format '<account_handle>/<workspace_handle>'"))

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`

logout()

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

`open`

open()

Open the Prefect Cloud UI in the browser.

`ls`

ls()

List available workspaces.

`set`

set(workspace_handle: str = typer.Option(None, '--workspace', '-w', help="Full handle of workspace, in format '<account_handle>/<workspace_handle>'"))

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

Classes

`LoginSuccess`

`LoginFailed`

`LoginResult`

`ServerExit`

block ip_allowlist

API Reference

​prefect.cli.cloud

​Functions

​set_login_api_ready_event

​lifespan

​receive_login

​receive_failure

​serve_login_api

​confirm_logged_in

​get_current_workspace

​prompt_select_from_list

​login_with_browser

​check_key_is_valid_for_login

​login

​logout

​open

​ls

​set

​Classes

​LoginSuccess

​LoginFailed

​LoginResult

​ServerExit