Skip to main content

Install CLI

Install the Uncloud command-line utility to manage your machines and deploy apps using uc commands. You will run uc locally so choose the appropriate installation method for your operating system.

NOTE

Windows is not natively supported yet, but you can install and run uc in a WSL terminal by following the instructions for Linux.

Homebrew (macOS, Linux)​

If you have Homebrew package manager installed, this is the recommended installation method on macOS and Linux:

brew install psviderski/tap/uncloud

To upgrade to the latest version:

brew upgrade uncloud

Install script (macOS, Linux)​

For a quick automated installation, use the install script:

curl -fsS https://get.uncloud.run/install.sh | sh

The script will:

  • Detect your operating system and architecture
  • Download the appropriate latest binary from GitHub releases
  • Install it to /usr/local/bin/uncloud using sudo (you may need to enter your user password)
  • Create a shortcut uc in /usr/local/bin for convenience

Don't like curl | sh? You can download and review the install script first and then run it:

curl -fsSO https://get.uncloud.run/install.sh
cat install.sh
sh install.sh

GitHub download (macOS, Linux)​

You can manually download and use a pre-built binary from the latest release on GitHub.

curl -L https://github.com/psviderski/uncloud/releases/latest/download/uncloud_macos_arm64.tar.gz | tar xz
mv uncloud uc

You can use the ./uc binary directly from the current directory, or move it to a directory in your system's PATH to run it as uc from any location.

For example, move it to /usr/local/bin which is a common location for user-installed binaries:

sudo mv ./uc /usr/local/bin

Follow the same steps to upgrade to the latest version in the future.

Debian​

On a Debian system, you can install Uncloud CLI from an unofficial repository maintained by @dariogriffo:

curl -sS https://debian.griffo.io/EA0F721D231FDD3A0A17B9AC7808B4DD62C41256.asc | sudo gpg --dearmor --yes -o /etc/apt/trusted.gpg.d/debian.griffo.io.gpg
echo "deb https://debian.griffo.io/apt $(lsb_release -sc 2>/dev/null) main" | sudo tee /etc/apt/sources.list.d/debian.griffo.io.list
apt install -y uncloud

Alternatively, you can download .deb packages directly from the repository releases page.

Verify installation​

After installation, verify that uc command is working:

uc --version

Next steps​

Now that you have uc installed, you're ready to: