[cli-consistency] Fix CLI/docs inconsistencies from 2026-05-06 consistency report#1174
Merged
Merged
Conversation
…target help, add experimental labels Agent-Logs-Url: https://github.com/microsoft/apm/sessions/448beb91-8a53-49c9-b138-dbe506134e86 Co-authored-by: sergio-sisternes-epam <207026618+sergio-sisternes-epam@users.noreply.github.com>
…p text Agent-Logs-Url: https://github.com/microsoft/apm/sessions/448beb91-8a53-49c9-b138-dbe506134e86 Co-authored-by: sergio-sisternes-epam <207026618+sergio-sisternes-epam@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Fix missing windsurf value in deps update command
[cli-consistency] Fix CLI/docs inconsistencies from 2026-05-06 consistency report
May 6, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
This PR addresses CLI help-text consistency gaps identified in the 2026-05-06 CLI Consistency Report by updating Click help strings to reflect the current set of supported targets/runtimes and experimental labeling.
Changes:
- Mark
apm runtimeandapm runhelp text as experimental to align with existing documentation. - Update
apm install --runtimehelp text to includewindsurfin the supported runtime list. - Update
--targethelp text forapm installandapm deps updateto mentioncopilot-coworkwhen the experimental flag is enabled.
Show a summary per file
| File | Description |
|---|---|
| src/apm_cli/commands/runtime.py | Updates the apm runtime group help label to include (experimental). |
| src/apm_cli/commands/run.py | Updates the apm run command help label to include (experimental). |
| src/apm_cli/commands/install.py | Updates --runtime help to include windsurf; updates --target help to mention copilot-cowork behind an experimental flag. |
| src/apm_cli/commands/deps/cli.py | Updates apm deps update --target help to include windsurf and mention copilot-cowork behind an experimental flag. |
Copilot's findings
Comments suppressed due to low confidence (1)
src/apm_cli/commands/install.py:843
- The help text introduces
copilot-coworkbut does not mention the enforced constraint that it is user-scope only (the install pipeline errors if--target copilot-coworkis used without--global). Please add that--globalrequirement to thecopilot-coworknote so the CLI help matches actual behavior.
"-t",
"target",
type=TargetParamType(),
default=None,
help="Target harness(es) to deploy to. Comma-separated for multiple: --target claude,cursor. Highest-priority entry in the resolution chain (--target > apm.yml targets: > auto-detect). Values: copilot, claude, cursor, opencode, codex, gemini, windsurf, agent-skills, all. 'agent-skills' deploys to .agents/skills/ (cross-client). 'all' = copilot+claude+cursor+opencode+codex+gemini+windsurf (excludes agent-skills); combine with 'agent-skills' for both. 'copilot-cowork' is also accepted when the copilot-cowork experimental flag is enabled (run 'apm experimental enable copilot-cowork'). Note: '--target all' on 'apm compile' is deprecated; use 'apm compile --all' instead.",
- Files reviewed: 4/4 changed files
- Comments generated: 2
Comment on lines
799
to
803
| @click.option( | ||
| "--runtime", | ||
| help=( | ||
| "Target specific runtime only (copilot, codex, vscode, cursor, opencode, gemini, claude)" | ||
| "Target specific runtime only (copilot, codex, vscode, cursor, opencode, gemini, claude, windsurf)" | ||
| ), |
| type=TargetParamType(), | ||
| default=None, | ||
| help="Target platform (comma-separated). Values: copilot, claude, cursor, opencode, codex, gemini, agent-skills, all. 'agent-skills' deploys to .agents/skills/ (cross-client). 'all' = copilot+claude+cursor+opencode+codex+gemini (excludes agent-skills); combine with 'agent-skills' for both.", | ||
| help="Target platform (comma-separated). Values: copilot, claude, cursor, opencode, codex, gemini, windsurf, agent-skills, all. 'agent-skills' deploys to .agents/skills/ (cross-client). 'all' = copilot+claude+cursor+opencode+codex+gemini+windsurf (excludes agent-skills); combine with 'agent-skills' for both. 'copilot-cowork' is also accepted when the copilot-cowork experimental flag is enabled (run 'apm experimental enable copilot-cowork').", |
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.
Five CLI help text inconsistencies from the 2026-05-06 CLI Consistency Report —
windsurfmissing from two--target/--runtimeflags, undocumentedcopilot-coworktarget, and two commands missing their(experimental)label.Changes
Medium severity
apm deps update --target: addedwindsurfandcopilot-cowork (experimental)to help text — now matchesapm install --targetapm install --runtime: addedwindsurfto the valid runtimes list(copilot, codex, vscode, cursor, opencode, gemini, claude, windsurf)apm install --target: added a note thatcopilot-coworkis accepted when the experimental flag is enabled (apm experimental enable copilot-cowork)Low severity
apm run: help text updated to"Run a script with parameters (experimental)"— aligns with docsapm runtime: group help text updated to"Manage AI runtimes (experimental)"— aligns with docsType of change
Testing