Vercel

vercel activity

View activity events for a linked project or team, with filtering by type, date range, and project.

Signature / Usage

vercel activity
vercel activity ls --all --since 30d
vercel activity ls --type deployment --since 7d
vercel activity types

Options / Props

Notes

• --all and --project are mutually exclusive
• Pagination: --next accepts the timestamp value printed after each page

Related

• logs.md

vercel agent

Generate or update a section about Vercel deployment best practices in the project's agent guidance file (AGENTS.md or CLAUDE.md).

Signature / Usage

vercel agent init
vercel agent init --yes

Options / Props

Notes

• Target file is AGENTS.md by default; CLAUDE.md when run from Claude Code
• Wrapped in <!-- VERCEL BEST PRACTICES START --> / <!-- VERCEL BEST PRACTICES END --> markers
• Safe to re-run: updates only the marked section; existing content is preserved
• Creates the file if it doesn't exist; appends if markers are absent

vercel alerts

List recent alerts for a linked project, a specific project, or an entire team. Supports AI investigation summaries and alert rule management.

Signature / Usage

vercel alerts
vercel alerts --all
vercel alerts --type usage_anomaly --since 2026-03-01T00:00:00.000Z
vercel alerts inspect <groupId>
vercel alerts rules ls
vercel alerts rules add --body ./rule.json

Options / Props

Notes

• Default scope: linked project from the last 24 hours
• --all requires team context

Related

• activity.md

vercel alias

Apply custom domain aliases to Vercel deployments.

Signature / Usage

vercel alias set [deployment-url] [custom-domain]
vercel alias rm [custom-domain]
vercel alias ls
vercel alias ls --limit 100

Options / Props

Notes

• Do NOT include https:// in the [custom-domain] argument
• For production promotion, prefer vercel promote or vercel rollback instead
• Use vercel --prod --skip-domain to create a staged production deployment without domain assignment

Related

• deploy.md
• promote.md
• rollback.md
• domains.md

vercel api

Make authenticated HTTP requests to the Vercel API from the terminal. Beta command.

Signature / Usage

vercel api /v2/user
vercel api /v9/projects -X POST -F name=my-project
vercel api /v6/deployments --paginate
vercel api   # interactive endpoint discovery
vercel api ls  # list all available endpoints

Options / Props

Notes

• Running without an endpoint enters interactive mode with OpenAPI-based discovery
• vercel api ls lists all available API endpoints
• Authentication uses the current CLI session automatically

Related

• global-options.md
• curl.md

vercel bisect

Binary search through deployments to find when a bug was introduced, similar to git bisect but without rebuilding each commit.

Signature / Usage

vercel bisect
vercel bisect --good https://example.com --bad https://example-s93n1nfa.vercel.app
vercel bisect --path /blog/first-post --open
vercel bisect --run ./test.sh

Options / Props

Notes

• Good and bad deployments must be production deployments
• If an alias URL is used, it resolves to the current alias target at the time of bisect
• Manual steps: at each deployment prompt, mark it good or bad

Related

• deploy.md
• inspect.md

vercel blob

Interact with Vercel Blob storage: upload, download, list, delete, copy files, and manage stores.

Signature / Usage

vercel blob list
vercel blob put image.jpg --access public
vercel blob get https://... --output ./local.jpg
vercel blob del https://...
vercel blob copy [from-url] [to-pathname] --access public
vercel blob create-store my-store --access public
vercel blob list-stores

Options / Props

Notes

• Subcommands: list / ls, put, del, copy / cp, get, create-store, delete-store, get-store, list-stores / ls-stores, empty-store

Related

• env.md

vercel build

Build a Vercel Project locally or in a CI environment. Output is placed in .vercel/output (Build Output API v3 format).

Signature / Usage

vercel build
vercel build --prod
vercel build --target=staging
vercel build --output ./custom-output

Options / Props

Notes

• Run vercel pull first to ensure local env vars and project settings are up to date
• Use with vercel deploy --prebuilt to deploy without sharing source code with Vercel
• System environment variables are not available at build time with --prebuilt; avoid using it if your framework relies on them

Related

• deploy.md
• pull.md

vercel buy

Purchase Vercel products (credits, addons, subscriptions, domains) from the CLI.

Signature / Usage

vercel buy credits v0 100
vercel buy credits gateway 250
vercel buy addon siem 1
vercel buy pro
vercel buy domain example.com

Options / Props

Notes

• All subcommands except domain require team scope; use --scope if needed
• Subcommands: credits [v0|gateway|agent] <amount>, addon <name> <quantity>, pro, v0, domain <domain>
• credits max $1,000 per purchase
• addon requires Flex plan; current supported addon: siem
• domain delegates to vercel domains buy

Related

• domains.md

vercel cache

Manage CDN cache and Data cache for a project: purge, invalidate, or dangerously delete cached content.

Signature / Usage

vercel cache purge
vercel cache purge --type cdn
vercel cache invalidate --tag blog-posts
vercel cache dangerously-delete --tag blog-posts
vercel cache invalidate --srcimg /api/avatar/1

Options / Props

Notes

• purge: immediately removes CDN cache; subsequent requests serve MISS
• invalidate: marks cached content as STALE; subsequent requests revalidate in background
• dangerously-delete: immediately removes cached content; subsequent requests block while revalidating
• --tag and --srcimg are mutually exclusive

Related

• deploy.md

vercel certs

Manage SSL certificates for domains: list, issue, and remove. Vercel manages certificates automatically.

Signature / Usage

vercel certs ls
vercel certs issue foo.com bar.com
vercel certs issue foo.com --challenge-only
vercel certs rm [certificate-id]

Options / Props

Notes

• Subcommands: ls, issue [domain1 domain2 ...], rm [certificate-id]
• Vercel auto-manages certificates; manual issuance is rarely needed

Related

• domains.md

vercel contract

View contract commitment information for your Vercel account: contract periods, commitment types, and values.

Signature / Usage

vercel contract
vercel contract --format json

Options / Props

Notes

• Output table shows: Contract ID, Contract Period, Commitment Type, Category, Period, Commitment, Description
• Category is either "Spend" (Pro plans) or "Usage" (Enterprise plans)

vercel curl

Make HTTP requests to Vercel deployments with automatic deployment protection bypass. Beta command.

Signature / Usage

vercel curl /api/hello
vercel curl /api/users -- --request POST --header "Content-Type: application/json" --data '{"name":"John"}'
vercel curl /api/status --deployment https://my-app-abc123.vercel.app
vercel curl --trace /api/hello

Options / Props

Notes

