Installing ROCm CLI#
ROCm CLI ships as a single prebuilt binary. Platform support:
Platform |
Prebuilt binary |
Notes |
|---|---|---|
Linux (x86_64) |
Yes |
Ubuntu 24.04 or newer; full support, including the live dashboard and both inference engines |
Windows (x86_64) |
Yes |
CLI and Lemonade serving; no live dashboard or vLLM |
WSL2 (x86_64) |
Yes (Linux binary) |
Ubuntu 24.04 or newer; full support, including the live dashboard |
macOS |
No |
No official installer, release, CI, or QA coverage |
For WSL2 setup and diagnosis, see ROCm CLI on WSL2.
Live dashboard telemetry requires Linux or WSL2 (see Interactive interfaces). vLLM serving is Linux or WSL2 only (see vLLM adapter).
The minimum supported Linux release, native or under WSL2, is Ubuntu 24.04. On
other distributions the equivalent requirement is glibc 2.38 with
GLIBCXX_3.4.32: that is what the Lemonade engine is linked against, and every
published build of it needs those versions, so there is no older release to fall
back to. Ubuntu 22.04 ships glibc 2.35 and cannot run it; Ubuntu 24.04 provides
glibc 2.39 and GLIBCXX_3.4.33.
The installer downloads a prebuilt bundle, verifies its SHA-256 checksum,
installs the rocm and rocmd binaries into ~/.local/bin, and adds that
directory to your shell PATH. Rerun it any time to upgrade.
Linux and WSL2 (x86_64)#
curl -fsSL https://raw.githubusercontent.com/ROCm/rocm-cli/main/install.sh | sh
This tracks the default release channel. For nightly builds, pass the
nightly channel instead:
curl -fsSL https://raw.githubusercontent.com/ROCm/rocm-cli/main/install.sh | sh -s -- nightly
Windows (x86_64, PowerShell)#
irm https://raw.githubusercontent.com/ROCm/rocm-cli/main/install.ps1 | iex
This tracks the default release channel. For nightly builds, set
ROCM_CLI_CHANNEL to nightly first:
$env:ROCM_CLI_CHANNEL = "nightly"
irm https://raw.githubusercontent.com/ROCm/rocm-cli/main/install.ps1 | iex
Verify the installation#
Open a new terminal so the updated PATH takes effect, then run:
rocm version
The output shows the ROCm CLI version with its release tag or branch and commit
hash, the ROCm SDK that ROCm CLI would use on this computer, and the GPU driver
version. A successful install prints the CLI version line. The SDK and driver
lines read not detected when none is found, which is expected on a computer
where you haven’t installed ROCm or a driver yet.
If the shell reports rocm: command not found, confirm that the install
directory is on your PATH. That is ~/.local/bin on Linux,
%USERPROFILE%\.local\bin on Windows, or the folder you set with
ROCM_CLI_INSTALL_DIR.
Build from source#
Building requires Rust; the pinned toolchain in
rust-toolchain.toml (currently 1.96.0) installs automatically through rustup.
git clone https://github.com/ROCm/rocm-cli
cd rocm-cli
cargo build --release
This produces the two binaries under target/release/:
rocm: the CLI and interactive interfacesrocmd: the background telemetry daemon used by the dashboard
Run without installing:
cargo run --release --bin rocm -- examine
Or copy the release binaries onto your PATH:
install -m 0755 target/release/rocm target/release/rocmd ~/.local/bin/
See Contributing for the full development setup, test commands, and commit-signing requirements.
Uninstall ROCm CLI#
To remove ROCm CLI and what it manages:
rocm uninstall
Pass --dry-run first to preview what it removes. For the full flag list, see
Logs and cleanup.