host: improve CLI help text accessibility across all utilities - #1
Draft
chuckleu1976 with Copilot wants to merge 2 commits into
Draft
host: improve CLI help text accessibility across all utilities#1chuckleu1976 with Copilot wants to merge 2 commits into
chuckleu1976 with Copilot wants to merge 2 commits into
Conversation
Add Usage lines, Options headers, and plain-English descriptions to every option in the three host utilities: * simtrace2-sniff: usage line, per-option descriptions with defaults and format hints (e.g. hexadecimal vendor/product IDs). * simtrace2-cardem-pcsc: same, plus required-option callouts and an explanation of the --set-sim-presence polarity values. * simtrace2-tool: same, plus per-command descriptions and an Examples section showing typical invocations. Agent-Logs-Url: https://github.com/chuckleu1976/simtrace2/sessions/43697421-efee-4a41-a0db-6f93f34e5cbb Co-authored-by: chuckleu1976 <124535746+chuckleu1976@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Update user interface for better accessibility
host: improve CLI help text accessibility across all utilities
Apr 1, 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.
The
--helpoutput for all three host utilities was bare option lists with no descriptions,<pr_title>host: improve CLI help text for better accessibility
</pr_title>
<pr_description>
The
--helpoutput across all three host utilities was bare option lists with no descriptions, defaults, or usage context — unhelpful to new users and easy to misuse.Changes
simtrace2-sniff,simtrace2-cardem-pcsc,simtrace2-tool): addedUsage:line andOptions:header; added plain-English description for every optionsimtrace2-sniff/simtrace2-cardem-pcsc: noted hex format and default values for-i/-V/-P; added(required)markers on mandatory vendor/product ID flagssimtrace2-cardem-pcsc: clarified-Z --set-sim-presencepolarity (0=active-low, 1=active-high); added default for-n --pcsc-reader-numsimtrace2-tool: added per-command descriptions; addedExamples:sectionBefore/after for
simtrace2-tool:-k --keep-running Restart automatically when the USB device disconnects
-i --gsmtap-ip A.B.C.D IP address of GSMTAP receiver for Wireshark (default: 127.0.0.1)
simtrace2-tool -V 1d50 -P 4001 modem reset cycle
simtrace2-tool -V 1d50 -P 4001 modem sim-switch remote
simtrace2-tool -V 1d50 -P 4001 modem sim-card insert