2 min read

Vercel CLI Overview

Learn how to use the Vercel command-line interface (CLI) to manage and configure your Vercel Projects from the command line.
Table of Contents

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
yarn
npm
pnpm i -g vercel

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

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

pnpm
yarn
npm
pnpm i -g vercel@latest

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

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

terminal
vercel --version

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.

Last updated on May 25, 2024