Home

AncestryLLM documentation

AncestryLLM is a local-first command-line tool for genealogy research. It combines deterministic RootsMagic and GEDCOM workflows with optional, explicitly selected LLM providers.

The canonical source is this docs/ directory. It is published to the AncestryLLM documentation site and the GitHub Wiki; the Wiki remains available, but neither published view is an independent documentation source.

Start with the CLI reference for one-shot commands or the interactive console guide. In 0.4.0 these are the only implemented product surfaces: both use the same command specification, transport-neutral executor, application DTOs, and genealogy services. The 0.5.0 scope adds a bounded, offline Electron shell with Home, Diagnostics, a sanitized capability summary, and local visual Settings only. It uses a private control-only sidecar and has no genealogy, files, jobs, chat, providers, cloud accounts, or updater surface. The desktop shell guide defines its supported targets, manual signed-installer model, unsigned-artifact distinction, and sanitized recovery contract. The desktop verification guide defines the exact-head hosted matrix, machine-readable evidence, and external release blockers. Later domain adapters must reuse the existing service surface rather than define another command or domain layer. The pages below cover versioning, privacy controls, providers, GEDCOM interoperability, backups, release operations, and security practices.

All user-selected files are governed by the shared bounded file-ingress policy, including byte and record budgets, race detection, output alias rejection, and transactional publication.

Documentation links

Documentation links use relative Markdown filenames (for example, [Console guide](CONSOLE.md)). This keeps links valid from this docs/ directory in the repository. The Pages build rewrites local links only in its generated staging directory, from .md targets to site paths. Wiki synchronization rewrites the same local targets to extensionless Wiki page links. The canonical source remains unchanged.

Use the sidebar to navigate the complete published documentation set.

The bounded 0.5.0 shell and accepted later-roadmap desktop direction, process boundaries, target MVP scope, and secure development gates are defined in the Electron and FastAPI desktop ADR. Its OWASP Top 10:2025 and NIST SP 800-218 control evidence is maintained in the threat model, and the implemented control lifecycle is in Packaged desktop sidecar.

Maintainers can reproduce the deterministic publishing step locally with the wiki synchronization guide. The Wiki operations and recovery runbook covers dispatch, verification, troubleshooting, rollback, and reinitialization.