Install the Uffizzi CLI¶
This guide describes how to install the command-line interface (CLI) tool
uffizzi, which will allow you to create and manage ephemeral environments on Uffizzi Cloud. If you're self-hosting Uffizzi, you should instead follow the self-hosting installation guide.
For macOS or Linux users, you can install the Uffizzi CLI via the Homebrew tap:
Note: Be sure to first run
brew tap before running
From the binrary releases¶
The Uffizzi CLI is currently available as a binary for macOS and Linux. Windows users should use our official Docker container image, available on Docker Hub.
Alternatively, you can download binaries directly from the GitHub Releases page, then add the location to your
Configure the CLI¶
Once you've downloaded and installed the Uffizzi CLI, run
uffizzi config to set the Uffizzi API server you want to use. Accept the default value
app.uffizzi.com (Uffizzi Cloud):
Login to Uffizzi Cloud or your installation of Uffizzi.
Via GitHub or GitLab OAuth¶
Once you've configured the Ufizzi CLI, you can login with your GitHub or GitLab credentials via
uffizzi login. This command will open a browser window to https://app.uffizzi.com where you can sign up for a new account or sign in to an existing account.
Once you're logged in, return to the CLI. You'll need to select which GitHub/GitLab account you want to use as the default account context, for example, if you have both a personal and organizational account. You can change this setting later with the
uffizzi config command.
If you have an email and password login for Uffizzi, you can login via:
Via Environment Variables¶
Alternatively, for email/password accounts (i.e. not GitHub or GitLab OAuth), if you set environment varialbes
UFFIZZI_USER_PASSWORD, Uffizzi will log you in automatically when you run
Create a new project¶
In Uffizzi, every environment must belong to a project. If this is your first time setting up Uffizzi, select Create a new project. Then enter a project name, slug, description.