# squid_mesh v0.1.0-alpha.7 - Table of Contents

Durable workflow runtime for Elixir applications.

## Pages

- [Documentation](index.md)
- [README](readme.md)
- [Architecture](architecture.md)
- [Durable Dispatch Protocol](durable_dispatch_protocol.md)
- [Positioning](positioning.md)
- [Compatibility Matrix](compatibility.md)
- [Tool Adapters](tool_adapters.md)
- [Observability](observability.md)
- [Workflow Authoring](workflow_authoring.md)
- [Host App Integration](host_app_integration.md)
- [Operations Guide](operations.md)
- [Production Readiness](production_readiness.md)
- [Changelog](changelog.md)
- [Contributing](contributing.md)
- [Code of Conduct](code_of_conduct.md)
- [LICENSE](license.md)

## Modules

- [SquidMesh](SquidMesh.md): Public entrypoint for the Squid Mesh runtime.
- [SquidMesh.AttemptStore](SquidMesh.AttemptStore.md): Durable store for step-attempt history.
- [SquidMesh.Config](SquidMesh.Config.md): Loads and validates host application configuration for Squid Mesh.
- [SquidMesh.Executor](SquidMesh.Executor.md): Behaviour implemented by host applications to deliver Squid Mesh work.
- [SquidMesh.Executor.Payload](SquidMesh.Executor.Payload.md): Backend-neutral payloads that host executors can hand to their queue.

- [SquidMesh.Observability](SquidMesh.Observability.md): Internal helpers for runtime telemetry and structured logs.
- [SquidMesh.Persistence.Run](SquidMesh.Persistence.Run.md): Persisted workflow run state.
- [SquidMesh.Persistence.StepAttempt](SquidMesh.Persistence.StepAttempt.md): Persisted attempt state for a step run.
- [SquidMesh.Persistence.StepRun](SquidMesh.Persistence.StepRun.md): Persisted state for one workflow step execution.
- [SquidMesh.Run](SquidMesh.Run.md): Public representation of a workflow run.
- [SquidMesh.RunAuditEvent](SquidMesh.RunAuditEvent.md): Public representation of one durable workflow audit event.
- [SquidMesh.RunExplanation](SquidMesh.RunExplanation.md): Structured diagnostic explanation for one workflow run.
- [SquidMesh.RunStepState](SquidMesh.RunStepState.md): Public representation of one logical workflow step within a run.
- [SquidMesh.RunStore](SquidMesh.RunStore.md): Durable run persistence and lifecycle operations.
- [SquidMesh.RunStore.Persistence](SquidMesh.RunStore.Persistence.md): Write-side persistence helpers for workflow runs.
- [SquidMesh.RunStore.Serialization](SquidMesh.RunStore.Serialization.md): Read-side serialization and hydration helpers for workflow runs.
- [SquidMesh.Runtime.BuiltInStep](SquidMesh.Runtime.BuiltInStep.md): Executes declarative built-in workflow steps.
- [SquidMesh.Runtime.Compensation](SquidMesh.Runtime.Compensation.md): Executes durable saga compensation for completed workflow steps.
- [SquidMesh.Runtime.DispatchAgent](SquidMesh.Runtime.DispatchAgent.md): Jido-native dispatch coordination state for one durable dispatch queue.
- [SquidMesh.Runtime.DispatchProtocol](SquidMesh.Runtime.DispatchProtocol.md): Defines the durable dispatch journal contract.
- [SquidMesh.Runtime.DispatchProtocol.ActionAttempt](SquidMesh.Runtime.DispatchProtocol.ActionAttempt.md): Rebuildable projection of one dispatch attempt.
- [SquidMesh.Runtime.DispatchProtocol.Entry](SquidMesh.Runtime.DispatchProtocol.Entry.md): One durable runtime journal entry.
- [SquidMesh.Runtime.DispatchProtocol.Projection](SquidMesh.Runtime.DispatchProtocol.Projection.md): Rebuildable projection over durable dispatch journal entries.
- [SquidMesh.Runtime.Dispatcher](SquidMesh.Runtime.Dispatcher.md): Enqueues durable workflow step execution.
- [SquidMesh.Runtime.Journal](SquidMesh.Runtime.Journal.md): Jido.Storage boundary for Squid Mesh durable runtime facts.
- [SquidMesh.Runtime.Journal.Checkpoint](SquidMesh.Runtime.Journal.Checkpoint.md): A compact projection snapshot with the durable thread revision it covers.
- [SquidMesh.Runtime.ManualAction](SquidMesh.Runtime.ManualAction.md): Validation and serialization helpers for durable manual workflow actions.
- [SquidMesh.Runtime.RetryPolicy](SquidMesh.Runtime.RetryPolicy.md): Resolves workflow retry configuration into concrete runtime decisions.
- [SquidMesh.Runtime.Reviewer](SquidMesh.Runtime.Reviewer.md): Applies explicit approval decisions to paused approval steps.
- [SquidMesh.Runtime.Runner](SquidMesh.Runtime.Runner.md): Backend-neutral runtime entrypoints for host executors.
- [SquidMesh.Runtime.StateMachine](SquidMesh.Runtime.StateMachine.md): Explicit run lifecycle state machine for the Squid Mesh runtime.
- [SquidMesh.Runtime.StepExecutor](SquidMesh.Runtime.StepExecutor.md): Executes one workflow step through Jido and persists the outcome.
- [SquidMesh.Runtime.StepExecutor.Execution](SquidMesh.Runtime.StepExecutor.Execution.md): Executes a prepared workflow step without mutating durable run state.
- [SquidMesh.Runtime.StepExecutor.Outcome](SquidMesh.Runtime.StepExecutor.Outcome.md): Persistence and dispatch handling for completed step executions.
- [SquidMesh.Runtime.StepExecutor.Preparation](SquidMesh.Runtime.StepExecutor.Preparation.md): Prepares a runnable workflow step for execution.
- [SquidMesh.Runtime.StepExecutor.PreparedStep](SquidMesh.Runtime.StepExecutor.PreparedStep.md): Immutable handoff from preparation into execution and apply.
- [SquidMesh.Runtime.StepInput](SquidMesh.Runtime.StepInput.md): Step-execution input normalization for the runtime.
- [SquidMesh.Runtime.StepRecovery](SquidMesh.Runtime.StepRecovery.md): Recovery helpers for step claims left running by interrupted workers.

