Skip to main content

Installation

Install the Node package:
It needs a supported Node release and ES modules, so set "type": "module" in package.json:

Create a Workspace

Start with the RAM VFS, an in-memory filesystem mounted at /data that needs no credentials.
quickstart.ts
Mounts are read-only unless you set a mode. MountMode.WRITE lets the shell create and change files under /data. Run it:
Output:
ws.shell does not throw when a command fails. Check result.exitCode and result.stderrText. See the in-app API reference.

Next steps

For a browser app, start from the Browser Quickstart.

Virtualize data storage

S3, Slack, Google Drive, Postgres and 50+ more, as files.

Install CLIs

gh, git, Linear, Office and PDF tools in the same shell.

Run programs on a machine

python3 and node in Mirage, on the host or in a sandbox.

Connect an agent

The TypeScript agent SDKs, wired to one workspace.

Set what an agent may do

Profiles, command rules, asks and hidden paths.

In-App API

Every workspace and session call, with an example.