[![Join the community on GitHub Discussions](https://badgen.net/badge/join%20the%20discussion/on%20github/black?icon=github)](https://github.com/vercel/vercel/discussions)

Downloads in past


10,19421212.4.63 days ago3 years agoMinified + gzip package size for @vercel/client in KB


Join the community on GitHub Discussions
The official Node.js client for deploying to Vercel.


Firstly, install the package:
npm install @vercel/client

Next, load it:
const { createDeployment } = require('@vercel/client');

Then call inside a for...of loop to follow the progress with the following arguments:
  • <path> - a directory path / file path / array of file paths (must be on the same level)
  • <options> - An object containing token, an optional teamId and any vercel.json-valid fields

async function deploy() {
  let deployment;

  for await (const event of createDeployment({
    token: process.env.TOKEN,
    path: '/Users/me/Code/myproject',
  })) {
    if (event.type === 'ready') {
      deployment = event.payload;

  return deployment;

Full list of events:
  // File events
  // Deployment events

You can also get the events set programmatically:
import { EVENTS } from '@vercel/client';