• Requires curl to be installed on the system
• Place -- before passing flags to the underlying curl command
• Available in Vercel CLI v48.8.0+
• Automatically adds x-vercel-protection-bypass header

Related

• httpstat.md
• traces.md
• api.md

vercel deploy

Deploy a Vercel project. Default command when no subcommand is specified.

Signature / Usage

vercel
vercel deploy
vercel deploy --prod
vercel deploy --prebuilt --archive=tgz
vercel deploy --target=staging

Options / Props

Notes

• stdout is always the deployment URL; suitable for piping
• stderr carries error messages; check exit code in CI scripts
• When using --prebuilt, System Environment Variables are absent at build time

Related

• build.md
• promote.md
• rollback.md
• alias.md
• list.md

vercel dev

Replicate the Vercel deployment environment locally to test Functions and Middleware without deploying.

Signature / Usage

vercel dev
vercel dev --listen 5005

Options / Props

Notes

• Run npm install before using vercel dev
• If your framework's dev command (e.g. next dev) already supports all needed features, prefer that over vercel dev
• The Development Command configured in Project Settings affects vercel dev behavior for the whole team

Related

• pull.md
• build.md
• env.md

vercel dns

Manage DNS records for domains: list, add, remove, and import zone files.

Signature / Usage

vercel dns ls [domain]
vercel dns add [domain] [subdomain] [A|AAAA|ALIAS|CNAME|TXT] [value]
vercel dns add [domain] '@' MX [record-value] [priority]
vercel dns add [domain] [name] SRV [priority] [weight] [port] [target]
vercel dns add [domain] [name] CAA '[flags] [tag] "[value]"'
vercel dns rm [record-id]
vercel dns import [domain] [path-to-zonefile]

Options / Props

Notes

• New DNS records may take up to 24 hours to propagate
• Subcommands: ls [domain], add, rm [record-id], import [domain] [zonefile]

Related

• domains.md
• certs.md

vercel domains

Buy, transfer, and manage domains under the current scope.

Signature / Usage

vercel domains ls
vercel domains inspect [domain]
vercel domains add [domain] [project]
vercel domains rm [domain]
vercel domains buy [domain]
vercel domains price [domain] [...domain]
vercel domains check [domain] [...domain]
vercel domains move [domain] [scope-name]
vercel domains transfer-in [domain]

Options / Props

Notes

• Subcommands: ls, inspect, add, rm, buy, price, check, move, transfer-in
• Project dashboard provides more options and control than CLI

Related

• dns.md
• certs.md
• alias.md

vercel env

Manage environment variables in Vercel Projects: list, add, update, remove, pull to file, and run commands with env vars.

Signature / Usage

vercel env ls [environment] [gitbranch]
vercel env add [name] [environment] [gitbranch]
vercel env update [name] [environment]
vercel env rm [name] [environment]
vercel env pull [file]
vercel env pull --environment=preview --git-branch=feature-branch
vercel env run -- next dev
vercel env run -e production -- next build

Options / Props

Notes

• Sensitive env vars (default for production/preview) are not viewable after creation; development env vars cannot be sensitive
• vercel env pull exports to a file (default: .env.local); vercel env run injects without writing to disk
• For vercel build / vercel dev, use vercel pull instead
• Team policy "Enforce Sensitive Environment Variables" overrides --no-sensitive
• The -- separator is required for vercel env run -- <command>

Related

• pull.md
• dev.md
• build.md

vercel firewall

Manage Vercel Firewall: custom rules, IP blocks, system bypass, attack mode, and system mitigations. Custom rule and IP block changes are staged until published.

Signature / Usage

vercel firewall overview
vercel firewall rules list
vercel firewall rules add "Block bots" \
  --condition '{"type":"user_agent","op":"sub","value":"crawler"}' \
  --action deny --yes
vercel firewall rules edit "My Rule" --action challenge --duration 5m --yes
vercel firewall ip-blocks block 1.2.3.4 --yes
vercel firewall attack-mode enable --duration 24h --yes
vercel firewall diff
vercel firewall publish --yes

Options / Props

rules add / rules edit

ip-blocks block / unblock

attack-mode enable

Notes

• Staging: rules add/edit/remove and ip-blocks block/unblock are staged; run vercel firewall publish to apply
• Immediate: system-bypass, attack-mode, system-mitigations take effect without publishing
• vercel firewall diff reviews staged changes; vercel firewall discard cancels them
• Condition type values include: path, method, host, ip_address, user_agent, geo_country, header, cookie, query, ja4_digest, and more
• Operator values: eq, neq, sub, pre, suf, re, ex, nex, inc, ninc, gt, gte, lt, lte

Related

• project.md

vercel flags

Manage Vercel Flags (feature flags) for a project: create, list, inspect, update, set variants, split traffic, rollout, enable/disable, archive, delete, and manage SDK keys.

Signature / Usage

vercel flags list
vercel flags create my-feature --kind boolean
vercel flags create welcome-msg --kind string --variant control="Hello" --variant treatment="Hi"
vercel flags set my-feature --environment production --variant true
vercel flags split ai-model --environment production --by user.id --weight stable=95 --weight candidate=5
vercel flags rollout checkout --environment production --by user.id --stage 5,6h --stage 50,1d
vercel flags enable my-feature --environment production
vercel flags disable my-feature --environment production
vercel flags archive my-feature --yes
vercel flags rm my-feature --yes
vercel flags sdk-keys ls
vercel flags sdk-keys add --type server --environment production
vercel flags override my-flag=true

Options / Props

Notes

• Boolean flags always have false/true variants (labeled Off/On)
• JSON flags accept any valid JSON value including objects, arrays, numbers, strings, null
• A flag must be archived before it can be deleted
• FLAGS_SECRET env var is required for vercel flags override
• vercel flags prepare writes synthetic @vercel/flags-definitions package; typically run automatically by the build pipeline

Related

• env.md
• deploy.md

vercel git

Manage Git provider repository connections for a Vercel Project.

Signature / Usage

vercel git connect
vercel git connect --yes
vercel git disconnect
vercel git ls

Options / Props

Notes

• Searches for a local .git config file with at least one remote URL
• Subcommands: connect, disconnect [provider], ls

Related

• link.md
• deploy.md

Vercel CLI Global Options

Options available across all Vercel CLI commands.

Options / Props

Notes

• --project precedence: --project flag > VERCEL_PROJECT_ID env var > .vercel/project.json
• --token precedence: --token flag > VERCEL_TOKEN env var
• Use VERCEL_TOKEN in CI/CD to avoid exposing tokens in process lists

Related

• overview.md

vercel guidance

Enable or disable guidance messages shown after CLI commands.

Signature / Usage

