ka

Install

Needs Node.js 22 or newer. Installs the ka command:

npm i -g @maschinenlesbar.org/openka-cli

Access

No account, no API key, no configuration — install and query.

Quick start

# Ingest a window of Berlin's Schriftliche Anfragen (question + answer + PDF text)
ka sync --source berlin --since 2024-01-01 --limit 50

# Search it
ka search "Brücken Zustand" --parliament berlin --year 2024
ka show berlin-19-18221

# Get the canonical record, or another rendering of it
ka get berlin-19-18221 --format json     # canonical JSON: the stored bytes
ka get berlin-19-18221 --format md       # readable
ka get berlin-19-18221 --format jsonld   # schema.org

# Prove it: re-run the extraction from the archived bytes and compare
ka verify berlin-19-18221

# See what the extractor refused to answer
ka review

# Bulk output
ka export --format csv --out corpus.csv
ka feed --party GRÜNE --out gruene.atom

Commands

• sync

  fetch, extract and store Anfragen from one or more sources

• search

  full-text search over the corpus

• get

  print one record in a machine-readable format

• show

  render one record for reading

• open

  print the path of a record's archived source document

• verify

  re-run an extraction from the archived bytes and assert identical output

• review

  work the abstention queue: records the extractor refused to complete

• reindex

  rebuild the search index and catalog from the stored records

• sources

  the source map and its health

• reextract

  re-extract stored records from their archived bytes with this build's extractor — no network; then rebuild the index

• rm

  remove records from the corpus, with their catalog rows and index postings (takes the corpus lock)

• export

  export the corpus (or a selection of it) in bulk

• feed

  an Atom feed of the newest matching Anfragen

• schema

  print the JSON Schema of the canonical record

• stats

  what is in this corpus: coverage, completeness, extractor versions, disk use, and breakdowns with --by

• doctor

  check the corpus: filesystem, free space, lock, catalog against records, macOS ._* files (exit 3 on a problem)

• status

  what a running sync is doing — progress, rate, time left — or how the last one ended

• config

  credentials kept apart from the corpus, in $XDG_CONFIG_HOME/openka/credentials (bund.api-key)

All commands, arguments and options →

TypeScript library

@maschinenlesbar.org/openka-cli is also a typed API client you can import in your own code, with no runtime HTTP dependencies.

API reference → Library usage and architecture →

The tool, not the data

The data comes from the provider behind the API, under its own terms — see DATA_LICENSE.md. The code is dual-licensed AGPL-3.0-or-later or commercial — see LICENSING.md.