docs: add Vercel Eve integration guide - #320
Merged
Merged
Conversation
Document `@e2b/eve-sandbox`, the E2B backend for Vercel Eve's agent sandbox, alongside Eve's built-in vercel()/docker()/microsandbox()/ justbash() backends. Covers the two-phase SandboxBackend lifecycle (build-time prewarm into an E2B snapshot, runtime reconnect-or-fork), session persistence via auto-pause, and the Eve-to-E2B network policy mapping — including the policies the backend rejects rather than silently weakening. Adds the Vercel Eve icon with a dark-mode fill and a nav entry.
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
docs/agents/eve.mdxdocumenting@e2b/eve-sandbox, the E2B sandbox backend for Vercel Eve — the E2B counterpart to Eve's built-invercel()/docker()/microsandbox()/justbash()backends.SandboxBackendlifecycle: build-timeprewarm()capturing bootstrap + seed files into an E2B snapshot, runtimecreate()reconnecting bysandboxId→eveSessionKeymetadata → snapshot fork.onTimeout: 'pause',autoResume: true, 30-minute default) and the two non-obvious consequences:shutdown()is a deliberate no-op, and reconnects intentionally do not re-apply the factorynetworkPolicy.<Warning>listing the four policies the backend rejects rather than silently weakening (subnets.denywith an allow-list, per-rulematch,forwardURL,transformwith a catch-all allow).images/icons/vercel-eve.svg(Vercel mark, with aprefers-color-schemefill swap so it stays visible on the dark theme) and a nav entry indocs.json.Facts in the page were read from the
eve-sandboxsource, not inferred: defaults, option names, metadata keys, and every network-policy branch.Test plan
docs.jsonparses and the page appears in the Agents nav between Pi and Google ADK<Note>,<Warning>, and<CardGroup>all display/docs/template/quickstart,/docs/sandbox/persistence,/docs/sandbox,/docs/network/internet-access,/docs/sdk-reference/js-sdkvercel.com/docs/eve,eve.dev/docs/sandbox, the GitHub repoKnown blockers before merge
@e2b/eve-sandboxis not published to npm yet (npm view404s), so thenpm i @e2b/eve-sandbox e2bsnippet will not work until 0.1.0 ships.eve-sandbox'sexamples/package.jsonpinseve ^0.18.1while the root peer range is^0.27.0; the page documents >= 0.27 per the peer range.