Common Options¶
All hipo-utils tools share a set of common command-line options.
Universal Options¶
These options are available in all tools:
| Option | Description |
|---|---|
-h, --help | Show help message and exit |
-v, --version | Show version information and exit |
--no-color | Disable colored output |
-q, --quiet | Suppress progress and informational output |
Output Format Options¶
Tools that produce text output support multiple formats:
| Option | Description |
|---|---|
-f, --format <fmt> | Output format: plain, csv, json |
--json | Shorthand for --format json |
Tools: hipo-dump, hipo-stats, hipo-search
Format Details¶
| Format | Description | Use Case |
|---|---|---|
plain | Human-readable text with alignment | Interactive use |
csv | Comma-separated values | Spreadsheets, data import |
json | JSON objects | Scripting, web integration |
Bank Selection Options¶
Many tools support selecting specific banks:
| Option | Description |
|---|---|
-b, --banks <names> | Specify banks (comma-separated) |
-I, --include-banks <banks> | Include only specified banks |
-E, --exclude-banks <banks> | Exclude specified banks |
Wildcard Patterns¶
Bank selection supports * wildcards:
# All REC banks
-I "REC::*"
# Exclude all RAW banks
-E "RAW::*"
# Multiple patterns
-E "RAW::*,COAT::*"
Event Range Options¶
Control which events are processed:
| Option | Description |
|---|---|
-e, --events <range> | Event range (e.g., 0-100, 50) |
-n, --nevents <n> | Number of events to process |
-s, --start <n> | Starting event index |
Range Syntax¶
Exit Codes¶
Most tools use consistent exit codes:
| Code | Meaning |
|---|---|
0 | Success |
1 | Error / Failure / Differences found |
2 | Usage error / File not found |
Scripting Tips¶
Disable Colors¶
Always use --no-color when parsing output:
Quiet Mode¶
Use -q to suppress progress bars and informational messages: