Vercel · vercel.com

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:

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.

If 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.

Using the vercel 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. 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:

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:

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

Learn more about the activity command

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

Learn more about the agent command

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

Learn more about the ai-gateway command

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

Learn more about the alerts command

Apply custom domain aliases to your Vercel deployments.

Learn more about the alias command

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

Learn more about the api command

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

Learn more about the bisect command

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

Learn more about the blob command

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

Learn more about the build command

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

Learn more about the buy command

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

Learn more about the cache command

Manage certificates for your domains.

Learn more about the certs command

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

Run vercel connect create <service> --help to see how you can connect to a specific service.

Learn more about the connect command

View contract commitment information for your Vercel account.

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.

Learn more about the crons command

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

Learn more about the curl command

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

Learn more about the deploy command

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

Learn more about the deploy-hooks command

Replicate the Vercel deployment environment locally and test your project.

Learn more about the dev command

Manage your DNS records for your domains.

Learn more about the dns command

Buy, sell, transfer, and manage your domains.

Learn more about the domains command

Manage environment variables in your Vercel Projects.

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.

Learn more about the firewall command

Manage feature flags for your Vercel Project.

Learn more about the flags command

Manage your Git provider connections.

Learn more about the git command

Manage Global Config stores: list, create, inspect, update, remove, and manage items, read tokens, and backups. vercel edge-config continues to work as an alias.

Learn more about the global-config command

Enable or disable guidance messages shown after CLI commands.

Learn more about the guidance command

Get information about all available Vercel CLI commands.

Learn more about the help command

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

Learn more about the httpstat command

Initialize example Vercel Projects locally from the examples repository.

Learn more about the init command

Retrieve information about your Vercel deployments.

Learn more about the inspect command

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

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.

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.

Learn more about the link command

List recent deployments for the current Vercel Project.

Learn more about the list command

Login to your Vercel account through CLI.

Learn more about the login command

Logout from your Vercel account through CLI.

Learn more about the logout command

List runtime logs for a specific deployment.

Learn more about the logs command

Set up MCP client configuration for your Vercel 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.

Learn more about the metrics command

Work with microfrontends configuration.

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.

Learn more about the oauth-apps command

Open your current project in the Vercel Dashboard.

Learn more about the open command

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

Learn more about the project command

Promote an existing deployment to be the current deployment.

Learn more about the promote command

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

Learn more about the pull command

Rebuild and redeploy an existing deployment.

Learn more about the redeploy command

Manage project-level redirects.

Learn more about the redirects command

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

Learn more about the remove command

Roll back production deployments to previous deployments.

Learn more about the rollback command

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

Learn more about the rolling-release command

Manage project-level routing rules for your Vercel Project.

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.

Learn more about the sandbox command

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

Learn more about the skills command

Switch between different team scopes.

Learn more about the switch command

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

Learn more about the target command

List, add, remove, and manage your teams.

Learn more about the teams command

Enable or disable telemetry collection. Learn what data Vercel CLI collects and how to opt out.

Learn more about the telemetry command

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

Learn more about the tokens command

Inspect request traces for your project.

Open a trace directly in the tree or waterfall view:

Learn more about the traces command

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

Learn more about the upgrade command

View billing usage and costs for your Vercel account.

Learn more about the usage command

Manage Vercel Container Registry repositories, tags, and images from the terminal. See the Container Registry CLI Reference for the full surface.

Learn more about the vcr command

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

Learn more about the webhooks command

Display the username of the currently logged in user.

Learn more about the whoami command

Read the original on vercel.com ↗