@fredlackey/cli-proxmox

Command-line interface for Proxmox VE node, VM, storage, and snapshot management. JSON output by default so AI agents and scripts can consume it directly, with a human-friendly mode when you're working interactively.

Install

npm install -g @fredlackey/cli-proxmox

Usage

Every command accepts credentials directly as flags. No setup step is required.

proxmox vm list \
  --base-url https://pve.example.com:8006 \
  --token-id 'root@pam!terraform-token' \
  --token-secret <secret>

proxmox vm clone \
  --base-url https://pve.example.com:8006 \
  --token-id 'root@pam!terraform-token' \
  --token-secret <secret> \
  --vmid 9000 \
  --newid 200 \
  --name web-prod \
  --full

If you've already run proxmox configure, you can omit the credential flags:

proxmox vm list
proxmox snapshot create \
  --vmid 200 \
  --snapname before-upgrade \
  --vmstate
proxmox storage content --storage local --content iso
proxmox task wait --upid <upid> --timeout 120

Configure (Optional)

The configure command is optional. Every command accepts credentials directly as flags (e.g. --base-url, --token-id, --token-secret). You never need to run configure to use this tool. It exists as a convenience so you don't have to pass the same flags on every invocation.

proxmox configure \
  --base-url https://pve.example.com:8006 \
  --token-id 'root@pam!terraform-token' \
  --token-secret <secret> \
  --default-node pm-b

Running proxmox configure without flags prompts for each value interactively. Credentials are stored in ~/.config/cli-proxmox/config.json and that file is the only config source. There are no environment variables to set.

TLS certificate verification is disabled by default since Proxmox typically uses self-signed certs. Pass --verify-ssl to configure if you have a properly signed certificate.

If a required credential is missing at runtime, the error tells you exactly what to do:

{
  "error": "Missing required value: --token-id. Pass it as a flag or run \"proxmox configure\"."
}

Full Command Reference

For the complete list of commands and flags, see COMMANDS.md.

Output

All commands write JSON to stdout by default. When run in an interactive terminal, output switches to a human-friendly format with colors. Use the global --json and --interactive flags to override the auto-detection.

Contributing

If you find a gap or have a feature request, open an issue or submit a pull request on GitHub.

Questions?

If you have questions, comments, or just want to talk shop, feel free to reach out.

Fred Lackey
[email protected]
https://fredlackey.com

License

Apache-2.0