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:
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.
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 use the --token option to authenticate.
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
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
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
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 feature flags for your Vercel Project.
Learn more about the flags command
Manage your Git provider connections.
Learn more about the git 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 more.
Learn more about the integration command
Manage individual resources from marketplace integrations: remove, disconnect from projects, and configure auto-recharge thresholds.
Learn more about the integration-resource 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
Work with microfrontends configuration.
Learn more about the microfrontends 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
Switch between different team scopes.
Learn more about the switch command
List, add, remove, and manage your teams.
Learn more about the teams command
Manage custom environments (targets) and use the --target flag on relevant commands.
Learn more about the target command
Enable or disable telemetry collection.
Learn more about the telemetry 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.