Vercel CLI Overview

Vercel gives you multiple ways to interact with and configure your Vercel Projects. With the command-line interface (CLI) you can interact with the Vercel platform using a terminal, or through an automated system, enabling you to retrieve logs, manage certificates, replicate your deployment environment locally, manage Domain Name System (DNS) records, and more.

If you'd like to interface with the platform programmatically, check out the REST API documentation.

To download and install Vercel CLI, run the following command:

pnpm i -g vercel

When there is a new release of Vercel CLI, running any command will show you a message letting you know that an update is available.

If you have installed our command-line interface through npm or Yarn, the easiest way to update it is by running the installation command yet again.

pnpm i -g vercel@latest

If you see permission errors, please read npm's official guide. Yarn depends on the same configuration as npm.

The --version option can be used to verify the version of Vercel CLI currently being used.

vercel --version

Vercel CLI requires you to log in and authenticate before accessing resources or performing administrative tasks. In a terminal environment, you can use vercel login, which requires manual input. In a CI/CD environment where manual input is not possible, you can create a token on your tokens page and then authenticate using one of these methods:

• Set the VERCEL_TOKEN environment variable
• Pass the --token option to the command

Using the VERCEL_TOKEN environment variable is recommended for CI/CD because it avoids exposing the token in command-line arguments, which can be visible in process lists and logs. If both are provided, the --token flag takes precedence over the environment variable.

Native CLI binaries are also available as an experimental opt-in install.

Native CLI binaries can reduce setup in environments where installing and maintaining Node.js is unnecessary or inconvenient, including lightweight containers, CI jobs, or managed developer workspaces.

To install the native binary, run:

pnpm i-g@vercel/vc-native-f

The -f flag is required because the native package installs the same global bin names as the standard CLI. It allows pnpm to replace existing global vercel and vc bin links. Once installed, vercel and vc run the native binary matched to your OS and CPU architecture, across macOS, Linux, and Windows on x64 and arm64.

Platform-specific packages are also available when you need a specific binary:

pnpm i-g@vercel/vc-native-darwin-x64-f

View activity events for your Vercel project or team, filtered by type, date range, and project.

vercel activity
vercel activityls--all--since30d
vercel activityls--typedeployment--since7d

Learn more about the activity command

Generate an AGENTS.md file in the current project with Vercel deployment best practices for coding agents.

vercel agentinit
vercel agentinit--yes

Learn more about the agent command

Manage AI Gateway resources, including API keys, from the CLI.

vercel ai-gatewayapi-keyscreate
vercel ai-gatewayapi-keyscreate--namemy-key--budget500--refresh-periodmonthly

Learn more about the ai-gateway command

List recent alerts for a linked project, a specific project, or an entire team.

vercel alerts
vercel alerts--all
vercel alerts--project [project-name]

Learn more about the alerts command

Apply custom domain aliases to your Vercel deployments.

vercel aliasset [deployment-url] [custom-domain]
vercel aliasrm [custom-domain]
vercel aliasls

Learn more about the alias command

Make authenticated HTTP requests to the Vercel API from your terminal. This is a beta command.

vercel api [endpoint]
vercel api/v2/user
vercel api/v9/projects-XPOST-Fname=my-project

Learn more about the api command

Perform a binary search on your deployments to help surface issues.

vercel bisect
vercel bisect--good [deployment-url] --bad [deployment-url]

Learn more about the bisect command

Interact with Vercel Blob storage to upload, download, list, delete, and copy files.

vercel bloblist
vercel blobput [path-to-file]
vercel blobget [url-or-pathname]
vercel blobdel [url-or-pathname]
vercel blobcopy [from-url] [to-pathname]

Learn more about the blob command

Build a Vercel Project locally or in your own CI environment.

vercel build
vercel build--prod

Learn more about the build command

Purchase Vercel products like credits, addons, subscriptions, and domains directly from the CLI.

vercel buycreditsv0100
vercel buyaddonsiem1
vercel buypro
vercel buydomainexample.com

Learn more about the buy command

Manage cache for your project (CDN cache and Data cache).

vercel cachepurge
vercel cachepurge--typecdn
vercel cachepurge--typedata
vercel cacheinvalidate--tagfoo
vercel cachedangerously-delete--tagfoo

Learn more about the cache command

Manage certificates for your domains.

vercel certsls
vercel certsissue [domain]
vercel certsrm [certificate-id]

Learn more about the certs command

Manage connectors: create, list, attach to projects, request runtime tokens, and remove them. This is a beta command.

vercel connectcreate<type>
vercel connectlist
vercel connecttoken<id>
vercel connectattach<id>
vercel connectdetach<id>
vercel connectupdate<id>
vercel connectremove<id>
vercel connectopen<id>

Learn more about the connect command

View contract commitment information for your Vercel account.

vercel contract
vercel contract--formatjson

Learn more about the contract command

Manage Cron Jobs for a project: add cron entries to vercel.json, list them, and trigger them on demand. This command is in beta.

