Befehle

Alle Befehle, Argumente und Optionen von abgeordnetenwatch 0.0.8, 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.

OptionBeschreibungStandard
-V, --version output the version number
--base-url <url> API base URL https://www.abgeordnetenwatch.de
--timeout <ms> time limit per request in milliseconds, whole response included (0 disables) 30000
--user-agent <ua> User-Agent header value
--max-retries <n> retries for transient 429/503 responses 2
--max-response-bytes <n> cap response body size in bytes (0 = unlimited) 104857600
--compact print JSON on a single line instead of pretty-printed

abgeordnetenwatch list

List a collection, with optional filters, sorting and paging

abgeordnetenwatch list [options] <entity> [filters...]

Argumente

<entity> erforderlich
entity collection (18 available; see 'entities')
[filters…] optional
field filters as key=value, e.g. sex=f 'year_of_birth[gt]=1990'

Optionen

OptionBeschreibungStandard
--range-start <n> 0-based offset of the first item
--range-end <n> page size (number of items; API honours up to 1000, else falls back to 100)
--sort-by <field> field name to sort by (e.g. last_name, id)
--sort-direction <dir> asc or desc
--data-only print just the data array (not the meta envelope)

abgeordnetenwatch get

Fetch a single entity by id

abgeordnetenwatch get [options] <entity> <id>

Argumente

<entity> erforderlich
entity collection (see 'entities')
<id> erforderlich
numeric entity id

Optionen

OptionBeschreibungStandard
--data-only print just the data object (not the meta envelope)

abgeordnetenwatch count

Count how many entities match the given filters

abgeordnetenwatch count [options] <entity> [filters...]

Argumente

<entity> erforderlich
entity collection (see 'entities')
[filters…] optional
field filters as key=value