2026-07-28 14:21:19 +00:00
# Scriptorium
2026-05-04 18:55:18 +00:00
2026-07-28 14:21:19 +00:00
Scriptorium is a prompt-execution application with a command-line interface and
an HTTP service. It prepares prompt requests, runs them against
OpenAI-compatible model endpoints, and returns generated output with validation
metadata.
2026-05-04 20:36:12 -05:00
2026-07-28 14:21:19 +00:00
The application uses
2026-11-18 19:25:54 +00:00
[PromptKit v0.23.2 ](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/382ccfb14b9630fd8f48c8364dbe2b6159637d71/ )
2026-07-28 14:21:19 +00:00
for prompt, profile, schema, preparation, generation, and validation behavior.
Scriptorium owns executable configuration, CLI and HTTP mapping, process
behavior, output presentation, and HTTP artifact-containment policy.
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-07-28 14:21:19 +00:00
This renders the prepared prompt and effective runtime settings without calling
a model. For complete invocation and output behavior, see the
[CLI reference ](docs/cli.md ).
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-09-26 18:15:28 +00:00
- [Application configuration inspection ](docs/cli.md#application-configuration-inspection )
2026-10-04 13:04:02 +00:00
- [Framework configuration inspection ](docs/cli.md#framework-configuration-inspection )
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-28 19:43:57 +00:00
- [Migration from the former Go package ](docs/consumers/migrating-to-promptkit.md )
2026-10-04 13:04:02 +00:00
- [Upgrade Promptkit source selectors and definitions ](docs/consumers/upgrading-promptkit.md )
2026-07-05 02:56:57 +00:00
- [Subprocess integration ](docs/integrations/subprocess.md )
2026-05-26 03:21:11 +00:00
- [Architecture policy ](docs/policy/architecture.md )
2026-11-18 19:25:54 +00:00
- [Promptkit framework formats ](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/382ccfb14b9630fd8f48c8364dbe2b6159637d71/docs/formats.md )
- [Promptkit Go consumer guide ](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/382ccfb14b9630fd8f48c8364dbe2b6159637d71/docs/consumers/pkg-promptkit.md )
2026-05-26 03:33:25 +00:00
## Examples
2026-07-28 14:21:19 +00:00
- [Minimal configuration ](examples/config.yml ) and
2026-09-26 18:15:28 +00:00
[complete configuration ](examples/config.full.yml ), plus a
2026-11-17 22:15:10 +00:00
[composed import/overlay example ](examples/config.composed.yml ), a
2026-11-18 19:25:54 +00:00
[collection composition example ](examples/config.collections.yml ), a
[collection checkout discovery example ](examples/config.discovery.yml ), and a
2026-10-03 17:43:58 +00:00
[backend inheritance example ](examples/config.inheritance.yml )
2026-07-28 14:21:19 +00:00
- [Prompt definitions ](examples/prompts/ ), [execution profiles ](examples/profiles/ ),
[schemas ](examples/schemas/ ), and [synthetic input fixtures ](examples/fixtures/ )
2026-07-26 14:25:44 +00:00
- [Render script ](examples/render-markdown-summary.sh )
- [HTTP request ](examples/http-run.json )
2026-09-26 16:36:45 +00:00
2026-09-28 01:39:10 +00:00
Scriptorium is licensed under the [GPL v3.0 or later ](COPYRIGHT ).
2026-09-26 16:36:45 +00:00
[Open Source attribution notices ](docs/oss/attribution.md ) are available.