Skip to content

Start typing to search the documentation.

Mirage

Last updated View as Markdown

The Mirage connector adapts an application-owned Mirage Workspace into Flue’s sandbox interface. Mirage offers runtime packages for Node and browser-class runtimes, allowing the connector pattern to be used on Node or Cloudflare when you choose compatible resources.

Add the connector

pnpm exec flue add mirage

Requirements

TargetRuntime packageNotes
Node.js@struktoai/mirage-nodeCan use Node-compatible Mirage resources.
Cloudflare@struktoai/mirage-browserUse browser-compatible Workspace resources only.

The generated connector uses Mirage’s shared workspace contract. Some Mirage resources, such as SSH- or database-oriented Node resources, require the Node runtime and must not be imported into a Cloudflare build.

Choose this connector when

Use Mirage when your application wants to assemble a workspace from explicit mounted resources and present that workspace to an agent through a single sandbox boundary. Your application owns resource mounting, credentials, writable boundaries, and workspace lifetime.

See Sandboxes, Deploy on Node.js, Deploy on Cloudflare, and Sandbox Connector API.