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 vercelyarn global add vercelnpm i -g vercelbun add -g vercelWhen 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@latestyarn global add vercel@latestnpm i -g vercel@latestbun add -g vercel@latestIf you see permission errors, please read npm's official guide. Yarn depends on the same configuration as npm.
To see what changed in each version, browse the release notes.
The --version option can be used to verify the version of Vercel CLI currently being used.
vercel --versionvercel command with the --version option.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. If you don't have a Vercel account yet, you can create one with vercel signup. 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_TOKENenvironment variable - Pass the
--tokenoption 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.
View activity events for your Vercel project or team, filtered by type, date range, and project.
vercel activity
vercel activity --all --since 30d
vercel activity --type deployment --since 7dLearn more about the activity command
Generate an AGENTS.md file in the current project with Vercel deployment best practices for coding agents.
vercel agent init
vercel agent init --yesLearn more about the agent command
Find projects with Agent Runs activity, list recent runs, and inspect run metadata and conversation traces.
vercel agent-runs projects
vercel agent-runs list
vercel agent-runs inspect run_1234567890
vercel agent-runs trace run_1234567890 --jsonLearn more about the agent-runs command
Manage AI Gateway resources, including API keys, from the CLI.
vercel ai-gateway api-keys create
vercel ai-gateway api-keys create --name my-key --amount 500 --refresh-period monthlyLearn 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 alias set [deployment-url] [custom-domain]
vercel alias remove [custom-domain]
vercel alias listLearn more about the alias command
Make authenticated HTTP requests to the Vercel API from your terminal.
vercel api [endpoint]
vercel api /v2/user
vercel api /v9/projects -X POST -F name=my-projectLearn more about the api command
View usage and costs, contract commitments, your Spend Management budget, and invoices for your team.
vercel billing usage
vercel billing contract
vercel billing budgets set --amount 200 --pause --webhook https://example.com/spend
vercel billing invoices list
vercel billing invoices download [invoice-id]Learn more about the billing 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 blob list
vercel blob put [path-to-file] --access private
vercel blob get [url-or-pathname] --access private
vercel blob delete [url-or-pathname]
vercel blob copy [from-url] [to-pathname] --access privateLearn more about the blob command
Build a Vercel Project locally or in your own CI environment.
vercel build
vercel build --prodLearn more about the build command
Purchase Vercel products like credits, addons, subscriptions, and domains directly from the CLI.
vercel buy credits v0 100
vercel buy pro
vercel buy domain example.comLearn more about the buy command
Manage cache for your project (CDN cache, Runtime cache, and Data cache).
vercel cache purge
vercel cache purge --type cdn
vercel cache purge --type data
vercel cache invalidate --tag foo
vercel cache dangerously-delete --tag fooLearn more about the cache command
Manage certificates for your domains.
vercel certs list
vercel certs issue [domain]
vercel certs delete [certificate-id]Learn more about the certs command
Read recent Vercel product updates or search the changelog by keyword.
vercel changelog
vercel changelog search "AI SDK"
vercel changelog --limit 10 --jsonLearn more about the changelog command
Enable or disable Vercel CI for your repository, and inspect or rerun its jobs. Vercel CI is in Beta.
vercel ci ls
vercel ci inspect --wait
vercel ci logs --failed
vercel ci disable --remote originLearn more about the ci command
Review and manage existing Vercel Toolbar comment threads from the terminal.
vercel comments
vercel comments inspect <thread>
vercel comments resolve <thread> --message 'Fixed in the latest deployment.'Learn more about the comments command
Manage connectors: create, list, attach to projects, request runtime tokens, and remove them.
vercel connect create <service>
vercel connect list
vercel connect token <id>
vercel connect attach <id>
vercel connect detach <id>
vercel connect update <id>
vercel connect delete <id>
vercel connect open <id>
vercel connect contacts add <id> --phone-number +12025550123Run vercel connect create <service> --help to see how you can connect to a specific service.
Learn more about the connect 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 crons list
vercel crons add --path /api/cron --schedule "0 10 * * *"
vercel crons run /api/cronLearn more about the crons command
Make HTTP requests to your Vercel deployments with automatic deployment protection bypass.
vercel curl [path]
vercel curl /api/hello
vercel curl /api/data --deployment [deployment-url]Learn more about the curl command
List and inspect production Daemons, override instance counts, and restart individual instances.
vercel daemons list
vercel daemons inspect worker
vercel daemons instances list workerLearn more about the daemons command
Deploy your Vercel projects. Default command when no subcommand is specified.
vercel
vercel deploy
vercel deploy --prodLearn more about the deploy command
Manage Deploy Hooks: list, create, and remove deploy hook URLs that trigger new deployments when called.
vercel deploy-hooks list
vercel deploy-hooks create cms-rebuild --git-branch main
vercel deploy-hooks delete hook_abc123Learn more about the deploy-hooks command
Replicate the Vercel deployment environment locally and test your project.
vercel dev
vercel dev --listen 3000Learn more about the dev command
Manage your DNS records for your domains.
vercel dns list [domain]
vercel dns add [domain] [name] [type] [value]
vercel dns remove [record-id]Learn more about the dns command
Check your CLI setup and see how to fix each problem, without logging in or linking a project.
vercel doctor
vercel doctor --jsonLearn more about the doctor command
Buy, transfer, and manage your domains.
vercel domains list
vercel domains add [domain] [project]
vercel domains remove [domain]
vercel domains buy [domain]
vercel domains price [domain] [...domain]
vercel domains check [domain] [...domain]Learn more about the domains command
Manage drains that forward logs, traces, Web Analytics, and Speed Insights data to external endpoints.
vercel drains list
vercel drains inspect drn_example --json
vercel drains create --name app-logs --type logs --url https://example.com/drainLearn more about the drains command
Manage environment variables in your Vercel Projects.
vercel env list
vercel env add [name] --environment [environment]
vercel env update [name] --environment [environment]
vercel env remove [name] --environment [environment]
vercel env pull [file]
vercel env run -- <command>Learn more about the env command
Manage custom environments and use the --environment option on relevant commands.
vercel environments list
vercel deploy --environment=stagingLearn more about the environments command
Send bugs, friction, and feature requests to the Vercel team without logging in or linking a project.
vercel feedback "The error didn't explain how to fix the issue"
vercel feedback --field product=cli --field type=bug --field actual="Unknown option: --preview"Learn more about the feedback command
Manage your Vercel Firewall: view changes, publish, manage IP blocks, system bypass entries, custom rules, attack mode, and system mitigations.
vercel firewall overview
vercel firewall publish
vercel firewall ip-blocks block <ip>
vercel firewall rules list
vercel firewall attack-mode enableLearn more about the firewall command
Manage feature flags for your Vercel Project.
vercel flags list
vercel flags evaluations [flag]
vercel flags create [slug]
vercel flags versions [flag] --limit 10
vercel flags versions diff [flag] --revision [number]
vercel flags set [flag] --environment [environment] --variant [variant]
vercel flags segments list
vercel flags segments create beta-users --add include:user.id=user_123
vercel flags open [flag]Learn more about the flags command
Manage your Git provider connections.
vercel git connect
vercel git connect [git-url]
vercel git disconnectLearn more about the git command
Manage Global Config stores: list, create, inspect, update, delete, and manage items, read tokens, and backups.
vercel global-config list
vercel global-config create flags
vercel global-config items flags --key betaUiEnabled
vercel global-config tokens flags --add "Production read"
vercel global-config backups flagsLearn more about the global-config command
Enable or disable guidance messages shown after CLI commands.
vercel guidance enable
vercel guidance disable
vercel guidance statusLearn more about the guidance command
Read the public Vercel platform status, active incidents, scheduled maintenance, and recently resolved incidents.
vercel health
vercel health --jsonLearn more about the health 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 [framework-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] --waitLearn 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 integration add <integration-name> [--claim | --no-claim]
vercel integration list [project]
vercel integration discover
vercel integration guide <integration-name>
vercel integration balance <integration-name>
vercel integration open <integration-name> [resource-name]
vercel integration remove <integration-name>
vercel integration resource connect <resource-name> [project]
vercel integration resource disconnect <resource-name> [project]
vercel integration resource delete <resource-name>
vercel integration resource create-threshold <resource-name> <minimum> <spend> <limit>
vercel integration resource claim [resource-name]Learn more about the integration command
Manage Vercel KMS issuers, signing keys, and project grants. This command is in beta.
vercel kms list --scope my-team --json
vercel kms inspect iss_example --scope my-team --jsonLearn more about the kms command
Link a local directory to a Vercel Project, or add projects to an existing repository link.
vercel link
vercel link --cwd [path-to-directory]
vercel link --repo
vercel link addLearn 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 loginLearn more about the login command
Logout from your Vercel account through CLI.
vercel logoutLearn more about the logout command
Query runtime log entries and CDN request records for your project.
vercel logs
vercel logs requests
vercel logs --deployment [deployment-url]Learn more about the logs command
Set up MCP clients to use Vercel MCP.
vercel mcp
vercel mcp --projectLearn more about the mcp command
List and query metrics from your terminal, and inspect the schema to discover available dimensions and aggregations.
vercel metrics schema
vercel metrics schema <metric-or-prefix>
vercel metrics database.duration_ms --query 'plan:pro'
vercel metrics <metric_name> --since 7d --granularity 1d --project project-name --environment production
vercel metrics <metric_name> --all --group-by projectId --since 24h --environment productionLearn more about the metrics command
Work with microfrontends configuration.
vercel microfrontends pull
vercel microfrontends pull --deployment [deployment-id]Learn more about the microfrontends command
Create, list, inspect, update, and delete monitors for a project or team, and manage their notification destinations. Replaces the deprecated vercel alerts rules commands.
vercel monitors ls
vercel monitors notifications
vercel monitors add --project my-app --body ./monitor.json
vercel monitors rm [monitor-id]Learn more about the monitors command
Open your current project in the Vercel Dashboard.
vercel openLearn more about the open command
Create and manage organizations and their child teams: list and inspect organizations, create an organization from a team, and create or add child teams.
vercel organizations list
vercel --scope acme organizations create --slug acme
vercel organizations teams create acme --slug acme-web --name "Acme Web"Learn more about the organizations command
Look up Hobby, Pro, and Enterprise features from the public pricing table.
vercel pricing
vercel pricing "skew protection"
vercel pricing firewall --jsonLearn more about the pricing command
List, create, inspect, delete, and manage your Vercel Projects.
vercel project list
vercel project create [project-name]
vercel project delete [project-name]
vercel project inspect [project-name]
vercel project keep [project-name] --scope [team-slug]Learn more about the project command
Promote an existing deployment to be the current deployment.
vercel promote [deployment-id-or-url]
vercel promote status [project]Learn more about the promote command
Update your local project with remote environment variables and project settings.
vercel pull
vercel pull --environment=productionLearn 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 redirects list
vercel redirects add /old /new --status 301
vercel redirects import redirects.csv --force
vercel redirects promote <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 rollback status [project]Learn more about the rollback command
Manage your project's rolling releases to gradually roll out new deployments.
vercel rolling-release update --enable --advancement-type=manual-approval --stage=10 --stage=50
vercel rolling-release start --deployment=[deployment-id]
vercel rolling-release approve --deployment=[deployment-id] --currentStageIndex=[stage-index]
vercel rolling-release complete --deployment=[deployment-id]Learn more about the rolling-release command
Manage project-level routing rules for your Vercel Project.
vercel routes list
vercel routes add --ai "Rewrite /api/* to https://backend.internal/*"
vercel routes update "API Proxy" --dest "https://new-api.example.com/:path*"
vercel routes publishLearn 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 sandbox list
vercel sandbox create --connectLearn more about the sandbox command
Inspect and manage Vercel Schedules for a linked project. This command is in beta.
vercel schedules list
vercel schedules create daily-cleanup --cron "0 2 * * *" --topic scheduled-cleanup
vercel schedules invoke daily-cleanupLearn more about the schedules command
Inspect the security posture of your Vercel team with checks against vulnerable misconfigurations and settings, and triage Security Review vulnerabilities.
vercel security
vercel security check --findings
vercel security check [check-name]
vercel security vulnerabilitiesLearn more about the security command
Set up coding agents for Vercel: install the Vercel plugin for Claude Code, Codex, and OpenCode, and connect your agents to AI Gateway.
vercel setup
vercel setup gateway
vercel setup --dry-runLearn more about the setup command
Create a new Vercel account through CLI. Once sign-up is complete, you are signed in with the new account.
vercel signupLearn more about the signup command
Discover agent skills relevant to your project, or search the skill catalog.
vercel skills
vercel skills nextjs
vercel skills nextjs --jsonLearn more about the skills command
Manage storage resources and their project connections, including environment variables and Blob credentials.
vercel storage list
vercel storage status --all --json
vercel storage connect my-uploads --dry-runLearn more about the storage command
Switch between different team scopes.
vercel switch
vercel switch [team-slug]Learn more about the switch command
List, add, remove, and manage your teams.
vercel teams list
vercel teams create
vercel teams invite [email]Learn more about the teams command
Enable or disable telemetry collection. Learn what data Vercel CLI collects and how to opt out.
vercel telemetry status
vercel telemetry enable
vercel telemetry disableLearn more about the telemetry command
Configure supported coding agents to use Token Pass through AI Gateway.
vercel token-pass --agent opencode --dry-run
vercel token-pass setup --agent opencode --scope my-team --yesLearn more about the token-pass command
Manage your personal Vercel authentication tokens: list, create, and revoke API tokens.
vercel tokens list
vercel tokens create "CI deploy"
vercel tokens revoke tok_abc123Learn more about the tokens command
Inspect request traces for your project, and manage the sampling rules that decide which requests Vercel traces.
vercel traces inspect [request-id]
vercel traces [request-id]
vercel traces inspect [request-id] --open
vercel traces config ls
vercel traces config set 25 --environment production
vercel traces config remove --environment productionOpen a trace directly in the tree or waterfall view:
vercel traces inspect [request-id] --open --view=tree
vercel traces inspect [request-id] --open --view=waterfallLearn 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 --autoupdate
vercel upgrade --jsonLearn more about the upgrade command
Manage Vercel Container Registry repositories, tags, and images from the terminal. See the Container Registry CLI Reference for the full surface.
vercel vcr ls
vercel vcr login dockerLearn more about the vcr command
Manage webhooks for your account.
vercel webhooks list
vercel webhooks inspect <id>
vercel webhooks create <url> --event <event>
vercel webhooks delete <id>Learn more about the webhooks command
Display the username of the currently logged in user.
vercel whoamiLearn more about the whoami command
- The Complete Guide to Vercel Connect: Use Vercel Connect to call provider APIs like Slack, GitHub, Linear, Microsoft, Discord, Snowflake, and Salesforce from your agents and services with short-lived, scoped tokens instead of long-lived secrets.
- Does Vercel support Docker deployments?: Vercel supports deploying OCI-compatible container images through Vercel Functions and Vercel Container Registry, with Active CPU pricing and automatic scaling.
- Build a fullstack app with Next.js 16 and Prisma Postgres: Create a fullstack blog with the Next.js App Router, Prisma, Sign in with Vercel, Prisma Postgres from the Vercel Marketplace, and deploy it to Vercel.
Was this helpful?