vercel guidance enable
vercel guidance disable
vercel guidance status

Notes

• Guidance messages suggest recommended next steps after operations like deployment
• Also controllable per-command with vercel deploy --guidance

Related

• deploy.md

vercel help

Display help information for Vercel CLI commands.

Signature / Usage

vercel help
vercel help [command]
vercel --help
vercel [command] --help

Notes

• Equivalent to the --help / -h global option on any command
• Shows available subcommands and options for the specified command

Related

• global-options.md
• overview.md

vercel httpstat

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

Signature / Usage

vercel httpstat /api/hello
vercel httpstat /api/users -- -X POST -H "Content-Type: application/json" -d '{}'
vercel httpstat /api/status --deployment https://my-app-abc123.vercel.app

Options / Props

Notes

• Requires httpstat to be installed (pip install httpstat or brew install httpstat)
• Place -- before flags intended for the underlying httpstat command
• Available in Vercel CLI v48.9.0+
• Output shows: DNS Lookup, TCP Connection, TLS Handshake, Server Processing, Content Transfer timings

Related

• curl.md
• traces.md

vercel init

Initialize a Vercel supported framework example locally from the official examples repository.

Signature / Usage

vercel init
vercel init [framework-name]
vercel init gatsby my-project-directory
vercel init gatsby my-project --force

Options / Props

Notes

• Without arguments, shows an interactive list of supported frameworks
• Optional second argument renames the local directory
• Examples sourced from github.com/vercel/vercel/tree/main/examples

Related

• link.md
• deploy.md

vercel inspect

Retrieve information about a Vercel deployment by URL or ID.

Signature / Usage

vercel inspect [deployment-id-or-url]
vercel inspect https://example-app.vercel.app --logs
vercel inspect https://example-app.vercel.app --wait
vercel inspect https://example-app.vercel.app --logs --wait

Options / Props

Notes

• If deployment is queued or canceled there are no logs to display
• Combine --logs --wait to stream all build logs until deployment is ready

Related

• list.md
• logs.md
• deploy.md

vercel install

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

Signature / Usage

vercel install <integration-name>
vercel i neon

Notes

• Fully interchangeable with vercel integration add; same flags and behavior
• Short alias: vercel i

Related

• integration.md

vercel integration

Manage marketplace integrations: provision resources, discover integrations, manage installations, and control individual resources.

Signature / Usage

vercel integration add neon
vercel integration add acme/acme-redis --name my-db --plan pro
vercel integration list
vercel integration installations
vercel integration discover postgres
vercel integration guide neon --framework nextjs
vercel integration balance neon
vercel integration open neon my-database
vercel integration remove neon --yes
vercel integration resource connect my-database my-project
vercel integration resource disconnect my-database --all --yes
vercel integration resource remove my-database --disconnect-all --yes
vercel integration resource create-threshold my-database 50 100 2000 --yes
vercel integration resource claim my-stripe-sandbox

Options / Props

integration add

integration list

integration resource connect / disconnect

integration resource remove

integration resource create-threshold

Arguments: <resource-name> <minimum> <spend> <limit> (all in USD; minimum <= spend <= limit)

integration resource claim

Notes

• vercel install and vercel i are aliases for vercel integration add
• Multi-product integrations use slash syntax: integration/product
• vercel integration-resource <subcommand> and vc ir <subcommand> are backward-compatible aliases
• Removing an integration requires all resources to be removed first
• Sandbox resources show [SANDBOX] tag in vercel integration list

Related

• install.md
• env.md
• project.md

vercel link

Link a local directory to a Vercel Project. Stores metadata in .vercel/project.json.

Signature / Usage

vercel link
vercel link [path-to-directory]
vercel link --yes --project foo
vercel link --repo

Options / Props

Notes

• VERCEL_PROJECT_ID env var can be used instead of --project; --project takes precedence
• Once linked, other CLI commands auto-detect the project from .vercel/project.json

Related

• deploy.md
• pull.md
• dev.md
• global-options.md

vercel list

List recent deployments for the currently-linked Vercel Project. Alias: vercel ls.

Signature / Usage

vercel list
vercel list [project-name]
vercel list --status READY,BUILDING
vercel list --meta githubCommitSha=de8b89f
vercel list my-app --environment=staging

Options / Props

Notes

• vercel ls is the short form of vercel list
• Metadata filtering useful for finding deployments by Git commit SHA

Related

• deploy.md
• inspect.md
• remove.md

vercel login

Authenticate with your Vercel account through the CLI.

Signature / Usage

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

Notes

• For CI/CD where manual input is not possible, use VERCEL_TOKEN env var or --token global option instead
• --token flag takes precedence over VERCEL_TOKEN if both are provided

Related

• logout.md
• whoami.md
• global-options.md

vercel logout

Log out of your Vercel account through the CLI.

Signature / Usage

vercel logout

Related

• login.md
• whoami.md

vercel logs

Display request logs or stream live runtime logs for a Vercel project.

Signature / Usage

vercel logs
vercel logs --follow
vercel logs --level error --since 1h
vercel logs --environment production --status-code 500 --json
vercel logs --query "timeout" --json | jq '.message'

Options / Props

Notes

• Default shows request logs from the last 24 hours for the linked project and branch
• --follow finds the latest deployment for the current git branch
• Combine --follow --deployment to stream logs for a specific deployment

Related

• inspect.md
• traces.md

vercel mcp

Configure MCP clients (Claude Code, Cursor, VS Code with Copilot, Claude.ai) to use Vercel's hosted MCP endpoint at https://mcp.vercel.com.

Signature / Usage

vercel mcp
vercel mcp --clients "Cursor,VS Code with Copilot"
vercel mcp --project

Options / Props

Notes

• Does not deploy any MCP server; only adjusts client-side configuration on your machine
• For Claude.ai and Claude for desktop, prints manual setup instructions
• For Claude Code, Cursor, VS Code with Copilot, configures the client directly
• Without --clients, launches an interactive client picker

Related

• link.md

vercel metrics

Query observability metrics and inspect available metrics, dimensions, and aggregations. Requires Observability Plus.

Signature / Usage

vercel metrics vercel.request.count
vercel metrics vercel.request.count --group-by route --since 24h
vercel metrics vercel.request.route_cpu_duration_ms --aggregation p95 --group-by route
vercel metrics vercel.request.count --all --group-by project_id
vercel metrics schema
vercel metrics schema vercel.request

Options / Props

Notes

• vercel metrics schema lists all available metrics
• vercel metrics schema <metric-or-prefix> shows valid aggregations and dimensions for a metric
• Requires Metrics permission

Related

• logs.md
• traces.md

vercel microfrontends

