Befehle

Alle Befehle, Argumente und Optionen von oparl 0.0.2, 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
`--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]

Optionen

Option	Beschreibung	Standard
`--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 Werte: 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>

Argumente

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

`oparl bodies`

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

oparl bodies [options] <systemUrl>

Argumente

<systemUrl> erforderlich: System URL

Optionen

Option	Beschreibung	Standard
`--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>

Argumente

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

Optionen

Option	Beschreibung	Standard
`--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>

Argumente

<url> erforderlich: object or list URL