vercel cronsls
vercel cronsadd--path/api/cron--schedule"0 10 * * *"
vercel cronsrun/api/cron

Learn more about the crons command

Make HTTP requests to your Vercel deployments with automatic deployment protection bypass. This is a beta command.

vercel curl [path]
vercel curl/api/hello
vercel curl/api/data--deployment [deployment-url]

Learn more about the curl command

Deploy your Vercel projects. Default command when no subcommand is specified.

vercel
vercel deploy
vercel deploy--prod

Learn more about the deploy command

Manage Deploy Hooks: list, create, and remove deploy hook URLs that trigger new deployments when called.

vercel deploy-hooksls
vercel deploy-hookscreatecms-rebuild--refmain
vercel deploy-hooksrmhook_abc123

Learn more about the deploy-hooks command

Replicate the Vercel deployment environment locally and test your project.

vercel dev
vercel dev--port3000

Learn more about the dev command

Manage your DNS records for your domains.

vercel dnsls [domain]
vercel dnsadd [domain] [name] [type] [value]
vercel dnsrm [record-id]

Learn more about the dns command

Buy, sell, transfer, and manage your domains.

vercel domainsls
vercel domainsadd [domain] [project]
vercel domainsrm [domain]
vercel domainsbuy [domain]
vercel domainsprice [domain] [...domain]
vercel domainscheck [domain] [...domain]

Learn more about the domains command

Manage Edge Config stores: list, create, inspect, update, remove, and manage items, read tokens, and backups.

vercel edge-configlist
vercel edge-configaddflags
vercel edge-configitemsflags--keybetaUiEnabled
vercel edge-configtokensflags--add"Production read"
vercel edge-configbackupsflags

Learn more about the edge-config command

Manage environment variables in your Vercel Projects.

vercel envls
vercel envadd [name] [environment]
vercel envupdate [name] [environment]
vercel envrm [name] [environment]
vercel envpull [file]
vercel envrun--<command>

Learn more about the env command

Manage your Vercel Firewall: view changes, publish, manage IP blocks, system bypass entries, custom rules, attack mode, and system mitigations.

vercel firewalloverview
vercel firewallpublish
vercel firewallip-blocksblock<ip>
vercel firewallruleslist
vercel firewallattack-modeenable

Learn more about the firewall command

Manage feature flags for your Vercel Project.

vercel flagslist
vercel flagscreate [slug]
vercel flagsset [flag] --environment [environment] --variant [variant]
vercel flagssegmentsls
vercel flagssegmentscreatebeta-users--addinclude:user.id=user_123
vercel flagsopen [flag]

Learn more about the flags command

Manage your Git provider connections.

vercel gitls
vercel gitconnect
vercel gitdisconnect [provider]

Learn more about the git command

Enable or disable guidance messages shown after CLI commands.

vercel guidanceenable
vercel guidancedisable
vercel guidancestatus

Learn more about the guidance command

Get information about all available Vercel CLI commands.

vercel help
vercel help [command]

Learn more about the help command

Visualize HTTP request timing statistics for your Vercel deployments with automatic deployment protection bypass.

vercel httpstat [path]
vercel httpstat/api/hello
vercel httpstat/api/data--deployment [deployment-url]

Learn more about the httpstat command

Initialize example Vercel Projects locally from the examples repository.

vercel init
vercel init [project-name]

Learn more about the init command

Retrieve information about your Vercel deployments.

vercel inspect [deployment-id-or-url]
vercel inspect [deployment-id-or-url] --logs
vercel inspect [deployment-id-or-url] --wait

Learn more about the inspect command

Install a marketplace integration and provision a resource. Alias for vercel integration add.

vercel install<integration-name>

Learn more about the install command

Manage marketplace integrations: provision resources, discover available integrations, view setup guides, check balances, and manage individual resources with the nested resource subcommand.

vercel integrationadd<integration-name> [--claim | --no-claim]
vercel integrationlist [project]
vercel integrationdiscover
vercel integrationguide<integration-name>
vercel integrationbalance<integration-name>
vercel integrationopen<integration-name> [resource-name]
vercel integrationremove<integration-name>
vercel integrationresourceconnect<resource-name> [project]
vercel integrationresourcedisconnect<resource-name> [project]
vercel integrationresourceremove<resource-name>
vercel integrationresourcecreate-threshold<resource-name><minimum><spend><limit>
vercel integrationresourceclaim [resource-name]

The resource subcommand is also available as vercel integration-resource <subcommand> and vc ir <subcommand> (backward-compatible aliases).

Learn more about the integration command

Link a local directory to a Vercel Project.

vercel link
vercel link [path-to-directory]

Learn more about the link command

List recent deployments for the current Vercel Project.

vercel list
vercel list [project-name]

Learn more about the list command

Login to your Vercel account through CLI.

vercel login
vercel login [email]
vercel login--github

Learn more about the login command

Logout from your Vercel account through CLI.

vercel logout

Learn more about the logout command

List runtime logs for a specific deployment.

vercel logs [deployment-url]
vercel logs [deployment-url] --follow

