Skip to content

Getting Started

1. Install the CLI

The pmtiles CLI tool is a single binary you can download at GitHub Releases.

2. Find the latest daily planet

Go to maps.protomaps.com/builds and find a recent daily basemap build.

Use the pmtiles CLI to inspect that archive:

bash
pmtiles show https://build.protomaps.com/20240607.pmtiles
pmtiles show https://build.protomaps.com/20240607.pmtiles
txt
...
planetiler:osm:osmosisreplicationtime 2024-06-07T05:00:00Z
...
...
planetiler:osm:osmosisreplicationtime 2024-06-07T05:00:00Z
...

The above metadata shows that the file contains OpenStreetMap data up to that day.

3. Extract any area

We can now create a subset of the planet file, my_area.pmtiles, with just tiles matching the bounding box 4.742883,51.830755,5.552837,52.256198 centered around Utrecht, Netherlands.

bash
pmtiles extract https://build.protomaps.com/20240607.pmtiles my_area.pmtiles --bbox=4.742883,51.830755,5.552837,52.256198
pmtiles extract https://build.protomaps.com/20240607.pmtiles my_area.pmtiles --bbox=4.742883,51.830755,5.552837,52.256198

Note: You can find the bounding box of your own area, using tools, such as http://bboxfinder.com/

4. View the basemap

maps.protomaps.com is a viewer for basemaps. Drag our file my_area.pmtiles onto the Drop Zone to view the map:

utrecht image

Next Steps

An open source mapping system released under the BSD and ODbL licenses.