Commands

Every command, argument and option of bundeshaushalt 0.5.1, read from the CLI itself.

Global options

These options work with every command.

Option	Description	Default
`-V, --version`	output the version number
`--base-url <url>`	API base URL	`https://bundeshaushalt.de`
`--timeout <ms>`	time limit per request in milliseconds, whole response included (0 = no limit)	`30000`
`--user-agent <ua>`	User-Agent header value
`--max-retries <n>`	retries for transient 429/503 responses and reset connections (0..10; each waits the server's Retry-After, up to 30 s)	`2`
`--max-response-bytes <n>`	cap response body size in bytes (0 = unlimited; 100 MiB)	`104857600`
`--log-format <format>`	how errors, warnings and notes are written to stderr: text (log4j style: time, level, [topic], message) or jsonl (one JSON object per line: ts, level, topic, msg); default text
`--compact`	print JSON on a single line instead of pretty-printed

Federal budget data (account: expenses | income)

bundeshaushalt budget [options] <year> <account>

Arguments

Options

Option	Description	Default
`--quota <quota>`	planned vs realised (default target) Choices: target, actual
`--unit <unit>`	how elements are grouped (default single) Choices: single, function, group
`--id <id>`	element id: "G-…" a group, "F-…" a function, unprefixed the budget structure; must match --unit, which it sets when omitted

Federal expenses for a year (shortcut)

bundeshaushalt expenses [options] <year>

Arguments

Options

Option	Description	Default
`--quota <quota>`	planned vs realised (default target) Choices: target, actual
`--unit <unit>`	how elements are grouped (default single) Choices: single, function, group
`--id <id>`	element id: "G-…" a group, "F-…" a function, unprefixed the budget structure; must match --unit, which it sets when omitted

Federal income for a year (shortcut)

bundeshaushalt income [options] <year>

Arguments

Options

Option	Description	Default
`--quota <quota>`	planned vs realised (default target) Choices: target, actual
`--unit <unit>`	how elements are grouped (default single) Choices: single, function, group
`--id <id>`	element id: "G-…" a group, "F-…" a function, unprefixed the budget structure; must match --unit, which it sets when omitted