PromptRunner (PromptRunnerSDK v0.9.0)

Copy Markdown View Source

Public API for building plans and executing prompt runs.

Summary

Functions

plan(input, opts \\ [])
preflight(input, opts \\ [])
repair(input, opts \\ [])
run(input, opts \\ [])
run_prompt(prompt_text, opts \\ [])
scaffold(input, opts \\ [])
status(input)
validate(input, opts \\ [])
version()

Returns the Prompt Runner version.

Functions

plan(input, opts \\ [])

@spec plan(
  term(),
  keyword()
) :: {:ok, PromptRunner.Plan.t()} | {:error, term()}

preflight(input, opts \\ [])

@spec preflight(
  term(),
  keyword()
) :: {:ok, map()} | {:error, term()}

repair(input, opts \\ [])

@spec repair(
  term(),
  keyword()
) :: {:ok, PromptRunner.Run.t()} | {:error, term()}

run(input, opts \\ [])

@spec run(
  term(),
  keyword()
) :: {:ok, PromptRunner.Run.t()} | {:error, term()}

run_prompt(prompt_text, opts \\ [])

@spec run_prompt(
  String.t(),
  keyword()
) :: {:ok, PromptRunner.Run.t()} | {:error, term()}

scaffold(input, opts \\ [])

@spec scaffold(
  term(),
  keyword()
) :: {:ok, map()} | {:error, term()}

status(input)

@spec status(term()) :: {:ok, map()} | {:error, term()}

validate(input, opts \\ [])

@spec validate(
  term(),
  keyword()
) :: :ok | {:error, term()}

version()

@spec version() :: String.t()

Returns the Prompt Runner version.

This is the single source of truth for every version string Prompt Runner emits, including the CLI banner, generated packet manifests, and the run_prompts.exs install entry.