Repository navigation
docs(cli-reference): fix drifted flags, exit codes, anchors and sample output - #3805
Merged
Merged
Conversation
Daniel Meppiel (danielmeppiel)
requested a review
from Sergio Sisternes (sergio-sisternes-epam)
as a code owner
November 17, 2026 20:39
Contributor
There was a problem hiding this comment.
🟡 Changes recommended
The CLI documentation incorrectly describes targets as producing no compile output when they can fall back to minimal and generate AGENTS.md.
1 open issue
What changed in this PR
This docs-only PR updates APM's CLI and primitive references as one batch of the documentation re-sweep in #3800. It changes documentation, not runtime behavior.
Changes:
- Corrects command flags, exit codes, configuration requirements, and feature descriptions.
- Refreshes sample output, target information, and dependency-inspection guidance.
- Repairs anchors and updates primitive model and directory examples.
| File | Description |
|---|---|
| docs/src/content/docs/reference/primitive-types.md | Adds Skill.source and corrects directory examples. |
| docs/src/content/docs/reference/cli/targets.md | Updates output ordering and Copilot detection signals. |
| docs/src/content/docs/reference/cli/run.md | Corrects the available-scripts status symbol. |
| docs/src/content/docs/reference/cli/publish.md | Revises registry-related exit codes. |
| docs/src/content/docs/reference/cli/prune.md | Links to installed dependency inspection. |
| docs/src/content/docs/reference/cli/preview.md | Clarifies panels shown without prompt files. |
| docs/src/content/docs/reference/cli/policy.md | Documents policy warnings and their output row. |
| docs/src/content/docs/reference/cli/plugin.md | Updates format options and naming constraints. |
| docs/src/content/docs/reference/cli/pack.md | Fixes an anchor and bundle cross-reference. |
| docs/src/content/docs/reference/cli/marketplace.md | Documents offline mode and command-specific flags. |
| docs/src/content/docs/reference/cli/list.md | Points readers to dependency list and tree commands. |
| docs/src/content/docs/reference/cli/find.md | Corrects source-reference descriptions and examples. |
| docs/src/content/docs/reference/cli/experimental.md | Adds Grok Cloud and clarifies marketplace flag behavior. |
| docs/src/content/docs/reference/cli/config.md | Clarifies persisted HTTP registry configuration. |
| docs/src/content/docs/reference/cli/compile.md | Repairs the targets anchor and expands the output table. |
| docs/src/content/docs/reference/cli/cache.md | Refreshes sample output status symbols. |
Review effort: Balanced
…e output Surgical fixes from the post-0.36 docs corpus re-sweep. Every changed claim was checked against current main (CLI --help, source, or a scratch-dir run). Pages that a still-open PR edits are left out, per the approved scope. Refs #3800 Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Daniel Meppiel (danielmeppiel)
force-pushed
the
docs-sweep/cli-reference
branch
from
November 17, 2026 21:00
240a06f to
c37367d
Compare
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
Surgical fixes to the CLI reference pages (
reference/cli/*,reference/primitive-types.md), checked againstapm <cmd> --helpand the click definitions on current main.pack.md: a broken#36-targetanchor now points to#36-target-and-targets.publish.md: an unknown--registryname exits 1, not 2. Missingregistries:is listed under exit 1.config.md: a persistedhttp://mcp-registry-urldoes not needMCP_REGISTRY_ALLOW_HTTP=1(config-sourced URLs are exempt).experimental.md: adds the missinggrok-cloudflag.marketplace-authoringgates nothing today.list.md,prune.md:apm listlists scripts. Installed packages areapm deps list/apm deps tree.find.md:--sourceprintsowner/repo@ref, not a.gitURL.policy.md: documents thewarningsfield and row.plugin.md: plugin-name rule and the--format/--claude-pluginsynopsis.preview.md,cache.md,run.md,targets.md: sample output now matches real output (status symbols, row order,.github/mcp.jsoncopilot signal).pack.md: says "above", not "below", for the Claude plugin bundle.primitive-types.md:.apm/context/directory,owner/repoinstall paths,Skill.source.Pages that a still-open PR also edits are left out of this PR, as the approved scope requires. Their fixes are held for after those PRs land, and the sweep report lists them.
Issue and approved scope
Issue: Refs #3800
Human scope-approval comment: #3800 (comment)
Does this PR complete the issue, or what remains? Partial: one area batch of the corpus re-sweep. Pages edited by still-open PRs are not touched here; their findings are recorded in the final sweep report and re-checked after v0.36.1.
Type of change
Testing
.venv/bin/apm <cmd> --help, the source undersrc/apm_cli/, or a scratch-directory run.cd docs && npm run buildexits 0 ("All internal links are valid"; "Checked 1197 relative link(s) ... No broken relative links found").Spec conformance (OpenAPM v0.1)