Commands

Every command, argument and option of ddb 0.6.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>`	API base URL	`https://api.deutsche-digitale-bibliothek.de/2`
`--timeout <ms>`	per-request timeout in milliseconds
`--user-agent <ua>`	User-Agent header value
`--max-retries <n>`	retries for transient 429/503 responses and reset connections (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 to this file instead of stdout (- = stdout)
`--force`	overwrite the --output file if it already exists

Search cultural-heritage objects via the v2 Solr index (returns native Solr JSON)

ddb search [options] <query>

Arguments

Options

Option	Description	Default
`--rows <n>`	number of documents to return (Solr rows; default 10)
`--offset <n>`	offset of the first document (Solr start), for paging
`--sort <spec>`	Solr sort, e.g. "score desc" or "id asc"
`--fields <list>`	comma-separated fields to return (Solr fl), e.g. id,title
`--filter <fq>`	Solr filter query (fq), repeatable, e.g. type_fct:mediatype_002
`--facet <field>`	compute counts for this facet field (repeatable), e.g. type_fct
`--facet-limit <n>`	cap the number of values returned per facet (Solr default 100; -1 = all, still sorted by count)
`--collection <name>`	Solr collection to query	`search`
`--handler <name>`	Solr request handler; only handlers returning Solr's standard response envelope (numFound, docs) are supported	`select`

Fetch one item component by its 32-character id (GET /2/items/{id})

ddb item [options] <id>

Arguments

Options

Option	Description	Default
`--part <component>`	component to fetch: view \| aip \| edm \| binaries \| children \| parents \| source \| source-description \| source-record \| iiif \| citation (default view)	`view`
`--lang <code>`	preferred language for labels (view/aip/edm/binaries/source/source-description)
`--rows <n>`	page size for --part children
`--offset <n>`	offset for --part children

Print the DDB backend version — a quick connectivity check (no key needed)

ddb version [options]