Befehle

Alle Befehle, Argumente und Optionen von ckan 0.0.5, 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>`	CKAN site URL (env CKAN_BASE_URL)	`https://suche.transparenz.hamburg.de`
`--portal <id>`	a known portal by id (see `ckan portals`)
`--timeout <ms>`	per-request timeout in milliseconds
`--user-agent <ua>`	User-Agent header value
`--max-retries <n>`	retries for transient 429/503 responses
`--max-response-bytes <n>`	cap response body size in bytes (0 = unlimited; default 100 MiB)
`--compact`	print JSON on a single line instead of pretty-printed

`ckan search`

Search datasets (Solr query syntax)

ckan search [options] [query]

Argumente

[query] optional: full-text query, e.g. elbe or title:haushalt

Optionen

Option	Beschreibung	Standard
`--rows <n>`	max results (servers cap this, usually at 1000)
`--start <n>`	offset for paging
`--sort <expr>`	e.g. "metadata_modified desc"
`--fq <filter>`	filter query, e.g. organization:allris (repeatable; all must match)
`--facet <field>`	count values of a field, e.g. res_format (repeatable)
`--facet-limit <n>`	max values per facet (default 50; -1 = all)

`ckan package`

Show one dataset by id or name

ckan package [options] <id>

Argumente

<id> erforderlich: id or name

`ckan resource`

Show one resource (distribution) by id

ckan resource [options] <id>

Argumente

<id> erforderlich: resource id

`ckan organization`

Show one organization (publisher) by id or name

ckan organization [options] <id>

Argumente

<id> erforderlich: id or name

`ckan group`

Show one group (theme/category) by id or name

ckan group [options] <id>

Argumente

<id> erforderlich: id or name

`ckan packages`

List dataset names

ckan packages [options]

Optionen

Option	Beschreibung	Standard
`--limit <n>`	max names
`--offset <n>`	offset for paging

`ckan organizations`

List organizations (data publishers)

ckan organizations [options]

Optionen

Option	Beschreibung	Standard
`--all-fields`	return full objects instead of names
`--limit <n>`	max entries
`--offset <n>`	offset for paging

`ckan groups`

List groups (themes/categories)

ckan groups [options]

Optionen

Option	Beschreibung	Standard
`--all-fields`	return full objects instead of names
`--limit <n>`	max entries
`--offset <n>`	offset for paging

`ckan tags`

List tags

ckan tags [options]

Optionen

Option	Beschreibung	Standard
`--query <substring>`	only tags containing this substring

`ckan status`

Show the portal's site title, CKAN version and extensions

ckan status [options]

`ckan licenses`

List the licences the portal offers

ckan licenses [options]

`ckan action`

Call any CKAN action by name (generic escape hatch)

ckan action [options] <name>

Argumente

<name> erforderlich

Optionen

Option	Beschreibung	Standard
`--param <key=value>`	query parameter (repeatable)

`ckan portals`

List the known CKAN portals in Germany (use one with --portal <id>)

ckan portals [options]

Optionen

Option	Beschreibung	Standard
`--check`	check every portal live now and report the result