prefect.cli.config

Config command — native cyclopts implementation.

Manages Prefect settings and profiles.

Functions

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

set_(settings: Annotated[list[str], cyclopts.Parameter(help='Settings in VAR=VAL format')]) -> None

Change the value for a setting by setting the value in the current profile.

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

validate() -> None

Read and validate the current profile.

Deprecated settings will be automatically converted to new names.

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

unset(setting_names: Annotated[list[str], cyclopts.Parameter(help='Setting names to unset')]) -> None

Restore the default value for a setting.

Removes the setting from the current profile.

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

view() -> None

Display the current settings.