Skip to content
VDuchauffourPublic

About

A k9s-like terminal UI for Proxmox VE

Resources

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

pvox

A k9s-like terminal UI for Proxmox VE clusters.

Features

  • Real-time cluster resource view (nodes, VMs, LXC, storage)
  • Start, stop, and reboot actions with confirmation prompts
  • CPU/memory sparkline history in detail view
  • Color-coded status indicators (with --no-color support)
  • Keyboard-driven navigation with filter search
  • Async task tracking for lifecycle operations

Install

cargo install pvox

Configuration

pvox reads ~/.config/pvox/config.yaml. CLI flags override file values:

connection:
  endpoint: https://pve.local
  token_id: root@pam!pvox
  secret: abc123
  insecure: true
ui:
  theme: default
refresh_interval: 5

CLI Flags

Usage: pvox [OPTIONS]

Options:
      --endpoint <ENDPOINT>  Proxmox endpoint URL
      --token-id <TOKEN_ID>  API token ID (e.g. root@pam!pvox)
      --secret <SECRET>        API token secret
      --insecure [<INSECURE>]  Allow insecure HTTPS (self-signed certs) [possible values: true, false]
      --config <CONFIG>      Path to config file
  -h, --help                 Print help


Development

To ensure that you follow the development workflow, please setup the pre-commit hooks:

just pre-commit-install

Note: This requires uv to be installed, as the hooks are run via uvx pre-commit.

Common tasks:

just      # list all recipes
just run  # cargo run
just test # cargo test
just ci   # fmt-check + lint-strict + test

About

A k9s-like terminal UI for Proxmox VE

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages