Installing the CLI

To interact with Fuzzball through the CLI, you must first install the CLI.

Select one of the tabs below to see instructions specific for your operating system.

select

Please select the appropriate installation method for your environment

RPM

The easiest was to install the Fuzzball CLI on Rocky or other enterprise Linux distribution is to install the pre-compiled binary via an RPM file hosted on Depot.

You must obtain a username and login token from the CIQ sales/support team to log into Depot and install tools like the Fuzzball CLI.

The instructions for installing the depot cli tool can be found on the CIQ Depot page. They are reproduced here for convenience.

$ DEPOT_USER="" # populate with your username for CIQ Depot

$ ACCESS_KEY="" # populate with the Depot key obtained from the CIQ sales/support team

$ sudo dnf install -y https://depot.ciq.com/public/files/depot-client/depot/depot.x86_64.rpm

$ sudo depot register -u ${DEPOT_USER} -t ${ACCESS_KEY}

$ sudo depot dnf

Now that you have the depot CLI installed and dnf configured, you can install the Fuzzball CLI.

$ sudo dnf -y install fuzzball-cli

You can now use the Fuzzball CLI. Remember that the --help flag is available to guide you in your Fuzzball usage.

$ fuzzball --help
This fuzzball cli allows users to interface with a fuzzball cluster(s)

Usage:
  fuzzball [command]

Available Commands:
  account      Manage accounts
  completion   Generate the autocompletion script for the specified shell
  context      Manage fuzzball contexts
  definition   Manage fuzzball compute resource definitions
  desktop      Manage and provision fuzzball virtual desktops
  help         Help about any command
  organization Manage your organization
  profile      Manage user profile information
  secret       Manage fuzzball secrets
  storage      Manage Fuzzball storage and volumes
  version      Print the CLI and agent version
  workflow     Manage fuzzball workflows

Flags:
  -c, --color string   Set the color output for fuzzball ($FUZZBALL_COLOR) (default "auto")
      --disable-auth   Disables auth ($FUZZBALL_DISABLE_AUTH)
      --disable-tls    Disables tls ($FUZZBALL_DISABLE_TLS)
  -h, --help           help for fuzzball
      --insecure       Enable insecure connections ($FUZZBALL_INSECURE)
  -j, --json           Output in json ($FUZZBALL_JSON)

Use "fuzzball [command] --help" for more information about a command.

deb

To install the Fuzzball CLI on Ubuntu, Debian, or other deb based system, you must install the pre-compiled binary in a .deb package and use the apt command. You will need to user a browser to either download the .deb package or to obtain the proper link to download the package with wget or similar at the command line.

First, open your browser and navigate to CIQ portal. Make sure to select your organization that has access to Fuzzball in the lower part of the navigation pane on the left. (Or contact CIQ for access to this product.)

CIQ portal landing page

Now click on “My Products” –> “Fuzzball” –> “Fuzzball CLI RPMs” –> version –> architecture –> “deb”.

Currently, .deb packages are stored under the “Fuzzball CLI RPMs” heading even though they are not RPMs.

CIQ portal Fuzzball CLI deb listing

At this point, you can download the deb package by clicking on it. Or you can generate a link suitable for use at the command line with something like wget by clicking on the small ellipses menu to the right and selecting “Copy download link.” Then you can install the package using apt or dkpg.

The following example assumes you copied the download link and are downloading the deb package with wget and then installing it with apt.

$ wget https://ciq-portal:6l7d-2hjc-2mmq@depot.ciq.com/my/fuzzball/fuzzball-cli/v2.1.10/amd64/deb/fuzzball-cli_amd64.deb
--2025-05-12 15:51:22--  https://ciq-portal:*password*@depot.ciq.com/my/fuzzball/fuzzball-cli/v2.1.10/amd64/deb/fuzzball-cli_amd64.deb
Resolving depot.ciq.com (depot.ciq.com)... 165.232.132.175
Connecting to depot.ciq.com (depot.ciq.com)|165.232.132.175|:443... connected.
HTTP request sent, awaiting response... 401 Unauthorized
Authentication selected: Basic realm="depot"
Reusing existing connection to depot.ciq.com:443.
HTTP request sent, awaiting response... 200 OK
Length: 41748904 (40M) [application/octet-stream]
Saving to: ‘fuzzball-cli_amd64.deb’

