Document completed console migration: prompt-toolkit/Rich REPL as sole interactive console - #80
Conversation
Update docs to describe the prompt-toolkit/Rich REPL as the only interactive console.\n\n- Remove legacy console fallback and future cmd2-removal language from console architecture docs.\n- Document descriptor/spec-based command registration and module authoring.\n- Add privacy and threat-model notes for the consolidated REPL.
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 714996ef52
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| CLI grammar. | ||
| Running `ancestry` with no arguments starts the supported interactive console. | ||
| The console is the asynchronous prompt-toolkit/Rich REPL installed by the main | ||
| package. It is the only interactive console surface; one-shot usage is |
There was a problem hiding this comment.
Restore the legacy-console compatibility note
In environments where operators still need the cmd2 fallback, this statement is inaccurate: src/ancestryllm/cli.py:349-352 still special-cases ancestry --legacy-console and launches AncestryConsole, and the regression test test_main_uses_default_shell_legacy_console_and_preserves_one_shot_dispatch still asserts that path works. Removing the documented compatibility path makes the console guide and migration status misleading until the reachable flag and shipped cmd2 console are actually removed.
Useful? React with 👍 / 👎.
Motivation
cmd2fallback, the--legacy-consoleswitch, and cmd2-specific authoring patterns so docs match the current implementation.ModuleDescriptor/CommandSpecand thin service dispatchers rather than terminal-specific classes.Description
README.md)ModuleDescriptor/CommandSpecdriven commands. (editeddocs/CONSOLE.md)--legacy-consolecompatibility paths, add a command registration model section, and clarify allowed dependencies and future work scope. (editeddocs/REPL_ARCHITECTURE.md)docs/MODULE_AUTHORING.md)docs/PRIVACY_AND_CONSENT.md,docs/THREAT_MODEL.md)Testing
make lintwhich failed in this environment because.venv/bin/ruffis missing (environment-local tooling not present), so lint checks could not complete here.cmd2,--legacy-console,CommandSet, and other legacy/fallback phrases were removed or updated by running the repository search command used during the update, which returned no residual matches for those legacy terms in the edited docs.Codex Task