2026-07-04 03:01:38 +00:00
|
|
|
# Notarius
|
2026-07-03 04:42:08 +00:00
|
|
|
|
2026-07-26 13:11:40 +00:00
|
|
|
Notarius is a Go CLI for turning source material into structured artifacts with
|
|
|
|
|
configured extraction pipelines. The implemented D&D workflow reads Seriatim
|
2026-08-05 20:12:16 +00:00
|
|
|
transcript JSON and can produce NPC, location, and item registries; their
|
|
|
|
|
source-grounded occurrences; scene descriptions, combat turns, enemy events,
|
|
|
|
|
and spell casts.
|
2026-07-26 13:11:40 +00:00
|
|
|
|
|
|
|
|
## Quickstart
|
|
|
|
|
|
2026-11-22 06:57:27 +00:00
|
|
|
Set `OPENROUTER_API_KEY` in your environment, then run the maintained
|
|
|
|
|
[minimal example](examples/dnd-minimal/config.yml) with its synthetic transcript:
|
2026-07-26 13:11:40 +00:00
|
|
|
|
|
|
|
|
~~~
|
2026-11-22 06:57:27 +00:00
|
|
|
go run ./cmd/notarius run dnd-session \
|
|
|
|
|
--config examples/dnd-minimal/config.yml \
|
|
|
|
|
--input-file examples/dnd-minimal/transcript.json
|
2026-07-26 13:11:40 +00:00
|
|
|
~~~
|
|
|
|
|
|
2026-11-22 06:57:27 +00:00
|
|
|
This makes model calls and publishes domain JSON artifacts. Command syntax and exit
|
2026-07-26 13:11:40 +00:00
|
|
|
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
|
2026-11-22 06:57:27 +00:00
|
|
|
[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.
|
2026-07-26 13:11:40 +00:00
|
|
|
|
2026-08-25 02:03:11 +00:00
|
|
|
## Install A Source Release
|
|
|
|
|
|
2026-11-17 20:09:48 +00:00
|
|
|
Source builds require Go at or above the consumer minimum declared in
|
2026-11-17 20:56:06 +00:00
|
|
|
[`go.mod`](go.mod). Go 1.27.0 is required by the selected ConfigKit
|
2026-11-17 20:09:48 +00:00
|
|
|
dependency.
|
|
|
|
|
|
2026-08-25 02:03:11 +00:00
|
|
|
Install a pinned source release with Go:
|
|
|
|
|
|
|
|
|
|
~~~
|
|
|
|
|
GOWORK=off go install \
|
|
|
|
|
gitea.maximumdirect.net/eric/notarius/cmd/notarius@<tag>
|
|
|
|
|
~~~
|
|
|
|
|
|
|
|
|
|
Replace `<tag>` 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).
|
|
|
|
|
|
2026-07-26 13:11:40 +00:00
|
|
|
## 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.
|
2026-11-22 06:57:27 +00:00
|
|
|
- [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.
|
2026-07-26 17:22:27 +00:00
|
|
|
- [Subprocess consumer guide](docs/consumers/subprocess.md) — invoke Notarius
|
|
|
|
|
from an orchestrator and consume a published result.
|
2026-08-09 20:57:28 +00:00
|
|
|
- [Complete D&D consumer guide](docs/consumers/dnd-pipeline.md) — run the full
|
|
|
|
|
D&D pipeline as a subprocess and discover its structured artifacts.
|
2026-07-26 13:11:40 +00:00
|
|
|
- [Internal overview](docs/internal/overview.md) — implemented component map
|
|
|
|
|
for maintainers.
|
|
|
|
|
- [Developer guide](docs/development.md) — contributor orientation and
|
|
|
|
|
validation guidance.
|
2026-11-22 06:57:27 +00:00
|
|
|
- [Native migration guide](docs/consumers/native-migration.md) — move existing
|
|
|
|
|
configurations, invocations, and consumers to the native surface.
|
2026-11-20 13:06:52 +00:00
|
|
|
- [Future work](docs/roadmap/future.md) — separate backlog of ideas and priorities.
|
2026-09-28 01:43:24 +00:00
|
|
|
|
|
|
|
|
Notarius is licensed under the [GPL v3.0 or later](COPYRIGHT).
|
|
|
|
|
|
|
|
|
|
[Open Source attribution notices](docs/oss/attribution.md) are available.
|