Manage Vercel Microfrontends: create groups, add/remove projects, pull configuration for local development. Alias: vercel mf.

Signature / Usage

vercel microfrontends create-group --name="My Group" --project=web --default-app=web --yes
vercel mf add-to-group --group="My Group" --default-route=/docs
vercel mf remove-from-group
vercel mf delete-group --group="My Group"
vercel mf inspect-group --group="My Group" --format=json
vercel mf pull
vercel mf pull --dpl dpl_123xyz

Options / Props

create-group

add-to-group

remove-from-group

delete-group

inspect-group

pull

Notes

• Default application cannot be removed from a group via CLI; use the dashboard or delete-group
• pull requires Vercel CLI 44.2.2+

Related

• link.md
• deploy.md

vercel open

Open the current linked project in the Vercel Dashboard in the default browser.

Signature / Usage

vercel open

Notes

• Requires the directory to be linked to a Vercel project (run vercel link first)
• Opens https://vercel.com/{team-slug}/{project-name}
• Available in Vercel CLI v48.10.0+

Related

• link.md
• project.md

Vercel CLI Overview

Command-line interface for managing Vercel Projects, deployments, domains, environment variables, and more from a terminal.

Signature / Usage

# Install
npm i -g vercel
pnpm i -g vercel
yarn global add vercel
bun i -g vercel

# Update
npm i vercel@latest

# Check version
vercel --version

# CI/CD authentication
export VERCEL_TOKEN=<token>
vercel deploy

Notes

• Default command (no subcommand) is vercel deploy
• CI/CD: set VERCEL_TOKEN env var or pass --token
• Native binaries available via @vercel/vc-native (experimental)
• vc is an alias for vercel

Related

• global-options.md
• deploy.md
• login.md
• link.md

vercel project

Manage Vercel Projects: list, add, inspect, rename, remove, and configure checks, protection, access groups, analytics, Speed Insights, and OIDC tokens. Alias: vercel projects.

Signature / Usage

vercel project ls
vercel project add my-app
vercel project inspect [name]
vercel project rename my-project my-renamed-project
vercel project rm my-app
vercel project protection enable my-app --password
vercel project members my-project --format json
vercel project web-analytics my-project
vercel project speed-insights my-project
vercel project token my-project --format=json

Options / Props

list

protection

members / access-groups

token

Notes

• Subcommands: list / ls, add, inspect, rename, remove / rm, checks, protection, members, access-groups, access-summary, web-analytics, speed-insights, token
• Project arguments accept project name or ID (e.g. my-app or prj_abc123); defaults to linked project when omitted

Related

• link.md
• env.md
• deploy.md

vercel promote

Promote an existing deployment to be the current production deployment (assign production domains to it).

Signature / Usage

vercel promote [deployment-id-or-url]
vercel promote https://example-app.vercel.app --timeout=5m
vercel promote status [project]

Options / Props

Notes

• Production deployments are the typical promote target; promoting Preview deployments requires confirmation
• vercel promote status [project] shows status of pending promotions
• Timeout does not cancel the actual promotion; it continues on Vercel's side

Related

• rollback.md
• deploy.md
• alias.md

vercel pull

Sync environment variables and project settings to a local cache under .vercel/ for use by vercel build and vercel dev.

Signature / Usage

vercel pull
vercel pull --environment=preview
vercel pull --environment=preview --git-branch=feature-branch
vercel pull --environment=production
vercel pull --environment=staging

Options / Props

Notes

• Only needed if using vercel build or vercel dev; not needed otherwise
• To export env vars to a file (e.g. .env), use vercel env pull instead
• Re-run after updating env vars on Vercel to refresh the local cache

Related

• env.md
• build.md
• dev.md

CLI

vercel redeploy

Rebuild and redeploy an existing deployment.

Signature / Usage

vercel redeploy [deployment-id-or-url]
vercel redeploy https://example-app.vercel.app --no-wait
vercel redeploy https://example-app.vercel.app --target=staging

Options / Props

Notes

• stdout is always the new deployment URL; suitable for piping
• Check stderr and exit code in CI scripts for error handling

Related

• deploy.md
• rollback.md
• promote.md

vercel redirects

Manage project-level redirects that apply to all deployments and environments without requiring a new deployment.

Signature / Usage

vercel redirects list
vercel redirects add /old /new --status 301
vercel redirects upload redirects.csv --overwrite
vercel redirects promote <version-id>
vercel redirects restore <version-id>
vercel redirects remove /old-path

Options / Props

list

add

upload

remove / promote / restore

Notes

• Subcommands: list, list-versions, add, upload, remove, promote <version-id>, restore <version-id>
• CSV upload format: source,destination,status,caseSensitive,preserveQueryParams
• Changes take effect immediately after creation; no deployment needed

Related

• routes.md

vercel remove

Remove deployments by URL/ID or remove all deployments for a project. Alias: vercel rm.

Signature / Usage

vercel remove [deployment-url]
vercel remove [deployment-url-1 deployment-url-2]
vercel remove [project-name]
vercel remove my-project --safe
vercel remove my-deployment.com --yes

Options / Props

Notes

• Providing a project name removes all deployments for that project
• With --safe and a project name, only removes deployments without active domains

Related

• list.md
• deploy.md

vercel rollback

Roll back production deployments to a previous deployment.

Signature / Usage

vercel rollback
vercel rollback [deployment-id-or-url]
vercel rollback status [project]
vercel rollback status --timeout 30s

Options / Props

Notes

• Hobby plan: can only roll back to the immediately previous production deployment
• To undo a rollback, use vercel promote [deployment-id-or-url]
• vercel rollback status [project] shows status of pending rollbacks
• Timeout does not cancel the actual rollback

Related

• promote.md
• deploy.md

vercel rolling-release

Manage rolling releases to gradually roll out new deployments to a fraction of users. Alias: vercel rr.

Signature / Usage

vercel rolling-release configure --enable --advancement-type=automatic --stage=10,5m
vercel rolling-release configure --enable --advancement-type=manual-approval --stage=10 --stage=50
vercel rolling-release configure --disable
vercel rr start --dpl=dpl_123abc456def
vercel rr approve --dpl=dpl_abc --currentStageIndex=0
vercel rr abort --dpl=dpl_abc
vercel rr complete --dpl=dpl_abc
vercel rr fetch

Options / Props

configure

start / approve / abort / complete

Notes

• Subcommands: configure, start, approve, abort, complete, fetch
• automatic advancement uses time-based stages; manual-approval requires explicit approval between stages
• Final 100% stage is added automatically

Related

• deploy.md
• promote.md

vercel routes

