apm view
Show local metadata for an installed package, or query remote refs without cloning.
Synopsis
Section titled “Synopsis”apm view PACKAGE [FIELD] [OPTIONS]apm info is accepted as a hidden alias for backward compatibility.
Description
Section titled “Description”apm view has two modes, selected by the optional FIELD argument:
- No field — read installed package metadata from
apm_modules/(or~/.apm/apm_modules/with-g). Local-only; the package must be installed. versionsfield — query the remote for available tags and branches. No local install required.
When PACKAGE matches the NAME@MARKETPLACE pattern, apm view resolves the plugin against the marketplace manifest and prints its entry (name, version, description, source, tags) instead of a Git repository view. This applies whether or not versions is passed.
See apm outdated to compare locked versions against remotes, and apm install to add a package to the manifest.
Subcommands
Section titled “Subcommands”apm view <package>
Section titled “apm view <package>”Reads metadata from the installed copy. Exits non-zero if apm_modules/ is missing or the package is not installed; on a missing package, prints the list of installed packages to help disambiguate.
Output includes: name, version, description, author, source, install path, lockfile ref and commit (when available), context-file counts (skills, prompts, instructions), workflow count, and hook count.
apm view <package> versions
Section titled “apm view <package> versions”Lists remote tags and branches for the package. Calls the remote — requires network access, and for private repositories requires GITHUB_APM_PAT (see authentication).
Output is a table with name, type (tag or branch), and short commit SHA.
Arguments
Section titled “Arguments”| Argument | Required | Description |
|---|---|---|
PACKAGE | yes | owner/repo, short repo name (installed only), or NAME@MARKETPLACE for a marketplace plugin |
FIELD | no | Field selector. Only versions is supported today |
Options
Section titled “Options”| Option | Description |
|---|---|
-g, --global | Inspect a package installed in user scope (~/.apm/apm_modules/) |
Examples
Section titled “Examples”Show metadata for an installed package:
apm view microsoft/apm-sample-packageShort-name lookup (resolves against apm_modules/):
apm view apm-sample-packageList remote tags and branches without cloning:
apm view microsoft/apm-sample-package versionsInspect a package installed at user scope:
apm view microsoft/apm-sample-package -gView a marketplace plugin’s manifest entry:
apm view code-review@acme-pluginsRelated
Section titled “Related”apm outdated— compare locked versions against remote tagsapm install— add a package toapm.ymland install it