diff --git a/README.md b/README.md index b76f256..e400928 100644 --- a/README.md +++ b/README.md @@ -11,8 +11,25 @@ It shells out to `cv4pve-cli` and uses its current context (`cv4pve-cli config u it stores no credentials itself. Tested with cv4pve-cli 2.4.0; with another version the app warns at startup, because it parses output formats that are not a stable API. +## Install + +Needs [uv](https://docs.astral.sh/uv/) and a working `cv4pve-cli` on `PATH`. + +```sh +uv tool install git+https://git.duckboot.net/Duckboot/cv4pve-cli-tui +cv4pve-tui # from any directory +uv tool upgrade cv4pve-tui # later: get the newest main +uv tool uninstall cv4pve-tui +``` + +From a local checkout instead: `uv tool install .` (add `--force` to reinstall after +changes). + ## Run + +Installed: `cv4pve-tui`. From a checkout without installing: + ```sh uv run cv4pve-tui ```