The uctl CLI

Contents

The uctl CLI#

While the union CLI provides the primary mechanism for interacting with Union, another CLI, called uctl, is also provided.

uctl provides the same functionality as union but also includes additional functionality for managing Union-specific entities like users, roles, and Union configurations.

In addition, uctl is a compiled binary, which makes it faster and more efficient than the Python-based union CLI and more suitable for situations like running in CI/CD environment where you might want to avoid the overhead of large Python dependencies.

Installing uctl#

To install uctl, you can use Homebrew on macOS or curl on macOS, Linux, or Windows:

To use Homebrew, do this:

$ brew tap unionai/homebrew-tap
$ brew install uctl

To use curl, set BINDIR to the install location (it defaults to ./bin) and run the following command:

$ curl -sL https://raw.githubusercontent.com/unionai/uctl/main/install.sh | bash

To download manually, see the UCTL releases.

To use curl, set BINDIR to the install location (it defaults to ./bin) and run the following command:

$ curl -sL https://raw.githubusercontent.com/unionai/uctl/main/install.sh | bash

To download manually, see the UCTL releases.

To use curl, in a Linux shell (such as WSL), set BINDIR to the install location (it defaults to ./bin) and run the following command:

$ curl -sL https://raw.githubusercontent.com/unionai/uctl/main/install.sh | bash

To download manually, see the UCTL releases.

Note

uctl is an enhanced version of flytectl, the Flyte command-line tool, that lets you manage not only Flyte entities (projects, domains, workflows, tasks, and launch plans) but also Union-specific entities like users, roles, and Union configurations.