Add user documentation for Notarius CLI and config

This commit is contained in:
2026-07-04 03:01:38 +00:00
parent 5fab9936d0
commit 4dd00347e0
3 changed files with 367 additions and 1 deletions

View File

@@ -1,2 +1,29 @@
# go-application-template
# Notarius
Notarius is a Go CLI for extracting structured artifacts from source material
with explicit, configurable pipeline modules.
The current implementation reads Seriatim minimal transcript JSON, chunks the
source units, extracts D&D spell-cast artifacts with an OpenAI-compatible LLM,
and writes JSON output plus diagnostics for each run.
```sh
NOTARIUS_LLM_DEFAULT_BASE_URL=http://127.0.0.1:8080/v1 \
NOTARIUS_LLM_DEFAULT_MODEL=your-model \
go run ./cmd/notarius run dnd-session \
--config examples/dnd-spells.config.yml \
--input examples/seriatim-minimal-transcript.json
```
If the provider requires authentication, set
`NOTARIUS_LLM_DEFAULT_API_KEY` in the environment before running the command.
Outputs are written under `./notarius-output/<run-id>/` unless `--output-dir`
is provided.
Useful references:
- [CLI reference](docs/cli.md)
- [Configuration reference](docs/config.md)
- [Seriatim input contract](docs/integrations/seriatim.md)
- [Maintained example config](examples/dnd-spells.config.yml)
- [Maintained example input](examples/seriatim-minimal-transcript.json)