1.9 KiB
Notarius
Notarius is a Go CLI for turning source material into structured artifacts with configured extraction pipelines. The implemented D&D workflow reads Seriatim transcript JSON and can produce NPC, location, and item registries; their source-grounded occurrences; scene descriptions, combat turns, enemy events, and spell casts.
Quickstart
Provide an OpenRouter API key through the environment, then run the maintained minimal example:
OPENROUTER_API_KEY=your-api-key \
go run ./cmd/notarius run dnd-session \
--config examples/dnd-minimal.config.yml \
--input examples/seriatim-minimal-transcript.json
The command publishes a JSON output bundle. Its command syntax and exit behavior are documented in the CLI reference; configuration, credentials, and module selection are owned by the configuration reference.
For the complete ordered D&D workflow, use the complete configuration with its synthetic transcript. It demonstrates all implemented D&D lanes and the supporting campaign references.
Documentation
- CLI reference — commands, flags, output streams, and exits.
- Configuration reference — configuration files, profiles, validation, and module selection.
- Operations — output, state, recovery, and debug handling.
- Integration contracts — Seriatim input and published artifact formats.
- Subprocess consumer guide — invoke Notarius from an orchestrator and consume a published result.
- Internal overview — implemented component map for maintainers.
- Developer guide — contributor orientation and validation guidance.
- Future work — unimplemented ideas and priorities.