Learn more about the logs command

Set up MCP client configuration for your Vercel Project.

vercel mcp
vercel mcp--project

Learn more about the mcp command

Query metrics from your terminal and inspect the schema to discover the metrics, dimensions, and aggregations available to your account.

vercel metricsschema
vercel metricsschema<metric-or-prefix>
vercel metrics<metric-id>--since7d--granularity1d--projectproject-name--prod
vercel metrics<metric-id>--all--group-byproject_id--since24h--prod

Learn more about the metrics command

Work with microfrontends configuration.

vercel microfrontendspull
vercel microfrontendspull--dpl [deployment-id]

Learn more about the microfrontends command

Register Vercel Apps (OAuth) and manage team installations: register new apps, list and dismiss installation requests, install apps with permissions, and uninstall them.

vercel oauth-appslist-requests
vercel oauth-appsregister--name"My App"--slugmy-app--redirect-urihttps://app.example.com/oauth/callback
vercel oauth-appsinstall--client-idcl_abc--permissionread:project
vercel oauth-appsremoveinst_abc123--yes

Learn more about the oauth-apps command

Open your current project in the Vercel Dashboard.

vercel open

Learn more about the open command

List, add, inspect, remove, and manage your Vercel Projects.

vercel projectls
vercel projectadd
vercel projectrm
vercel projectinspect [project-name]

Learn more about the project command

Promote an existing deployment to be the current deployment.

vercel promote [deployment-id-or-url]
vercel promotestatus [project]

Learn more about the promote command

Update your local project with remote environment variables and project settings.

vercel pull
vercel pull--environment=production

Learn more about the pull command

Rebuild and redeploy an existing deployment.

vercel redeploy [deployment-id-or-url]

Learn more about the redeploy command

Manage project-level redirects.

vercel redirectslist
vercel redirectsadd/old/new--status301
vercel redirectsuploadredirects.csv--overwrite
vercel redirectspromote<version-id>

Learn more about the redirects command

Remove deployments either by ID or for a specific Vercel Project.

vercel remove [deployment-url]
vercel remove [project-name]

Learn more about the remove command

Roll back production deployments to previous deployments.

vercel rollback
vercel rollback [deployment-id-or-url]
vercel rollbackstatus [project]

Learn more about the rollback command

Manage your project's rolling releases to gradually roll out new deployments.

vercel rolling-releaseconfigure--cfg='[config]'
vercel rolling-releasestart--dpl=[deployment-id]
vercel rolling-releaseapprove--dpl=[deployment-id]
vercel rolling-releasecomplete--dpl=[deployment-id]

Learn more about the rolling-release command

Manage project-level routing rules for your Vercel Project.

vercel routeslist
vercel routesadd--ai"Rewrite /api/* to https://backend.internal/*"
vercel routesedit"API Proxy"--dest"https://new-api.example.com/:path*"
vercel routespublish

Learn more about the routes command

Interact with Vercel Sandbox: list, create, connect, and manage sandboxes from the terminal. See the Sandbox CLI Reference for the full surface.

vercel sandboxlist
vercel sandboxcreate--connect

Learn more about the sandbox command

Discover agent skills relevant to your project, or search the skill catalog.

vercel skills
vercel skillsnextjs
vercel skillsnextjs--json

Learn more about the skills command

Switch between different team scopes.

vercel switch
vercel switch [team-name]

Learn more about the switch command

Manage custom environments (targets) and use the --target flag on relevant commands.

vercel targetlist
vercel targetls
vercel deploy--target=staging

Learn more about the target command

List, add, remove, and manage your teams.

vercel teamslist
vercel teamsadd
vercel teamsinvite [email]

Learn more about the teams command

Enable or disable telemetry collection.

vercel telemetrystatus
vercel telemetryenable
vercel telemetrydisable

Learn more about the telemetry command

Manage your personal Vercel authentication tokens: list, create, and revoke API tokens.

vercel tokensls
vercel tokensadd"CI deploy"
vercel tokensrmtok_abc123

Learn more about the tokens command

Inspect request traces for your project.

vercel tracesget [request-id]
vercel traces [request-id]
vercel tracesget [request-id] --open

Open a trace directly in the tree or waterfall view:

vercel tracesget [request-id] --open--view=tree
vercel tracesget [request-id] --open--view=waterfall

Learn more about the traces command

Upgrade the Vercel CLI to the latest version and manage automatic updates.

vercel upgrade
vercel upgrade--dry-run
vercel upgrade--enable-auto
vercel upgrade--format=json

Learn more about the upgrade command

View billing usage and costs for your Vercel account.

vercel usage
vercel usage--from2025-01-01--to2025-01-31
vercel usage--breakdowndaily

Learn more about the usage command

Manage webhooks for your account. This command is in beta.

vercel webhookslist
vercel webhooksget<id>
vercel webhookscreate<url>--event<event>
vercel webhooksrm<id>

Learn more about the webhooks command

Display the username of the currently logged in user.

vercel whoami

Learn more about the whoami command