Automatic persistence now in beta on Vercel Sandbox

1
import { Sandbox } from '@vercel/sandbox';
2

3
// Create a named sandbox
4
const sandbox = await Sandbox.create({ name: 'user-a-workspace' });
5
await sandbox.runCommand('npm', ['install']);
6
await sandbox.stop();
7

8
// Later, resume where you left off
9
const sandbox = await Sandbox.get({ name: 'user-a-workspace' });
10
await sandbox.runCommand('npm', ['run', 'dev']);

1
const sandbox = await Sandbox.create({ name: "long-lived-sandbox" });
2
await sandbox.writeFiles([{
3
  path: "run.sh",
4
  content: Buffer.from('#!/bin/bash\necho "ready"'),
5
  mode: 0o755,
6
}]);
7

8
// Days later
9
const resumedSandbox = await Sandbox.get({ name: "long-lived-sandbox" });
10
console.log(resumedSandbox.status); // stopped automatically
11

12
await resumedSandbox.runCommand("./run.sh"); // "Hello!"
13
console.log(resumedSandbox.status); // running

1
const sandbox = await Sandbox.get({ name: 'user-alice' });
2

3
// Scale up resources on a running sandbox
4
await sandbox.update({ resources: { vcpus: 4 } });
5

6
// Inspect session history and snapshots
7
const { sessions } = await sandbox.listSessions();
8
const { snapshots } = await sandbox.listSnapshots();
9

10
// Search across sandboxes
11
const { sandboxes } = await Sandbox.list({
12
  namePrefix: 'user-',
13
  sortBy: 'name',
14
});
15

16
// Permanently remove a sandbox and all its data
17
await sandbox.delete();

1
  # Spin up a sandbox for a user
2
  sandbox create --name user-alice
3

4
  # User runs commands — if the sandbox timed out, it resumes automatically
5
  sandbox run --name user-alice -- npm test
6

7
  # Check what happened across sessions
8
  sandbox sessions list user-alice
9

10
  # Tune resources without recreating
11
  sandbox config vcpus user-alice 4
12
  sandbox config timeout user-alice 5h