Skip to content
GitHub

Product

Benchmarks Partners

Resources

Docs Blog

How to run your first Vercel sandbox

How to run your first Vercel sandbox

Garrison Snelling

Founder, ComputeSDK

how-to sandboxes vercel

You can clone this repo and update your credentials to run locally.
Or, just deploy an example with Vercel or Stackblitz:

Want to use Vercel sandboxes to run AI-generated code? ComputeSDK makes it easy. Let’s walk through the process of getting a basic application running inside a Vercel sandbox.

Why use Vercel as your sandbox provider?

Vercel is known for its globally distributed serverless infrastructure and developer-friendly experience.
If you’re already using Vercel for deployments, using them as a sandbox provider integrates seamlessly into your existing workflow.
They offer excellent performance with edge computing capabilities and automatic SSL.
Let’s see how we can easily run a basic Vite app inside of a Vercel sandbox.

Let’s start by creating a new Next.js project

Run this command in your terminal:

npx create-next-app@latest vercel-basic

You can use all of the defaults when prompted.
Once it has been created, be sure to create an .env file to add your credentials to.
Add these credentials to your .env file and keep reading to learn how to create them.

VERCEL_TOKEN=your_vercel_token
VERCEL_TEAM_ID=your_vercel_team_id
VERCEL_PROJECT_ID=your_vercel_project_id

Now install ComputeSDK and the Vercel provider

ComputeSDK ships as a small core package plus one package per provider, so you only install what you use.

npm install computesdk @computesdk/vercel

Create a Vercel account

If you don’t already have one, create a Vercel account here.

Create a Vercel project

Screenshot of Vercel's create project page

We only need the project for Vercel’s sandbox functionality, so it doesn’t really matter what you deploy as to your project. But here are a few good options.

  1. Clone this this repo.
  2. Use Vercel’s Next.js Boilerplate
  3. Use one of your existing Git repositories
  4. Deploy a copy of this app on Vercel
Screenshot of Vercel's project settings page

Once you have created a Vercel project, you’ll need to gather your Vercel credentials:

  1. Team ID: Found in your Team Settings (if using a team account)
Screenshot of Vercel's project settings page
  1. Project ID: Found in your Project Settings → General
Screenshot of Vercel's project settings page
  1. Vercel Token: Go to your Account Settings → Tokens → Create Token
Screenshot of Vercel's account settings page

Save these values in your .env file.

VERCEL_TOKEN=your_vercel_token
VERCEL_TEAM_ID=your_vercel_team_id
VERCEL_PROJECT_ID=your_vercel_project_id

Prefer not to manage a token? The Vercel provider also supports OIDC auth — run vercel env pull to populate VERCEL_OIDC_TOKEN in your .env file and omit token/teamId/projectId entirely.

Now we’ll move on to creating the actual sandbox logic

We need to create the API route to create the sandbox

Import the vercel factory from @computesdk/vercel and pass it your credentials. compute.sandbox.create() provisions a sandbox on Vercel.

// app/api/sandbox/route.ts
import { NextResponse } from 'next/server';
import { vercel } from '@computesdk/vercel';

const compute = vercel({
  token: process.env.VERCEL_TOKEN,
  teamId: process.env.VERCEL_TEAM_ID,
  projectId: process.env.VERCEL_PROJECT_ID,
});

export async function POST() {

  const sandbox = await compute.sandbox.create();

  return NextResponse.json({
    sandboxId: sandbox.sandboxId,
  });
}

Next, we’ll edit the page.tsx file

We’ll keep it simple and just add one button to run our sandbox test with.
Paste this code into Page.tsx

// app/page.tsx
'use client';

export default function Home() {
  const createSandbox = async () => {
    const res = await fetch('/api/sandbox', { method: 'POST' });
    const data = await res.json();
    console.log(data);
  };

  return (
    <div className="flex min-h-screen flex-col items-center justify-center p-24">
      <h1 className="mb-8 text-4xl font-bold">ComputeSDK Sandbox Test</h1>
      <button
        className="rounded bg-blue-500 px-4 py-2 font-bold text-white hover:bg-blue-700"
        type="button"
        onClick={createSandbox}
      >
        Create Vercel sandbox
      </button>
    </div>
  );
}

Now, our first test

Click the button on the main page.

screenshot of next.js app button

Now navigate to your Vercel project -> sandboxes.

Screenshot of Vercel's sandboxes page

You should see a running sandbox.
Success!

You’ve successfully created your first Vercel sandbox

If you want to use another sandbox provider like E2B or Daytona, swap the import and factory call — install @computesdk/e2b and use import { e2b } from '@computesdk/e2b' instead, with that provider’s own credentials. The rest of your code (runCommand, filesystem, getUrl) stays the same — that’s the point of the universal Sandbox interface.

Making changes within the sandbox

Now, let’s take the next step and run a primitive Vite app inside of our sandbox as an example of what we are able to do within the sandbox itself.

