# PromptRunnerSDK v0.6.1 - Table of Contents

Prompt Runner SDK - Convention-driven and legacy-config prompt orchestration
for Elixir, Mix, and production applications with streaming output,
provider abstractions, runtime stores, and git integration.

## Pages

- [Prompt Runner SDK](readme.md)
- [Getting Started](getting-started.md)
- [Convention Mode](convention-mode.md)
- [CLI Guide](cli.md)
- [API Guide](api.md)
- [Configuration Reference](configuration.md)
- [Legacy Config Mode](legacy-config.md)
- [Provider Guide](providers.md)
- [Rendering Modes](rendering.md)
- [Multi-Repository Workflows](multi-repo.md)
- [Architecture](architecture.md)
- [Migration Notes](migration.md)
- [Examples Overview](examples.md)
- [Simple Example](example-simple.md)
- [Multi-Repo Example](example-multi-repo.md)

- Reference
  - [Changelog](changelog.md)
  - [LICENSE](license.md)

## Modules

- [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.ToolSummary](PromptRunner.Rendering.Studio.ToolSummary.md): Generates human-readable spinner text and summary lines for tool calls.

- Core API
  - [PromptRunner](PromptRunner.md): Public API for building plans and executing prompt runs.

  - [PromptRunner.Application](PromptRunner.Application.md): OTP application for Prompt Runner SDK.
  - [PromptRunner.CLI](PromptRunner.CLI.md): Command-line entrypoint for convention and legacy PromptRunner workflows.

  - [PromptRunner.Plan](PromptRunner.Plan.md): Fully resolved execution plan used by the PromptRunner runtime.

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

- 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.LegacyConfigSource](PromptRunner.Source.LegacyConfigSource.md): Source implementation for explicit v0.4-style PromptRunner config files.

  - [PromptRunner.Source.ListSource](PromptRunner.Source.ListSource.md): Source implementation for in-memory `%PromptRunner.Prompt{}` lists.

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

- Configuration
  - [PromptRunner.Config](PromptRunner.Config.md): Loads and normalizes configuration for the prompt runner.

  - [PromptRunner.Prompt](PromptRunner.Prompt.md): Normalized prompt representation used across all PromptRunner sources.

  - [PromptRunner.Scaffold](PromptRunner.Scaffold.md): Generates legacy PromptRunner files from a convention-based prompt directory.

- 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.Observer.PubSub](PromptRunner.Observer.PubSub.md): Convenience helpers for broadcasting PromptRunner events through `Phoenix.PubSub`.

- Utilities
  - [PromptRunner.Git](PromptRunner.Git.md): Git commit helpers for single-repo and multi-repo prompt runs.

  - [PromptRunner.RepoTargets](PromptRunner.RepoTargets.md): Expands repo group references (`@group_name`) in target repo lists.
  - [PromptRunner.Validator](PromptRunner.Validator.md): Validates prompt runner configuration.

## Mix Tasks

- Core API
  - [mix prompt_runner](Mix.Tasks.PromptRunner.md): Mix task wrapper for the `PromptRunner` CLI.