diff --git a/README.md b/README.md index 31d41e9..f2f1b63 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,52 @@ -# pve-toolkit +# Proxmox VE Toolkit + +A terminal-based menu for common Proxmox VE administration tasks. It uses `whiptail` to display menus and runs Proxmox command-line tools on the local node. + +> **Development software:** This toolkit is still in development and has not been validated for production use. Use it only in a test environment. + +## Features + +- List VMs and containers, view their names, status, and configuration +- Start, gracefully shut down, or reboot a VM or container +- List, create, and delete VM or container snapshots +- Back up and restore VMs or containers +- Unlock VMs or containers +- View cluster resources, nodes, and recent tasks +- Check Proxmox storage status and display LVM reports +- View cluster status, Proxmox version, subscription status, and host performance + +## Requirements + +- Proxmox VE +- Go to build the program +- `whiptail` +- Root access to run the program + +On Debian-based systems, install `whiptail` with: + +``` +apt install whiptail +``` +## Build + +Save the source code as main.go, then build it with: +``` +go build -o proxmox-toolkit main.go +``` +## Run + +Run the program as root on a Proxmox VE node: +``` +sudo ./proxmox-toolkit +``` + +The toolkit displays a development warning at startup. Review each action and its target before confirming it. Some operations can change guest or cluster state. + +## Safety notes + + This software is intended for testing, not production use. + Snapshot creation and deletion affect guest state and storage. + Backups and restores can consume significant storage and may create or overwrite resources. + Unlock a guest only after confirming no task is still running for it. + A snapshot is not a substitute for a backup. -A basic toolkit for administrating a Proxmox VE server \ No newline at end of file