vercel

mirror of https://github.com/LukeHagar/vercel.git synced 2025-12-10 04:22:12 +00:00

Files

Sean Massa 25e2b7f0ce [tests] fix flakey tests (#9071 )

Fixes flakey tests / CI:

- git metadata test for corrupted `.git` directory
- version identifier for `build-utils` being using in `fs-detectors`'s `devDependencies`
- bad import from `../dist/..`

2022-12-13 04:19:26 +00:00

scripts

[cli] Revert replace update-notifier dependency with built in (#9000 )

2022-12-02 18:20:11 -06:00

src

[tests] fix flakey tests (#9071 )

2022-12-13 04:19:26 +00:00

test

[tests] fix flakey tests (#9071 )

2022-12-13 04:19:26 +00:00

types

[cli] Fix vc dev when user has ipv6 configured (#7956 )

2022-06-13 21:04:00 +00:00

package.json

[cli] Remove unused dependency email-prompt (#9042 )

2022-12-08 14:21:05 +00:00

README.md

[docs] add more details on local development (#8960 )

2022-11-23 11:43:30 -06:00

tsconfig.json

[cli] Use ts-node with SWC instead of ts-eager (#8224 )

2022-07-22 17:53:15 +00:00

Usage

Vercel is the platform for frontend developers, providing the speed and reliability innovators need to create at the moment of inspiration.

We enable teams to iterate quickly and develop, preview, and ship delightful user experiences. Vercel has zero-configuration support for 35+ frontend frameworks and integrates with your headless content, commerce, or database of choice.

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
yarn
yarn 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

`yarn dev <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:

yarn dev deploy
yarn dev whoami
yarn dev login
yarn dev switch --debug

When you are satisfied with your changes, make a commit and create a pull request!