46 lines
1.8 KiB
Markdown
46 lines
1.8 KiB
Markdown
# 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:
|
|
|
|
```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.
|
|
For complete invocation and output behavior, see the [CLI reference](docs/cli.md).
|
|
|
|
## Documentation
|
|
|
|
- [CLI reference](docs/cli.md)
|
|
- [Configuration reference](docs/config.md)
|
|
- [HTTP API reference](docs/api.md)
|
|
- [Operations guide](docs/operations.md)
|
|
- [Consumer integration overview](docs/consumers/api.md)
|
|
- [Go library package](docs/consumers/pkg-scriptorium.md)
|
|
- [Subprocess integration](docs/integrations/subprocess.md)
|
|
- [OpenAI-compatible chat integration](docs/integrations/openai-compatible-chat.md)
|
|
- [Architecture policy](docs/policy/architecture.md)
|
|
|
|
## Examples
|
|
|
|
- [Minimal configuration](examples/config.yml) and [complete configuration](examples/config.full.yml)
|
|
- [Prompt definitions](examples/prompts/), [execution profiles](examples/profiles/), [schemas](examples/schemas/), and [synthetic input fixtures](examples/fixtures/)
|
|
- [Render script](examples/render-markdown-summary.sh)
|
|
- [HTTP request](examples/http-run.json)
|
|
- [Go library example](examples/go-library/prepare/main.go)
|