Skip to main content

​
prefect.cli.profile

Command line interface for working with profiles.

​
Functions

​
ls 

ls()
List profile names.

​
create 

create(name: str, from_name: str = typer.Option(None, '--from', help='Copy an existing profile.'))
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: Optional[str] = typer.Argument(None, help='Name of profile to inspect; defaults to active profile.'), output: Optional[str] = typer.Option(None, '--output', '-o', help='Specify an output format. Currently supports: json'))
Display settings from a given profile; defaults to active.

​
show_profile_changes 

show_profile_changes(user_profiles: ProfilesCollection, default_profiles: ProfilesCollection) -> bool

​
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