Skip to content

Commit e544cbb

Browse files
committed
add docs on cluster command.
1 parent a6ab65a commit e544cbb

File tree

2 files changed

+13
-1
lines changed

2 files changed

+13
-1
lines changed

pmtiles/cli.md

+12
Original file line numberDiff line numberDiff line change
@@ -171,6 +171,18 @@ Options:
171171
* `--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.
172172
* `--tmpdir`: specify the location of the temporary directory.
173173

174+
### cluster
175+
176+
Cluster an unclustered existing archive, optimizing the size and layout. Archives created by tippecanoe, planetiler, and the pmtiles CLI are already clustered.
177+
178+
```bash
179+
pmtiles cluster INPUT.mbtiles
180+
```
181+
182+
Options:
183+
184+
* `--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.
185+
174186
### upload
175187

176188
Upload an archive to cloud storage.

pmtiles/create.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -70,4 +70,4 @@ Run the basemaps program on your own computer to modify the layers or generate o
7070

7171
## Tilemaker
7272

73-
[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`.
73+
[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).

0 commit comments

Comments
 (0)