# Sprites v0.2.3 - Table of Contents

> Elixir SDK for Fly.io Sprites: computers for agents. Manage Sprites and run remote commands from Elixir, with APIs that match the language's conventions.

## Pages

- [Sprites Elixir SDK](readme.md)

## Modules

- [Sprites](Sprites.md): Elixir SDK for Sprites - remote code container runtime.
- [Sprites.Checkpoint](Sprites.Checkpoint.md): Checkpoint management for sprites.
- [Sprites.Client](Sprites.Client.md): HTTP client for Sprites REST API operations.

- [Sprites.Command](Sprites.Command.md): Represents a running command on a sprite.
- [Sprites.Control](Sprites.Control.md): Module-level pool management for control connections.
- [Sprites.ControlConn](Sprites.ControlConn.md): A persistent WebSocket connection to a sprite's control endpoint.
- [Sprites.ControlPool](Sprites.ControlPool.md): Pool of `Sprites.ControlConn` processes for a single sprite.
- [Sprites.Error](Sprites.Error.md): Error types for the Sprites SDK.

- [Sprites.Filesystem](Sprites.Filesystem.md): Filesystem operations for sprites.
- [Sprites.Policy](Sprites.Policy.md): Network policy management for sprites.

- [Sprites.Policy.Rule](Sprites.Policy.Rule.md): Network policy rule.
- [Sprites.Protocol](Sprites.Protocol.md): Binary protocol encoding/decoding for Sprites WebSocket.
- [Sprites.Proxy](Sprites.Proxy.md): Port forwarding and proxying for sprites.
- [Sprites.Proxy.PortMapping](Sprites.Proxy.PortMapping.md): Port mapping configuration.
- [Sprites.Proxy.Session](Sprites.Proxy.Session.md): Active proxy session managed by a GenServer.

- [Sprites.Session](Sprites.Session.md): Session management for sprites.
- [Sprites.Sprite](Sprites.Sprite.md): Represents a sprite instance.

- [Sprites.Stream](Sprites.Stream.md): Provides an Elixir Stream-based interface for command output.
- [Sprites.StreamMessage](Sprites.StreamMessage.md): A message from a streaming operation (checkpoint create/restore).

- Exceptions
  - [Sprites.Error.APIError](Sprites.Error.APIError.md): Raised when the API returns an error response.
  - [Sprites.Error.CommandError](Sprites.Error.CommandError.md): Raised when a command fails with non-zero exit code.
  - [Sprites.Error.ConnectionError](Sprites.Error.ConnectionError.md): Raised when WebSocket connection fails.
  - [Sprites.Error.FilesystemError](Sprites.Error.FilesystemError.md): Raised when a filesystem operation fails.
  - [Sprites.Error.TimeoutError](Sprites.Error.TimeoutError.md): Raised when an operation times out.

