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.
Select a version and architecture
Section titled “Select a version and architecture”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 -m | QHx artifact architecture |
|---|---|
x86_64 | amd64 |
aarch64 or arm64 | arm64 |
Set the exact version and selected architecture:
QHX_VERSION=v0.12.0QHX_ARCH=amd64The latest tag follows the current stable release and is convenient for
exploration, but it can change. Use an exact version when repeatability matters.
Retrieve the OCI artifact
Section titled “Retrieve the OCI artifact”The supported OCI retrieval contract uses
ORAS and produces bin/qhx:
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/qhxsudo install -m 0755 bin/qhx /usr/local/bin/qhxqhx --versionFor the example above, the final command reports:
qhx v0.12.0The 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.
Customer portal download
Section titled “Customer portal download”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.