Alle Befehle, Argumente und Optionen von govdata 0.5.1, direkt aus der CLI gelesen.
Die Beschreibungen der Befehle, Argumente und Optionen stammen direkt aus der CLI und sind englisch.
Diese Optionen gelten für jeden Befehl.
| Option | Beschreibung | Standard |
|---|---|---|
-V, --version |
output the version number | |
--base-url <url> |
API base URL (default: "https://ckan.govdata.de") | |
--timeout <ms> |
per-request timeout in milliseconds (default 30000; 0 = no timeout) | |
--user-agent <ua> |
User-Agent header value | |
--max-retries <n> |
retries for transient 429/503 responses and reset connections (0..10; linear backoff, longer if the server's Retry-After asks, 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 |
govdata searchSearch datasets (Solr query syntax)
govdata search [options] [query]Argumente
[query]
optionalOptionen
| Option | Beschreibung | Standard |
|---|---|---|
--rows <n> |
max results | |
--start <n> |
offset for paging | |
--sort <expr> |
e.g. "metadata_modified desc" | |
--fq <filter> |
filter query, e.g. groups:tran (repeatable; all must match) |
govdata packageShow one dataset by id or name
govdata package [options] <id>Argumente
<id>
erforderlichgovdata packagesList dataset names
govdata packages [options]Optionen
| Option | Beschreibung | Standard |
|---|---|---|
--limit <n> |
max names (1 or more; omit for all) | |
--offset <n> |
offset for paging |
govdata organizationsList organizations (data publishers)
govdata organizations [options]Optionen
| Option | Beschreibung | Standard |
|---|---|---|
--all-fields |
return full objects instead of names |
govdata organizationShow one organization
govdata organization [options] <id>Argumente
<id>
erforderlichgovdata groupsList groups (themes/categories)
govdata groups [options]Optionen
| Option | Beschreibung | Standard |
|---|---|---|
--all-fields |
return full objects instead of names |
govdata groupShow one group
govdata group [options] <id>Argumente
<id>
erforderlichgovdata tagsList tags
govdata tags [options]Optionen
| Option | Beschreibung | Standard |
|---|---|---|
--query <substring> |
filter tags by substring |
govdata resourceShow one resource (distribution) by id
govdata resource [options] <id>Argumente
<id>
erforderlichgovdata actionCall any CKAN action by name (generic escape hatch)
govdata action [options] <name>Argumente
<name>
erforderlichOptionen
| Option | Beschreibung | Standard |
|---|---|---|
--param <key=value> |
query parameter (repeatable) |