Befehle

Alle Befehle, Argumente und Optionen von entgeltatlas 0.5.1, 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	`https://rest.arbeitsagentur.de`
`--api-key <key>`	X-API-Key header value (env: ENTGELTATLAS_API_KEY)
`--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, default 2; each waits the server's Retry-After, up to 30 s)
`--max-response-bytes <n>`	cap response body size in bytes (0 = unlimited; default 100 MiB)
`--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

`entgeltatlas obtain-key`

Obtain the public X-API-Key this API requires and print it. The key is published by the Bundesagentur für Arbeit and is not a secret; none is bundled with this package, so it is read from the source at run time.

entgeltatlas obtain-key [options]

Optionen

Option	Beschreibung	Standard
`--export`	print "export ENTGELTATLAS_API_KEY=<key>" for use with eval

`entgeltatlas config`

the API key, kept in a credentials file of its own: $XDG_CONFIG_HOME/entgeltatlas/credentials, else ~/.config/entgeltatlas/credentials (api-key)

`entgeltatlas config set`

store a credential: typed at a prompt without echo, or piped in (entgeltatlas obtain-key | entgeltatlas config set api-key) — never given as an argument

entgeltatlas config set [options] <name>

Argumente

<name> erforderlich: api-key

`entgeltatlas config get`

show a stored credential, masked (abcd…wxyz, or **** below 20 characters) unless --reveal

entgeltatlas config get [options] <name>

Argumente

<name> erforderlich: api-key

Optionen

Option	Beschreibung	Standard
`--reveal`	print the whole value, for a script that passes it on — it then is on your screen or in its log

`entgeltatlas config unset`

remove a stored credential

entgeltatlas config unset [options] <name>

Argumente

<name> erforderlich: api-key

`entgeltatlas config list`

every stored credential, masked, and where the file is

entgeltatlas config list [options]

`entgeltatlas entgelte`

Gross-salary statistics for a KldB-2010 occupation code

entgeltatlas entgelte [options] <kldb>

Argumente

<kldb> erforderlich: KldB-2010 occupation code (3–5 digits, e.g. 84304)

Optionen

Option	Beschreibung	Standard
`-l, --level <code>`	Anforderungsniveau 1–4 (see `codes`)
`-r, --region <code>`	Region 1–30 (see `codes`)
`-g, --gender <code>`	Geschlecht 1–3 (see `codes`)
`-a, --age <code>`	Alter 1–4 (see `codes`)
`-b, --branch <code>`	Branche 1–11 (see `codes`)

`entgeltatlas regionen`

List region codes (the `r` dimension)

entgeltatlas regionen [options]

`entgeltatlas geschlechter`

List gender codes (the `g` dimension)

entgeltatlas geschlechter [options]

`entgeltatlas alter`

List age-band codes (the `a` dimension)

entgeltatlas alter [options]

`entgeltatlas branchen`

List branch/industry codes (the `b` dimension)

entgeltatlas branchen [options]

`entgeltatlas codes`

Print the dimension code tables (l/r/g/a/b) — works offline, no API key

entgeltatlas codes [options]