Befehle

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

Option	Beschreibung	Standard
`-V, --version`	output the version number
`--base-url <url>`	API base URL	`https://fragdenstaat.de`
`--timeout <ms>`	per-request timeout in milliseconds (0..2147483647)
`--user-agent <ua>`	User-Agent header value
`--max-retries <n>`	retries for transient 429/503 responses and connection resets (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
`-o, --output <file>`	write output (JSON, or CSV with --csv) to this file ("-" = stdout)
`--force`	with -o, overwrite the output file if it already exists

`fragdenstaat request`

FOI requests (Informationsfreiheitsanfragen) — the central resource

`fragdenstaat request list`

List/filter public FOI requests

fragdenstaat request list [options]

Optionen

Option	Beschreibung	Standard
`--status <status>`	filter by lifecycle status Werte: awaiting_user_confirmation, publicbody_needed, awaiting_publicbody_confirmation, awaiting_response, awaiting_classification, asleep, resolved
`--resolution <resolution>`	filter by outcome (resolved requests) Werte: successful, partially_successful, not_held, refused, user_withdrew_costs, user_withdrew
`--jurisdiction <id>`	filter by jurisdiction id
`--law <id>`	filter by FOI law id
`--categories <name>`	filter by the exact category name, case-sensitive (e.g. "Umwelt"; not an id or slug)
`--classification <name>`	filter by the exact public-body classification name, case-sensitive (e.g. "Ministerium")
`--campaign <id>`	filter by campaign id ("-" = requests in no campaign)
`--public-body <id>`	filter by addressed public-body id
`--tags <tag>`	filter by one tag name, exact and case-sensitive
`--reference <prefix>`	filter by reference (prefix match)
`--slug <slug>`	filter by exact slug
`--is-foi [bool]`	only genuine FOI requests (true/false)
`--checked [bool]`	only moderator-checked requests (true/false)
`--has-same [bool]`	only requests with identical copies (true/false)
`--costs-min <eur>`	minimum charged costs in EUR
`--costs-max <eur>`	maximum charged costs in EUR
`--created-after <date>`	created on/after this date (YYYY-MM-DD)
`--created-before <date>`	created on/before this date (YYYY-MM-DD)
`--project <id>`	filter by project id
`--user <id>`	filter by requesting user id
`--follower <id>`	filter by follower user id
`--offset <n>`	offset within the total dataset (>= 0)
`--limit <n>`	max number of results (1..50)
`--csv`	output this page as the server-rendered CSV instead of JSON (one page of up to 50 rows; page with --offset)

`fragdenstaat request get`

Get one request by id (includes its message thread)

fragdenstaat request get [options] <id>

Argumente

<id> erforderlich: numeric resource id

`fragdenstaat request search`

Full-text search over public requests

fragdenstaat request search [options]

Optionen

Option	Beschreibung	Standard
`--q <text>`	full-text query
`--jurisdiction <slug>`	restrict to a jurisdiction
`--category <slug>`	restrict to a category
`--offset <n>`	offset within the total dataset (>= 0)
`--limit <n>`	max number of results (1..50)
`--csv`	output this page as the server-rendered CSV instead of JSON (one page of up to 50 rows; page with --offset)

`fragdenstaat request tags`

Autocomplete request tag names

fragdenstaat request tags [options] <query>

Argumente

<query> erforderlich: tag name fragment to autocomplete (must be non-empty)

Optionen

Option	Beschreibung	Standard
`--offset <n>`	offset within the total dataset (>= 0)
`--limit <n>`	max number of results (1..50)

`fragdenstaat publicbody`

Public bodies / authorities (Behörden) that receive FOI requests

`fragdenstaat publicbody list`

List/filter public bodies

fragdenstaat publicbody list [options]

Optionen

Option	Beschreibung	Standard
`--q <text>`	full-text query over name/description
`--jurisdiction <id>`	filter by jurisdiction id
`--classification <id>`	filter by classification id (subtree match)
`--classification-id <id>`	filter by exact classification id
`--category <id>`	filter by category id
`--regions <ids>`	filter by geo-region id (with its sub-regions), or a comma list of ids (exactly those)
`--slug <slug>`	filter by exact slug
`--lnglat <lng,lat>`	filter to bodies whose regions contain a lng,lat point (not sorted by distance)
`--offset <n>`	offset within the total dataset (>= 0)
`--limit <n>`	max number of results (1..50)
`--csv`	output this page as the server-rendered CSV instead of JSON (one page of up to 50 rows; page with --offset)

`fragdenstaat publicbody get`

Get one public body by id

fragdenstaat publicbody get [options] <id>

Argumente

<id> erforderlich: numeric resource id

`fragdenstaat publicbody search`

Full-text search over public bodies

fragdenstaat publicbody search [options]

Optionen

Option	Beschreibung	Standard
`--q <text>`	full-text query
`--jurisdiction <id>`	restrict to a jurisdiction id
`--classification <id>`	restrict to a classification id
`--category <id>`	restrict to a category id
`--offset <n>`	offset within the total dataset (>= 0)
`--limit <n>`	max number of results (1..50)
`--csv`	output this page as the server-rendered CSV instead of JSON (one page of up to 50 rows; page with --offset)

`fragdenstaat publicbody autocomplete`

Autocomplete public-body names

fragdenstaat publicbody autocomplete [options] <query>

Argumente

<query> erforderlich: text to autocomplete (must be non-empty)

Optionen

Option	Beschreibung	Standard
`--offset <n>`	offset within the total dataset (>= 0)
`--limit <n>`	max number of results (1..50)

`fragdenstaat law`

FOI laws (IFG, UIG, VIG, state transparency acts, local statutes)

`fragdenstaat law list`

List/filter FOI laws

fragdenstaat law list [options]

Optionen

Option	Beschreibung	Standard
`--q <text>`	full-text query over name/description
`--jurisdiction <id>`	filter by jurisdiction id
`--mediator <id>`	filter by mediator public-body id
`--meta [bool]`	only meta-laws (combinations) — true/false
`--id <id>`	filter by law id
`--offset <n>`	offset within the total dataset (>= 0)
`--limit <n>`	max number of results (1..50)
`--csv`	output this page as the server-rendered CSV instead of JSON (one page of up to 50 rows; page with --offset)

`fragdenstaat law get`

Get one law by id

fragdenstaat law get [options] <id>

Argumente

<id> erforderlich: numeric resource id

`fragdenstaat law autocomplete`

Autocomplete law names

fragdenstaat law autocomplete [options] <query>

Argumente

<query> erforderlich: text to autocomplete (must be non-empty)

Optionen

Option	Beschreibung	Standard
`--offset <n>`	offset within the total dataset (>= 0)
`--limit <n>`	max number of results (1..50)

`fragdenstaat jurisdiction`

Jurisdictions (Bund, the 16 Länder, the EU)

`fragdenstaat jurisdiction list`

List jurisdictions

fragdenstaat jurisdiction list [options]

Optionen

Option	Beschreibung	Standard
`--offset <n>`	offset within the total dataset (>= 0)
`--limit <n>`	max number of results (1..50)
`--csv`	output this page as the server-rendered CSV instead of JSON (one page of up to 50 rows; page with --offset)

`fragdenstaat jurisdiction get`

Get one jurisdiction by id

fragdenstaat jurisdiction get [options] <id>

Argumente

<id> erforderlich: numeric resource id

`fragdenstaat category`

Topical categories (Themen) — a tree

`fragdenstaat category list`

List/filter categories

fragdenstaat category list [options]

Optionen

Option	Beschreibung	Standard
`--q <text>`	full-text query
`--name <name>`	filter by exact name
`--parent <id>`	filter to direct children of this category id
`--ancestor <id>`	filter to all descendants of this category id
`--depth <n>`	filter by tree depth (a non-negative integer)
`--is-topic [bool]`	only topic categories (true/false)
`--offset <n>`	offset within the total dataset (>= 0)
`--limit <n>`	max number of results (1..50)
`--csv`	output this page as the server-rendered CSV instead of JSON (one page of up to 50 rows; page with --offset)

`fragdenstaat category get`

Get one category by id

fragdenstaat category get [options] <id>

Argumente

<id> erforderlich: numeric resource id

`fragdenstaat category autocomplete`

Autocomplete category names

fragdenstaat category autocomplete [options] <query>

Argumente

<query> erforderlich: text to autocomplete (must be non-empty)

Optionen

Option	Beschreibung	Standard
`--offset <n>`	offset within the total dataset (>= 0)
`--limit <n>`	max number of results (1..50)

`fragdenstaat classification`

Public-body classifications (Behördentypen) — a tree

`fragdenstaat classification list`

List/filter classifications

fragdenstaat classification list [options]

Optionen

Option	Beschreibung	Standard
`--q <text>`	full-text query
`--name <name>`	filter by exact name
`--parent <id>`	filter to direct children of this classification id
`--ancestor <id>`	filter to all descendants of this classification id
`--depth <n>`	filter by tree depth (a non-negative integer)
`--offset <n>`	offset within the total dataset (>= 0)
`--limit <n>`	max number of results (1..50)
`--csv`	output this page as the server-rendered CSV instead of JSON (one page of up to 50 rows; page with --offset)

`fragdenstaat classification get`

Get one classification by id

fragdenstaat classification get [options] <id>

Argumente

<id> erforderlich: numeric resource id

`fragdenstaat campaign`

Campaigns (Kampagnen) — coordinated mass-request projects

`fragdenstaat campaign list`

List campaigns

fragdenstaat campaign list [options]

Optionen

Option	Beschreibung	Standard
`--offset <n>`	offset within the total dataset (>= 0)
`--limit <n>`	max number of results (1..50)
`--csv`	output this page as the server-rendered CSV instead of JSON (one page of up to 50 rows; page with --offset)

`fragdenstaat campaign get`

Get one campaign by id

fragdenstaat campaign get [options] <id>

Argumente

<id> erforderlich: numeric resource id

`fragdenstaat georegion`

Geographic regions (Regionen): states, districts, municipalities, zip codes

`fragdenstaat georegion list`

List/filter geo-regions

fragdenstaat georegion list [options]

Optionen

Option	Beschreibung	Standard
`--q <text>`	full-text query
`--name <name>`	filter by exact name
`--kind <kind>`	filter by region kind Werte: country, state, admin_district, district, admin_cooperation, municipality, borough, zipcode, admin_court_jurisdiction
`--kind-detail <text>`	filter by kind detail label
`--level <n>`	filter by hierarchy level (a non-negative integer)
`--region-identifier <id>`	filter by region identifier
`--slug <slug>`	filter by exact slug
`--ancestor <id>`	filter to descendants of this region id
`--id <ids>`	filter by region id, or a comma list of ids (e.g. 5,6)
`--latlng <lat,lng>`	point-in-region lookup for a lat,lng point
`--offset <n>`	offset within the total dataset (>= 0)
`--limit <n>`	max number of results (1..50)
`--csv`	output this page as the server-rendered CSV instead of JSON (one page of up to 50 rows; page with --offset)

`fragdenstaat georegion get`

Get one geo-region by id (includes geometry)

fragdenstaat georegion get [options] <id>

Argumente

<id> erforderlich: numeric resource id

`fragdenstaat georegion autocomplete`

Autocomplete geo-region names

fragdenstaat georegion autocomplete [options] <query>

Argumente

<query> erforderlich: text to autocomplete (must be non-empty)

Optionen

Option	Beschreibung	Standard
`--offset <n>`	offset within the total dataset (>= 0)
`--limit <n>`	max number of results (1..50)

`fragdenstaat message`

Messages (Nachrichten) in the correspondence of FOI requests

`fragdenstaat message list`

List/filter messages (use --request to scope to one request)

fragdenstaat message list [options]

Optionen

Option	Beschreibung	Standard
`--request <id>`	filter to one request's correspondence
`--kind <kind>`	filter by transport (email, post, fax, ...) Werte: email, post, fax, upload, phone, visit, import
`--is-response [bool]`	only replies from the authority (true/false)
`--offset <n>`	offset within the total dataset (>= 0)
`--limit <n>`	max number of results (1..50)
`--csv`	output this page as the server-rendered CSV instead of JSON (one page of up to 50 rows; page with --offset)

`fragdenstaat message get`

Get one message by id

fragdenstaat message get [options] <id>

Argumente

<id> erforderlich: numeric resource id

`fragdenstaat document`

Published documents (Dokumente) extracted from FOI responses

`fragdenstaat document list`

List/filter published documents

fragdenstaat document list [options]

Optionen

Option	Beschreibung	Standard
`--publicbody <id>`	filter by publishing public-body id
`--foirequest <id>`	filter by source request id
`--collection <id>`	filter by document-collection id
`--portal <id>`	filter by document-portal id
`--directory <id>`	filter by directory id
`--tag <slug>`	filter by tag slug
`--ids <ids>`	filter by a comma-separated list of numeric document ids (repeatable)
`--created-after <date>`	created on/after this date (YYYY-MM-DD)
`--created-before <date>`	created on/before this date (YYYY-MM-DD)
`--offset <n>`	offset within the total dataset (>= 0)
`--limit <n>`	max number of results (1..50)
`--csv`	output this page as the server-rendered CSV instead of JSON (one page of up to 50 rows; page with --offset)

`fragdenstaat document get`

Get one document by id (includes its pages)

fragdenstaat document get [options] <id>

Argumente

<id> erforderlich: numeric resource id