Befehle

Alle Befehle, Argumente und Optionen von ausbildungssuche 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: AUSBILDUNGSSUCHE_API_KEY)
`--timeout <ms>`	time limit per request in milliseconds, whole response included (default 30000; 0 = no limit)
`--user-agent <ua>`	User-Agent header value
`--max-retries <n>`	retries for transient 429/503 responses (0..10; 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

`ausbildungssuche obtain-key`

Obtain the public X-API-Key this API requires and print it. The key is the same for everyone and not a secret; it is documented by the community project bundesAPI (github.com/bundesAPI/ausbildungssuche-api), not by the Bundesagentur für Arbeit. None is bundled with this package, so it is read from that README at run time.

ausbildungssuche obtain-key [options]

Optionen

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

`ausbildungssuche config`

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

`ausbildungssuche config set`

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

ausbildungssuche config set [options] <name>

Argumente

<name> erforderlich: api-key

`ausbildungssuche config get`

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

ausbildungssuche 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

`ausbildungssuche config unset`

remove a stored credential

ausbildungssuche config unset [options] <name>

Argumente

<name> erforderlich: api-key

`ausbildungssuche config list`

every stored credential, masked, and where the file is

ausbildungssuche config list [options]

`ausbildungssuche search`

Search apprenticeship/training offers

ausbildungssuche search [options]

Optionen

Option	Beschreibung	Standard
`--sw <text>`	search keyword (sw); currently ignored by the API, use --ids to filter by occupation
`--sty <n>`	offer type 0..3 (sty)
`--orte <loc>`	location as "Name_lon_lat", longitude first, e.g. "Köln_6.957_50.938", or several comma-separated (orte); needs --uk
`--re <code>`	Bundesland code (re), e.g. BAY, NRW, THÜ; comma-separated or repeated for several
`--uk <radius>`	radius around --orte: 10, 25, 50, 100 (km), or "Bundesweit" (uk); a km radius needs --orte
`--ids <id>`	numeric occupation id(s), the dkzId from angebot.systematiken[]; comma-separated or repeated for several (ids)
`--bart <type>`	numeric training type, the bildungsart.id, e.g. 102 Berufsausbildung (bart)
`--bg`	only offers eligible for an education voucher (bg)
`--bt <code>`	start-date code(s) (bt): 2 = earlier dates, 101..112 = January..December of the following year; 0 and 1 filter too, meaning undocumented; not a date. Comma-separated or repeated for several
`--page <n>`	0-based page
`--size <n>`	page size, 1..20 (the server serves at most 20 rows per page)

`ausbildungssuche details`

Full details for one apprenticeship offer by id

ausbildungssuche details [options] <id>

Argumente

<id> erforderlich: numeric offer id