fix: CLI consistency — short aliases, default displays, help text#392
Open
fix: CLI consistency — short aliases, default displays, help text#392
Conversation
… text Co-authored-by: danielmeppiel <51440732+danielmeppiel@users.noreply.github.com> Agent-Logs-Url: https://github.com/microsoft/apm/sessions/78aadfdd-539f-425c-906b-27636a5ed359
Co-authored-by: danielmeppiel <51440732+danielmeppiel@users.noreply.github.com> Agent-Logs-Url: https://github.com/microsoft/apm/sessions/78aadfdd-539f-425c-906b-27636a5ed359
Copilot
AI
changed the title
[WIP] Fix missing '-v' short alias for --verbose in apm install
fix: CLI consistency — short aliases, default displays, help text
Mar 20, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
This PR improves APM CLI UX consistency by adding common short aliases, ensuring defaults are displayed in help output, and tightening several help strings. It also updates the CLI reference docs to match the new/clarified CLI surface.
Changes:
- Added short aliases for frequently used flags:
apm install --verbosenow supports-v, andapm runtime remove --yesnow supports-y. - Enabled default-value display in help for
apm mcp list --limitandapm pack --format. - Clarified help text for
apm audit,apm config get, andapm compile -o, with matching documentation updates.
Reviewed changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| src/apm_cli/commands/runtime.py | Adds -y alias to the runtime removal confirmation option. |
| src/apm_cli/commands/install.py | Adds -v alias for verbose install output. |
| src/apm_cli/commands/mcp.py | Shows the default value for --limit in mcp list help. |
| src/apm_cli/commands/pack.py | Shows the default value for --format in pack help. |
| src/apm_cli/commands/config.py | Clarifies config get help to reflect optional key behavior. |
| src/apm_cli/commands/compile/cli.py | Updates -o/--output help to reflect legacy --single-agents usage. |
| src/apm_cli/commands/audit.py | Clarifies audit help to reflect --file support. |
| docs/src/content/docs/reference/cli-commands.md | Updates the CLI reference to reflect new aliases, defaults, and clarified help text. |
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.
Description
Resolves 7 findings from the automated CLI Consistency Report (4 medium, 3 low).
Short aliases (muscle-memory consistency):
apm install --verbose→ added-v(matchescompile,audit)apm runtime remove --yes→ added-y(matchesinit)Default value display:
apm mcp list --limit→ now shows[default: 20](matchesmcp search)apm pack --format→ now shows[default: apm](matches--target,--output)Help text clarity:
apm audit→ "Scan installed packages (or any file) for hidden Unicode characters"apm config get→ "Get one or all configuration values"apm compile -o→ "Output file path (use with --single-agents legacy mode)"Docs (
cli-commands.md) andCHANGELOG.mdupdated to match.Type of change
Testing
📱 Kick off Copilot coding agent tasks wherever you are with GitHub Mobile, available on iOS and Android.