# squid_mesh v0.1.1 - Table of Contents

> Durable workflow runtime for Elixir applications.

## Pages

- [Changelog](changelog.md)
- [Contributing](contributing.md)
- [Code of Conduct](code_of_conduct.md)
- [LICENSE](license.md)

- Start Here
  - [Squid Mesh Documentation](index.md)
  - [SquidMesh](readme.md)
  - [Getting Started](getting_started-1.md)

- Livebooks
  - [Getting Started With Squid Mesh](getting_started-2.md)
  - [Workflow Authoring](workflow_authoring-3.md)

- Guides
  - [Observability](observability.md)
  - [Actor Visibility](actor_visibility.md)
  - [Workflow Authoring](workflow_authoring-4.md)
  - [Host App Integration](host_app_integration.md)
  - [Operations Guide](operations.md)

- Reference
  - [Supported Baseline](compatibility.md)
  - [Tool Adapters](tool_adapters.md)
  - [Storage Strategy and Adapter Contract](storage_strategy.md)
  - [Graph Inspection Contract](graph_inspection.md)
  - [Reference Workflows](reference_workflows.md)
  - [Production Readiness](production_readiness.md)

- Internals
  - [Architecture](architecture.md)
  - [Jido Runtime Architecture](jido_runtime_architecture.md)
  - [Durable Dispatch Protocol](durable_dispatch_protocol.md)
  - [Positioning](positioning.md)

- AI Usage Rules
  - [Squid Mesh Usage Rules](usage-rules.md)
  - [Squid Mesh Runtime Usage Rules](runtime.md)
  - [Squid Mesh Host App Usage Rules](host-apps.md)
  - [Squid Mesh Workflow Authoring Usage Rules](workflow-authoring.md)
  - [Squid Mesh Testing Usage Rules](testing.md)
  - [Squid Mesh Documentation Usage Rules](documentation.md)
  - [Squid Mesh Tooling Usage Rules](tooling.md)

## Modules

