Skip to content

Document completed console migration: prompt-toolkit/Rich REPL as sole interactive console - #80

Merged
sodejm merged 1 commit into
mainfrom
codex/update-documentation-for-cmd2-retirement
Jul 22, 2026
Merged

Document completed console migration: prompt-toolkit/Rich REPL as sole interactive console#80
sodejm merged 1 commit into
mainfrom
codex/update-documentation-for-cmd2-retirement

Conversation

@sodejm

@sodejm sodejm commented Jul 21, 2026

Copy link
Copy Markdown
Owner

Motivation

  • Consolidate interactive console documentation to reflect that the prompt-toolkit/Rich REPL is the supported and only interactive console surface after the cmd2 retirement and migration work.
  • Remove references to the temporary cmd2 fallback, the --legacy-console switch, and cmd2-specific authoring patterns so docs match the current implementation.
  • Clarify the transport-neutral command registration and module-authoring model so authors target ModuleDescriptor/CommandSpec and thin service dispatchers rather than terminal-specific classes.

Description

  • Updated README startup guidance to identify the prompt-toolkit/Rich REPL as the only supported interactive console and adjusted the wording to reflect the consolidation. (edited README.md)
  • Rewrote the console guide to remove legacy/fallback language, document strict REPL parsing and navigation controls, and add a new "Command registration" section describing ModuleDescriptor/CommandSpec driven commands. (edited docs/CONSOLE.md)
  • Updated the REPL architecture doc to state consolidation is complete, remove --legacy-console compatibility paths, add a command registration model section, and clarify allowed dependencies and future work scope. (edited docs/REPL_ARCHITECTURE.md)
  • Replaced cmd2-centric module authoring guidance with the descriptor/spec-based workflow and explicit guidance that modules remain thin and UI-independent. (edited docs/MODULE_AUTHORING.md)
  • Extended privacy/consent and threat-model docs to reference the prompt-toolkit/Rich REPL boundary, privacy-filtered completion, no-echo secret handling, history redaction, and related controls. (edited docs/PRIVACY_AND_CONSENT.md, docs/THREAT_MODEL.md)

Testing

  • Ran make lint which failed in this environment because .venv/bin/ruff is missing (environment-local tooling not present), so lint checks could not complete here.
  • Verified via a targeted search that references to 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

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.

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 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".

Comment thread docs/CONSOLE.md
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

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge 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 👍 / 👎.

@sodejm
sodejm merged commit c22172c into main Jul 22, 2026
5 checks passed
@sodejm
sodejm deleted the codex/update-documentation-for-cmd2-retirement branch July 22, 2026 01:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant