CLI Reference

protovoters [--help]

Print help information and exit

Flags

--help: Print help information and exit

Output

A concise version of this reference.

protovoters --version

Print version information and exit

Flags

--version: Print version information and exit

Output

Replace x.x.x with the current version.

x.x.x

protovoters build [--bbox] [--polygon] [--output] [<OCD-ID>]

Build a voter file from a specified political division (by OCD Division ID), bounding box or GeoJSON Polygon.

Arguments

• <OCD-ID>: The OCD Division ID of the political division you want to build a voter file for. Mutually exclusive with --bbox and --polygon.

Flags

• --bbox: The bounding box of the area you want to build a voter file for. The Core Library will compute automatically the relevant divisions and filter the output to the bbox. Mutually exclusive with <OCD-ID> and --polygon
• --polygon: The GeoJSON Polygon you want to build a voter file for, or a path to a file containing it. The Core Library will compute automatically the relevant divisions and filter the output to the polygon. Mutually exclusive with <OCD-ID> and --bbox
• --output: The filepath to where you want to write the voter file to.

Output

stdin will output a progress screen, and the file specified in --output (or an automatically generated file name) will contain a Protovoters Specification-compliant voter file in FlatGeobuf format.

protovoters list [<OCD-ID>]

List available divisions, filterable by OCD Division ID.

Arguments

• <OCD-ID>: OCD Divison ID to filter by. For instance, ocd-division/country:us/state:tx will filter for divisions in Texas.

Output

A tree graph of available divisions, sorted by OCD-ID.

Example

└─ country-us
   └─ state-tx
      └─ county
         └─ travis

protovoters install

Installs bash autocomplete support

Output

None

protovoters uninstall

Uninstalls bash autocomplete support

Output

None