cloudcenmax-cli

Command-line client for the CloudCenmax platform API. Deploy and manage cloud VPS servers, browse the catalog, check your balance, and run provider actions — all from your terminal, with stable exit codes and --json output built for scripts and CI.

Install

npm install -g cloudcenmax-cli

Requires Node 18 or newer. Works on macOS, Linux, and Windows.

Quickstart

# Authenticate with an API key from https://cloudcenmax.com/api-keys
cmx login

# Deploy a server (hostname must be 6+ chars, alphanumeric / - / _ / .)
cmx resources deploy --sku <sku-code> --name web-prod --template ubuntu-24
cmx resources list

Commands

cmx account                             Show org balance and dunning status
cmx catalog list [--all]                Browse the SKU catalog
cmx catalog show <code>                 Inspect a single SKU
cmx catalog templates [--search …]      List OS templates for `--template`
cmx resources list [--all]              List your resources
cmx resources show <id>                 Show one resource
cmx resources deploy --sku --name       Provision a new resource
                      --template …      Pass `--template ubuntu` or numeric id
cmx resources start|stop|reboot <id>    Control the lifecycle
cmx resources delete <id>               Terminate a resource
cmx resources actions <id>              List provider-specific actions
cmx resources action <id> <key>         Execute a provider action
cmx resources buckets …                 Manage S3-compatible buckets
cmx ledger list [--all]                 View billing ledger
cmx deposits list [--all]               List deposit transactions
cmx deposits create <amount>            Top up your balance

Global flags: --json (raw output), --profile <name> (switch accounts), --base-url <url>, --api-key <key>, --all (follow pagination).

Configuration

Credentials are resolved in this order (first match wins):

1. Explicit flags: --api-key, --base-url
2. Environment variables: CCM_API_KEY, CCM_BASE_URL, CCM_PROFILE
3. The config file written by cmx login: ~/.cloudcenmax/config.json (mode 600)

Scripting

# Machine-readable output for any command
cmx resources list --json | jq -r '.[] | select(.status=="active").name'

# Stable exit codes for CI gates
cmx account --json || echo "blocked, exit $?"

Exit codes: 0 success · 1 generic · 2 auth · 3 permission · 4 insufficient balance · 5 invalid state / validation · 6 rate limited · 7 network error.

License

MIT