Skip to content

Reference

This section is the authoritative reference for APM. If you’re learning APM, start in the consumer ramp or producer ramp instead – the reference assumes you know what you’re looking for.

Per-command pages live under reference/cli/. Grouped by lifecycle phase:

Phase Commands
Project setup init, install, lock, update, uninstall
Inspect and audit view, deps, outdated, list, find, audit, doctor
Compile and integrate compile, prune, targets, runtime
Cache and config cache, config
Run scripts run
Author and distribute pack, unpack, preview, plugin, publish, lifecycle, marketplace, search, self-update
Governance approve, deny, policy, mcp
Experimental experimental
Doc What it specifies
Manifest schema Every field in apm.yml
Lockfile spec apm.lock.yaml schema, semantics, and integrity contract
Policy schema apm-policy.yml rules, merge semantics, severity
Targets matrix Which primitive types each target (Copilot, Claude, …) supports
Baseline checks The CI checks apm audit --ci runs
Environment variables Every env var APM reads, with precedence
Primitive types Skill, prompt, instruction, agent, hook, command
Package types APM packages, plugins, marketplaces
Examples Worked end-to-end examples
Experimental Surface area still subject to change
Common errors Symptoms, causes, and fixes for frequently reported errors
  • <placeholder> – you must substitute a real value.
  • [optional] – argument or flag is optional.
  • All commands assume apm is on PATH; install instructions are in the Quickstart.
  • Status symbols in CLI output: [+] success, [!] warning, [x] error, [i] info, [*] action, [>] running.