vercel

(★ 16,119)

Develop. Preview. Ship.

Owner Repos

hyper ★ 44,699

A terminal built on web technologies

TypeScript
swr ★ 32,465

React Hooks for Data Fetching

TypeScript
turborepo ★ 30,965

Build system optimized for JavaScript and TypeScript, written in Rust

Rust
pkg ★ 24,354

Package your Node.js project into an executable

JavaScript
commerce ★ 14,223

Next.js Commerce

TypeScript
satori ★ 13,827

Enlightened library to convert HTML and CSS to SVG

TypeScript

File Explorer

ZIP Download

Showing a partial file list — download the zip above to see everything.

  • .editorconfig
  • .gitattributes
  • .gitignore
  • .node_version
  • .npmrc
  • .nvmrc
  • .prettierignore
  • .syncpackrc.json
  • .vercel.approvers
  • .vercelignore
  • AGENTS.md
  • biome.jsonc
  • Cargo.lock
  • Cargo.toml
  • DEVELOPING_A_RUNTIME.md
  • fx-diff-test.txt
  • LICENSE
  • package.json
  • README.md
  • RELEASE.md

# Installation Guide

node
Prerequisites

Setup Steps

git clone https://github.com/vercel/vercel.git

Clone the repository locally.

corepack enable

Enable Corepack for package manager management.

pnpm install

Install project dependencies.

pnpm build

Build project packages.

pnpm test-unit

Run unit tests to verify the environment.

Key Commands

pnpm install

Install all package dependencies in the monorepo.

pnpm build

Build all packages in the project.

pnpm lint

Check code style and lint rules.

pnpm test-unit

Execute all unit tests.

Since it is a monorepo, pnpm must be used and npm should be avoided.

# Use via CDN

jsDelivr

jsDelivr serves any public GitHub repository as a CDN with zero setup. Pick a version and a file to get a ready-to-paste link and snippet.

Showing a partial file list.

Link
Example

Command Glossary

Commands referenced in this DOCs, explained below.

🔍

corepack

View Details ▼

Zero-runtime-dependency package acting as bridge between Node projects and their package managers.

corepack enable

Add the Corepack shims to the Node.js installation directory to make them available as global commands:

corepack enable --install-directory {{path/to/directory}}

Add the Corepack shims to a specific directory:

corepack disable

Remove the Corepack shims from the Node.js installation directory:

🔍

git clone

View Details ▼

Clone an existing repository.

git clone {{remote_repository_location}} {{path/to/directory}}

Clone an existing repository into a new directory (the default directory is the repository name):

git clone --recursive {{remote_repository_location}}

Clone an existing repository and its submodules:

git clone {{[-n|--no-checkout]}} {{remote_repository_location}}

Clone only the `.git` directory of an existing repository:

🔍

git push

View Details ▼

Push commits to a remote repository.

git push

Send local changes in the current branch to its default remote counterpart:

git push {{remote_name}} {{local_branch}}

Send changes from a specific local branch to its remote counterpart:

git push {{[-u|--set-upstream]}} {{remote_name}} {{local_branch}}

Send changes from a specific local branch to its remote counterpart, and set the remote one as the default push/pull target of the local one:

🔍

jest

View Details ▼

A zero-configuration JavaScript testing platform.

jest

Run all available tests:

jest {{path/to/file1 path/to/file2 ...}}

Run the test suites from the given files:

jest {{regex1 regex2 ...}}

Run the test suites from files within the current and subdirectories, whose paths match the given `regex`:

🔍

npm pack

View Details ▼

Create a tarball from a package.

npm pack

Create a tarball from the current package in the current directory:

npm pack {{path/to/package_directory}}

Create a tarball from a specific package folder:

npm pack --dry-run

Run a dry run to preview the tarball contents without creating it:

🔍

npm

View Details ▼

JavaScript and Node.js package manager.
Manage Node.js projects and their module dependencies.
Some subcommands such as `install`, `run`, etc. have their own usage documentation.

npm init {{[-y|--yes]}}

Create a `package.json` file with default values (omit `--yes` to do it interactively):

npm {{[i|install]}}

Download all the packages listed as dependencies in `package.json`:

npm {{[i|install]}} {{package_name}}@{{version}}

Download a specific version of a package and add it to the list of dependencies in `package.json`:

🔍

pnpm

View Details ▼

Fast, disk space efficient package manager for Node.js.
Manage Node.js projects and their module dependencies.

pnpm init

Create a `package.json` file:

pnpm {{[i|install]}}

Download all the packages listed as dependencies in `package.json`:

pnpm add {{module_name}}@{{version}}

Download a specific version of a package and add it to the list of dependencies in `package.json`:

🔍

vercel

View Details ▼

Deploy and manage your Vercel deployments.

vercel

Deploy the current directory:

vercel --prod

Deploy the current directory to production:

vercel {{path/to/project}}

Deploy a directory:

// repository documentation