Vercel sandboxes only expose ports you declare up front, so this time we pass ports to create().

Update /api/sandbox/route.ts

Add the following to your route.ts file directly below this in your code:

const sandbox = await compute.sandbox.create({ ports: [5173] });

Create a basic Vite app inside our sandbox subfolder

// Scaffold Vite React app
await sandbox.runCommand('npm create vite@5 app -- --template react');

Use the writeFile method

Customize the vite.config.js so we can access the local dev server.

// Custom vite.config.js to allow access to sandbox at port 5173
  const viteConfig = `import { defineConfig } from 'vite'
  import react from '@vitejs/plugin-react'

  export default defineConfig({
    plugins: [react()],
    server: {
      host: '0.0.0.0',
      port: 5173,
      strictPort: true,
      hmr: false,
      allowedHosts: ['.vercel.run', 'localhost', '127.0.0.1'],
    },
  })
  `;
  await sandbox.filesystem.writeFile('app/vite.config.js', viteConfig);

Run npm install using the runCommand method

cwd is an optional per-call override — if you don’t pass one, commands run in whatever Vercel’s own sandbox default working directory is. We pass cwd: 'app' here simply because that’s the subfolder we just scaffolded the Vite project into.

  // Install dependencies
  await sandbox.runCommand('npm install', {
    cwd: 'app',
  })

Start local dev server in the background with runCommand

  // Start dev server
  sandbox.runCommand('npm run dev', {
    cwd: 'app',
  });

Use the getUrl method to get a preview URL

  // Get preview URL
  const url = await sandbox.getUrl({ port: 5173 });
  console.log('previewUrl:', url)

The hostname getUrl() returns is on Vercel’s own .vercel.run domain, not a ComputeSDK-branded one. This only works because we declared ports: [5173] when we created the sandbox above — Vercel sandboxes don’t expose ports you didn’t ask for up front.

Return the preview url along with the sandboxId

  return NextResponse.json({
    sandboxId: sandbox.sandboxId,
    url,
  });

Finished route.ts file

Your /app/api/sandbox/route.ts file should look like this now:

import { NextResponse } from 'next/server';
import { vercel } from '@computesdk/vercel';

const compute = vercel({
  token: process.env.VERCEL_TOKEN,
  teamId: process.env.VERCEL_TEAM_ID,
  projectId: process.env.VERCEL_PROJECT_ID,
});

export async function POST() {

  const sandbox = await compute.sandbox.create({ ports: [5173] });

  // Create basic Vite React app
  await sandbox.runCommand('npm create vite@5 app -- --template react');

  // Custom vite.config.js to allow access to sandbox at port 5173
  const viteConfig = `import { defineConfig } from 'vite'
  import react from '@vitejs/plugin-react'

  export default defineConfig({
    plugins: [react()],
    server: {
      host: '0.0.0.0',
      port: 5173,
      strictPort: true,
      hmr: false,
      allowedHosts: ['.vercel.run', 'localhost', '127.0.0.1'],
    },
  })
  `;
  await sandbox.filesystem.writeFile('app/vite.config.js', viteConfig);

  // Install dependencies
  await sandbox.runCommand('npm install', {
    cwd: 'app',
  })

  // Start dev server
  sandbox.runCommand('npm run dev', {
    cwd: 'app',
  });

  // Get preview URL
  const url = await sandbox.getUrl({ port: 5173 });
  console.log('previewUrl:', url)

  return NextResponse.json({
    sandboxId: sandbox.sandboxId,
    url,
  });
}

Testing Vite app inside sandbox

Here is an overview of our project now:

  1. Uses ComputeSDK to create a sandbox in Vercel
  2. Uses ComputeSDK’s runCommand to scaffold a basic Vite app inside it
  3. Uses ComputeSDK to run a dev server (port 5173) on the sandbox
  4. Uses ComputeSDK’s getUrl to connect to the Vite app running on the 5173 port in our browser

Now, after you click the “Create Vercel Sandbox” button on your localhost homepage you should:

  1. See a sandbox running in your Vercel project -> Sandboxes tab.

  2. See a preview URL in your activity logs (if running on Vercel).

Screenshot of Vercel's logs page
  1. See a preview URL logged to your terminal (if you’re running locally), on Vercel’s own .vercel.run domain.
  2. If you visit that URL you should see the boilerplate Vite React app running in your Vercel sandbox!
screenshot of Vite app running in Vercel sandbox via ComputeSDK

Congrats! You’ve successfully created your first sandbox application

You have done the following:

  • created a Vercel sandbox with ComputeSDK
  • used our runCommand, writeFile, and getUrl methods (these work with any provider)
  • ran a Vite app inside the sandbox
  • accessed the app running within the sandbox through its preview URL

ComputeSDK makes it easy to standardize this process across providers.
So now that you’ve written this code in Vercel, you can easily adjust this code to run in any sandbox provider.

Happy Sandboxing!

Have questions?
Want to be added as a provider?
Reach out to us at [email protected]