Deploy

Ship stable map URLs

Deploy compiles your selected map styles in memory, uploads them to Tileflow, and writes a local frontend manifest containing the hosted production URLs.

Hosted deployment currently requires approved access.Use a pre-provisioned key locally or set TILEFLOW_API_KEY in CI.

Terminal

export TILEFLOW_API_KEY=tf_live_...
tileflow validate
tileflow deploy

Behavior

Validate, publish, then write the manifest

The CLI validates every named map before any upload. It publishes one environment per map, prints the stable style URLs, and writes public/tileflow/manifest.json by default. Use --manifest to choose another path and --tileset to override a tileset for this deploy.

Manifest

Use the same map name in production

The local production manifest maps names such as madrid to stable hosted style URLs. Framework adapters also emit local manifests and style assets during static app builds.

public/tileflow/manifest.json

{
  "version": 1,
  "apiUrl": "https://api.tileflow.dev",
  "maps": {
    "madrid": {
      "environment": "madrid",
      "mapId": "map_1234567890abcdef",
      "styleId": "sty_456",
      "styleUrl": "https://api.tileflow.dev/maps/map_1234567890abcdef/style.json",
      "tilesetId": "world"
    }
  },
  "styles": {
    "madrid": "https://api.tileflow.dev/maps/map_1234567890abcdef/style.json"
  }
}

Hosted deploys cannot publish local icon folders yet.Use a hosted sprite URL, or use tileflow build and a framework adapter for self-hosted icon assets. Static rendering also requires every external sprite host to be explicitly approved in the renderer network allowlist; the default OSM Bright sprite is served by Tileflow itself.

Use environment variables for headless deploys

CI should set TILEFLOW_API_KEY and optionally TILEFLOW_API_URL. Run validation before deploy so style errors fail before any network write.

TILEFLOW_API_KEY=tf_live_... tileflow validate
TILEFLOW_API_KEY=tf_live_... tileflow deploy

Status

Confirm the deployed surface

After deploy, tileflow status shows registered tilesets, PMTiles archives, deployed styles, upload dates, and missing archive warnings.

Terminal

tileflow status