- [SquidMesh](SquidMesh.md): Public entrypoint for the Squid Mesh runtime.
- [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 schedule Squid Mesh cron work.
- [SquidMesh.Executor.Leases](SquidMesh.Executor.Leases.md): Behaviour for backends that own worker claims and lease extension.
- [SquidMesh.Executor.Leases.Claim](SquidMesh.Executor.Leases.Claim.md): Backend-neutral worker claim returned by a lease adapter.
- [SquidMesh.Executor.Payload](SquidMesh.Executor.Payload.md): Backend-neutral cron payloads that host schedulers can hand to their queue.
- [SquidMesh.Persistence.JournalCheckpoint](SquidMesh.Persistence.JournalCheckpoint.md): Persisted checkpoint value for a Jido storage key.
- [SquidMesh.Persistence.JournalEntry](SquidMesh.Persistence.JournalEntry.md): Append-only persisted Jido journal entry.
- [SquidMesh.Persistence.JournalThread](SquidMesh.Persistence.JournalThread.md): Persisted metadata for one Jido journal thread.
- [SquidMesh.ReadModel.Explanation](SquidMesh.ReadModel.Explanation.md): Projection-backed explanation for the journal-backed runtime.
- [SquidMesh.ReadModel.Explanation.Diagnostic](SquidMesh.ReadModel.Explanation.Diagnostic.md): Deterministic explanation built from a projection-backed inspection snapshot.
- [SquidMesh.ReadModel.Inspection](SquidMesh.ReadModel.Inspection.md): Projection-backed inspection for the journal-backed runtime.
- [SquidMesh.ReadModel.Inspection.Snapshot](SquidMesh.ReadModel.Inspection.Snapshot.md): Projection-backed inspection snapshot for one Jido-native workflow run.
- [SquidMesh.ReadModel.Listing](SquidMesh.ReadModel.Listing.md): Projection-backed run listing for the journal-backed runtime.
- [SquidMesh.ReadModel.Listing.Summary](SquidMesh.ReadModel.Listing.Summary.md): Redacted journal-backed run listing row.
- [SquidMesh.ReadModel.Visibility](SquidMesh.ReadModel.Visibility.md): Actor-scoped read-model redaction helpers.
- [SquidMesh.Runs.DynamicWorkPreview](SquidMesh.Runs.DynamicWorkPreview.md): Validated, read-only preview of one dynamic work record.
- [SquidMesh.Runs.GraphInspection](SquidMesh.Runs.GraphInspection.md): Graph-oriented inspection output for one workflow run.
- [SquidMesh.Runs.GraphInspection.Edge](SquidMesh.Runs.GraphInspection.Edge.md): Public graph edge for workflow run inspection.
- [SquidMesh.Runs.GraphInspection.Node](SquidMesh.Runs.GraphInspection.Node.md): Public graph node for workflow run inspection.
- [SquidMesh.Runtime.AgentRecovery](SquidMesh.Runtime.AgentRecovery.md): Restart recovery coordinator for Jido-native workflow and dispatch agents.
- [SquidMesh.Runtime.BuiltInStep](SquidMesh.Runtime.BuiltInStep.md): Executes declarative built-in workflow steps.
- [SquidMesh.Runtime.DispatchAgent](SquidMesh.Runtime.DispatchAgent.md): Jido-native dispatch coordination state for one durable dispatch queue.
- [SquidMesh.Runtime.DispatchNotifier](SquidMesh.Runtime.DispatchNotifier.md): Boundary for live dispatch wakeups emitted after durable scheduling.
- [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.Journal](SquidMesh.Runtime.Journal.md): Storage boundary for Squid Mesh durable runtime facts.
- [SquidMesh.Runtime.Journal.Cancellation](SquidMesh.Runtime.Journal.Cancellation.md): Journal-backed workflow cancellation.
- [SquidMesh.Runtime.Journal.Checkpoint](SquidMesh.Runtime.Journal.Checkpoint.md): A compact projection snapshot with the durable thread revision it covers.
- [SquidMesh.Runtime.Journal.Executor](SquidMesh.Runtime.Journal.Executor.md): Executes one visible attempt from the journal-backed runtime queue.
- [SquidMesh.Runtime.Journal.ManualControl](SquidMesh.Runtime.Journal.ManualControl.md): Journal-backed manual intervention controls.
- [SquidMesh.Runtime.Journal.Options](SquidMesh.Runtime.Journal.Options.md): Validates public options that reach journal-backed runtime threads.
- [SquidMesh.Runtime.Journal.Replay](SquidMesh.Runtime.Journal.Replay.md): Journal-backed workflow replay.
- [SquidMesh.Runtime.Journal.Starter](SquidMesh.Runtime.Journal.Starter.md): Journal-backed workflow start boundary for the Jido-native runtime.
- [SquidMesh.Runtime.Journal.Storage](SquidMesh.Runtime.Journal.Storage.md): Normalized storage boundary for journal-backed runtime state.
- [SquidMesh.Runtime.Journal.Storage.Ecto](SquidMesh.Runtime.Journal.Storage.Ecto.md): Postgres-compatible Ecto storage adapter for Squid Mesh journal runtime state.
- [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.RunCatalogProjection](SquidMesh.Runtime.RunCatalogProjection.md): Rebuildable projection over the global journal run catalog.
- [SquidMesh.Runtime.RunIndexProjection](SquidMesh.Runtime.RunIndexProjection.md): Rebuildable projection over a workflow's run-index journal.
- [SquidMesh.Runtime.Runner](SquidMesh.Runtime.Runner.md): Backend-neutral runtime entrypoints for host scheduler jobs.
- [SquidMesh.Runtime.ScheduleIdentity](SquidMesh.Runtime.ScheduleIdentity.md): Builds stable identities for scheduled workflow activations.
- [SquidMesh.Runtime.ScheduleMetadata](SquidMesh.Runtime.ScheduleMetadata.md): Normalizes scheduler metadata for cron-triggered workflow starts.
- [SquidMesh.Runtime.Signal](SquidMesh.Runtime.Signal.md): Squid Mesh-native runtime command signal envelope.
- [SquidMesh.Runtime.Signal.JidoAdapter](SquidMesh.Runtime.Signal.JidoAdapter.md): Converts Squid Mesh runtime command signals to and from `Jido.Signal`.
- [SquidMesh.Runtime.StepInput](SquidMesh.Runtime.StepInput.md): Step-execution input normalization for the runtime.
- [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.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.ActionRegistry](SquidMesh.Workflow.ActionRegistry.md): Host-owned trust boundary for runtime-authored workflow actions.
- [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.EditorSpec](SquidMesh.Workflow.EditorSpec.md): JSON-safe workflow spec projection for visual editors.
- [SquidMesh.Workflow.Info](SquidMesh.Workflow.Info.md): Read helpers for compiled Squid Mesh workflow Spark metadata.
- [SquidMesh.Workflow.PayloadFieldSpec](SquidMesh.Workflow.PayloadFieldSpec.md): Spark entity for one trigger payload field.

- [SquidMesh.Workflow.PayloadSpec](SquidMesh.Workflow.PayloadSpec.md): Spark entity for a trigger payload block.

- [SquidMesh.Workflow.SparkExtension](SquidMesh.Workflow.SparkExtension.md): Spark extension that defines the Squid Mesh workflow DSL.
- [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.TransitionSpec](SquidMesh.Workflow.TransitionSpec.md): Spark entity for one declared workflow transition.

- [SquidMesh.Workflow.TriggerDefinitionSpec](SquidMesh.Workflow.TriggerDefinitionSpec.md): Spark entity for one concrete trigger kind inside a workflow trigger.

- [SquidMesh.Workflow.TriggerSpec](SquidMesh.Workflow.TriggerSpec.md): Spark entity for one Squid Mesh workflow trigger declaration.

- [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.