CLI

Initialize, validate, preview, and deploy

The CLI handles the work around your config: initialize a project, validate changes, preview maps, deploy stable style URLs, manage tilesets, and check project status.

Terminal

pnpm add -D @tileflow/cli@alpha

Reference

Commands and options

Run tileflow <command> --help for generated terminal help. Paths are resolved from the current working directory.

tileflow init--force

Create a starter tileflow.config.ts in the current project.

tileflow login--manual, --no-browser, --api-key, --api-url, --app-url

Authorize through the approved dashboard account or store a pre-provisioned API key manually.

tileflow whoamiNo options

Show the active project, key prefix, API URL, dashboard URL, and scopes.

tileflow logoutNo options

Remove the saved local CLI credential.

tileflow validate--config, --tile-base-url

Validate config and generated MapLibre style schema shape.

tileflow build--config, --out, --tile-base-url

Generate static styles and sprite assets for CI, inspection, or self-hosting.

tileflow dev--config, --port, --tile-base-url

Run a standalone preview on port 3333 for non-Vite or custom apps.

tileflow deploy--config, --manifest, --tileset, --api-url, --api-key

Upload styles to Tileflow and write the local frontend manifest.

tileflow status--json, --api-url, --api-key

Show registered tilesets, uploaded PMTiles archives, and deployed styles.

tileflow tileset register--id, --name, --schema, --api-url, --api-key

Create an isolated project tileset manifest before uploading its PMTiles archive.

tileflow tileset upload<file>, --id, --api-url, --api-key

Validate and upload a PMTiles archive of at most 32 MiB through the API.

Auth

Authorize the CLI from your approved dashboard account

Hosted access is limited to approved accounts. Use tileflow login for the browser device flow, tileflow login --manual for an existing key, and setTILEFLOW_API_KEY in CI.

Terminal

# Approved accounts can authorize the CLI in the dashboard.
tileflow login
 
# Or store an existing project key manually.
tileflow login --manual
 
# CI or headless machines
TILEFLOW_API_KEY=tf_live_... tileflow deploy
 
# Confirm the saved credential and scopes
tileflow whoami

Tilesets

Register data before deploying maps that depend on it

Use the tileset commands when a map needs a PMTiles archive beyond the defaultworld dataset.

Terminal

export TILEFLOW_API_KEY=tf_live_...
tileflow tileset register --id madrid --name Madrid
tileflow tileset upload ./madrid.pmtiles --id madrid
tileflow status
tileflow deploy --tileset madrid