Run captured programs on any machine you can reach over SSH.
The ssh machine provider reaches a machine running sshd, and
runs the programs it captures on it. Anything you can
already ssh into works, with nothing to install on it. You run the
machine; Mirage only runs programs on it. Python SDK and Node.
Installation
Python
TypeScript
pip install 'mirage-ai[ssh]'
pnpm add ssh2
Usage
captures defaults to @external:
every program Mirage does not have itself. Name @python to run
Python on the machine too.
Pick a mount_type. With ssh, the machine needs sshfs, and
passwordless sudo for a mountpoint its user cannot create (/data).
With mirage, it needs fuse3, uv or npm to install
mirage-fuse, and the same sudo.
A Mac takes mirage alone, with macFUSE in place of fuse3
(A Mac).Without mount_type, two ways:Files already on the machine. Mount the machine’s directory with the
ssh VFS at a prefix equal to its path there. The same
path then names the same file on both sides, with nothing to install:
Any other mount (S3, Slack and so on). Install Mirage and fuse3 on the
machine, and start Mirage with a sandbox.yaml that lists the same paths:
ssh mybox mirage workspace create sandbox.yaml
Mirage never rewrites paths and nothing checks that they match. A program on
the machine opens its files directly, outside this workspace’s mount modes
and permissions.
Notes
host is also the address unless hostname overrides it; port,
username, identity_file, private_key and timeout are optional.
Authentication is a key or an agent, never a password.
private_key takes the key’s own text rather than a path, so a
credential pointer can read it
from a secret store.
The machine’s login shell must be POSIX-compatible. Commands use the
session’s working directory and environment.
Host keys are not verified, so treat the network path to the machine as
trusted.