fuzzball-cli_amd64.deb               100%[===================================================================>]  39.81M  25.9MB/s    in 1.5s

2025-05-12 15:51:24 (25.9 MB/s) - ‘fuzzball-cli_amd64.deb’ saved [41748904/41748904]

$ sudo apt install ./fuzzball-cli_amd64.deb
Reading package lists... Done
Building dependency tree... Done
Reading state information... Done
Note, selecting 'fuzzball-cli' instead of './fuzzball-cli_amd64.deb'
The following NEW packages will be installed:
  fuzzball-cli
0 upgraded, 1 newly installed, 0 to remove and 111 not upgraded.
Need to get 0 B/42.1 MB of archives.
After this operation, 0 B of additional disk space will be used.
Get:1 /tmp/fuzzball-cli_amd64.deb fuzzball-cli amd64 2.1.10-58-g9fb80d10d [42.1 MB]
Selecting previously unselected package fuzzball-cli.
(Reading database ... 156044 files and directories currently installed.)
Preparing to unpack /tmp/fuzzball-cli_amd64.deb ...
Unpacking fuzzball-cli (2.1.10-58-g9fb80d10d) ...
Setting up fuzzball-cli (2.1.10-58-g9fb80d10d) ...

$ fuzzball help
This fuzzball cli allows users to interface with a fuzzball cluster(s).
For additional documentation, please visit https://ui.stable.fuzzball.ciq.dev/docs

Usage:
  fuzzball [command]
[...snip]

macOS

Requirements

For users on macOS, the Fuzzball CLI is distributed as a Homebrew formula. To install it, you can download the formula definition file, which is available on the CIQ portal.

You will also need Homebrew installed on your system. Please consult the official Homebrew documentation for installation instructions.

Download the Formula File

Open your browser and navigate to CIQ portal. Make sure to select your organization that has access to Fuzzball in the lower part of the navigation pane on the left. (Or contact CIQ for access to this product.)

Then, Navigate to “My Products” –> “Fuzzball” –> “Fuzzball CLI RPMs” –> version –> architecture –> homebrew and download the file ending with .rb.

Currently, Homebrew formula files (.rb) are stored under the “Fuzzball CLI RPMs” heading even though they are not RPMs.

Set Environment Variables

You also need to set two environment variables in your terminal with your access token credentials. You can find these credentials in the “Access Token” tab in the CIQ portal. CIQ portal access
token page

Here’s an example of setting the environment variables in your terminal:

# export HOMEBREW_DEPOT_USERNAME="fake-username"
# export HOMEBREW_DEPOT_PASSWORD="some-fake-token"

Install the CLI

Once you have downloaded the formula definition file and set the environment variables, install the Fuzzball CLI using Homebrew:

# brew install /path/to/downloaded/fuzzball-cli.rb

Replace /path/to/downloaded/fuzzball-cli.rb with the actual path to the downloaded file.

Verify Installation

You can verify that the Fuzzball CLI has been installed successfully by checking your Homebrew package list:

# brew list | grep fuzzball

You can also test the CLI directly:

# fuzzball --help

This should display the Fuzzball CLI help information, confirming that the installation was successful.

Windows

To install the Fuzzball CLI on Windows, you can use the Windows Subsystem for Linux (WSL). On modern Windows distributions, you can simply open PowerShell as an administrator and execute the wsl --install command to get started. Check the WSL installation docs for more detailed instructions.

If you’d like to use Rocky Linux within WSL, you can follow the instructions detailed in the Rocky documentation.

Once you have WSL set up with the Linux distribution of your choice, you can follow either the RPM or deb installation instructions by clicking on the appropriate tab above.