Manage project-level routing rules (rewrites, redirects, header transforms) that apply to all deployments. Changes are staged until published.

Signature / Usage

vercel routes list
vercel routes add --ai "Rewrite /api/* to https://backend.internal/*" --yes
vercel routes add "API Proxy" \
  --src "/api/:path*" --src-syntax path-to-regexp \
  --action rewrite --dest "https://api.example.com/:path*" --yes
vercel routes edit "API Proxy" --dest "https://new-api.example.com/:path*"
vercel routes delete "Old Redirect" --yes
vercel routes publish --yes
vercel routes list --diff

Options / Props

list

add / edit

reorder

export

Notes

• Staging workflow: changes are staged → vercel routes diff → vercel routes publish
• vercel routes discard-staging cancels staged changes
• Condition types for --has / --missing: header, cookie, query, host
• Can also define routes in source control via vercel.json or vercel.ts

Related

• redirects.md
• firewall.md

vercel sandbox

Entry point for managing Vercel Sandbox from the CLI. Modeled on the Docker CLI.

Signature / Usage

vercel sandbox list
vercel sandbox create --connect
vercel sandbox exec <sandbox-id> <command>
vercel sandbox connect <sandbox-id>
vercel sandbox stop <sandbox-id>
vercel sandbox remove <sandbox-id>
vercel sandbox snapshot <sandbox-id>

Notes

• Full command surface documented at Sandbox CLI Reference
• Subcommands: list, create, config, copy / cp, exec, connect / ssh, stop, remove, run, snapshot, snapshots, login, logout
• stop snapshots and suspends the sandbox (filesystem preserved, resumable)
• remove permanently deletes the sandbox including all snapshots and sessions

Related

• deploy.md

vercel skills

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

Signature / Usage

vercel skills
vercel skills nextjs
vercel skills nextjs --json

Options / Props

Notes

• Without arguments, detects project framework (via @vercel/fs-detectors) and package.json dependencies to recommend matching skills
• With a query argument, searches the catalog by keyword

Related

• agent.md

vercel switch

Switch the active team scope in the Vercel CLI.

Signature / Usage

vercel switch
vercel switch [team-name]

Notes

• Without an argument, shows an interactive list of teams
• vercel teams switch [slug] is equivalent
• Does not accept --token global flag; use --scope for per-command scope override

Related

• teams.md
• whoami.md

vercel target

List and use custom deployment environments (targets) beyond production, preview, and development.

Signature / Usage

vercel target list
vercel target ls
vercel deploy --target=staging
vercel pull --environment=staging
vercel env add MY_KEY staging

Notes

• vercel target list (alias: vercel targets ls) lists custom environments configured for the linked project
• The --target flag is available on vercel deploy and vercel redeploy
• The --environment flag on vercel pull and vercel env also accepts custom environment names

Related

• deploy.md
• pull.md
• env.md

vercel teams

Manage teams: list, create, invite members, switch scope, inspect SAML/SSO, list members, and check join-request status. Aliases: vercel team, vercel switch.

Signature / Usage

vercel teams list
vercel teams add --slug acme --name "Acme Corp"
vercel teams invite abc@vercel.com xyz@vercel.com
vercel teams switch acme
vercel teams members --format json
vercel teams sso
vercel teams request

Options / Props

list

add

members

sso / request

Notes

• Subcommands: list / ls, add / create, invite, switch / change, request / access-request, sso, members / member
• vercel switch [team-name] is a top-level alias for vercel teams switch

Related

• switch.md
• whoami.md

vercel telemetry

Enable or disable CLI telemetry collection.

Signature / Usage

vercel telemetry status
vercel telemetry enable
vercel telemetry disable

Notes

• Telemetry tracks: command invoked, CLI version, general machine info (CPU count, OS, CI flag)
• No sensitive data is collected (no env vars, file paths, file contents, logs, or serialized errors)
• Debug mode: VERCEL_TELEMETRY_DEBUG=1 prints telemetry events to stderr without sending them

Related

• overview.md

vercel traces

Inspect request traces for a linked project or a specific deployment.

Signature / Usage

vercel traces get req_1234567890
vercel traces req_1234567890           # `get` is the default subcommand
vercel traces get req_1234567890 --open --view=tree
vercel traces get req_1234567890 --json

Options / Props

Notes

• get is the default subcommand: vercel traces req_... equals vercel traces get req_...
• Capture a trace during a request with vercel curl --trace /api/hello

Related

• curl.md
• logs.md

vercel usage

View billing usage and costs for the current billing period or a custom date range.

Signature / Usage

vercel usage
vercel usage --from 2025-01-01 --to 2025-01-31
vercel usage --breakdown daily
vercel usage --from 2025-01-01 --to 2025-01-31 --breakdown weekly
vercel usage --format json

Options / Props

Notes

• Available to Owner, Member, Developer, Security, Billing, and Enterprise Viewer roles
• Default shows current billing period
• Supports up to 1-year date range with 1-day granularity

Related

• contract.md

vercel webhooks

Manage webhooks for your Vercel account: list, inspect, create, and remove. Beta command.

Signature / Usage

vercel webhooks list
vercel webhooks get <id>
vercel webhooks create <url> --event deployment.created --event deployment.ready
vercel webhooks create <url> --event deployment.created --project prj_abc123
vercel webhooks rm <id> --yes

Options / Props

Notes

• Subcommands: list / ls, get / inspect, create / add, rm / remove / delete
• On create, the webhook secret is shown only once; save it immediately to verify x-vercel-signature headers
• Project must be specified by project ID (e.g. prj_abc123), not project name
• See official docs for supported event types

Related

• project.md

vercel whoami

Display the username of the currently logged-in Vercel user.

Signature / Usage

vercel whoami

Related

• login.md
• logout.md
• teams.md

Build Output API

A file-system specification for the .vercel/output/ directory that produces a Vercel deployment without using Vercel's build system. Primarily targeting framework authors who want to utilize all Vercel platform features.

Signature / Usage

.vercel/output/
  config.json          ← required
  static/              ← static files served directly
  functions/           ← Vercel Functions directory

Minimal config.json:

{
  "version": 3
}

Options / Props

config.json top-level

Route (Source route)

Route (Handler route)

ImagesConfig

Image Optimization API endpoint: /_vercel/image?url=<url>&w=<width>&q=<quality>

WildcardConfig item

Override

Cron item

Transform

Notes

• config.json with at least "version": 3 is required
• The cache property only applies when Vercel builds from source (not prebuilt artifacts)
• framework.version is for display purposes only
• Native dependencies built locally may not match Vercel's Linux x64 build image

Related

• vercel-json.md
• vercel-ts.md

