vercel global-config
The vercel global-config command manages Global Config stores from the CLI. It mirrors the dashboard API surface: create stores, inspect metadata, patch items in batch, list items, manage read tokens, and restore backups. For an overview of Global Config and how to read from it at runtime, see Vercel Global Config.
vercel global-config [subcommand]Using the vercel global-config command to manage Global Config stores.
Lists Global Config stores for the current team. Running vercel global-config with no subcommand runs list.
vercel global-config
vercel global-config list
vercel global-config list --format json--format json for machine-readable output.| Option | Type | Description |
|---|---|---|
-F, --format <FORMAT> | String | Output format (json) |
Creates a new Global Config store with the given slug. Optionally seeds it with initial items.
vercel global-config add flags
vercel global-config add flags --items '{"betaUiEnabled":true,"region":"sfo1"}'Create a store with slug flags, optionally with seed items.
| Argument | Required | Description |
|---|---|---|
slug | Yes | Slug for the new Global Config store |
| Option | Type | Description |
|---|---|---|
--items <JSON> | String | Optional JSON object of initial items ({ "key": <value>, ... }) |
-F, --format <FORMAT> | String | Output format (json) |
Shows metadata for a Global Config store. Accepts either the store ID (starts with ecfg_) or the slug.
vercel global-config get flags
vercel global-config get ecfg_abc123 --format json| Argument | Required | Description |
|---|---|---|
id-or-slug | Yes | Store ID (e.g. ecfg_abc123) or slug |
| Option | Type | Description |
|---|---|---|
-F, --format <FORMAT> | String | Output format (json) |
Renames a Global Config store (--slug) and/or patches its items (--patch). For complex updates, use the batch items API shape.
vercel global-config update flags --slug feature-flags
vercel global-config update flags --patch '{"items":[{"operation":"upsert","key":"betaUiEnabled","value":true}]}'Rename a store and/or patch items in batch.
| Argument | Required | Description |
|---|---|---|
id-or-slug | Yes | Store ID or slug |
| Option | Type | Description |
|---|---|---|
--slug <SLUG> | String | New slug for the store |
--patch <JSON> | String | Batch items payload ({"items":[...]} or a bare array). Each item needs operation (create, update, upsert, or delete), key, and usually value |
-F, --format <FORMAT> | String | Output format (json) |
Deletes a Global Config store.
vercel global-config remove flags --yes--yes to skip the confirmation prompt.| Argument | Required | Description |
|---|---|---|
id-or-slug | Yes | Store ID or slug |
| Option | Type | Description |
|---|---|---|
-y, --yes | Boolean | Skip the confirmation prompt |
-F, --format <FORMAT> | String | Output format (json) |
Lists items in a Global Config store, or fetches one item with --key.
vercel global-config items flags
vercel global-config items flags --key betaUiEnabled| Argument | Required | Description |
|---|---|---|
id-or-slug | Yes | Store ID or slug |
| Option | Type | Description |
|---|---|---|
-k, --key <KEY> | String | When set, fetch a single item by key |
-F, --format <FORMAT> | String | Output format (json) |
Lists, creates (--add), or revokes (--remove) read tokens for a Global Config store. Read tokens authenticate Global Config reads from your application at runtime.
vercel global-config tokens flags
vercel global-config tokens flags --add "Production read"
vercel global-config tokens flags --remove tok_abc123 --yes| Argument | Required | Description |
|---|---|---|
id-or-slug | Yes | Store ID or slug |
| Option | Type | Description |
|---|---|---|
--add <LABEL> | String | Create a new read token with this label (1-52 characters) |
--remove <ID_OR_TOKEN> | String[] | Revoke one or more tokens by ID or plaintext token (repeatable). Requires --yes in non-interactive mode |
-y, --yes | Boolean | Skip the confirmation prompt |
-F, --format <FORMAT> | String | Output format (json) |
Lists backups for a Global Config store, fetches a single backup version with --backup-version, or restores items from a backup with --restore.
vercel global-config backups flags
vercel global-config backups flags --backup-version backup_version_abc123 --format json
vercel global-config backups flags --restore backup_version_abc123 --yes| Argument | Required | Description |
|---|---|---|
id-or-slug | Yes | Store ID or slug |
| Option | Type | Description |
|---|---|---|
--backup-version <VERSION_ID> | String | Fetch a single backup version by ID |
--restore <VERSION_ID> | String | Restore items from a backup version. Cannot be used with --backup-version |
--limit <NUMBER> | Number | Maximum number of backups to list (0 to 50) |
--next <CURSOR> | String | Pagination cursor from a previous backup list response |
-y, --yes | Boolean | Skip the confirmation prompt when restoring |
-F, --format <FORMAT> | String | Output format (json) |
vercel global-config add flags --items '{"betaUiEnabled":false,"region":"sfo1"}'vercel global-config update flags --patch '{"items":[
{"operation":"upsert","key":"betaUiEnabled","value":true},
{"operation":"delete","key":"oldFlag"}
]}'Apply a batch of item operations in one call. See the batch items REST API reference.
vercel global-config tokens flags --add "Production read"Create a labeled read token. The CLI prints the plaintext token (and its ID) once; capture it before it scrolls away.
vercel global-config backups flags --restore backup_version_abc123 --yesRestore flags from a backup version and skip the confirmation prompt.
The Global Config SDK reads from a GLOBAL_CONFIG environment variable (falling back to EDGE_CONFIG) that contains a full connection string, not just the token. The connection string format is:
https://global-config.vercel.com/<globalConfigId>?token=<token>Use vercel global-config get <id-or-slug> to look up the Global Config ID, then combine it with the token. See Global Config dashboard for details on the connection string format.
The following global options can be passed when using the vercel global-config command:
--cwd--debug--global-config--help--local-config--no-color--non-interactive--scope--team--token--version
For more information on global options and their usage, refer to the options section.
Was this helpful?