Vercel Sandbox

Vercel Sandbox allows you to run arbitrary code in isolated, ephemeral Linux VMs. This product is in beta.

​

What is a sandbox?

A sandbox is an isolated Linux system for your experimentation and use. Internally, it is a Firecracker MicroVM that is powered by the same infrastructure that powers 1M+ builds a day at Vercel.

​

Getting started

Vercel Sandbox is in beta.

To get started, create a new project:

mkdir sandbox-test
cd sandbox-test
pnpm init
pnpm add @vercel/sandbox ms
pnpm add -D @types/ms @types/node

Link it to Vercel:

vercel link

Pull its environment variables:

vercel env pull

Now create next-dev.ts:

import ms from "ms";
import { Sandbox } from "@vercel/sandbox";
import { setTimeout } from "timers/promises";
import { spawn } from "child_process";

async function main() {
  const sandbox = await Sandbox.create({
    source: {
      url: "https://github.com/vercel/sandbox-example-next.git",
      type: "git",
    },
    resources: { vcpus: 4 },
    timeout: ms("5m"),
    ports: [3000],
    runtime: "node22",
  });

  console.log(`Installing dependencies...`);
  const install = await sandbox.runCommand({
    cmd: "npm",
    args: ["install", "--loglevel", "info"],
    stderr: process.stderr,
    stdout: process.stdout,
  });

  if (install.exitCode != 0) {
    console.log("installing packages failed");
    process.exit(1);
  }

  console.log(`Starting the development server...`);
  await sandbox.runCommand({
    cmd: "npm",
    args: ["run", "dev"],
    stderr: process.stderr,
    stdout: process.stdout,
    detached: true,
  });

  await setTimeout(500);
  spawn("open", [sandbox.domain(3000)]);
}

main().catch(console.error);

Run it like this:

node --env-file .env.local --experimental-strip-types ./next-dev.ts

This will:

• Start a sandbox, seeding it with a git repository.
• Install dependencies.
• Run a next dev server
• Open it in your browser

All while streaming logs to your local terminal.

​

Authentication

​

Vercel OIDC token

The SDK uses Vercel OIDC tokens to authenticate whenever available. This is the most straightforward and recommended way to authenticate.

When developing locally, you can download a development token to .env.local using vercel env pull. After 12 hours the development token expires, meaning you will have to call vercel env pull again.

In production, Vercel manages token expiration for you.

​

Access token

If you want to use the SDK from an environment where VERCEL_OIDC_TOKEN is unavailable, you can also authenticate using an access token:

• Go to your team settings, and copy the team ID.
• Go to a project’s settings, and copy the project ID.
• Go to your Vercel account settings and create a token. Make sure it is scoped to the team ID from the previous step.

Set your team ID, project ID, and token to the environment variables VERCEL_TEAM_ID, VERCEL_PROJECT_ID, and VERCEL_TOKEN. Then pass these to the create method:

const sandbox = await Sandbox.create({
  teamId: process.env.VERCEL_TEAM_ID!,
  projectId: process.env.VERCEL_PROJECT_ID!,
  token: process.env.VERCEL_TOKEN!,
  source: {
    url: "https://github.com/vercel/sandbox-example-next.git",
    type: "git",
  },
  resources: { vcpus: 4 },
  // Defaults to 5 minutes. The maximum is 45 minutes.
  timeout: ms("5m"),
  ports: [3000],
  runtime: "node22",
});

​

Limitations

• sudo is not available. User code is executed as the vercel-sandbox user.
• Max resources: 8 vCPUs. You will get 2048 MB of memory per vCPU.
• Sandboxes have a maximum runtime duration of 45 minutes, with a default of 5 minutes. This can be configured using the timeout option of Sandbox.create().

​

System

The base system is an Amazon Linux 2023 system with the following additional packages installed.

bind-utils
bzip2
findutils
git
gzip
iputils
libicu
libjpeg
libpng
ncurses-libs
openssl
openssl-libs
procps
tar
unzip
which
whois
zstd

• The node22 image ships a Node 22 runtime under /vercel/runtimes/node22.
• The python3.13 image ships a Python 3.13 runtime under /vercel/runtimes/python.
• User code is executed as the vercel-sandbox user.
• /vercel/sandbox is writable.