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

# Sprites

Sprites provider for ComputeSDK - cloud sandboxes powered by Sprites

## Installation & Setup

```bash
npm install @computesdk/sprites
```

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

```bash
SPRITES_TOKEN=your_sprites_token
```

## Usage

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

const compute = sprites({
  apiKey: process.env.SPRITES_TOKEN,
});

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

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

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

### Configuration Options

```typescript
interface SpritesConfig {
  /** Sprites API token - if not provided, will fallback to SPRITES_TOKEN environment variable */
  apiKey?: string;
  /** Base URL for the Sprites API - defaults to https://api.sprites.dev/v1 */
  baseUrl?: string;
  /** Execution timeout in milliseconds */
  timeout?: number;
}
```

### Supported Operations

| Method       | Supported | Notes                                                                   |
| ------------ | --------- | ----------------------------------------------------------------------- |
| `create`     | ✅         | Provisions a new Sprite via `POST /sprites`.                            |
| `getById`    | ✅         | Looks up a Sprite by name.                                              |
| `list`       | ✅         | Lists all Sprites for the token.                                        |
| `destroy`    | ✅         | Deletes the Sprite.                                                     |
| `runCommand` | ✅         | Executes commands over the `bash` exec endpoint; supports `cwd`/`env`.  |
| `getInfo`    | ✅         |                                                                         |
| `getUrl`     | ✅         | Returns the Sprite's public URL (Sprites are created with public auth). |
| `filesystem` | ✅         | Native `read`, `write`, `mkdir`, `readdir`, `exists`, `remove`.         |


---

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