> ## Documentation Index
> Fetch the complete documentation index at: https://docs.mirage.strukto.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# boxd

> Run captured programs on a boxd machine.

What to install and a runnable Python example. The settings, how the workspace connects and the notes are on [boxd](https://docs.mirage.strukto.ai/home/setup/machine/boxd.md), shared by both SDKs.

## Install

```bash theme={null}
pip install 'mirage-ai[boxd]'
```

```python theme={null}
from boxd import AsyncBoxd

boxd = AsyncBoxd(region="fra")
machine = await boxd.machines.create("mirage-box", isolated=True)
await boxd.machines.wait_until_ready(machine.id)
print(machine.id)
```

## Usage

`captures` defaults to [`@external`](https://docs.mirage.strukto.ai/home/setup/machine/overview#captures):
every program Mirage does not have itself. Name `@python` to run
Python on the machine too.

```python theme={null}
from mirage import RAMVFS, MountMode, Workspace

ws = Workspace(
    {"/data": RAMVFS()},
    mode=MountMode.EXEC,
    machines={
        "box": {
            "provider": "boxd",
            "machine_id": "machine-id",
            "region": "fra",
            "captures": ["@python", "@external"],
        }
    },
)
await ws.shell("python3 -c 'print(1 + 1)'")
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.