Skip to main content

​
Installing qumod

qumod is the official command-line interface and automation runtime for Qumo Deploy. It is compiled as a self-contained, native executable with no external dependencies (neither Node.js nor Deno is required on the host system). The installer downloads the binary for your platform from https://dl.qumo-deploy.com, verifies it against the release’s SHA256SUMS, and installs it to your home directory. It needs no sudo.
  • macOS & Linux install to ~/.qumod/bin/qumod. If that directory is not on your PATH, the installer prints the line to add to your shell profile.
  • Windows installs to %LOCALAPPDATA%\qumod\bin\qumod.exe and adds that directory to your user PATH. Open a new terminal afterwards.
Pin a version, or choose where to install, with environment variables:
The CLI is versioned separately from the control plane. https://dl.qumo-deploy.com/qumod/latest names the newest release. The download host keeps the newest 10 releases. An older pinned version stops installing once nine newer releases are out, so move a pin forward when you upgrade.

​
Manual Download

Each of the newest 10 releases is published under https://dl.qumo-deploy.com/qumod/v<version>/, with a SHA256SUMS file listing each binary’s checksum: For example, on Linux (x86_64):
On macOS, use shasum -a 256 -c - instead of sha256sum -c -.
The Linux binaries are built for glibc. Alpine and other musl-based images cannot run them; use a Debian- or Ubuntu-based image.

​
Verifying Installation

Verify that the CLI is installed properly and accessible:
Expected output:
You can also test JSON output format:

​
Updating

Update an installed qumod in place:
It reads https://dl.qumo-deploy.com/qumod/latest, downloads the binary for your platform, checks it against that release’s SHA256SUMS, and replaces the running executable. Nothing is installed if the download fails or the checksum does not match, and a binary that is already the latest is left alone. With --json, updated says whether it changed anything. QUMOD_DOWNLOAD_URL points the command at a mirror, as it does for the installers. The install directory must be writable by your user; a system-wide installation needs the same permissions as installing there in the first place. On Windows the replaced executable cannot be deleted while the updating process is still running. It is left beside the new one as qumod.exe.old-<pid>, and the next qumod update removes it.

​
Automatic Version Warnings

When invoked, qumod periodically checks whether a newer version is available (cached in ~/.qumo/version-cache.json for 24 hours with a 1.5-second network timeout). If your binary is outdated, it prints a non-blocking notification to stderr in text mode or as a JSON object on stderr when using --json, leaving stdout intact. Set QUMOD_NO_VERSION_CHECK=1 in automated environments to disable this check. You can also re-run the installer (it replaces the binary in place):
qumod version shows what you have.

​
Compatibility with the control plane

Every API response names the oldest qumod the control plane supports in the X-Min-Qumod-Version header. An older qumod prints a warning, and the control plane refuses its requests with HTTP 426 Upgrade Required; run qumod update. Until version 1.0.0, every released qumod is supported. From 1.0.0 on, qumod and the control plane share their MAJOR.MINOR version, and qumod is supported one MINOR version older or newer than the control plane (qumod 1.1.x with a 1.0.x or 1.2.x control plane).

​
Uninstalling

Delete the install directory, and the saved sign-in if you want that gone too. Run qumod logout first to also end the session on the control plane.
On Windows, also remove %LOCALAPPDATA%\qumod\bin from your user PATH (Settings → System → About → Advanced system settings → Environment Variables). If you installed with QUMOD_INSTALL, delete that directory instead.

​
Next Steps

Sign in, then run your first command:

Authentication Guide

Learn how to authenticate interactively via browser Device Flow or headless API tokens.