# PromptRunnerSDK v0.12.1 - Table of Contents > Prompt Runner SDK - packet-first prompt execution for Elixir and CLI workflows with verifier-owned completion, retry, repair, and git-aware repository orchestration. ## Pages - [Prompt Runner SDK](readme.md) - [Getting Started](getting-started.md) - [From ADRs To Packets](from-adrs-to-packets.md) - [CLI Guide](cli.md) - [API Guide](api.md) - [Packet Manifest Reference](configuration.md) - [Templates](templates.md) - [Profiles](profiles.md) - [Provider Guide](providers.md) - [Simulated Provider](simulated-provider.md) - [Verification And Repair](verification-and-repair.md) - [Packet Linting](linting.md) - [Supervising A Long Run](supervision.md) - [Operator Workspaces](workspaces.md) - [Rendering Modes](rendering.md) - [Watching And Steering A Live Run](control.md) - [Agent-Controlled Linear Runs](agent-control.md) - [Multi-Repository Packets](multi-repo.md) - [Architecture](architecture.md) - [Examples Overview](examples.md) - [Authoring From ADRs Packet Example](example-authoring.md) - [Single Repo Packet Example](example-single-repo.md) - [Claude Packet Example](example-claude.md) - [Simulated Recovery Packet Example](example-simulated-recovery.md) - [Multi-Repo Packet Example](example-multi-repo.md) - Reference - [Changelog](changelog.md) - [LICENSE](license.md) ## Modules - [PromptRunner.CLI.Control](PromptRunner.CLI.Control.md): The `prompt_runner control` commands. - [PromptRunner.Capabilities](PromptRunner.Capabilities.md): Versioned capabilities exposed without compiling or inspecting a checkout. - [PromptRunner.ContractMigration](PromptRunner.ContractMigration.md): Safe, explicit conversion of legacy verifier command strings to argv contracts. - [PromptRunner.Control.Amendment](PromptRunner.Control.Amendment.md): Changing what "done" means for a prompt, on the record. - [PromptRunner.Control.Interventions](PromptRunner.Control.Interventions.md): The append-only record of what a human said to a run, kept with the packet. - [PromptRunner.Control.Plane](PromptRunner.Control.Plane.md): The runner's half of the control plane. - [PromptRunner.Control.Store](PromptRunner.Control.Store.md): The file transport for one control-plane state root. - [PromptRunner.Control.Subscriber](PromptRunner.Control.Subscriber.md): Follows a run's event stream and forwards it to a subscribing process. - [PromptRunner.Escript](PromptRunner.Escript.md): Bootstraps the installed escript without depending on a source checkout. - [PromptRunner.PathRewriter](PromptRunner.PathRewriter.md): Rebinds source-checkout paths in packet text to logical workspace paths. - [PromptRunner.Rendering](PromptRunner.Rendering.md): Renders prompt-runner canonical event streams through a pluggable renderer and sink pipeline. - [PromptRunner.Rendering.Renderer](PromptRunner.Rendering.Renderer.md): Behaviour for rendering prompt-runner canonical event maps into human-readable output. - [PromptRunner.Rendering.Renderers.CompactRenderer](PromptRunner.Rendering.Renderers.CompactRenderer.md): Compact single-line token renderer for prompt-runner canonical events. - [PromptRunner.Rendering.Renderers.StudioRenderer](PromptRunner.Rendering.Renderers.StudioRenderer.md): CLI-grade interactive renderer for prompt-runner canonical events. - [PromptRunner.Rendering.Renderers.VerboseRenderer](PromptRunner.Rendering.Renderers.VerboseRenderer.md): Verbose line-by-line renderer for prompt-runner canonical events. - [PromptRunner.Rendering.Sink](PromptRunner.Rendering.Sink.md): Behaviour for output destinations that receive rendered prompt-runner text and raw events. - [PromptRunner.Rendering.Sinks.CallbackSink](PromptRunner.Rendering.Sinks.CallbackSink.md): A sink that forwards events to a callback function. - [PromptRunner.Rendering.Sinks.FileSink](PromptRunner.Rendering.Sinks.FileSink.md): A sink that writes rendered output to a log file with ANSI codes stripped. - [PromptRunner.Rendering.Sinks.JSONLSink](PromptRunner.Rendering.Sinks.JSONLSink.md): A sink that writes prompt-runner events as JSON Lines. - [PromptRunner.Rendering.Sinks.TTYSink](PromptRunner.Rendering.Sinks.TTYSink.md): A sink that writes rendered output to a terminal device. - [PromptRunner.Rendering.Studio.ANSI](PromptRunner.Rendering.Studio.ANSI.md): ANSI terminal utilities for the studio renderer pipeline. - [PromptRunner.Rendering.Studio.Diff](PromptRunner.Rendering.Studio.Diff.md): Showing what a tool changed on disk. - [PromptRunner.Rendering.Studio.ToolSummary](PromptRunner.Rendering.Studio.ToolSummary.md): Generates human-readable spinner text and summary lines for tool calls. - [PromptRunner.RunJournal](PromptRunner.RunJournal.md): Append-only durable run records. - [PromptRunner.RunLifecycle](PromptRunner.RunLifecycle.md): Durable run identity and immutable selection fences. - [PromptRunner.Scheduler](PromptRunner.Scheduler.md): Dependency-aware, deterministic prompt scheduling. - [PromptRunner.Verifier.Glob](PromptRunner.Verifier.Glob.md): Read-only glob cardinality and non-empty-file verification. - [PromptRunner.Verifier.JSON](PromptRunner.Verifier.JSON.md): Read-only JSON syntax and declarative shape verification. - [PromptRunner.Verifier.SourceAbsent](PromptRunner.Verifier.SourceAbsent.md): Read-only assertion that forbidden regexes are absent from declared source paths. - [PromptRunner.Verifier.Yaml](PromptRunner.Verifier.Yaml.md): Read-only YAML syntax and root-shape verification. - [PromptRunner.Workspace](PromptRunner.Workspace.md): Operator-owned workspace planning, materialization, and readiness. - [PromptRunner.Workspace.ArtifactBuilder](PromptRunner.Workspace.ArtifactBuilder.md): Builds declared contract artifacts during explicit workspace preparation. - [PromptRunner.Workspace.Doctor](PromptRunner.Workspace.Doctor.md): Read-only readiness checks for an operator-owned workspace. - [PromptRunner.Workspace.LegacyStateImporter](PromptRunner.Workspace.LegacyStateImporter.md): Imports trusted terminal completion records into an operator workspace. - [PromptRunner.Workspace.Manifest](PromptRunner.Workspace.Manifest.md): Strict, versioned operator-workspace manifest. - [PromptRunner.Workspace.Materializer](PromptRunner.Workspace.Materializer.md): Materializes full, independent, operator-owned Git clones. - [PromptRunner.Workspace.Plan](PromptRunner.Workspace.Plan.md): Resolved immutable operator-workspace paths. - [PromptRunner.Workspace.Reference](PromptRunner.Workspace.Reference.md): Resolves prepared workspaces by manifest path, id, or current directory. - [PromptRunner.Workspace.Status](PromptRunner.Workspace.Status.md): Read-only reconciliation of run, lease, containment, journal, and progress facts. - [PromptRunner.Workspace.ToolchainDoctor](PromptRunner.Workspace.ToolchainDoctor.md): Read-only validation of every tool version pin from its exact project cwd. - [PromptRunner.Workspace.Watch](PromptRunner.Workspace.Watch.md): Bounded, evidence-producing workspace health monitor. - Core API - [PromptRunner](PromptRunner.md): Public API for building plans and executing prompt runs. - [PromptRunner.AgentControl](PromptRunner.AgentControl.md): Agent-directed control for a linear packet run. - [PromptRunner.Application](PromptRunner.Application.md): OTP application for Prompt Runner SDK. - [PromptRunner.CLI](PromptRunner.CLI.md): Command-line entrypoint for the Prompt Runner packet workflow. - [PromptRunner.FailureEnvelope](PromptRunner.FailureEnvelope.md): Prompt Runner's normalized recovery view over provider and runtime failures. - [PromptRunner.Packet](PromptRunner.Packet.md): Packet manifest loader and generator. - [PromptRunner.PacketLint](PromptRunner.PacketLint.md): Static authoring hazards in a packet. - [PromptRunner.Packets](PromptRunner.Packets.md): Prompt operations within a packet. - [PromptRunner.Plan](PromptRunner.Plan.md): Fully resolved execution plan used by the PromptRunner runtime. - [PromptRunner.Profile](PromptRunner.Profile.md): Home-scoped Prompt Runner profiles. - [PromptRunner.RecoveryConfig](PromptRunner.RecoveryConfig.md): Normalization and defaults for Prompt Runner recovery policy. - [PromptRunner.RecoveryPolicy](PromptRunner.RecoveryPolicy.md): Recovery decisions for Prompt Runner attempts. - [PromptRunner.Run](PromptRunner.Run.md): Result returned from `PromptRunner.run/2` and `PromptRunner.run_prompt/2`. - [PromptRunner.RunSpec](PromptRunner.RunSpec.md): Normalized description of a requested prompt run before planning. - [PromptRunner.Runtime](PromptRunner.Runtime.md): Packet-local runtime state persisted under `.prompt_runner/state.json`. - [PromptRunner.Verifier](PromptRunner.Verifier.md): Deterministic prompt verification. - [PromptRunner.Verifier.Doc](PromptRunner.Verifier.Doc.md): The `doc:` verify clause: an artifact-quality gate for written deliverables. - [PromptRunner.Verifier.ReposClean](PromptRunner.Verifier.ReposClean.md): The `repos_clean:` verify clause: assert that sessions committed their work. - [PromptRunner.Watch](PromptRunner.Watch.md): Supervision for a long unattended packet run. - Sources - [PromptRunner.Source](PromptRunner.Source.md): Behaviour for loading prompts from directories, legacy config, or in-memory input. - [PromptRunner.Source.DirectorySource](PromptRunner.Source.DirectorySource.md): Source implementation that loads numbered prompt files from a directory. - [PromptRunner.Source.ListSource](PromptRunner.Source.ListSource.md): Source implementation for in-memory `%PromptRunner.Prompt{}` lists. - [PromptRunner.Source.PacketSource](PromptRunner.Source.PacketSource.md): Source implementation for Prompt Runner packet directories. - [PromptRunner.Source.Result](PromptRunner.Source.Result.md): Normalized source output consumed by `PromptRunner.Plan`. - [PromptRunner.Source.SinglePromptSource](PromptRunner.Source.SinglePromptSource.md): Source implementation for one raw prompt string. - Runtime - [PromptRunner.Committer](PromptRunner.Committer.md): Behaviour for post-prompt commit or callback actions. - [PromptRunner.Committer.CallbackCommitter](PromptRunner.Committer.CallbackCommitter.md): Committer that delegates post-run handling to a callback function. - [PromptRunner.Committer.GitCommitter](PromptRunner.Committer.GitCommitter.md): Committer that applies git commits to one or more target repositories. - [PromptRunner.Committer.NoopCommitter](PromptRunner.Committer.NoopCommitter.md): Committer that records no post-run git or callback action. - [PromptRunner.RuntimeStore](PromptRunner.RuntimeStore.md): Behaviour for progress tracking and log destination selection. - [PromptRunner.RuntimeStore.FileStore](PromptRunner.RuntimeStore.FileStore.md): File-backed runtime store used by CLI and legacy runs. - [PromptRunner.RuntimeStore.MemoryStore](PromptRunner.RuntimeStore.MemoryStore.md): In-memory runtime store used by API-first runs. - [PromptRunner.RuntimeStore.NoopStore](PromptRunner.RuntimeStore.NoopStore.md): No-op runtime store for integrations that do not want persisted state. - [PromptRunner.SimulatedLLM](PromptRunner.SimulatedLLM.md): Built-in deterministic provider used for retry, repair, and resume demos. - Configuration - [PromptRunner.Config](PromptRunner.Config.md): Loads and normalizes configuration for the prompt runner. - [PromptRunner.FrontMatter](PromptRunner.FrontMatter.md): Markdown front matter reader and writer used by Prompt Runner packet files. - [PromptRunner.Prompt](PromptRunner.Prompt.md): Normalized prompt representation used across all PromptRunner sources. - [PromptRunner.Template](PromptRunner.Template.md): Prompt scaffold templates. - LLM Integration - [PromptRunner.LLM](PromptRunner.LLM.md): Behaviour and types for LLM integrations. - [PromptRunner.LLMFacade](PromptRunner.LLMFacade.md): Thin delegator implementing the `PromptRunner.LLM` behaviour. - [PromptRunner.Session](PromptRunner.Session.md): Prompt Runner bridge onto the current ASM session runtime. - Observability - [PromptRunner.Control](PromptRunner.Control.md): Watch a live run, and change how it renders, without attaching to it. - [PromptRunner.Control.Entry](PromptRunner.Control.Entry.md): One line of the control log: a command, who issued it, when, and what happened to it. - [PromptRunner.Control.Snapshot](PromptRunner.Control.Snapshot.md): What a run looks like from outside it. - [PromptRunner.Observer.PubSub](PromptRunner.Observer.PubSub.md): Convenience helpers for broadcasting PromptRunner events through `Phoenix.PubSub`. - Compatibility - [PromptRunner.Git](PromptRunner.Git.md): Git commit helpers for single-repo and multi-repo prompt runs, plus the read-only repository inspection used by the verifier and by `watch`. - [PromptRunner.RepoTargets](PromptRunner.RepoTargets.md): Expands repo group references (`@group_name`) in target repo lists. - [PromptRunner.Scaffold](PromptRunner.Scaffold.md): Compatibility helper that generates the older explicit file set from a plan. - [PromptRunner.Source.LegacyConfigSource](PromptRunner.Source.LegacyConfigSource.md): Source implementation for explicit v0.4-style PromptRunner config files. - [PromptRunner.Validator](PromptRunner.Validator.md): Validates prompt runner configuration. ## Mix Tasks - [mix prompt_runner.migrate_contracts](Mix.Tasks.PromptRunner.MigrateContracts.md): Migrates safely tokenizable legacy verifier commands to structured argv contracts. - Core API - [mix prompt_runner](Mix.Tasks.PromptRunner.md): Mix task wrapper for the `PromptRunner` CLI.