Wraps apm CLI binary install and agent-runtime setup (apm runtime setup/list/status/remove), the bootstrap step ahead of apm-workflow's configure/compile/audit loop.
2.5 KiB
2.5 KiB
name, description, metadata
| name | description | metadata | |||||
|---|---|---|---|---|---|---|---|
| apm-install | Use when the user wants to install the apm (Agent Package Manager) CLI itself, pin or upgrade its version, set up an air-gapped/enterprise mirror install, or install and manage an agent runtime that apm drives (Copilot CLI, Codex, Gemini, generic llm) — "install apm", "set up apm", "pin apm to a version", "apm runtime setup", "which runtime will apm run pick". Do not use for authoring apm.yml, scaffolding a package/marketplace, compiling, packing, publishing, or running apm audit — use apm-workflow for those. |
|
Gotchas
- apm does not execute agents itself — it only installs and manages the runtimes that do. "Install apm" and "install a runtime apm manages" are two separate steps; don't conflate them or skip the second when the user actually wants a working agent CLI, not just the package manager.
- The air-gapped/enterprise mirror path needs
GITHUB_URLandVERSIONset together against a downloadedinstall.sh— it does not work through the piped one-liner form. pip install apm-clirequires Python 3.10+; the quick-install script has no such prerequisite. Prefer the quick-install script unless the environment is pip-first.- Installing the Copilot CLI runtime through
apm runtime setup copilotrequires Node.js v22+ and npm v10+ already present — apm does not install Node/npm for you.
Install apm
Default:
curl -sSL https://aka.ms/apm-unix | sh
Escape hatches — combine as needed:
- Pin a version: append
@vX.Y.Zto the piped script's arguments, e.g.curl -sSL https://aka.ms/apm-unix | sh -s -- @v1.2.3. - Custom install directory: set
APM_INSTALL_DIRbefore running, e.g.APM_INSTALL_DIR=$HOME/.local/bin sh. - Air-gapped / GitHub Enterprise mirror: download
install.shfirst, then run it withGITHUB_URLandVERSIONset, e.g.GITHUB_URL=https://github.corp.com VERSION=v1.2.3 sh install.sh. - pip (Python 3.10+ environments):
pip install apm-cli. - Manual: download the platform archive from the GitHub releases page, extract, place the binary on
PATH.
Verify with apm --version.
Install or manage an agent runtime
Default:
apm runtime setup copilot
Other targets: apm runtime setup codex, apm runtime setup gemini, apm runtime setup llm.
apm runtime list— show installed runtimes.apm runtime status— show which runtimeapm runwill pick by default.apm runtime remove <name> -y— uninstall without an interactive prompt.