docs(sandbox): document Computer preview and VM keep-alive - #722
docs(sandbox): document Computer preview and VM keep-alive#722tembo[bot] wants to merge 1 commit into
Conversation
Add two pages under Features > Sandbox covering runtime behavior that recently changed in the product but had no documentation: - features/sandbox/computer.mdx: the Computer tab that streams the sandbox desktop, its dock applications, clipboard support, copy and refresh URL controls, and preview states. - features/sandbox/keep-alive.mdx: default keep-alive windows per work source, the focused-tab heartbeat, the composer option, the tembo set-vm-keep-alive CLI, the setVmKeepAlive MCP tool, and what happens when a window expires. Also add the XXL and Ultra sandbox sizes to the overview table so it matches the compute rates on the pricing page, and point plan limits at the pricing page instead of restating a memory threshold.
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
|
Requesting review from @benja who has experience with the following files modified in this PR:
|
|
A few blockers before this should merge:
The remaining documented behavior—including default windows, composer durations, CLI/MCP controls, snapshot fallback order, billing, preview states, and XXL/Ultra specifications—matches the implementation. |
Docs added/updated
Added
features/sandbox/computer.mdx— the Computer tab: what it streams, the desktop dock (Ulauncher, Chromium, PCManFM, VS Code, Ghostty) and the paths each opens, bidirectional clipboard, the copy/refresh preview-URL controls, the four preview states, and the constraints (60 FPS, no desktop on Docker sandboxes, stream ends with the VM).features/sandbox/keep-alive.mdx— how long a sandbox stays up: default windows per work source, the focused-tab heartbeat, the composer/option, thetembo set-vm-keep-aliveCLI, thesetVmKeepAliveMCP tool, suspend-and-snapshot on expiry, and the compute-cost constraint.Updated
features/sandbox/overview.mdx— added XXL and Ultra rows to the sandbox size table, replaced the "more than 32 GB of RAM" line with a pointer to plan limits on the pricing page, and linked the two new pages.docs.json— added both pages to Features → Sandbox.Codepaths covered
apps/api/src/agent/sandbox/keepAlive.ts,apps/api/src/config.ts(sandbox.keepAlive.*)apps/web/hooks/use-vm-keep-alive-activity.ts,POST /virtual-machine/:id/touch-keep-aliveapps/web/components/composer/slash-menu/keep-alive-scope.tsx,session-options.tsx,use-composer-keep-alive.tstembo set-vm-keep-alive <seconds>, JSON output, error casesapps/api/src/agent/guest/cli/commands/setVmKeepAlive.ts,packages/agent-runtime/src/runtime/tools/setVmKeepAlive.tssetVmKeepAliveMCP toolapps/api/src/server/routes/public-api/mcp.tsapps/api/src/agent/manager/stopExpiredKeepAliveVMs.ts,tasks/vm_stop.ts,tasks/vm_start.tsapps/api/src/services/vmRuntimeUsage.tsapps/api/src/agent/sandbox/sandboxes/vm.ts,apps/api/src/agent/sandbox/tools.ts,config.ts(sandbox.computerPreview.*)apps/web/components/session/workspace/computer/preview-state.ts,booting-state.tsx,unavailable-state.tsxapps/web/components/session/workspace/sidebar-header/{copy,refresh}-computer-url-button.tsxapps/web/components/session/workspace/sidebar-pages.tsxnix/sandbox/guest/computer-preview/{desktop,selkies,default}.nix,nix/sandbox/tembo-enable-computer.nixapps/api/src/config.ts(sandbox.sizes.*),packages/shared/src/entitlements.tsKey knowledge gaps addressed
Verified with
mintlify broken-links(no broken links) anddocs.jsonJSON validation.Note
Low Risk
Documentation-only changes with no runtime or security impact; content was cross-checked against existing product behavior and pricing.
Overview
Adds Computer and Keep alive docs under Features → Sandbox and wires them into
docs.jsonnavigation.The new Computer page explains the session sidebar desktop stream (dock apps, bidirectional clipboard, copy/refresh preview URL, boot/unavailable states, VM-only and keep-alive constraints). Keep alive documents default post-work windows by source, the focused-tab heartbeat, composer
/extensions,tembo set-vm-keep-alive/ MCPsetVmKeepAlive, suspend-and-snapshot on expiry, and compute billing caveats.Sandbox overview now links to both pages, adds XXL and Ultra to the size table, and points plan limits at pricing instead of the old 32 GB RAM contact line.
Reviewed by Cursor Bugbot for commit 062fee9. Bugbot is set up for automated code reviews on this repo. Configure here.