Polish CLI help consistency for commands, defaults, and stdin usage#1314
Draft
Polish CLI help consistency for commands, defaults, and stdin usage#1314
Conversation
Open
Agent-Logs-Url: https://github.com/SkBlaz/py3plex/sessions/f6448088-e166-4f00-a3f9-8e12be7dadee Co-authored-by: SkBlaz <10035780+SkBlaz@users.noreply.github.com>
Agent-Logs-Url: https://github.com/SkBlaz/py3plex/sessions/f6448088-e166-4f00-a3f9-8e12be7dadee Co-authored-by: SkBlaz <10035780+SkBlaz@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Evaluate CLI for usability and recommend improvements
Polish CLI help consistency for commands, defaults, and stdin usage
Mar 28, 2026
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.
This PR addresses CLI usability/consistency gaps in command help text, defaults wording, and examples/guidance. The goal is to make the CLI easier to scan and less ambiguous without changing command behavior.
Help text normalization
--type:er,ba,ws--algorithm:label_propStdin guidance consistency across commands
Input network file (use '-' for stdin)loadandquery) so piping expectations are clear.Top-level command discoverability
commandssectionCOMMAND)py3plex COMMAND --help)Parser clarity
--input-formatdestination explicit (dest="input_format") where used, aligning CLI definition with internal argument access.Focused ergonomics test updates
Example of the standardized help style now used:
🔒 GitHub Advanced Security automatically protects Copilot coding agent pull requests. You can protect all pull requests by enabling Advanced Security for your repositories. Learn more about Advanced Security.