Flyte CLI

This is the command line interface for Flyte.

flyte

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.

Set endpoint and organization:

$ flyte --endpoint <endpoint> --org <org> get project <project_name>

Increase verbosity level (This is useful for debugging, this will show more logs and exception traces):

$ flyte -vvv get logs <run-name>

Override the default config file:

$ flyte --config /path/to/config.yaml run ...

• Documentation
• GitHub: Please leave a star if you like Flyte!
• Slack: Join the community and ask questions.
• Issues

flyte abort

Abort an ongoing process.

flyte abort run

Abort a run.

flyte build

Build the environments defined in a python file or directory. This will build the images associated with the environments.

flyte create

Create resources in a Flyte deployment.

flyte create config

Creates a configuration file for Flyte CLI. If the --output option is not specified, it will create a file named config.yaml in the current directory. If the file already exists, it will raise an error unless the --force option is used.

flyte create secret

Create a new secret. The name of the secret is required. For example:

$ flyte create secret my_secret --value my_value

If --from-file is specified, the value will be read from the file instead of being provided directly:

$ flyte create secret my_secret --from-file /path/to/secret_file

The --type option can be used to create specific types of secrets. Either regular or image_pull can be specified. Secrets intended to access container images should be specified as image_pull. Other secrets should be specified as regular. If no type is specified, regular is assumed.

$ flyte create secret my_secret --type image_pull

flyte delete

Remove resources from a Flyte deployment.

flyte delete secret

Delete a secret. The name of the secret is required.

flyte deploy

Deploy one or more environments from a python file. This command will create or update environments in the Flyte system.

flyte gen

Generate documentation.

flyte gen docs

Generate documentation.

flyte get

Retrieve resources from a Flyte deployment.

You can get information about projects, runs, tasks, actions, secrets, logs and input/output values.

Each command supports optional parameters to filter or specify the resource you want to retrieve.

Using a get subcommand without any arguments will retrieve a list of available resources to get. For example:

• get project (without specifying a project), will list all projects.
• get project my_project will return the details of the project named my_project.

In some cases, a partially specified command will act as a filter and return available further parameters. For example:

• get action my_run will return all actions for the run named my_run.
• get action my_run my_action will return the details of the action named my_action for the run my_run.

flyte get action

Get all actions for a run or details for a specific action.

flyte get config

Shows the automatically detected configuration to connect with the remote backend.

The configuration will include the endpoint, organization, and other settings that are used by the CLI.

flyte get io

Get the inputs and outputs of a run or action. If only the run name is provided, it will show the inputs and outputs of the root action of that run. If an action name is provided, it will show the inputs and outputs for that action. If --inputs-only or --outputs-only is specified, it will only show the inputs or outputs respectively.

Examples:

$ flyte get io my_run

$ flyte get io my_run my_action

flyte get logs

Stream logs for the provided run or action. If only the run is provided, only the logs for the parent action will be streamed:

$ flyte get logs my_run

If you want to see the logs for a specific action, you can provide the action name as well:

$ flyte get logs my_run my_action

By default, logs will be shown in the raw format and will scroll the terminal. If automatic scrolling and only tailing --lines number of lines is desired, use the --pretty flag:

$ flyte get logs my_run my_action --pretty --lines 50

flyte get project

Get a list of all projects, or details of a specific project by name.

flyte get run

Get a list of all runs, or details of a specific run by name.

The run details will include information about the run, its status, but only the root action will be shown.

If you want to see the actions for a run, use get action <run_name>.

flyte get secret

Get a list of all secrets, or details of a specific secret by name.

flyte get task

Retrieve a list of all tasks, or details of a specific task by name and version.

Currently, both name and version are required to get a specific task.

flyte run

Run a task from a python file.

Example usage:

flyte run --name examples/basics/hello.py my_task --arg1 value1 --arg2 value2

Note: all arguments for the run command are provided right after the run command and before the file name.

You can also specify the project and domain using the --project and --domain options, respectively. These options can be set in the config file or passed as command line arguments.

Note: The arguments for the task are provided after the task name and can be retrieved using --help Example:

flyte run --name examples/basics/hello.py my_task --help

To run a task locally, use the --local flag. This will run the task in the local environment instead of the remote Flyte environment.