Skip to main content

Install and authenticate

Install the CLI, then provide a short-lived, narrowly scoped API key through the environment. The GitHub source install is available immediately:
On Windows PowerShell, Bun may print a PATH warning after a global install. Add its global bin directory to the current session, then run the command:
If you installed the GitHub package before the latest CLI build was published, reinstall it once to refresh the bundled executable:
To persist the path for future PowerShell windows, add C:\Users\<you>\.bun\bin to your user Path environment variable and open a new terminal. The CLI is distributed from GitHub. Do not use npm registry installation commands for this package; @kmerhosting/cli is not a published npm package. The installed command is kmerhosting. Use --json for machine-readable output and --base-url only when KmerHosting support has given you a non-production endpoint.

Resource commands

LXC and KVM are deliberately separate. lxc exposes inventory, metrics, power, snapshots, password rotation, reinstall, short-lived terminal tickets, auto-renew, and billing-period operations. kvm exposes inventory, power, credentials, renewal, cancellation/recovery, and the complete snapshot lifecycle for owned KVM services. The retired vps resource returns a migration message instead of guessing the product.
Run kmerhosting --help for the complete command list. For writes, --idempotency-key VALUE lets a retry reuse the same logical request. Destructive operations require --yes.

Safe automation

Set the API key only in a protected server environment. Every write must have a unique idempotency key. Dangerous LXC and KVM scopes require a matching IPv4 allowlist on the key; do not automate those actions from an untrusted or dynamic address. Password arguments can remain in shell history, so prefer a protected automation environment and clear history according to your operating-system policy. See API keys and scopes before using the CLI in CI.