profile

prefect.cli.profile

Profile command — native cyclopts implementation.

Manages Prefect profiles.

Functions

ls

ls()

List profile names.

create

create(name: str)

Create a new profile.

use

use(name: str)

Set the given profile to active.

delete

delete(name: str)

Delete the given profile.

rename

rename(name: str, new_name: str)

Change the name of a profile.

inspect

inspect(name: Annotated[Optional[str], cyclopts.Parameter(help='Name of profile to inspect; defaults to active.')] = None)

Display settings from a given profile; defaults to active.

populate_defaults

populate_defaults()

Populate the profiles configuration with default base profiles, preserving existing user profiles.

check_server_connection

check_server_connection() -> ConnectionStatus

Classes

ConnectionStatus

Methods:

auto

auto() -> str

Exposes enum.auto() to avoid requiring a second import to use AutoEnum