- [SquidMesh.Runtime.Unblocker](SquidMesh.Runtime.Unblocker.md): Resumes runs that are intentionally paused for manual intervention.
- [SquidMesh.Runtime.WorkflowAgent](SquidMesh.Runtime.WorkflowAgent.md): Jido-native workflow coordination state for one durable workflow run.
- [SquidMesh.Runtime.WorkflowAgent.Projection](SquidMesh.Runtime.WorkflowAgent.Projection.md): Rebuildable workflow-agent projection over one run-thread journal.
- [SquidMesh.Step](SquidMesh.Step.md): Public contract for authoring native Squid Mesh workflow steps.
- [SquidMesh.Step.Action](SquidMesh.Step.Action.md): Internal Jido action adapter for native Squid Mesh steps.
- [SquidMesh.Step.Context](SquidMesh.Step.Context.md): Durable runtime context passed to native Squid Mesh steps.
- [SquidMesh.StepAttempt](SquidMesh.StepAttempt.md): Public representation of one workflow step attempt.
- [SquidMesh.StepRun](SquidMesh.StepRun.md): Public representation of one workflow step execution.
- [SquidMesh.StepRunStore](SquidMesh.StepRunStore.md): Durable store for per-step workflow execution state.
- [SquidMesh.Tools](SquidMesh.Tools.md): Public boundary for invoking external tools from workflow steps.
- [SquidMesh.Tools.Adapter](SquidMesh.Tools.Adapter.md): Behaviour for Squid Mesh tool adapters.
- [SquidMesh.Tools.Error](SquidMesh.Tools.Error.md): Normalized tool failure shape.

- [SquidMesh.Tools.HTTP](SquidMesh.Tools.HTTP.md): HTTP tool adapter backed by Req.

- [SquidMesh.Tools.Result](SquidMesh.Tools.Result.md): Normalized successful tool result.

- [SquidMesh.Workflow](SquidMesh.Workflow.md): Declarative workflow contract for Squid Mesh workflow modules.
- [SquidMesh.Workflow.Definition](SquidMesh.Workflow.Definition.md): Runtime-facing representation of a compiled workflow definition.
- [SquidMesh.Workflow.Dsl](SquidMesh.Workflow.Dsl.md): Spark DSL wrapper for Squid Mesh workflow declarations.
- [SquidMesh.Workflow.Info](SquidMesh.Workflow.Info.md): Read helpers for compiled Squid Mesh workflow Spark metadata.
- [SquidMesh.Workflow.SparkExtension](SquidMesh.Workflow.SparkExtension.md): Spark extension that defines the Squid Mesh workflow step section.
- [SquidMesh.Workflow.Spec](SquidMesh.Workflow.Spec.md): Serializable, normalized workflow specification used to rebuild planner state.
- [SquidMesh.Workflow.StepSpec](SquidMesh.Workflow.StepSpec.md): Spark entity for one declared Squid Mesh workflow step.
- [SquidMesh.Workflow.Validation](SquidMesh.Workflow.Validation.md): Compile-time validation and normalization for workflow modules.

## Mix Tasks

- [mix squid_mesh.install](Mix.Tasks.SquidMesh.Install.md): Installs Squid Mesh by creating its migration in the host application.