prefect.cli.profile

Profile command — native cyclopts implementation.

Manages Prefect profiles.

Functions

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

ls()

List profile names.

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

create(name: str)

Create a new profile.

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

use(name: str)

Set the given profile to active.

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

delete(name: str)

Delete the given profile.

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

rename(name: str, new_name: str)

Change the name of a profile.

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

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 ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/profile.py#L321" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

populate_defaults()

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

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

check_server_connection() -> ConnectionStatus

Classes

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

Methods:

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

auto() -> str

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