> For the complete documentation index, see [llms.txt](https://docs.computesdk.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.computesdk.com/providers/isorun.md).

# Isorun

{% embed url="<https://www.computesdk.com/benchmarks/sandboxes/isorun/>" %}

Isorun provider for ComputeSDK — isolated Linux VM sandboxes for running untrusted and AI-generated code, billed by the second.

## Installation & Setup

```bash
npm install @computesdk/isorun
```

Add your Isorun credentials to a `.env` file:

```bash
ISORUN_API_KEY=your_isorun_api_key
```

## Usage

```typescript
import { isorun } from '@computesdk/isorun';

const compute = isorun({
  apiKey: process.env.ISORUN_API_KEY,
});

// Create sandbox
const sandbox = await compute.sandbox.create();

// Run a command
const result = await sandbox.runCommand('echo "Hello from Isorun!"');
console.log(result.stdout); // "Hello from Isorun!"

// Clean up
await sandbox.destroy();
```

### Configuration Options

```typescript
interface IsorunConfig {
  /** API key. Falls back to `ISORUN_API_KEY` env var. The runner endpoint is derived from the key. */
  apiKey?: string;
}
```

### Supported Operations

| Method       | Supported | Notes                                                                                                                                                      |
| ------------ | --------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `create`     | ✅         | Defaults to the `node` runtime (`node:22`); pass `runtime: 'python'` for `python:3.12-slim`. Accepts `image`, `vcpus`, `memMiB`, `diskMiB`, and `timeout`. |
| `getById`    | ✅         |                                                                                                                                                            |
| `list`       | ✅         |                                                                                                                                                            |
| `destroy`    | ✅         |                                                                                                                                                            |
| `runCommand` | ✅         | Supports `env`, `cwd`, and `background` options.                                                                                                           |
| `getInfo`    | ✅         |                                                                                                                                                            |
| `getUrl`     | ✅         | Returns the sandbox URL for a given port; honors a custom `protocol`.                                                                                      |
| `filesystem` | ✅         | `readFile` / `writeFile` are native; `mkdir`, `readdir`, `exists`, `remove` run via shell commands.                                                        |
| `snapshot`   | ✅         | `compute.snapshot.create` / `list` / `delete`.                                                                                                             |

### Notes

* The default command/sandbox timeout is 300000 ms (5 minutes).
* The `isorun` SDK exposes extra capabilities without ComputeSDK slots — `fork(n)`, `hibernate()` / `resume()`, and `setTimeout(seconds)`. Reach the raw instance via `compute.sandbox.getInstance(sandbox)`.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.computesdk.com/providers/isorun.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.