# 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 Set `OPENROUTER_API_KEY` in your environment, then run the maintained [minimal example](examples/dnd-minimal/config.yml) with its synthetic transcript: ~~~ go run ./cmd/notarius run dnd-session \ --config examples/dnd-minimal/config.yml \ --input-file examples/dnd-minimal/transcript.json ~~~ This makes model calls and publishes domain JSON artifacts. Command syntax and exit behavior are documented in the [CLI reference](docs/cli.md); configuration, credentials, and module selection are owned by the [configuration reference](docs/config.md). For the complete ordered D&D workflow, use [the complete configuration](examples/dnd-complete/config.yml) with [its synthetic transcript](examples/dnd-complete/transcript.json). It demonstrates all implemented D&D lanes, ordered generated references, native resource customization, and optional source auxiliaries. See the [complete workflow](docs/consumers/dnd-pipeline.md) for invocation and discovery. ## Install A Source Release Source builds require Go at or above the consumer minimum declared in [`go.mod`](go.mod). Go 1.27.0 is required by the selected ConfigKit dependency. Install a pinned source release with Go: ~~~ GOWORK=off go install \ gitea.maximumdirect.net/eric/notarius/cmd/notarius@ ~~~ Replace `` with a stable release tag such as `vMAJOR.MINOR.PATCH`. The installed command's diagnostic version is described in the [CLI reference](docs/cli.md); maintainers preparing a release should follow [Source Releases](docs/release.md). ## Documentation - [CLI reference](docs/cli.md) — commands, flags, output streams, and exits. - [Configuration reference](docs/config.md) — configuration files, profiles, validation, and module selection. - [Operations](docs/operations.md) — output, state, recovery, and debug handling. - [Integration contracts](docs/integrations/) — Seriatim input, domain artifacts, and native [ConfigKit](docs/integrations/pkg-configkit.md), [PromptKit](docs/integrations/pkg-promptkit.md), and [CommandKit](docs/integrations/pkg-commandkit.md) boundaries. - [Subprocess consumer guide](docs/consumers/subprocess.md) — invoke Notarius from an orchestrator and consume a published result. - [Complete D&D consumer guide](docs/consumers/dnd-pipeline.md) — run the full D&D pipeline as a subprocess and discover its structured artifacts. - [Internal overview](docs/internal/overview.md) — implemented component map for maintainers. - [Developer guide](docs/development.md) — contributor orientation and validation guidance. - [Native migration guide](docs/consumers/native-migration.md) — move existing configurations, invocations, and consumers to the native surface. - [Future work](docs/roadmap/future.md) — separate backlog of ideas and priorities. Notarius is licensed under the [GPL v3.0 or later](COPYRIGHT). [Open Source attribution notices](docs/oss/attribution.md) are available.