Vercel CLI logo

Vercel CLI

Command-line interface for the Vercel platform: deploy projects, run them locally with vercel dev, and manage deployments from the terminal.

install

Vercel CLI is the command-line client for the Vercel platform. It deploys projects from a local directory (vercel deploy, or plain vercel) and runs them locally with vercel dev. The --cwd flag points a command at a specific project directory. Vercel also supports deploying by running git push once a project is connected, by importing a project, or by starting from a template.

The repository is a pnpm monorepo that contains the CLI package (packages/cli) and the Builders used to build deployments, such as the Node and Next.js builders. Some Builders use @vercel/nft to tree-shake files before deployment. Builders can be tested against an existing project by packing them with npm pack, uploading the tarball with vercel <directory>, and referencing its URL in vercel.json.

The standard install is the Node.js-based CLI from the vercel npm package. Native binaries are distributed separately as @vercel/vc-native. Installing that package replaces the global vercel and vc commands, which is why --force is required. Platform-specific packages such as @vercel/vc-native-darwin-x64 can also be installed directly. The tool is for developers who deploy to Vercel, and for contributors working on the CLI or its Builders.

Installation

# via npm
npm i -g vercel
# via npm (native binary)
npm i -g @vercel/vc-native --force
# via npm (platform-specific native binary)
npm i -g @vercel/vc-native-darwin-x64 --force

Alternatives & related tools

add a badge to your README

Maintain Vercel CLI? Show that it's featured on trmn. The badge links back to this page.

Featured on trmn
Markdown
[![Featured on trmn](https://www.trmn.sh/badge/vercel-cli.svg)](https://www.trmn.sh/tools/vercel-cli?utm_source=badge)
HTML
<a href="https://www.trmn.sh/tools/vercel-cli?utm_source=badge"><img src="https://www.trmn.sh/badge/vercel-cli.svg" alt="Featured on trmn" height="20"></a>