git / github Configuration

Git-related configuration options available in vercel.json and vercel.ts to control automated deployments and GitHub integration behavior.

Signature / Usage

{
  "$schema": "https://openapi.vercel.sh/vercel.json",
  "git": {
    "deploymentEnabled": {
      "dev": false,
      "internal-*": false
    }
  }
}

Options / Props

git object

github object

Notes

• Branch patterns use minimatch syntax: e.g. "internal-*": false
• If a branch matches multiple rules, any true match triggers a deployment
• Setting git.deploymentEnabled: false (boolean) disables all automatic deployments
• github.silent and github.enabled are deprecated; use dashboard settings or git.deploymentEnabled

Related

• vercel-json.md
• vercel-ts.md

configuration

vercel.json

Static JSON configuration file for overriding Vercel project defaults. Place in the project root. Supports all properties listed below. Use only one config file: vercel.json or vercel.ts.

Signature / Usage

{
  "$schema": "https://openapi.vercel.sh/vercel.json",
  "buildCommand": "next build",
  "cleanUrls": true,
  "trailingSlash": false,
  "rewrites": [{ "source": "/about", "destination": "/about-our-company.html" }]
}

Options / Props

crons item

functions value

headers item

redirects item

rewrites item

images config

HasObject

bulkRedirectsPath fields

Notes

• Cannot use functions and builds together; builds is legacy
• bunVersion: "1.x" requires bun run --bun in package.json scripts when using ISR
• cleanUrls does not work with Next.js under vercel dev (works in deployed env)
• has in redirects / rewrites does not work locally with vercel dev
• Bulk redirects do not support wildcard or header matching
• routes is case-insensitive for src; prefer rewrites/redirects/headers for new code

Related

• vercel-ts.md
• git-configuration.md
• build-output-api.md

vercel.ts

Programmatic TypeScript configuration for Vercel that executes at build time. Supports the same properties as vercel.json plus dynamic generation via code. Use only one config file: vercel.ts or vercel.json.

Signature / Usage

import { routes, deploymentEnv, type VercelConfig } from '@vercel/config/v1';

export const config: VercelConfig = {
  buildCommand: 'npm run build',
  cleanUrls: true,
  trailingSlash: false,

  rewrites: [
    routes.rewrite('/api/(.*)', 'https://backend.example.com/$1'),
  ],
  redirects: [
    routes.redirect('/old-docs', '/docs', { permanent: true }),
  ],
  headers: [
    routes.cacheControl('/static/(.*)', {
      public: true,
      maxAge: '1 week',
      immutable: true,
    }),
  ],
  crons: [{ path: '/api/cleanup', schedule: '0 0 * * *' }],
};

Options / Props

All vercel.json properties are available. See vercel-json.md for the full property table.

Additional TypeScript-specific capabilities:

Install

npm i @vercel/config

Supported file names

vercel.ts, vercel.js, vercel.mjs, vercel.cjs, or vercel.mts.

Notes

• The config export must be a named export: export const config: VercelConfig = { ... }
• vercel.ts executes at build time — not at request time (except deploymentEnv references which expand at request time)
• Migrate from vercel.json by copying its contents into the config export, then progressively add dynamic features
• Prefer routes.* helpers over raw objects for rewrites, redirects, and headers for type safety
• Legacy properties from vercel.json are available; see static configuration reference

Related

• vercel-json.md
• git-configuration.md

Deploy Hooks

Deploy Hooks are unique URLs that accept HTTP requests to trigger deployments without needing a new commit. Each URL is linked to a specific project, repository, and branch.

Signature / Usage

# Trigger a deployment (GET or POST)
curl -X POST https://api.vercel.com/v1/integrations/deploy/<project-id>/<hook-id>

# Disable build cache
curl -X POST https://api.vercel.com/v1/integrations/deploy/<project-id>/<hook-id>?buildCache=false

Example Response

{
  "job": {
    "id": "okzCd50AIap1O31g0gne",
    "state": "PENDING",
    "createdAt": 1662825789999
  }
}

Options / Props

Creating a Deploy Hook

1. Connect your project to a Git repository. 2. Go to Project Settings → Git → Deploy Hooks. 3. Enter a name and select the branch to deploy. 4. Copy the generated URL.

Limits

Notes

• No authentication header is needed to trigger a hook; the unique URL acts as the secret — treat it like a token/password.
• If the same version is deployed multiple times, Vercel cancels previous deployments for the same hook to reduce build times.
• Deploy Hooks will not trigger if github.enabled = false is set in vercel.json.
• If a hook URL is compromised, revoke it in Project Settings and create a new one.
• Build cache is included by default; hooks created before May 11, 2021 must explicitly append ?buildCache=true or be replaced with a new hook.

Use Cases

• Headless CMS content change → trigger rebuild
• Scheduled deployments via third-party cron service
• Forced deployments from the command line without a code change

Related

• overview.md
• managing-deployments.md

Environments

Vercel provides three default environments (Local, Preview, Production) and supports Custom Environments on Pro/Enterprise plans for workflows like staging or QA.

Signature / Usage

# Deploy to a custom environment named "staging"
vercel deploy --target=staging

# Pull env vars from "staging"
vercel pull --environment=staging

# Add env var to "staging"
vercel env add MY_KEY staging

# Deploy to production
vercel --prod

Environment Types

Custom Environment Limits

Creating a Custom Environment (API)

curl --request POST \
  --url https://api.vercel.com/v9/projects/<project-id>/custom-environments \
  --header "Authorization: Bearer $VERCEL_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{
    "slug": "staging",
    "description": "Staging environment"
  }'

Options / Props

Notes

• Preview deployments create two URL types: a commit-specific URL and a branch-specific URL (always pointing to the latest commit on the branch).
• Pushing or merging to the production branch (default: main) triggers a production deployment and updates custom domains automatically.
• Custom environments require Pro or Enterprise plan.
• Disabling Auto-assign Custom Production Domains in Production settings enables a staging workflow where new commits don't go live until manually promoted.

Related

• overview.md
• git-integration.md
• promoting-deployments.md
• generated-urls.md

Generated URLs

When a deployment is created (preview or production), Vercel automatically generates a unique URL for accessing that specific deployment.

URL Formats

From Git

From Vercel CLI

URL Components

Notes

• URLs are publicly accessible by default; restrict with Deployment Protection.
• URLs longer than 63 characters before .vercel.app are truncated.
• Project names resembling web domains may be shortened to prevent anti-phishing browser warnings (e.g., www-company-com → company).
• The commit URL is accessible from the View deployment button in a PR; the branch URL from the Visit Preview button.
• Pro/Enterprise teams can replace .vercel.app with a custom domain via Preview Deployment Suffix (requires permission).

