2026-05-04 18:55:18 +00:00
|
|
|
# scriptorium
|
|
|
|
|
|
2026-07-05 03:02:11 +00:00
|
|
|
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.
|
2026-05-04 20:36:12 -05:00
|
|
|
|
2026-07-05 03:02:11 +00:00
|
|
|
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.
|
2026-05-04 21:08:40 -05:00
|
|
|
|
2026-05-26 03:21:11 +00:00
|
|
|
## Quickstart
|
2026-05-04 21:08:40 -05:00
|
|
|
|
2026-05-26 03:21:11 +00:00
|
|
|
From the repository root:
|
2026-05-04 21:23:48 -05:00
|
|
|
|
2026-05-06 16:50:11 +00:00
|
|
|
```bash
|
2026-05-26 03:21:11 +00:00
|
|
|
go run ./cmd/scriptorium render \
|
2026-05-06 16:50:11 +00:00
|
|
|
--config ./examples/config.yml \
|
|
|
|
|
--prompt generic.markdown_summary \
|
2026-05-06 15:59:22 +00:00
|
|
|
--input transcript=./examples/fixtures/transcript.md \
|
2026-05-26 03:21:11 +00:00
|
|
|
--input glossary=./examples/fixtures/glossary.yml \
|
2026-05-06 15:59:22 +00:00
|
|
|
--format json
|
|
|
|
|
```
|
|
|
|
|
|
2026-05-26 03:21:11 +00:00
|
|
|
This command renders the prepared prompt and effective runtime settings without calling an LLM.
|
2026-05-05 08:45:10 -05:00
|
|
|
|
2026-05-26 03:21:11 +00:00
|
|
|
## Documentation
|
2026-05-05 08:45:10 -05:00
|
|
|
|
2026-05-26 03:21:11 +00:00
|
|
|
- [CLI reference](docs/cli.md)
|
|
|
|
|
- [Configuration reference](docs/config.md)
|
2026-07-05 03:02:11 +00:00
|
|
|
- [HTTP API reference](docs/api.md)
|
2026-05-26 03:25:34 +00:00
|
|
|
- [Operations guide](docs/operations.md)
|
2026-07-05 03:02:11 +00:00
|
|
|
- [Consumer integration overview](docs/consumers/api.md)
|
2026-07-04 14:24:06 +00:00
|
|
|
- [Go library package](docs/consumers/pkg-scriptorium.md)
|
2026-07-05 02:56:57 +00:00
|
|
|
- [Subprocess integration](docs/integrations/subprocess.md)
|
2026-07-05 03:02:11 +00:00
|
|
|
- [OpenAI-compatible chat integration](docs/integrations/openai-compatible-chat.md)
|
2026-05-26 03:21:11 +00:00
|
|
|
- [Architecture policy](docs/policy/architecture.md)
|
2026-05-26 03:33:25 +00:00
|
|
|
|
|
|
|
|
## Examples
|
|
|
|
|
|
2026-07-05 03:02:11 +00:00
|
|
|
- `examples/config.yml`
|
|
|
|
|
- `examples/config.full.yml`
|
2026-05-26 03:33:25 +00:00
|
|
|
- `examples/render-markdown-summary.sh`
|
|
|
|
|
- `examples/http-run.json`
|
2026-07-04 14:24:06 +00:00
|
|
|
- `examples/go-library/prepare`
|
