Befehle

Alle Befehle, Argumente und Optionen von hochwasser 0.0.4, direkt aus der CLI gelesen.

Die Beschreibungen der Befehle, Argumente und Optionen stammen direkt aus der CLI und sind englisch.

Globale Optionen

Diese Optionen gelten für jeden Befehl.

Option	Beschreibung	Standard
`-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

Current regional flood alerts (Hochwasser-Warnungen) of the German states

hochwasser alerts [options]

Optionen

Option	Beschreibung	Standard
`--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 Werte: de, en
`--geojson`	output the alert areas as a GeoJSON FeatureCollection

Flood classification at the LHP gauges (no water levels — see pegel-online-cli)

hochwasser stations [options]

Optionen

Option	Beschreibung	Standard
`--states <codes>`	only these states — comma-separated codes, e.g. BY,SN (case-insensitive)
`--lang <lang>`	response language: de \| en Werte: 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

Per-state overview aggregated from the gauges: station count per lhpClass + worst class

hochwasser situation [options]

Optionen

Option	Beschreibung	Standard
`--states <codes>`	only these states — comma-separated codes, e.g. BY,SN (case-insensitive)
`--lang <lang>`	response language: de \| en Werte: de, en