README.md

# scriptorium

Scriptorium is a config-driven prompt execution engine.

It separates prompt definitions (what to generate) from execution profiles (how to call an OpenAI-compatible model endpoint), then runs or renders a prepared request from named input artifacts.

## Quickstart

From the repository root:

```bash
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.

## Documentation

- [CLI reference](docs/cli.md)
- [Configuration reference](docs/config.md)
- [Operations guide](docs/operations.md)
- [Troubleshooting](docs/troubleshooting.md)
- [Narratio subprocess integration](docs/integrations/narratio.md)
- [Architecture policy](docs/policy/architecture.md)
- [Documentation roadmap](docs/roadmap/documentation.md)
Initial commit 2026-05-04 18:55:18 +00:00			`# scriptorium`

Rewrite README and add canonical CLI/config documentation 2026-05-26 03:21:11 +00:00			`Scriptorium is a config-driven prompt execution engine.`
Bugfixes and improved alignment with architecture blueprint 2026-05-04 20:36:12 -05:00
Rewrite README and add canonical CLI/config documentation 2026-05-26 03:21:11 +00:00			`It separates prompt definitions (what to generate) from execution profiles (how to call an OpenAI-compatible model endpoint), then runs or renders a prepared request from named input artifacts.`
Add a minimal CLI 2026-05-04 21:08:40 -05:00
Rewrite README and add canonical CLI/config documentation 2026-05-26 03:21:11 +00:00			`## Quickstart`
Add a minimal CLI 2026-05-04 21:08:40 -05:00
Rewrite README and add canonical CLI/config documentation 2026-05-26 03:21:11 +00:00			`From the repository root:`
Add example profiles, schemas, and an end-to-end local fixture 2026-05-04 21:23:48 -05:00
Document application config support 2026-05-06 16:50:11 +00:00			```bash
Rewrite README and add canonical CLI/config documentation 2026-05-26 03:21:11 +00:00			`go run ./cmd/scriptorium render \`
Document application config support 2026-05-06 16:50:11 +00:00			`--config ./examples/config.yml \`
			`--prompt generic.markdown_summary \`
Updated documentation and tests to reflect the new render command 2026-05-06 15:59:22 +00:00			`--input transcript=./examples/fixtures/transcript.md \`
Rewrite README and add canonical CLI/config documentation 2026-05-26 03:21:11 +00:00			`--input glossary=./examples/fixtures/glossary.yml \`
Updated documentation and tests to reflect the new render command 2026-05-06 15:59:22 +00:00			`--format json`
			```

Rewrite README and add canonical CLI/config documentation 2026-05-26 03:21:11 +00:00			`This command renders the prepared prompt and effective runtime settings without calling an LLM.`
Updated documentation to reflect current build state 2026-05-05 08:45:10 -05:00
Rewrite README and add canonical CLI/config documentation 2026-05-26 03:21:11 +00:00			`## Documentation`
Updated documentation to reflect current build state 2026-05-05 08:45:10 -05:00
Rewrite README and add canonical CLI/config documentation 2026-05-26 03:21:11 +00:00			`- [CLI reference](docs/cli.md)`
			`- [Configuration reference](docs/config.md)`
Add operations and troubleshooting documentation 2026-05-26 03:25:34 +00:00			`- [Operations guide](docs/operations.md)`
			`- [Troubleshooting](docs/troubleshooting.md)`
Rewrite README and add canonical CLI/config documentation 2026-05-26 03:21:11 +00:00			`- [Narratio subprocess integration](docs/integrations/narratio.md)`
			`- [Architecture policy](docs/policy/architecture.md)`
			`- [Documentation roadmap](docs/roadmap/documentation.md)`