Befehle

Alle Befehle, Argumente und Optionen von jobsuche 0.6.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.

OptionBeschreibungStandard
-V, --version output the version number
--base-url <url> API base URL https://rest.arbeitsagentur.de
--api-key <key> X-API-Key header value. Prefer JOBSUCHE_API_KEY or `jobsuche config set api-key`: an --api-key argument is visible to other local users via the process table and shell history.
--timeout <ms> per-request timeout in milliseconds
--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)
--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

jobsuche 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.

jobsuche obtain-key [options]

Optionen

OptionBeschreibungStandard
--export print "export JOBSUCHE_API_KEY=<key>" for use with eval

jobsuche config

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

jobsuche config set

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

jobsuche config set [options] <name>

Argumente

<name> erforderlich
api-key

jobsuche config get

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

jobsuche config get [options] <name>

Argumente

<name> erforderlich
api-key

Optionen

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

jobsuche config unset

remove a stored credential

jobsuche config unset [options] <name>

Argumente

<name> erforderlich
api-key

jobsuche config list

every stored credential, masked, and where the file is

jobsuche config list [options]

jobsuche details

Full job details by reference number (refnr) or encoded code

jobsuche details [options] <refnrOrCode>

Argumente

<refnrOrCode> erforderlich
reference number (referenznummer) or encoded code