Related

• environments.md
• overview.md

Git Integration

Vercel automatically deploys on every branch push and merge to the production branch for GitHub, GitLab, Bitbucket, and Azure DevOps repositories.

Signature / Usage

# Connect a repo: use the Vercel Dashboard → New Project
# Then push normally:
git push origin feature-branch   # → preview deployment
git push origin main              # → production deployment

Supported Git Providers

Deployment Behavior

Production Branch Configuration

Vercel selects the production branch in this order: main → master → Bitbucket "production branch" setting → repository default branch.

To customize: Project Settings → Environments → Production → Branch Tracking → change branch name.

Deploying from a Git Reference (Dashboard)

1. Go to Project → Deployments → Create Deployment. 2. Enter a commit SHA (targeted) or a branch name (branch-based). 3. Select Create Deployment.

Private Repositories

For forks of public repositories, Vercel requires authorization from a team member before deploying a PR.

Notes

• Configure github.autoJobCancellation = false in vercel.json to disable automatic cancellation of queued builds.
• Vercel sends repository_dispatch events to GitHub on deployment status changes (vercel.deployment.ready, .success, .error, .canceled, .pending, .failed, .promoted, .skipped, .ignored).
• Commit authors on private repositories must have a Vercel account with linked Git credentials.

Related

• vercel-for-github.md
• vercel-for-gitlab.md
• vercel-for-bitbucket.md
• environments.md

Instant Rollback

Instant Rollback reverts your production domain(s) to a previous deployment without rebuilding. It is designed for swift recovery from production incidents like breaking changes or bugs.

Signature / Usage

# Undo a rollback / promote a different deployment (CLI)
vercel promote [deployment-id-or-url]

How to Perform an Instant Rollback (Dashboard)

1. On the Project Overview page, click Instant Rollback on the Production Deployment tile. 2. Select the deployment to roll back to. (Pro/Enterprise: click Choose another deployment for all eligible deployments.) 3. Verify rollback details: affected domains, environment variable state, and external service implications. 4. Click Confirm Rollback.

Alternatively: Deployments sidebar → find deployment → ellipsis (⋮) → Instant Rollback.

Eligible Deployments

Preview deployments that were never aliased to production are not eligible.

Plan Access

Behavior During Rollback

Undo a Rollback

Dashboard: Project Overview → Undo Rollback button → select deployment → Confirm.

CLI:

vercel promote [deployment-id-or-url]

Undoing restores auto-assignment of production domains so new pushes go live again.

Notes

• Rollback happens instantaneously — no rebuild is performed.
• After rollback, the rolled-back deployment is shown as the current production deployment with canceled/rolled-back commits highlighted.
• Configuration used by the rolled-back deployment may be stale relative to current project settings.
• Deleting an eligible deployment removes it from the rollback candidates list.

Related

• promoting-deployments.md
• rolling-releases.md
• managing-deployments.md

Managing Deployments

All current and past deployments are accessible from the Vercel Dashboard regardless of environment, status, or branch. Vercel CLI and the REST API provide programmatic alternatives.

Signature / Usage

# Delete a deployment via REST API
curl --request DELETE \
  --url https://api.vercel.com/v13/deployments/<deployment-id> \
  --header "Authorization: Bearer $VERCEL_TOKEN"

// Delete via SDK
import { Vercel } from '@vercel/sdk';
const vercel = new Vercel({ bearerToken: '<TOKEN>' });
await vercel.deployments.deleteDeployment({ id: 'deployment-id' });

Dashboard Actions

REST API Endpoints

When to Redeploy

Notes

• Deleting a deployment prevents using Instant Rollback on it and may break links in Git provider PR comments.
• A deployment retention policy can be configured to automatically delete deployments after a set period.
• Deployment protection (Vercel Authentication, Trusted IPs, Password Protection) can restrict access to deployments.
• Trusted IPs and Password Protection require Enterprise; Password Protection is also available as a paid Pro add-on.

Related

• overview.md
• promoting-deployments.md
• instant-rollback.md

Deploying to Vercel

A deployment on Vercel is the result of a successful build of your project. Each deployment generates a unique URL for previewing changes in a live environment.

Signature / Usage

# Git push (automatic)
git push origin main

# Vercel CLI
vercel --prod

# Deploy Hook (HTTP POST)
curl -X POST https://api.vercel.com/v1/integrations/deploy/<project-id>/<hook-id>

# REST API
POST https://api.vercel.com/v13/deployments

Deployment Methods

Environments

Notes

• Each deployment gets an automatically generated unique URL regardless of environment.
• After a rollback, Vercel disables auto-assignment of production domains until undone.
• Vercel CLI vercel (without --prod) creates a preview deployment; vercel --prod creates a production deployment.

Related

• environments.md
• git-integration.md
• deploy-hooks.md
• managing-deployments.md
• generated-urls.md

Promoting Deployments

Promoting a deployment means assigning your production domain(s) to a different deployment. Vercel supports three promotion approaches: Instant Rollback, promote preview to production, and staged production promotion.

Signature / Usage

# Promote a deployment via CLI
vercel promote [deployment-id-or-url]

Promotion Methods

Production Deployment States

Promoting Preview to Production (Dashboard)

1. Go to Project → Deployments in the sidebar. 2. Click the ellipsis (…) next to the preview deployment. 3. Select Promote to Production. 4. Review the domains that will be linked, then confirm.

Staged Production Workflow (Dashboard)

1. Project Settings → Environments → Production → Branch Tracking. 2. Disable Auto-assign Custom Production Domains. 3. Deploy as normal (commits go to Staged state). 4. When ready, Deployments → ellipsis (…) → Promote → confirm.

Notes

• If preview and production environment variables differ, promoting from preview to production switches to production vars; preview vars cannot be used in production.
• After an Instant Rollback, auto-assignment of production domains is disabled. Undo with Undo Rollback on the dashboard or vercel promote.
• A deployment that was previously promoted cannot be promoted again; roll back to it instead.
• Staged promotion does not trigger a rebuild; it instantly points the domain to the existing build.

Related

• instant-rollback.md
• managing-deployments.md
• environments.md

deployment

Rolling Release Deployment

Step-by-step guide for performing a rolling release deployment using the Vercel CLI: configure stages, deploy, start the release, monitor, advance or abort, and complete.

Requires a linked Vercel project (vercel link) and Pro or Enterprise plan.

Signature / Usage

