docs: fix CLI reference drift from consistency reports #140 and #152#160
Merged
danielmeppiel merged 4 commits intomainfrom Mar 4, 2026
Merged
docs: fix CLI reference drift from consistency reports #140 and #152#160danielmeppiel merged 4 commits intomainfrom
danielmeppiel merged 4 commits intomainfrom
Conversation
Fixes all doc-vs-CLI inconsistencies found by the automated CLI Consistency Checker: - Remove phantom --verbose flag from apm uninstall docs - Add apm prune section (undocumented command) - Add apm mcp list section (undocumented command) - Add 4 missing apm compile flags (--single-agents, -v/--verbose, --local-only, --clean) - Fix apm compile --target to show [vscode|agents|claude|all] - Add copilot to supported runtimes list - Fix apm runtime setup arg description (remove -> install) - Add --version TEXT option to apm runtime setup - Add --yes option to apm runtime remove - Remove duplicate apm runtime status section - Fix apm search/show -> apm mcp search/show in Quick Start - Fix apm search -> apm mcp search in Tips section - Remove internal dev note from apm deps update Fixes #152 Supersedes #140
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the CLI reference documentation to resolve drift reported by the automated CLI Consistency Checker (issues #140 and #152), bringing docs/cli-reference.md back in sync with the current APM CLI surface.
Changes:
- Removes the nonexistent
--verboseflag fromapm uninstalldocs and fixesapm mcp search/showreferences in the Quick Start + Tips sections. - Adds missing documentation for
apm prune,apm mcp list, and severalapm compileflags/--targetchoices. - Updates runtime docs to include the
copilotruntime and correctsapm runtime setup/removeargument/options content (including de-duplicatingruntime status).
Comments suppressed due to low confidence (2)
docs/cli-reference.md:506
apm mcp list’s--limitoption has a default of 20 in the CLI (@click.option("--limit", default=20, ...)), but the docs don’t mention the default (whereasapm mcp searchdoes). To keep the CLI reference accurate, add “(default: 20)” to the--limitdescription.
**Options:**
- `--limit INTEGER` - Number of results to show
docs/cli-reference.md:899
- The
copilotruntime description here doesn’t match the CLI/runtime manager description (“GitHub Copilot CLI with native MCP integration”). Aligning the wording will reduce confusion about what exactly gets installed/managed when users choosecopilot.
**Supported Runtimes:**
- **`copilot`** - GitHub Copilot coding agent
- **`codex`** - OpenAI Codex CLI with GitHub Models support
- **`llm`** - Simon Willison's LLM library with multiple providers
Collaborator
Author
|
@copilot address all the pull request review comments appropriately |
Contributor
|
@danielmeppiel I've opened a new pull request, #161, to work on those changes. Once the pull request is ready, I'll request review from you. |
7 tasks
Co-authored-by: danielmeppiel <51440732+danielmeppiel@users.noreply.github.com>
sergio-sisternes-epam
approved these changes
Mar 4, 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.
Description
Fixes all doc-vs-CLI inconsistencies found by the automated CLI Consistency Checker in #140 and #152.
Changes
--verbosefromapm uninstallapm prunesectionapm mcp listsectionapm compileflags (--single-agents,-v/--verbose,--local-only,--clean)apm compile --targetto show[vscode|agents|claude|all]copilotto supported runtimesapm runtime setupargument description ("remove" → "install")--version TEXTtoapm runtime setup--yestoapm runtime removeapm runtime statussectionapm search/apm show→apm mcp search/apm mcp showin Quick Startapm search→apm mcp searchin Tips sectionapm deps updateType of change
Fixes #152
Supersedes #140