CLI Reference

This page provides documentation for our command line tools.

osmox

OSMOX Command Line Tool.

Usage:

osmox [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
--version	boolean	Show the version and exit.	False
--help	boolean	Show this message and exit.	False

osmox run

Usage:

osmox run [OPTIONS] CONFIG_PATH INPUT_PATH OUTPUT_NAME

Options:

Name	Type	Description	Default
-f, --format	choice (geojson | geopackage | geoparquet)	Output file format (default: geopackage)	geopackage
-crs, --crs	text	crs string eg (default): 'epsg:27700' (UK grid)	epsg:27700
-s, --single_use	boolean	split multi-activity facilities into multiple single-activity facilities	False
-l, --lazy	boolean	if filtered object already has a label, do not search for more (supresses multi-use)	False
--help	boolean	Show this message and exit.	False

osmox validate

Validate a config.

Usage:

osmox validate [OPTIONS] CONFIG_PATH

Options:

Name	Type	Description	Default
--help	boolean	Show this message and exit.	False