# Full command sequence (quick reference)
vercel rolling-release configure --cfg '{"enabled":true,"advancementType":"automatic","stages":[{"targetPercentage":10,"duration":5},{"targetPercentage":50,"duration":10},{"targetPercentage":100}]}'
vercel deploy --prod
vercel rolling-release start --dpl <deployment-url>
vercel rolling-release fetch
vercel rolling-release approve --dpl <deployment-url> --currentStageIndex 0
vercel rolling-release complete --dpl <deployment-url>
# On errors:
vercel rolling-release abort --dpl <deployment-url>

CLI Commands

Workflow Steps

Notes

• After aborting, investigate logs before attempting another rollout: vercel logs --environment production --level error --since 30m --expand.
• --currentStageIndex starts at 0; increment by 1 for each subsequent manual approval.
• Automatic stages advance based on duration (in minutes); manual stages require explicit approve calls.

Related

• rolling-releases.md
• instant-rollback.md

Rolling Releases

Rolling Releases allow you to gradually shift traffic from your current production deployment to a new release candidate, monitoring metrics between stages before full promotion.

Requires Pro or Enterprise plan.

Signature / Usage

# Configure rolling release stages
vercel rolling-release configure --cfg '{"enabled":true,"advancementType":"automatic","stages":[{"targetPercentage":10,"duration":5},{"targetPercentage":50,"duration":10},{"targetPercentage":100}]}'

# Deploy to production (triggers rolling release)
vercel deploy --prod

# Start the rolling release
vercel rolling-release start --dpl <deployment-url>

# Check status
vercel rolling-release fetch

# Advance to next stage (manual approval mode)
vercel rolling-release approve --dpl <deployment-url> --currentStageIndex 0

# Complete rollout (100% traffic)
vercel rolling-release complete --dpl <deployment-url>

# Abort and revert to previous deployment
vercel rolling-release abort --dpl <deployment-url>

# Disable rolling releases
vercel rolling-release configure --cfg 'disable'

Stage Configuration

• Stages must be in ascending order of targetPercentage.
• The final stage must always be 100.
• A stage at 0% serves no traffic to the canary by default, but can be forced via the vcrrForceCanary=true query parameter.

REST API Endpoints

Traffic Cookie

Cookie name: _vcrr_<hash> where <hash> is derived from the project ID.

How Traffic Routing Works

1. When a user visits a production URL during an active rolling release, Vercel assigns them to a random bucket stored in a cookie (using client IP for consistency across incognito). 2. The bucket determines whether the user sees the base deployment or the release candidate. 3. When a stage advances, some buckets are reassigned; affected users see the new deployment on their next page load.

Notes

• Strongly recommended to enable Skew Protection alongside Rolling Releases to ensure backend API requests from a given page are served by the matching deployment's backend.
• Disabling Rolling Releases via the API while a rollout is in progress does not stop the active rollout — you must still call complete or rollback.
• Each new rolling release clones the project's current configuration; editing the configuration does not affect in-progress rollouts.
• An in-progress rolling release must be resolved (completed or aborted) before a new one can start.

Related

• instant-rollback.md
• rolling-release-deployment.md
• promoting-deployments.md

Vercel for Bitbucket

Vercel for Bitbucket automatically deploys Bitbucket projects, provides Preview Deployment URLs for every pull request, and keeps custom domains updated on production pushes.

Signature / Usage

# Self-hosted (Bitbucket Data Center): use Bitbucket Pipelines
vercel build              # build without exposing source to Vercel
vercel deploy --prebuilt  # upload .vercel/output to Vercel

Supported Bitbucket Products

Bitbucket Permissions Required

Repository Permissions

Organization & User Permissions

• Importing or connecting a repository requires Admin access to the repository.

Deployment Behavior

Notes

• Bot comments on PRs and commits can be silenced in Project Settings → Git → Connected Git Repository.
• Bitbucket Data Center (self-hosted) uses vercel build + vercel deploy --prebuilt via Bitbucket Pipelines.
• Bitbucket's "production branch" setting is used as a fallback when main and master branches don't exist.

System Environment Variables

Same set as GitHub integration. Key variable difference:

See vercel-for-github.md for the full variable list.

Related

• git-integration.md
• vercel-for-github.md
• environments.md

Vercel for GitHub

Vercel for GitHub automatically deploys GitHub projects, provides Preview Deployment URLs for every PR, and keeps custom domains updated on production pushes.

Signature / Usage

# Trigger GitHub Actions on Vercel deployment events
on:
  repository_dispatch:
    types:
      - 'vercel.deployment.success'

GitHub Permissions Required

Repository Permissions

Organization & User Permissions

System Environment Variables

Notes

• Personal account repositories require the Vercel user to be the repository Owner.
• Organization repositories require the user to be an Owner or Member with repository access (Outside Collaborators cannot import/connect).
• Bot comments on PRs and commits can be silenced in Project Settings → Git → Connected Git Repository.
• deployment_status GitHub webhook events can be disabled in Project Settings → Git to reduce noise; migrate to repository_dispatch events instead.
• GitHub Enterprise Server requires GitHub Actions integration (vercel build + vercel deploy --prebuilt).
• Fork PRs require authorization from a team member before deploying (disable with Git Fork Protection toggle).

Using GitHub Actions (GHES or Custom CI)

# Preview deployment
vercel pull --yes --environment=preview --token=${{ secrets.VERCEL_TOKEN }}
vercel build
vercel deploy --prebuilt

# Production deployment
vercel pull --yes --environment=production --token=${{ secrets.VERCEL_TOKEN }}
vercel build --prod
vercel deploy --prebuilt --prod

Related

• git-integration.md
• environments.md

Vercel for GitLab

Vercel for GitLab automatically deploys GitLab projects, provides Preview Deployment URLs for every merge request, and keeps custom domains updated on production pushes.

Signature / Usage

# Self-managed GitLab: use GitLab Pipelines
vercel build          # build without exposing source to Vercel
vercel deploy --prebuilt  # upload .vercel/output to Vercel

Supported GitLab Products

GitLab Permissions Required

• Importing or connecting a repository requires Maintainer access to the repository.
• If the repository belongs to a GitLab group, Maintainer access to the group is also required.

Deployment Behavior

System Environment Variables

Same set as GitHub integration. Key variables:

See vercel-for-github.md for the full variable list.

Notes

• Bot comments on MRs and commits can be silenced in Project Settings → Git → Connected Git Repository.
• In GitLab, a merge pipeline can fail while the branch pipeline succeeds, allowing MRs to merge with failing tests. Use Vercel CLI to deploy to avoid this GitLab issue.
• Self-Managed GitLab uses vercel build + vercel deploy --prebuilt via GitLab Pipelines.

Related

• git-integration.md
• vercel-for-github.md
• environments.md