vercel
v39.1.3
Published
The command-line interface for Vercel
Downloads
2,368,770
Maintainers
Keywords
Readme
Usage
Vercel's frontend cloud gives developers frameworks, workflows, and infrastructure to build a faster, more personalized web.
To install the latest version of Vercel CLI, run this command:
npm i -g vercel
To quickly start a new project, run the following commands:
vercel init # Pick an example project
cd <PROJECT> # Change directory to the new project
vercel # Deploy to the cloud
Finally, connect your Git repository to Vercel and deploy with git push
.
Documentation
For details on how to use Vercel CLI, check out our documentation.
Local Development
To develop Vercel CLI, first check out the source code, install dependencies, and build all packages:
git clone https://github.com/vercel/vercel.git
cd vercel
pnpm install
pnpm build
At this point you can make modifications to the CLI source code and test them out locally. The CLI source code is located in the packages/cli
directory.
cd packages/cli
pnpm vercel <cli-commands...>
From within the packages/cli
directory, you can use the "dev" script to quickly execute Vercel CLI from its TypeScript source code directly (without having to manually compile first). For example:
pnpm vercel deploy
pnpm vercel whoami
pnpm vercel login
pnpm vercel switch --debug
When you are satisfied with your changes, make a commit and create a pull request!