Eric Rakestraw
2f42bdde39
All checks were successful
ci/woodpecker/tag/release Pipeline was successful
52 lines
2.0 KiB
Markdown
52 lines
2.0 KiB
Markdown
# Scriptorium
|
|
|
|
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.
|
|
|
|
The application uses
|
|
[Promptkit v0.1.0](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.1.0/)
|
|
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.
|
|
|
|
## 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 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).
|
|
|
|
## 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)
|
|
- [Migration from the former Go package](docs/consumers/migrating-to-promptkit.md)
|
|
- [Subprocess integration](docs/integrations/subprocess.md)
|
|
- [Architecture policy](docs/policy/architecture.md)
|
|
- [Promptkit framework formats](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.1.0/docs/formats.md)
|
|
- [Promptkit Go consumer guide](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.1.0/docs/consumers/pkg-promptkit.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)
|