メインコンテンツまでスキップ
For the complete documentation index, see llms.txt.

Mapbox CLI

This section is the command reference for the Mapbox CLI (mapbox): every command group, the commands inside it, and their flags. For an introduction to the CLI, installing it, and how it behaves, see the Mapbox CLI guide.

Shared parameters

The command groups that call a Mapbox API — Accounts, Fonts, Geocoder, Search, Sprites, Static, Styles, and Tilesets — all take:

ParameterDescription
--username/-uFills the {username} path placeholder. Falls back to MAPBOX_USERNAME, then to the signed-in user — so you can omit it once you're signed in.
--token/-tAccess token. Falls back to MAPBOX_ACCESS_TOKEN, then stored credentials.
--profile <name>Which stored credentials to use.
--id <value>On a command that returns a list, print only the row with that id or name.

Each command group's own reference page lists only what's specific to it. Alphabetically, the command groups are:

Accounts

Access tokens and the scopes an account can grant them.

Agent Skills

Installs the Mapbox Agent Skills — hand-written guidance for coding agents on building with Mapbox. A different thing from Generate Skills below.

Authentication

Signs the CLI in to your Mapbox account and manages the token every other command uses: login, logout, refresh, and whoami.

Completion

Prints a shell completion script on stdout, for bash, zsh, fish, or PowerShell.

Fonts

The font faces map styles render text with.

Generate Skills

Writes the CLI's built-in command surface out as an Agent Skill, for a coding agent to read. A different thing from Agent Skills above.

Geocoder

Converts between place names and coordinates, forward and reverse.

Text search, reverse lookup, category search, and the category list, from the Search Box API.

Sprites

The sprite sheet a style draws its icons from, and the individual icons in it.

Static

A rendered map image or raster tile from a style.

Styles

Map styles and their drafts.

Tilesets

Tiles by tileset ID — raster, vector, and MRT — plus Tilequery, what vector features exist at or near a given point.

Tilesets-cli alias

Forwards everything verbatim to the separately installed Tilesets CLI — a different program from the Tilesets commands above.

Uninstall

Removes the mapbox binary. Stored credentials and a separately installed tilesets binary survive.

Usage

Reports account or token usage by product, by day.

Global options

Global options--output/-o, --schema, --dry-run, --yes/-y, --timeout, --use-login, and --debug — apply across every command, not only the API ones above.

このpageは役に立ちましたか?