Fix CLI consistency: docs alignment, emoji removal, show_default#266
Merged
danielmeppiel merged 3 commits intomainfrom Mar 12, 2026
Merged
Fix CLI consistency: docs alignment, emoji removal, show_default#266danielmeppiel merged 3 commits intomainfrom
danielmeppiel merged 3 commits intomainfrom
Conversation
- Fix pack --target docs to include copilot option and alias note
- Fix runtime setup/remove synopsis to match CLI ({copilot|codex|llm})
- Fix unpack --output docs to show -o shorthand and PATH type
- Add show_default=True to mcp search --limit option
- Fix --parallel-downloads type from INT to INTEGER in docs
- Remove emoji from apm config table title
- Update pack-distribute guide target tables
Co-authored-by: danielmeppiel <51440732+danielmeppiel@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] [cli-consistency] Fix documentation for apm pack --target options
Fix CLI consistency: docs alignment, emoji removal, show_default
Mar 12, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
Aligns CLI documentation with actual Click-generated help output and enforces the repo’s no-emoji CLI output policy in one config display, improving consistency across docs and CLI UX.
Changes:
- Updated CLI reference docs to match current option metavars/signatures and runtime command usage output.
- Adjusted
apm packtarget docs/guides to includecopilotand notevscodeas an alias. - Minor CLI help/UI tweaks: show default for
apm mcp search --limitand remove an emoji from the config table title.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| src/apm_cli/commands/mcp.py | Adds show_default=True for --limit so help displays the default value. |
| src/apm_cli/commands/config.py | Removes emoji from the Rich table title for config display. |
| docs/src/content/docs/reference/cli-commands.md | Updates CLI reference signatures/usages to better match Click output (targets, metavars, runtime usage). |
| docs/src/content/docs/guides/pack-distribute.md | Updates pack/distribute guide tables to include copilot target and vscode alias note. |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
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
Addresses all 6 findings from the CLI Consistency Report — 2 medium, 4 low severity.
Documentation alignment (
docs/src/content/docs/reference/cli-commands.md):apm pack --target:[vscode|claude|all]→[copilot|vscode|claude|all]+ alias noteapm runtime setup/remove:RUNTIME_NAME [OPTIONS]→[OPTIONS] {copilot|codex|llm}to match Click outputapm unpack --output:--output TEXT→-o, --output PATH--parallel-downloads:INT→INTEGERCode fixes:
src/apm_cli/commands/mcp.py: Addedshow_default=Trueto--limitso[default: 10]appears in help, matching docssrc/apm_cli/commands/config.py: Removed⚙️from config table title per no-emoji policyAlso updated
docs/src/content/docs/guides/pack-distribute.mdtarget tables to includecopilot.Type of change
Testing
📍 Connect Copilot coding agent with Jira, Azure Boards or Linear to delegate work to Copilot in one click without leaving your project management tool.