37 lines
1.5 KiB
Markdown
37 lines
1.5 KiB
Markdown
# Notarius
|
|
|
|
Notarius is a Go CLI for extracting structured artifacts from source material
|
|
with explicit, configurable pipeline modules.
|
|
|
|
The current implementation reads Seriatim 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)
|
|
- [Operations](docs/operations.md)
|
|
- [Troubleshooting](docs/troubleshooting.md)
|
|
- [Seriatim input contract](docs/integrations/seriatim.md)
|
|
- [OpenAI-compatible provider contract](docs/integrations/openai-compatible.md)
|
|
- [JSON output contract](docs/integrations/json-output.md)
|
|
- [D&D spell artifact contract](docs/integrations/dnd-spell-artifacts.md)
|
|
- [Developer workflow](docs/policy/development.md)
|
|
- [Internal architecture docs](docs/internal/overview.md)
|
|
- [Maintained example config](examples/dnd-spells.config.yml)
|
|
- [Maintained example input](examples/seriatim-minimal-transcript.json)
|