main

The Flyte CLI is the command line interface for working with the Flyte SDK and backend. It follows a simple verb/noun structure, where the top-level commands are verbs that describe the action to be taken, and the subcommands are nouns that describe the object of the action.

def main(
    ctx: click.Context,
    endpoint: str | None = None,
    insecure: bool = None,
    image_builder: str | None = None,
    verbose: int = 0,
    log_format: LogFormat = console,
    reset_root_logger: bool = False,
    org: str | None = None,
    config_file: str | None = None,
    auth_type: str | None = None,
    output_format: common.OutputFormat = table
)

The Flyte CLI is the command line interface for working with the Flyte SDK and backend. It follows a simple verb/noun structure, where the top-level commands are verbs that describe the action to be taken, and the subcommands are nouns that describe the object of the action. The root command can be used to configure the CLI for persistent settings, such as the endpoint, organization, and verbosity level.

Parameters

Name	Type	Description
ctx	click.Context	The Click context object, used to pass information between commands.
endpoint	`str	None` = None
insecure	bool = None	Use an insecure connection to the endpoint. If not specified, the CLI will use TLS.
image_builder	`str	None` = None
verbose	int = 0	Show verbose messages and exception traces. Repeating multiple times increases the verbosity (e.g., -vvv).
log_format	LogFormat = console	Formatting for logs, defaults to 'console' which is meant to be human readable. 'json' is meant for machine parsing.
reset_root_logger	bool = False	If set, the root logger will be reset to use Flyte logging style.
org	`str	None` = None
config_file	`str	None` = None
auth_type	`str	None` = None
output_format	common.OutputFormat = table	Output format for commands that support it. Defaults to 'table'.