Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

[cli-consistency] CLI Consistency Report — 2026-10-07

Closed Beginner friendly
  • Is something wrong?
#3,178 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 2 days

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
1-3 hours
Newbie friendliness
78/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Tech stack
cli, python
Domain
cli, documentation

Research direction

Read docs/src/content/docs/reference/cli/mcp.md and check its forwarded-options table against the apm mcp install --help output described in the issue. Also inspect packages/apm-guide/.apm/skills/apm-usage/commands.md for the same missing option. Done when both applicable docs mention --trust-transitive-mcp.

Written by the indexing model from the issue text.

Description

area/cli type/automation

CLI Consistency Report

Date: 2026-10-07
APM Version: Agent Package Manager (APM) CLI version 0.33.0 (280b8a7)
Commands Inspected: 23 (top-level apm --help plus 22 command/subcommand --help runs from the checklist)

Summary
Severity Count
High 0
Medium 1
Low 0
Medium Severity
apm mcp install docs omit --trust-transitive-mcp
  • Command: apm mcp install --help
  • Problem: The help text lists a forwarded option that docs/src/content/docs/reference/cli/mcp.md does not mention. Its flag table covers --registry and --mcp-version, but not this flag.
  • Evidence: The CLI help includes --trust-transitive-mcp Trust MCP servers from transitive dependencies. grep trust-transitive docs/src/content/docs/reference/cli/mcp.md returns nothing.
  • Suggested Fix: Add a --trust-transitive-mcp row to the forwarded-options table in mcp.md. Also update packages/apm-guide/.apm/skills/apm-usage/commands.md if it is missing there too.
Clean Areas
  • Every flag in the --help output of init, install, uninstall, update, compile, run, deps (list, tree, info, clean, update), mcp (search, show), config (set, get, list) and runtime setup appears in the matching reference page under docs/src/content/docs/reference/cli/. The one exception is the finding above.
  • Invalid-input checks (apm install --nonexistent-flag, apm deps info, apm config set, apm uninstall, apm runtime setup foo) each produced a clean Click usage error with no traceback.
  • Subcommands listed in help (mcp list, config unset, deps why, runtime list/status/remove) are documented.
  • No typos or placeholder text found in the help output.
Notes
  • docs/cli-reference.md does not exist. The CLI docs now live in docs/src/content/docs/reference/cli/*.md, and I compared against those.
  • I did not audit the short-flag and description consistency of -v, --dry-run and -y across every command beyond spot checks. The following differences are noted but not flagged:
    • apm run and apm uninstall have no -y.
    • apm mcp install has no --verbose in its own options and forwards it instead.
  • README command mentions were spot-checked. The apparent failures from my script were regex artifacts of flags and URLs, not missing commands.

[!WARNING]

Firewall blocked 1 domain

The following domain was blocked by the firewall during workflow execution:

  • api.github.com

[!TIP]
api.github.com is blocked because GitHub API access uses the built-in GitHub tools by default. Instead of adding api.github.com to network.allowed, use tools.github.mode: gh-proxy for direct pre-authenticated GitHub CLI access without requiring network access to api.github.com:

tools:
  github:
    mode: gh-proxy

See GitHub Tools for more information on gh-proxy mode.

To allow these domains, add them to the network.allowed list in your workflow frontmatter:

network:
  allowed:
    - defaults
    - "api.github.com"

See Network Configuration for more information.

Generated by CLI Consistency Checker · copilot · auto · 29.3 AIC · ⌖ 5.69 AIC · ⊞ 10.3K · ◷

  • expires on Oct 9, 2026, 1:11 PM UTC
Dominant language
Python
Stars
4k
Forks
393
Avg merge
4d 12h
Merged PRs (30d)
70

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from microsoft/apm

All issues in microsoft/apm

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.