Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add docs on cluster command. #106

Merged
merged 1 commit into from
Mar 19, 2025
Merged

add docs on cluster command. #106

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions pmtiles/cli.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -171,6 +171,18 @@ Options:
* `--no-deduplication`: Do not attempt to de-duplicate tile contents. Use this to speed up `convert` if you know the input has only unique tiles.
* `--tmpdir`: specify the location of the temporary directory.

### cluster

Cluster an unclustered existing archive, optimizing the size and layout. Archives created by tippecanoe, planetiler, and the pmtiles CLI are already clustered.

```bash
pmtiles cluster INPUT.mbtiles
```

Options:

* `--no-deduplication`: Do not attempt to de-duplicate tile contents. Use this to speed up `cluster` if you know the input has only unique tiles.

### upload

Upload an archive to cloud storage.
Expand Down
2 changes: 1 addition & 1 deletion pmtiles/create.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,4 +70,4 @@ Run the basemaps program on your own computer to modify the layers or generate o

## Tilemaker

[Tilemaker](https://github.com/systemed/tilemaker) is a program for creating basemap tilesets from OpenStreetMap, though not ones that match the layers in the Protomaps [Basemap Layers](/basemaps/layers). The PMTiles directories that Tilemakers produces are currently not optimized, which may result in large, slower fetches when decoding in a web browser. An alternative is to create MBTiles from Tilemaker and then use `pmtiles convert`.
[Tilemaker](https://github.com/systemed/tilemaker) is a program for creating basemap tilesets from OpenStreetMap, though not ones that match the layers in the Protomaps [Basemap Layers](/basemaps/layers). The PMTiles archives that Tilemaker produces are currently not clustered, which may result in large, slower fetches when decoding in a web browser. For production use you should optimize the archive with [pmtiles cluster](/pmtiles/cli#cluster).