37 lines
1.1 KiB
Markdown
37 lines
1.1 KiB
Markdown
# 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)
|
|
- [HTTP API integration](docs/integrations/http-api.md)
|
|
- [OpenAI-compatible chat integration](docs/integrations/openai-compatible-chat.md)
|
|
- [Narratio subprocess integration](docs/integrations/narratio.md)
|
|
- [Architecture policy](docs/policy/architecture.md)
|
|
|
|
## Examples
|
|
|
|
- `examples/render-markdown-summary.sh`
|
|
- `examples/http-run.json`
|