Every command, argument and option of jobsuche 0.6.1, 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 | 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-keyObtain 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]Options
| Option | Description | Default |
|---|---|---|
--export |
print "export JOBSUCHE_API_KEY=<key>" for use with eval |
jobsuche configthe API key, kept in a credentials file of its own: $XDG_CONFIG_HOME/jobsuche/credentials, else ~/.config/jobsuche/credentials (api-key)
jobsuche config setstore 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>Arguments
<name>
requiredjobsuche config getshow a stored credential, masked (abcd…wxyz, or **** below 20 characters) unless --reveal
jobsuche config get [options] <name>Arguments
<name>
requiredOptions
| Option | Description | Default |
|---|---|---|
--reveal |
print the whole value, for a script that passes it on — it then is on your screen or in its log |
jobsuche config unsetremove a stored credential
jobsuche config unset [options] <name>Arguments
<name>
requiredjobsuche config listevery stored credential, masked, and where the file is
jobsuche config list [options]jobsuche searchSearch job listings
jobsuche search [options]Options
| Option | Description | Default |
|---|---|---|
--was <text> |
job title / keyword (was) | |
--wo <text> |
location (wo) | |
--berufsfeld <text> |
occupational field | |
--arbeitgeber <text> |
employer name, exact and case-sensitive (e.g. "Siemens AG") | |
--umkreis <km> |
radius in km around the location (0-200) | |
--veroeffentlicht-seit <days> |
published within the last N days (0-100) | |
--zeitarbeit |
only temp-work agency listings (default: included with the rest) | |
--no-zeitarbeit |
leave out temp-work agency listings | |
--angebotsart <code> |
offer type code: 1 job, 2 self-employment, 4 apprenticeship/dual study, 34 internship/trainee | |
--page <n> |
1-based page (1 or more) | |
--size <n> |
page size |
jobsuche detailsFull job details by reference number (refnr) or encoded code
jobsuche details [options] <refnrOrCode>Arguments
<refnrOrCode>
required