@skaile/provider-vercel-sandbox
v0.1.0
Published
Vercel Sandbox deploy target for @skaile/workspaces
Readme
@skaile/provider-vercel-sandbox
A Vercel Sandbox deploy target for
@skaile/workspaces. It runs
a workspace inside a Vercel Sandbox and reaches it over the sandbox's public TLS
domain.
Install
skaile plugin install @skaile/provider-vercel-sandboxThe @vercel/sandbox SDK is an optional peer dependency — install it in your
project so the provider can lazy-load it at runtime:
npm install @vercel/sandboxAdd it to skaile.yaml:
plugins:
- "@skaile/provider-vercel-sandbox@^0.1.0"
deploy:
target: vercel-sandbox
config:
token: ${VERCEL_TOKEN}
runtime: node22
port: 8080Config
| Field | Type | Default | Notes |
|---|---|---|---|
| token | string | — | Vercel access token |
| teamId | string | — | Vercel team id |
| projectId | string | — | Vercel project id |
| runtime | string | node22 | Sandbox runtime |
| port | number | 8080 | Workspace WS port |
| timeout | number | 300000 | Sandbox max lifetime (ms) |
| buildStrategy | local \| remote \| managed | remote | |
How it works
@vercel/sandboxis lazy-loaded via a dynamicimport()insidecreate()/restore(), so this package builds and typechecks without the SDK installed (offline-safe).wsUrlis derived fromsandbox.domain(port)withhttps→wss(tlsTermination: "edge").
Limitations (v0.1.0)
- Requires
@vercel/sandboxinstalled in the host project at runtime. restore()readsVERCEL_TOKENfrom the environment (config is not persisted in the handle payload).
