Commands

Every command, argument and option of ckan 0.5.1, read from the CLI itself.

Global options

These options work with every command.

Option	Description	Default
`-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 (0..10; each backs off linearly, or waits a longer 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

`ckan search`

Search datasets (Solr query syntax)

ckan search [options] [query]

Arguments

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

Options

Option	Description	Default
`--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>

Arguments

<id> required: id or name

`ckan resource`

Show one resource (distribution) by id

ckan resource [options] <id>

Arguments

<id> required: resource id

`ckan organization`

Show one organization (publisher) by id or name

ckan organization [options] <id>

Arguments

<id> required: id or name

`ckan group`

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

ckan group [options] <id>

Arguments

<id> required: id or name

`ckan packages`

List dataset names

ckan packages [options]

Options

Option	Description	Default
`--limit <n>`	max names (1 or more; omit for all)
`--offset <n>`	offset for paging

`ckan organizations`

List organizations (data publishers)

ckan organizations [options]

Options

Option	Description	Default
`--all-fields`	return full objects instead of names
`--limit <n>`	max entries (1 or more; omit for all)
`--offset <n>`	offset for paging

`ckan groups`

List groups (themes/categories)

ckan groups [options]

Options

Option	Description	Default
`--all-fields`	return full objects instead of names
`--limit <n>`	max entries (1 or more; omit for all)
`--offset <n>`	offset for paging

`ckan tags`

List tags

ckan tags [options]

Options

Option	Description	Default
`--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>

Arguments

<name> required

Options

Option	Description	Default
`--param <key=value>`	query parameter (repeatable)

`ckan portals`

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

ckan portals [options]

Options

Option	Description	Default
`--check`	check every portal live now and report the result