# SmolBox v0.1.2 - Table of Contents

> An Elixir client and supervised execution runtime for self-hosted SmolVM workers

## Pages

- Start here
  - [SmolBox](readme.md)
  - [Getting started](getting-started.md)

- Using SmolBox
  - [Low-level client](client.md)
  - [Managed host integration](host-integration.md)
  - [Troubleshooting](troubleshooting.md)
  - [Telemetry and operator inspection](telemetry.md)

- Operations and compatibility
  - [Persistence and recovery contract](recovery.md)
  - [Deployment and trust boundaries](security.md)
  - [Resource evidence and deployment boundaries](resource-qualification.md)
  - [Compatibility evidence](compatibility.md)

## Modules

- Managed execution
  - [SmolBox](SmolBox.md): Standalone managed sandbox executions over pinned, host-operated SmolVM workers.
  - [SmolBox.Execution](SmolBox.Execution.md): Versioned persisted execution evidence, independent of caller processes.
  - [SmolBox.ExecutionSpec](SmolBox.ExecutionSpec.md): Immutable managed execution intent; host code supplies policy and artifact approval.
  - [SmolBox.Profile](SmolBox.Profile.md): Immutable, host-selected policy for disposable offline executions.
  - [SmolBox.Runtime](SmolBox.Runtime.md): Explicitly started supervisor for bounded managed execution.
  - [SmolBox.Runtime.WorkerConfig](SmolBox.Runtime.WorkerConfig.md): Host-approved managed worker, prepared artifacts, and exact profile revisions.

- Client and commands
  - [SmolBox.Client](SmolBox.Client.md): Low-level typed operations against an explicitly configured SmolVM worker.
  - [SmolBox.Command](SmolBox.Command.md): A bounded argument-vector command. No shell is inserted by SmolBox.
  - [SmolBox.Error](SmolBox.Error.md): A redacted operation failure with explicit dispatch evidence.
  - [SmolBox.Health](SmolBox.Health.md): Bounded worker health observation from SmolVM's `/health` endpoint.
  - [SmolBox.Machine](SmolBox.Machine.md): Validated observation of an offline disposable machine.
  - [SmolBox.MachineSpec](SmolBox.MachineSpec.md): Create a disposable machine from a host-approved prepared artifact.
  - [SmolBox.Result](SmolBox.Result.md): Observed command output and exit status. A nonzero exit is still an observed result.
  - [SmolBox.Worker](SmolBox.Worker.md): Trusted host configuration for a worker control endpoint.

- Files and artifacts
  - [SmolBox.ArtifactStore](SmolBox.ArtifactStore.md): Host-owned bounded file storage, independent of VM image preparation.
  - [SmolBox.ArtifactStore.Directory](SmolBox.ArtifactStore.Directory.md): Small host-owned local artifact adapter for examples and development.
  - [SmolBox.Files](SmolBox.Files.md): Guest workspace paths and byte digests.
  - [SmolBox.Manifest](SmolBox.Manifest.md): Exact input/output file declarations using opaque host artifact-store references.

- Store adapters
  - [SmolBox.Store](SmolBox.Store.md): Atomic host-store boundary for managed execution.
  - [SmolBox.Store.Codec](SmolBox.Store.Codec.md): Versioned data-only record encoding for trusted host store adapters.
  - [SmolBox.Store.Memory](SmolBox.Store.Memory.md): Explicitly ephemeral, bounded store for tests and local development.
  - [SmolBox.Store.RecordOps](SmolBox.Store.RecordOps.md): Pure checks shared by store adapters. These functions provide no atomicity;
adapters must hold the relevant record and worker transaction locks throughout.

- Extensions and internals
  - [SmolBox.Identity](SmolBox.Identity.md): Opaque machine names for an exclusively managed worker namespace.
  - [SmolBox.Runtime.Clock](SmolBox.Runtime.Clock.md): Default managed-runtime clock. Hosts synchronize wall clocks across controllers.
  - [SmolBox.Telemetry](SmolBox.Telemetry.md): Redacted, optional managed-runtime observations through `:telemetry`.
  - [SmolBox.Transport](SmolBox.Transport.md): Host-selected transport extension point. No callback may retry mutations.
  - [SmolBox.Transport.Req](SmolBox.Transport.Req.md): Bounded Req/Finch transport with verified TLS and no automatic retries or redirects.
  - [SmolBox.Wire.SSE](SmolBox.Wire.SSE.md): Incremental parser for the pinned SmolVM exec SSE protocol.