Uffizzi CLI
Uffizzi CLI is a command line interface for the Uffizzi platform. It allows you to manage your Uffizzi account and projects from the command line. See Installing Uffizzi to download the CLI.
The Uffizzi CLI allows you to easily interact with the Uffizzi API. To list available commands, you can run uffizzi or uffizzi help, or to get help on a specific group or subcommand run uffizzi [GROUP] help or uffizzi [GROUP] [SUBCOMMAND] help.
Command groups and Subcommands
The following are the different commands provided by the Uffizzi CLI divided between the different commands based on the products we support and the ones for managing your uffizzi account.
Resource Management
| Command | Subcommands | Description |
|---|---|---|
compose | create, delete, describe, events, list, update | Manage Docker Compose environments |
cluster | create, delete, list, update-kubeconfig | Manage virtual clusters |
dev | start, stop | Manage dev clusters |
connect (deprecated) | acr, docker_hub, docker_registry, ecr, gcr, ghcr | Manage connections to external services |
disconnect (deprecated) | acr, docker_hub, docker_registry, ecr, gcr, ghcr | Disconnect account from external services |
Administration
| Command | Subcommands | Description |
|---|---|---|
account | list, set-default | Manage your Uffizzi accounts |
config | get-value, list, set, unset | Manage the CLI's configuration |
install | Install the Uffizzi platform for self-hosting | |
login | Login to Uffizzi | |
logout | Logout of Uffizzi | |
project | create, delete, describe, list, secret, set-default | Manage projects |
version | Show CLI version |