Skip to content

Commit e2f5da5

Browse files
authored
Add guest comment display option and bump to 2.9.0 (#15)
Closes #14
2 parents e0405fc + 620d58f commit e2f5da5

3 files changed

Lines changed: 267 additions & 15 deletions

File tree

CHANGELOG.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
# 📝 Changelog
22

3+
- 2.9.0
4+
- Add an optional `--show-comments` flag and corresponding interactive option to show a short label derived from the latest PBS snapshot comment next to each VM/CT in the per‑guest summary and interactive search‑path selector (best‑effort, using `proxmox-backup-debug api get /admin/datastore/<DATASTORE>/snapshots`).
5+
- Simplify the per‑guest overview output by removing the raw byte count from each line and keeping only the human‑readable IEC size (GiB / MiB / TiB) to improve readability.
36
- 2.8.1
47
- Rename the main script file from `PBS_Chunk_Checker.py` to `pbs_chunk_checker.py` and adjust the self‑update logic and GitHub release workflow accordingly.
58
- Make the codebase more PEP‑8 compliant (import grouping, line breaks, and long f‑strings) without changing runtime behavior.

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ It calculates the **real disk space usage** of a specific **namespace**, **VM**,
99

1010
This allows accurate insights into space consumption per tenant or object — useful for chargeback, reporting, and storage optimization.
1111

12-
**Current version:** 2.8.1 (`./pbs_chunk_checker.py --version`)
12+
**Current version:** 2.9.0 (`./pbs_chunk_checker.py --version`)
1313

1414
See full changes in `CHANGELOG.md`.
1515

@@ -76,7 +76,7 @@ In interactive mode you can:
7676
- Select an existing datastore from the list or enter one manually
7777
- Navigate the datastore directory structure and choose the search path (or enter it manually)
7878
- Scan all guests within the current path (datastore root or a selected namespace) to get a per-guest size overview, sorted by usage
79-
- Open the Options overlay (press `o`) to adjust threads and toggle emoji output
79+
- Open the Options overlay (press `o`) to adjust threads, toggle emoji output, and enable guest comments next to IDs
8080
- When starting the full datastore scan you will see a warning and must confirm with `Proceed anyway? [y/N]` (English prompt) because the run can take a long time.
8181

8282
Interactive controls (TUI):
@@ -104,6 +104,7 @@ More threads can significantly speed up evaluations on fast storage and when man
104104
Defaults: `2 × CPU cores`, capped at `32`.
105105

106106
You can change the value in interactive mode by pressing `o` (Options) or by passing `--threads N` on the command line. Within the Options overlay you can also toggle emoji output (equivalent to `--no-emoji`) using the Space key.
107+
You can additionally enable showing a short guest label derived from the latest snapshot comment next to each VM/CT ID via the Options overlay or the `--show-comments` flag.
107108

108109
### Portable execution (no local file)
109110
Stream the script from GitHub and execute it immediately.
@@ -134,6 +135,7 @@ Notes:
134135
| `--all-guests` | Optional | Scan the entire datastore (or only the namespace given via `--searchpath`) and print a per-guest size summary (requires `--datastore`) ||
135136
| `--threads` | Optional | Degree of parallelism for parsing index files and statting chunks | `2 × CPU cores (max 32)` |
136137
| `--no-emoji` | Optional | Replace emoji icons in CLI output with ASCII labels | Emoji output |
138+
| `--show-comments` | Optional | Show a short guest label derived from the latest snapshot comment next to each VM/CT in per-guest summaries and interactive path selection | Disabled |
137139
| `--version` | Optional | Show the script version and exit ||
138140
| `--update` | Optional | Check for new releases and offer self-update, then exit ||
139141

0 commit comments

Comments
 (0)