Every command, argument and option of hochwasser 0.0.4, read from the CLI itself.
These options work with every command.
| Option | Description | Default |
|---|---|---|
-V, --version |
output the version number | |
--base-url <url> |
API base URL (append /test for the LHP test system) | https://api.hochwasserzentralen.de/public/v1 |
--timeout <ms> |
time limit per request in ms, whole response included (0 = no timeout) | |
--user-agent <ua> |
User-Agent header value | |
--max-retries <n> |
retries for transient 429/503 responses (0..10) | |
--max-response-bytes <n> |
cap response body size in bytes (0 = unlimited; default 100 MiB) | |
--compact |
print JSON on a single line instead of pretty-printed | |
-o, --output <file> |
write output to this file instead of stdout | |
--force |
overwrite the --output file if it already exists |
hochwasser alertsCurrent regional flood alerts (Hochwasser-Warnungen) of the German states
hochwasser alerts [options]Options
| Option | Description | Default |
|---|---|---|
--states <codes> |
only these states — comma-separated codes, e.g. BY,SN (case-insensitive) | |
--cap |
include the Common Alerting Protocol (CAP) detail block per alert | |
--lang <lang> |
response language: de | en Choices: de, en | |
--geojson |
output the alert areas as a GeoJSON FeatureCollection |
hochwasser stationsFlood classification at the LHP gauges (no water levels — see pegel-online-cli)
hochwasser stations [options]Options
| Option | Description | Default |
|---|---|---|
--states <codes> |
only these states — comma-separated codes, e.g. BY,SN (case-insensitive) | |
--lang <lang> |
response language: de | en Choices: de, en | |
--water <name> |
only stations whose water (river) name contains this text, case-insensitive | |
--min-class <n> |
only stations with lhpClass >= n (-1 no data .. 4 sehr großes Hochwasser; gauges without a class are dropped) | |
--geojson |
output the stations as a GeoJSON FeatureCollection of points |
hochwasser situationPer-state overview aggregated from the gauges: station count per lhpClass + worst class
hochwasser situation [options]Options
| Option | Description | Default |
|---|---|---|
--states <codes> |
only these states — comma-separated codes, e.g. BY,SN (case-insensitive) | |
--lang <lang> |
response language: de | en Choices: de, en |