Installation

Install flytectl

macOS (Homebrew)
Linux / macOS (curl)
GitHub releases

brew install flyteorg/homebrew-tap/flytectl

To upgrade an existing installation:

flytectl upgrade

jq must be installed before running this script.

curl -sL https://ctl.flyte.org/install | bash

By default, the binary is placed in ./bin. To install to /usr/local/bin:

curl -sL https://ctl.flyte.org/install | bash -s -- -b /usr/local/bin

To install a specific version:

curl -sL https://ctl.flyte.org/install | bash -s -- v1.13.0

To upgrade an existing installation:

flytectl upgrade

Download the appropriate archive from the GitHub releases page and extract the binary.Supported platforms:

OS	Architecture	Archive name
macOS	amd64	`flytectl_Darwin_x86_64.tar.gz`
macOS	arm64	`flytectl_Darwin_arm64.tar.gz`
Linux	amd64	`flytectl_Linux_x86_64.tar.gz`
Linux	arm64	`flytectl_Linux_arm64.tar.gz`
Windows	amd64	`flytectl_Windows_x86_64.zip`

# Example for Linux amd64
curl -L https://github.com/flyteorg/flyte/releases/download/flytectl/v1.13.0/flytectl_Linux_x86_64.tar.gz \
  | tar -xz -C /usr/local/bin flytectl
chmod +x /usr/local/bin/flytectl

Verify the installation

flytectl version

Your flytectl version should be >= 0.2.0.

Configure flytectl

flytectl reads its configuration from ~/.flyte/config.yaml by default. You can override this path with the --config flag or by setting the FLYTECTL_CONFIG environment variable.

export FLYTECTL_CONFIG=/path/to/custom/config.yaml

The config file is also searched in:

$HOME/.flyte/config.yaml (default)
Current working directory
/etc/flyte/config

Generate a config file

Use flytectl config init to write a starter config automatically:

For a local demo cluster

flytectl config init

This writes ~/.flyte/config.yaml pointing to localhost:30081.

For a remote cluster

flytectl config init --host flyte.myexample.com

For a remote cluster with insecure connection

flytectl config init --host flyte.myexample.com --insecure

Verify the config is valid

flytectl config validate

Config file format

admin:
  # gRPC endpoint — use dns:/// prefix for DNS-based load balancing
  endpoint: dns:///localhost:30081
  insecure: true          # Set to false to require TLS
  authType: Pkce          # Options: ClientSecret, Pkce, ExternalCommand

Local sandbox config

Automatically written by flytectl demo start or flytectl config init.

admin:
  endpoint: dns:///localhost:30081
  insecure: true
  authType: Pkce

AWS remote cluster config

admin:
  endpoint: dns:///flyte.myexample.com
  authType: Pkce
  insecure: false

GCS remote cluster config

admin:
  endpoint: dns:///flyte.myexample.com
  authType: Pkce
  insecure: false

Config with storage backend

admin:
  endpoint: dns:///flyte.myexample.com
  authType: Pkce
  insecure: false
storage:
  type: s3
  container: my-flyte-bucket
  connection:
    region: us-east-1
    auth-type: iam

For production deployments, set insecure: false and configure authType: Pkce or authType: ClientSecret.

flytectl

​Install flytectl

​Verify the installation

​Configure flytectl

​Generate a config file

​Config file format

Build docs developers (and LLMs) love

Install flytectl

Verify the installation

Configure flytectl

Generate a config file

Config file format