Skip to content

Command line

Terminal window
mapterm [SOURCE | --style STYLE] [--geojson FILE|URL]... [--raster NAME|URL]
[--at LAT,LON] [-z ZOOM] [--light]
[--snapshot COLSxROWS [--format F | --pick COL,ROW]]
Option
SOURCE A .pmtiles file or URL, an XYZ template with {z}/{x}/{y}, or a TileJSON URL, drawn with the built-in terminal style. Default: the OpenFreeMap planet. See Map sources.
--style STYLE A MapLibre style instead: liberty, positron, bright, dark, fiord (OpenFreeMap), mapterm-dark, mapterm-light, a style URL, or a style.json file. See Styles.
--light Start with the light built-in style (t switches).
--at LAT,LON Start position. Default: fit the data layers, else the source’s or style’s center.
-z ZOOM, --zoom ZOOM Start zoom. Fractions are fine.
Option
--geojson FILE|URL A data layer over the map: GeoJSON, CSV/TSV, GPX, KML or FlatGeobuf, up to 512 MB. Repeatable. See Data layers.
--raster NAME|URL|FILE An image layer under the vector map: a provider name, a tile URL, or a PMTiles file or URL of PNG/JPEG/WebP tiles. See Raster and satellite.
--raster-list List the providers and the keys they need, then exit.
--raster-key-cmd CMD Run a command to get the API key, e.g. 'pass show vantor/api-key'. Otherwise the provider’s variable, or MAPTERM_RASTER_KEY for URLs.
--raster-header 'N: V' An extra request header. Write an API key as {key} (e.g. 'X-Api-Key: {key}') so the key stays out of ps and shell history. Repeatable.
--raster-param N=V Fill another {N} in the URL, e.g. mosaic=NAME for Planet. Repeatable.
--date YYYY-MM-DD The day for dated layers (gibs). Default: yesterday, UTC.
--raster-list-mosaics List the Planet mosaics your key can use, then exit.
--raster-cache, --raster-no-cache Keep raster tiles on disk or not. Default: on, off for keyed providers.
--raster-attribution TEXT Credit shown for the layer. Known providers are filled in.
--tms Count raster rows from the bottom (TMS) even with a plain {y}.
Option
--snapshot COLSxROWS Render one frame to stdout and exit. See Snapshots.
--format text|ansi|html With --snapshot: plain text (default), 24-bit ANSI color, or an HTML <pre> fragment.
--pick COL,ROW With --snapshot: print the features under that cell as JSON lines instead. See Inspect.
-h, --help Show the help.

See Controls for everything. In short: wheel zooms at the cursor, drag pans with inertia, double-click zooms in (shift: out), shift+drag box zooms, arrows/hjkl pan, +/- zoom, / search, i inspect, m next style, t theme, c copy coordinates, v vector overlay, n labels, q quit.