Document installing cv4pve-tui as a uv tool #28

Merged
Duckboot merged 1 commits from docs/install-as-tool-17 into main 2026-11-03 01:32:52 +01:00
Showing only changes of commit ff6345c80f - Show all commits
+17
View File
@@ -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
```