feat: overview CLI for v2 summary - #35
Merged
Merged
Conversation
There was a problem hiding this comment.
🟢 Approval recommended
The new CLI command is fully wired, covered by a targeted unit test, and the documentation updates align with the implemented behavior.
Pull request overview
This PR adds a new overview CLI command that outputs a v2 research overview report (JSON or short text), and documents/tests the new entrypoint so users can quickly inspect v2 status from the command line.
Changes:
- Add
goratio overviewsubcommand wiring insrc/goratio/cli.py, backed bygenerate_v2_overview(...). - Add a unit test covering JSON output shape and key fields for the new command.
- Update README/CHANGELOG/ROADMAP to reflect the new CLI capability.
File summaries
| File | Description |
|---|---|
| tests/test_cli.py | Adds a unit test that runs overview and validates the JSON payload contains expected v2 protocol and overview status fields. |
| src/goratio/cli.py | Registers the new overview command and implements JSON/text rendering for its output. |
| README.md | Documents the new goratio overview command usage. |
| CHANGELOG.md | Notes the addition of the overview CLI. |
| .planning/ROADMAP.md | Marks the roadmap item as completed and updates the stated test count. |
Review details
- Files reviewed: 5/5 changed files
- Comments generated: 0
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
新增 overview 命令，输出 v2 研究总览。