Skip to content

Start typing to search the documentation.

boxd

Last updated View as Markdown

The boxd connector adapts an already-initialized boxd Box from @boxd-sh/sdk into Flue’s sandbox interface. Use it when an agent needs a provider-backed Linux virtual machine with filesystem and shell behavior rather than the lightweight default workspace.

Add the connector

Run the connector installation flow in your Flue project:

pnpm exec flue add boxd

The generated connector expects your application to create and own the boxd VM. It does not decide VM identity, retention, or cleanup for you.

Requirements

RequirementValue
Provider package@boxd-sh/sdk
CredentialBOXD_API_KEY, or provider-supported short-lived BOXD_TOKEN
Execution shapeLinux VM adapted to SandboxFactory
Lifecycle ownershipYour application owns creation, reuse, and deletion

Use it when

Choose boxd when a task requires real Linux command behavior in an isolated provider VM, particularly where a separate VM per workspace or agent instance is part of your application design.

Before reusing a VM across sessions or tenants, define identity, authorization, egress, secrets, and cleanup policies. Conversation persistence remains controlled separately by Flue session storage.

See Sandboxes for execution-boundary design and Sandbox Connector API for the adapter contract.