Commands

Every command, argument and option of oparl 0.0.2, read from the CLI itself.

Global options

These options work with every command.

OptionDescriptionDefault
-V, --version output the version number
--timeout <ms> time limit per request in ms, whole response included (0 = no timeout; default 120000)
--user-agent <ua> User-Agent header value
--max-retries <n> retries for transient 429/503 responses (0..10)
--max-redirects <n> redirects to follow on the same host (0..10, default 3)
--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
-o, --output <file> write output to this file instead of stdout

oparl endpoints

List known OParl endpoints: the registry at dev.oparl.org plus a curated list of servers it lacks, with the date and result of their last live check

oparl endpoints [options]

Options

OptionDescriptionDefault
--search <text> only endpoints whose title, URL or note contains this text (ignores case and accents; falls back to ä/ae spellings)
--oparl-version <version> only endpoints speaking this OParl version: 1.0, 1.1, or the full version URI
--working only endpoints that worked on their last check
--source <source> registry entries, curated entries, or both Choices: all, registry, curated all
--registry-url <url> registry URL https://dev.oparl.org/api/endpoints

oparl system

Fetch an endpoint's System object (the entry point of an OParl server)

oparl system [options] <url>

Arguments

<url> required
System URL, e.g. from `oparl endpoints`

oparl bodies

List the bodies (Körperschaften, usually municipalities) on an OParl server

oparl bodies [options] <systemUrl>

Arguments

<systemUrl> required
System URL

Options

OptionDescriptionDefault
--max-pages <n> pages to fetch, following links.next (0 = all) 0

oparl list

Walk one of a body's object lists. Returns { data, pages, next }: pass `next` to `oparl get` or raise --max-pages to continue. Servers may ignore the filters.

oparl list [options] <type> <bodyUrl>

Arguments

<type> required
object list to fetch
<bodyUrl> required
Body URL, e.g. from `oparl bodies`

Options

OptionDescriptionDefault
--max-pages <n> pages to fetch, following links.next (0 = all) 1
--modified-since <time> only objects modified since (YYYY-MM-DD or ISO 8601)
--modified-until <time> only objects modified until (YYYY-MM-DD or ISO 8601)
--created-since <time> only objects created since (YYYY-MM-DD or ISO 8601)
--created-until <time> only objects created until (YYYY-MM-DD or ISO 8601)
--limit <n> page size hint (1..1000); some servers ignore or reject it
--omit-internal ask the server to leave out embedded objects

oparl get

Fetch any OParl object or list page by URL

oparl get [options] <url>

Arguments

<url> required
object or list URL