uc commands. You will run uc locally on your development machine, so choose the appropriate installation method for your operating system.
The Uncloud CLI is a local tool. It doesn’t need to be installed on your servers. The
uc machine init command will automatically install the necessary components (uncloudd daemon) on your remote machines.macOS
Homebrew (recommended)
If you have Homebrew package manager installed, this is the recommended installation method:uncloud binary and creates a convenient uc shortcut.
To upgrade to the latest version:
Install script
For a quick automated installation without Homebrew:- Detect your macOS architecture (Apple Silicon or Intel)
- Download the appropriate latest binary from GitHub releases
- Install it to
/usr/local/bin/uncloudusingsudo(you may need to enter your password) - Create a shortcut
ucin/usr/local/binfor convenience
Manual download
Download the binary directly from GitHub releases:- Apple Silicon (M1/M2/M3)
- Intel
Linux
Install script (recommended)
The easiest way to install on Linux:- Auto-detect your Linux architecture (AMD64 or ARM64)
- Download the latest binary
- Install to
/usr/local/bin/uncloud - Create the
ucshortcut - Verify the installation with checksum validation
Homebrew
If you have Homebrew installed on Linux:Manual download
- AMD 64-bit
- ARM 64-bit
Debian/Ubuntu package
On Debian-based systems, you can install from an unofficial repository maintained by @dariogriffo:.deb packages directly from the repository releases.
Windows
Windows is not natively supported yet, but you can install and runuc in a WSL (Windows Subsystem for Linux) terminal.
Install from source
If you have Go 1.21 or later installed, you can build from source:$GOPATH/bin/uncloud. Make sure $GOPATH/bin is in your PATH.
To create the uc shortcut:
Custom installation directory
By default, the install script places binaries in/usr/local/bin. You can customize this:
PATH.
Verify installation
After installation, verify that theuc command works:
Update Uncloud
The update process depends on your installation method: Homebrew:Uninstall
To remove the Uncloud CLI from your local machine: Homebrew:Uninstalling the CLI from your local machine doesn’t affect Uncloud components running on your servers. To remove Uncloud from a machine, SSH into it and run
uncloud-uninstall.Troubleshooting
Command not found
If you getcommand not found: uc after installation:
-
Check that
/usr/local/binis in your PATH: -
If not, add it to your shell profile (
~/.bashrc,~/.zshrc, etc.): -
Reload your shell:
Permission denied
If you get permission errors when running the install script, make sure you’re usingsudo or the script is using sudo internally. The script needs to write to /usr/local/bin.
Checksum verification failed
If checksum verification fails during installation:- Try downloading again (might be a network issue)
- Check the GitHub releases page for known issues
- Manually download and verify the checksums
Next steps
Quickstart
Deploy your first app in minutes
CLI reference
Explore all available commands
