scriptorium/README.md

scriptorium

Scriptorium is a narrow prompt-execution application for rendering prompt requests, running them against OpenAI-compatible chat-completions endpoints, and serving the same run workflow over HTTP.

It keeps prompt definitions, execution profiles, schemas, and input artifacts as separate files so prompts can be reviewed and reused without baking model runtime settings into application code.

Quickstart

From the repository root:

go run ./cmd/scriptorium render \
  --config ./examples/config.yml \
  --prompt generic.markdown_summary \
  --input transcript=./examples/fixtures/transcript.md \
  --input glossary=./examples/fixtures/glossary.yml \
  --format json

This command renders the prepared prompt and effective runtime settings without calling an LLM. For complete invocation and output behavior, see the CLI reference.

Documentation

• CLI reference
• Configuration reference
• HTTP API reference
• Operations guide
• Consumer integration overview
• Go library package
• Subprocess integration
• OpenAI-compatible chat integration
• Architecture policy

Examples

• Minimal configuration and complete configuration
• Prompt definitions, execution profiles, schemas, and synthetic input fixtures
• Render script
• HTTP request
• Go library example