-
Using pip install (Windows/ Linux):
pip install vtiles
-
Show information of installed vtiles:
pip show vtiles
-
Install the latest vertion of vtiles:
pip install vtiles --upgrade
-
Visit vtiles on PyPI
- Show MBTiles metadata info:
Ex:
> mbtilesinfo <file_path>
> mbtilesinfo tiles.mbtiles
- Convert MBTiles file to folder: (support raster MBTiles (.png, .jpg, .webp) and vector MBTiles (.pbf))
Ex:
> mbtiles2folder -i <file_name.mbtiles> -o [output_folder (optional, current dir if not specified)] -flipy [TMS <--> XYZ tiling scheme (optional): 1 or 0, default is 0] -minzoom [optional, default is 0] -maxzoom [Maximum zoom level to export (optional, default is maxzoom from input MBTiles]
> mbtiles2folder -i tiles.mbtiles -o tiles_folder -flipy 0 -minzoom 0 -maxzoom 6
-
Convert a tiles folder to MBTiles file: (support raster tile (.png, .jpg, .webp) and vector tile (.pbf))
> folder2mbtiles -i <input_folder> -o [file_name.mbtiles (optional)] -flipy [TMS <--> XYZ tiling scheme (optional): 1 or 0, default is 0]
Ex:
> folder2mbtiles -i tiles_folder -o tiles.mbtiles -flipy 0
Without -o parameter: file_name.mbtiles has the same name with <input_folder> name at the current directory
- Convert MBTiles to GeoJSON.
Ex:
> mbtiles2geojson -i <input file> -o <Output GeoJSON> -minzoom <minzoom> -maxzoom <maxzoom> -flipy [TMS <--> XYZ tiling scheme (optional): 1 or 0, default is 0] -l [List of layer names to convert, all layers if not specified]
> mbtiles2geojson -i tiles.mbtils -o geojson.geojson -minzoom 0 - maxzoom 1 -flipy 0 -l water building
- Convert geojson file to mbtiles (need tippecanoe to be installed)
Ex:
> geojson2mbtiles -i <input files> -z <maxzoom> -o <output> -t <tippecanoe path> --extra-args <drop-densest-as-needed or coalesce-densest-as-needed or extend-zooms-if-still-dropping>
> geojson2mbtiles -i state.geojson district.geojson -z9 -o state_district.mbtiles -t /usr/local/bin/ --extra-args coalesce-densest-as-needed
(on Linux)
-
Uplpad a vector/ raster tiles folder to Amazon S3 Bucket:
> folder2s3 -i <input_folder> -format <'pbf', 'png', 'jpg', 'jpeg', 'webp', 'pbf', 'mvt'>
Ex:
> folder2s3 -i vectortiles_folder -format pbf
Input S3 parameters:
> S3 Bucket name: <Your S3 Bucket name (required)> > S3 Prefix: [Your S3 prefix (Optional. Press Enter to upload to the bucket root folder)] > AWS Access Key ID: <Your_Access_Key_ID (required)> > AWS Secret Access Key: <Your_Secrect_Access_Key (required)> > AWS Region: <AWS region (Optional. Press Enter to choose default region)>
- Uplpad a MBTiles file to Amazon S3 Bucket: Need to install aws cli and run aws configure to input credentials first
Ex:
> mbtiles2s3 <input file> <s3 bucket> -p (to see the uploading progress)
> mbtiles2s3 tiles.mbtiles s3://mybucket -p
- Extract a tile from MBTiles to PBF
Ex:
> mbtiles2pbf -i <input file> -z <zoom level> -x <tile column> -y <tile row> -o <output file>
> mbtiles2pbf -i tiles.mbtils -z 2 -x 1 -y 2 -o pbf_212.pbf
- Show pbf metadata info
Ex:
> pbfinfo <input file>
> pbfinfo pbf_file.pbf
- Convert tile data from a BBF file, MBTiles file, or URL to GeoJSON
Ex:
> pbf2geojson -i <input pbf, MBTiles or URL> -o <output file> -z <tile zoom level> - x <tile column> -y <tile row> -flipy [TMS <--> XYZ tiling scheme (optional): 1 or 0, default is 0]
> pbf2geojson -i pbf_file.pbf -o geojson_file.geojson -z 2 -x 1 -y 2
- Convert TMS <--> XYZ tiling scheme for a tiles folder
Ex:
> flipy -i <input folder> -o <output folder>
> flipy -i input_folder -o output_folder
- Convert Convert MBTiles to PMTiles
Ex:
> flipy -i <input MBTiles> -o <output PMTiles> -z <max zoom level>
> mbtiles2pmtiles -i mbtiles_file.mbtiles -o pmtiles_file.pmtiles -z 6
- Split an MBTiles file by selected layers
Ex:
> mbtilessplit -i <input file> -o <output file> -l <list of layer names to be splitted>
> mbtilessplit -i input_file.mbtiles -o splitted_file.mbtiles -l water
(mbtilessplit also save remaining mbtiles layers to {input file}_remained.mbtiles)
- Merge multiple MBTiles files into a single MBTiles file
Ex:
> mbtilesmerge -i <input file list> -o <output file> -l <list of layer names to be splitted>
> mbtilesmerge -i file_1.mbtiles file_2.mbtiles -o merged.mbtiles
- Compress MBTiles file with GZIP
Ex:
> mbtilescompress -i <input file> -o <output file>
> mbtilescompress -i mbtiles_file.mbtiles -o compressed.mbtiles
- Decompress MBTiles file (either being compressed with GZIP or ZLIB)
Ex:
> mbtilesdecompress -i <input file> -o <output file>
> mbtilesdecompress -i mbtiles_file.mbtiles -o decompressed.mbtiles
- Create or update metadata for an existing MBTiles file.
Ex:
> mbtilesfixmeta <input file>
> mbtilesfixmeta mbtiles_file.mbtiles
- Serve a raster tiles or vector tiles for the current folder, so clients can access to the tiles server via, for ex. htttp://localhost/8000/tiles/z/x/y.pbf.
> servefolder
- Serve raster tiles for the input MBTiles file, so clients can access to the tiles server via, for ex. htttp://localhost/8000/rastertiles/z/x/y.png.
> servembtiles --serve -p <port> -f <input file>
- Serve vector tiles for the input MBTiles file, so clients can access to the tiles server via, for ex. htttp://localhost/8000/vectortiles/z/x/y.pbf.
> servevectormbtiles --serve -p <port> -f <input file>
- Serve MVT tiles from a PostgreSQL/PostGIS database, so clients can access to the tiles server via, for ex. htttp://localhost/8000/mvt/z/x/y.pbf.
> servepostgis -config <YAML configuration file>
- Serve MVT tiles from a PostgreSQL/PostGIS database, so clients can access to the tiles server via, for ex. htttp://localhost/8000/pmtiles/z/x/y.pbf.
> servepostgis -i <PMTiles file> -port <port number> -host <host IP, default is localhost>
- Show PMTiles metadata.
> pmtilesinfo <mbtiles file> Z [zoom level] X [tile column] Y [tile row]
- Convert PMTiles file to folder
> pmtiles2folder -i <input file> -o <output_folder>
- Convert PMTiles file to MBTiles file
> pmtiles2mbtiles -i <input PMTiles> -o <output MBTiles>