> 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/freestyle.md).

# Freestyle

Set up the Freestyle provider for ComputeSDK, configure your API key, and create sandboxes to run commands.

[Freestyle](https://www.freestyle.sh) provider for ComputeSDK: full Linux virtual machines designed for long-running, complex agent tasks, with instant startup, persistence, and cheap snapshotting.

## Installation & Setup

```bash
npm install @computesdk/freestyle
```

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

```bash
FREESTYLE_API_KEY=your_freestyle_api_key
```

Freestyle base images ship no language runtime, so the **first** sandbox on an account bakes a Node + Python snapshot once (\~20 s) and every sandbox after boots from it in \~200–300 ms. Set `FREESTYLE_SNAPSHOT_ID` (or the `snapshotId` option) to your own snapshot to skip baking.

## Usage

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

const compute = freestyle({
  apiKey: process.env.FREESTYLE_API_KEY,
});

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

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

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

### Configuration Options

```typescript
interface FreestyleConfig {
  /** Freestyle API key. Falls back to FREESTYLE_API_KEY. */
  apiKey?: string;
  /** Snapshot every sandbox boots from. Falls back to FREESTYLE_SNAPSHOT_ID; auto-baked when unset. */
  snapshotId?: string;
  /** API base URL. Falls back to FREESTYLE_API_URL, then the SDK default. */
  baseUrl?: string;
  /** Idle seconds before Freestyle stops the VM. Default: 300 */
  idleTimeoutSeconds?: number;
  /** Default wall-clock limit for a single command, ms. Default: 300000 */
  timeout?: number;
  /** Keep the VM after it stops instead of deleting it. Default: ephemeral */
  persistent?: boolean;
  /** Outbound firewall. Defaults to allow-all outbound; pass { rules: [] } to seal. */
  firewall?: { rules: unknown[] };
}
```

## Capabilities

Freestyle VMs are full Linux guests, so the whole filesystem surface is native rather than shelled through `runCommand`:

```typescript
await sandbox.filesystem.writeFile('/tmp/app.js', 'console.log("hi")');
await sandbox.filesystem.readFile('/tmp/app.js');
await sandbox.filesystem.readdir('/tmp');
await sandbox.filesystem.mkdir('/tmp/sub');
await sandbox.filesystem.exists('/tmp/app.js');
await sandbox.filesystem.remove('/tmp/app.js');
```

Snapshots (`compute.snapshot.create` / `list` / `delete`) and reconnect-by-id (`compute.sandbox.getById`) are supported. `getUrl` is not: Freestyle exposes VMs through mapped domains ([`freestyle.domains`](https://docs.freestyle.sh)), not a stock per-port URL.


---

# 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/freestyle.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.