[docs] Update documentation for features from 2026-05-03#1118
Open
danielmeppiel wants to merge 1 commit intomainfrom
Open
[docs] Update documentation for features from 2026-05-03#1118danielmeppiel wants to merge 1 commit intomainfrom
danielmeppiel wants to merge 1 commit intomainfrom
Conversation
- Replace pipeline diagram reference from 'apm unpack' to 'apm install <bundle-path>' - Update targeting mental model section to use 'apm install <bundle-path>' phrasing - Add new 'apm install <bundle-path>' section documenting the unified install entrypoint, sha256 integrity verification, air-gapped restore, and lockfile recording - Deprecate 'apm unpack' section with explicit v0.13 removal notice Refs: #1099 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
danielmeppiel
added
automation
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the pack/distribute guide to document the newer local-bundle install flow from #1099 and the deprecation of apm unpack, so the distribution docs better match the recent 0.12 bundle workflow.
Changes:
- Replaces several
apm unpack-centric references withapm install <bundle-path>. - Adds a dedicated section for local bundle installs, including integrity verification and lockfile recording.
- Marks
apm unpackas deprecated and adds a migration note in this guide.
Show a summary per file
| File | Description |
|---|---|
docs/src/content/docs/guides/pack-distribute.md |
Updates the bundle distribution guide to cover local-bundle installs and apm unpack deprecation. |
Copilot's findings
Comments suppressed due to low confidence (2)
docs/src/content/docs/guides/pack-distribute.md:285
- This sentence says
apm install <bundle-path>deploys bundles produced byapm pack --format apm, but the CLI only recognizes local bundles that containplugin.json. Legacy--format apmtarballs are explicitly rejected with guidance to useapm unpack, so this should describe plugin-format bundles instead of the legacy APM format.
Deploys an APM bundle (directory or `.tar.gz` archive) produced by `apm pack --format apm` into a project directory without touching the network or the dependency resolver -- mirroring the `pip install ./wheel` / `cargo install --path` mental model.
docs/src/content/docs/guides/pack-distribute.md:303
apm install <bundle-path>does not handle both bundle formats today.detect_local_bundle()only accepts plugin bundles withplugin.json, andinstall.pyexplicitly tells users to useapm unpackfor legacy--format apmarchives, so this statement will send readers to a command path that fails.
Plugin-format output is consumed directly by Claude Code and other plugin hosts; `apm install <bundle-path>` handles both formats.
- Files reviewed: 1/1 changed files
- Comments generated: 3
|
|
||
| ## `apm unpack` (deprecated since 0.12) | ||
|
|
||
| > **Deprecated.** Use `apm install <bundle-path>` instead. `apm unpack` remains available for one release cycle (removal planned for v0.13). |
|
|
||
| ``` | ||
| apm install -> apm pack -> upload artifact -> download -> apm unpack (or tar xzf) | ||
| apm install -> apm pack -> upload artifact -> download -> apm install <bundle-path> (or tar xzf) |
Comment on lines
+112
to
+116
| $ apm install team-skills.tar.gz | ||
| [*] Installing team-skills.tar.gz -> . | ||
| [i] Bundle target: claude (1 dep(s), 3 file(s)) | ||
| [!] Bundle target 'claude' differs from project target 'copilot' | ||
| [+] Unpacked 3 file(s) (verified) | ||
| [+] Installed 3 file(s) (verified) |
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.
Documentation Updates - 2026-05-03
This PR updates the documentation based on features merged in the last 24 hours.
Features Documented
apm install <bundle-path>as the unified local bundle install entrypoint (from feat(install): apm install <local-bundle> + lockfile-embedded plugin packs (#1098) #1099)apm unpackdeprecation notice with v0.13 removal target (from feat(install): apm install <local-bundle> + lockfile-embedded plugin packs (#1098) #1099)Changes Made
docs/src/content/docs/guides/pack-distribute.md:apm install <bundle-path>instead ofapm unpackapm install <bundle-path>apm install <bundle-path>section added documenting the unified install entrypoint, sha256 integrity verification viapack.bundle_filesmanifest, air-gapped operation, andlocal_deployed_fileslockfile recordingapm unpacksection marked deprecated (since 0.12) with v0.13 removal noticeMerged PRs Referenced
apm install <bundle-path>+ lockfile-embedded plugin packs--target agent-skillsfor cross-client.agents/skills/deployment (already documented inskills.mdandcli-commands.md)ide-tool-integration.mdandcli-commands.md)Notes
PRs #1103 and #1104 were already documented in the codebase (the authors updated docs as part of those PRs). The only gap was
pack-distribute.mdwhich still referencedapm unpackas the primary bundle consumption path -- now updated to reflect the unifiedapm install <bundle-path>entrypoint shipped in #1099.Note
🔒 Integrity filter blocked 3 items
The following items were blocked because they don't meet the GitHub integrity level.
search_pull_requests: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".search_pull_requests: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".search_pull_requests: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".To allow these resources, lower
min-integrityin your GitHub frontmatter: