Skip to content

Install the QHx CLI

Install qhx on the connected administrative host before using the recommended qhx install workflow. QHx publishes a separate Linux executable for amd64 and arm64; select the artifact that matches the machine where the CLI will run, not necessarily the Kubernetes nodes it will manage.

Use an exact release version for a controlled installation. The examples use v0.12.0; replace it with the release you intend to install.

Map the host architecture reported by uname -m as follows:

uname -mQHx artifact architecture
x86_64amd64
aarch64 or arm64arm64

Set the exact version and selected architecture:

Terminal window
QHX_VERSION=v0.12.0
QHX_ARCH=amd64

The latest tag follows the current stable release and is convenient for exploration, but it can change. Use an exact version when repeatability matters.

The supported OCI retrieval contract uses ORAS and produces bin/qhx:

Terminal window
oras login oci.messier42.com
mkdir "qhx-cli-${QHX_VERSION}-${QHX_ARCH}"
cd "qhx-cli-${QHX_VERSION}-${QHX_ARCH}"
oras pull \
--platform "linux/${QHX_ARCH}" \
"oci.messier42.com/qhx/cli-oras:${QHX_VERSION}"
test -f bin/qhx
sudo install -m 0755 bin/qhx /usr/local/bin/qhx
qhx --version

For the example above, the final command reports:

qhx v0.12.0

The platform-qualified children and the unqualified multi-platform index are published together. Do not treat crane pull output or an image tar layout as the CLI installation interface; the ORAS artifact’s bin/qhx path is the supported layout.

You can alternatively download the architecture-specific QHx CLI archive from the customer portal. Extract the archive, install its bin/qhx file on PATH, and verify it with qhx --version as shown above.

Registry authentication for later installs

Section titled “Registry authentication for later installs”

oras login and docker login can store credentials in standard Docker-compatible credential configuration. qhx install discovers credentials for its selected source registry from that configuration, including configured credential helpers and stores. You can instead use the supported environment variables or explicit flags described in the qhx install guide.

Use your organization’s approved credential-storage and secret-handling process. Never place a deployment key directly in documentation, source files, or shell history.