https://github.com/hackergrrl/mapbox-style-downloader

https://github.com/hackergrrl/mapbox-style-downloader

Last synced: 24 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/hackergrrl/mapbox-style-downloader
• Owner: hackergrrl
• Created: 2019-01-30T18:38:29.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2020-12-15T17:04:48.000Z (almost 4 years ago)
• Last Synced: 2024-10-10T16:09:13.656Z (about 1 month ago)
• Language: JavaScript
• Size: 78.1 KB
• Stars: 9
• Watchers: 2
• Forks: 3
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
## mapbox-style-downloader

Download mapbox styles, tiles, glyphs, and sprites for offline use.

```

npm install -g mapbox-style-downloader

```

## Usage

To download, you need to get a MapBox API Token. You can get one by signing up

for mapbox and requesting a public key from them. It is free. It should start

with `pk`. This is your `token` to be used with mapbox-style-downloader.

To download, use the `download` command like so:

```sh

mapbox-style download mapbox://styles/mapbox/streets-v9 \

  --token='MAPBOX_API_TOKEN' \

  -o styledir \

  -z 8 \

  -Z 13 \

  -b '-60.1364 1.5626 -58.0627 3.475'

```

You need to provide a Mapbox Style URL as the first argument to `download`.

There are many of them, but this is an example: `mapbox://styles/mapbox/streets-v9`. You can see the full list on the MapBox website.

## Be careful!

This has the capability to send MapBox a lot of requests. Try not to get your

token throttled! Make sure you pick reasonable bounding boxes and zoom levels,

because the data can get very large, very fast.

## Serve styles

To serve the styles, you can use a static http server. MapBox isn't that picky

on how you serve your tiles. There is a built-in example with this command-line

tool. Just give the path to your `styledir` like so:

```

mapbox-style serve styledir

```

And you will be able to see your map, being served offline from the tiles,

sprites, and glyphs you just downloaded.

## API

```

USAGE: mapbox-style  [options]

  download STYLE_URL [options]

    -b, --bounds        bounding box in the form of "lat, lon, lat, lon"

    -o, --output        the output path for the styles

    -z, --minzoom       the minimum zoom for tile downloading [1,16]

    -Z, --maxzoom       the maximum zoom for tile downloading [1,16]

    -t, --token         your MapBox API token

    -u, --minutf        minimum UTF-8 char code to download glyphs for

    -U, --maxutf        maximum UTF-8 char code to download glyphs for

  serve

    -p, --port          the port to use for the server

  help

    see this help text

```