How Superserve compares
Ready to switch
Pick how you want to migrate. Do it yourself step by step, or give the prompt to a coding agent and let it change your code.- Human
- Agent
Before you start
- Get a Superserve API key. Sign in to the console, or sign up for free (no card required). Open API Keys and click Create Key. See Get an API key.
- Keep Vercel Sandbox installed. You remove it only after the cutover, in step 6.
1
Install the SDK and set your API key
Install the Superserve SDK next to
@vercel/sandbox. Set SUPERSERVE_API_KEY in your environment and CI secrets.2
Map the API
The main changes: every sandbox needs a To turn a Vercel image into a template, see Create a template.
name and you keep its id, a command is one shell string instead of a command and an argument list, times are in seconds, and a timeout pauses the sandbox instead of stopping it. The Vercel column shows @vercel/sandbox calls.- TypeScript
- Python
3
Update your code
Change the import, add a
name, convert milliseconds to seconds, and join each command and its arguments into one shell string. Shell-escape each argument, so that the shell does not expand $VAR, * or quotes. Set a command timeout for long commands such as installs and tests.4
Move existing sandboxes with the migration script
The script copies The script uses
/vercel/sandbox from each running or persistent Vercel sandbox into /home/user in a new Superserve sandbox. It does not change or delete your Vercel sandboxes. Run it with Node.js and the Vercel credentials you use today (VERCEL_OIDC_TOKEN, or VERCEL_TOKEN, VERCEL_TEAM_ID and VERCEL_PROJECT_ID) and SUPERSERVE_API_KEY set.migrate-from-vercel-sandbox.ts
@vercel/sandbox, so it runs in Node.js even if your app uses the Python SDK. Each upload and extract can take up to 10 minutes. For large directories or slow connections, raise TIMEOUT_MS. If a copy fails, the script deletes the new Superserve sandbox and moves on to the next one.The script copies files. Start your services in the new sandbox, then take a Superserve snapshot to save memory, processes and disk together.5
Verify and cut over
Run your test suite against Superserve. Check the sandbox list in the console. When the results match, send production traffic to Superserve.
6
Uninstall Vercel Sandbox
After the cutover, remove the
@vercel/sandbox package. Delete the Vercel credentials from your environment and CI secrets if nothing else uses them.