Skip to content

CLI Reference

unweaver

Usage:

unweaver [OPTIONS] COMMAND [ARGS]...

Options:

  --help  Show this message and exit.

build

Build a routable GeoPackage (graph.gpkg in the project directory) from the data in the {project}/layers directory.

Usage:

unweaver build [OPTIONS] PROJECT_DIRECTORY

Options:

  --precision INTEGER  Latitude-longitude coordinate rounding precision for
                       whether dataset polylines are connected.
  --changes-sign TEXT  A property whose sign should be flipped when reversing
                       an edge. Example: a positive steepness/incline field
                       value should be made negative for the reverse edge.
  --help               Show this message and exit.

serve

Run a web server with auto-generated web API endpoints that return JSON for shortest-path routes, shortest-path trees, and reachable trees for every profile in a project.

Usage:

unweaver serve [OPTIONS] PROJECT_DIRECTORY

Options:

  -h, --host TEXT     Host on which to run the server.
  -p, --port INTEGER  Port on which to run the server.
  --debug             Whether to run the server with in-browser error
                      tracebacks.
  --help              Show this message and exit.

weight

Precalculate all static weights for all profiles in a project.

Usage:

unweaver weight [OPTIONS] PROJECT_DIRECTORY

Options:

  --help  Show this message and exit.