-
Notifications
You must be signed in to change notification settings - Fork 0
MODULE_AUTHORING
A built-in module is registered through the explicit module registry with a
ModuleDescriptor and transport-neutral CommandSpec. The descriptor records
the module identity, summary, implementation path, and supported action names.
The command specification records action metadata and typed arguments used by
both one-shot CLI execution and the prompt-toolkit/Rich REPL.
Module authors should add or update the command specification first, then wire
the action to a thin dispatcher that delegates to an application service. The
dispatch layer must not open storage directly, read secrets, call providers, or
implement business rules. Services return serializable DTOs, progress events,
or stable AncestryError instances so terminal, JSON, and future adapters can
present the same result contract.
Interactive behavior is derived from the shared metadata:
- one-shot
ancestry MODULE ACTION ...parsing and validation; - root-level direct module commands in the REPL;
- active-module
run ACTION ...routing; - help text, action listings, and option validation; and
- privacy-filtered completion.
Do not author terminal-specific command classes for new modules. A module should not depend on prompt-toolkit, Rich, or any console input framework. Rich rendering belongs in presentation adapters only, and JSON output must remain a serialization of the same service result.
The user-facing command inventory belongs in the CLI reference, rather than module-specific documentation. Modules are built-in only in v1. Add tests proving disabled modules are not imported, commands are unavailable, service DTOs serialize, secrets stay out of history, and offline defaults make no network calls.
- Home
- CLI reference
- Interactive console guide
- Architecture ownership and dependency contracts
- Bounded file ingress
- Versioning and compatibility
- Continuous integration
- Release runbook
- Encrypted backup and recovery
- First-run storage diagnostics
- GEDCOM compatibility and release checks
- Built-in module authoring
- Privacy and consent
- Provider guide
- Local LLM benchmarks
- Local-first retrieval evaluation
- Wiki synchronization
- Wiki operations and recovery
- Security response checklist
- Electron and FastAPI desktop ADR
- Data-flow threat model and control matrix