summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md7
1 files changed, 7 insertions, 0 deletions
diff --git a/README.md b/README.md
index 64faa20..2d526f3 100644
--- a/README.md
+++ b/README.md
@@ -28,6 +28,7 @@ The program can be invoked with various command-line options to customize the ge
- `--output-format`: The output format for the report, one of `Plaintext`, `Markdown`, `Gemtext` (default: `Plaintext`)
- `--all`: Generate all possible reports except `Kernel` (optional)
- `--include-kernel`: Include the `Kernel` category when generating all reports (optional)
+- `--stats-order`: Comma-separated list of `Category:Metric` pairs to order sections for `--all` (optional). Unlisted sections are appended in the default order.
### Example Usage
@@ -37,6 +38,12 @@ The program can be invoked with various command-line options to customize the ge
This command generates a Markdown-formatted report for the top 10 hosts with the highest uptime.
+```bash
+./guprecords.raku --stats-dir="./records" --all --stats-order="Host:Uptime,Host:Boots"
+```
+
+This command generates all reports, placing the `Host:Uptime` section first, followed by `Host:Boots`, and then the remaining sections in the default order.
+
## Classes
- `Epoch`: A class representing the epoch value.