apm

(β˜… 3,599)

Agent Package Manager

Showing a partial file list β€” download the zip above to see everything.

  • .editorconfig
  • .gitattributes
  • .gitignore
  • .gitmodules
  • .pre-commit-config.yaml
  • apm.lock.yaml
  • apm.yml
  • AUTHORS
  • CHANGELOG.md
  • CODE_OF_CONDUCT.md
  • CONFORMANCE.json
  • CONFORMANCE.md
  • CONTRIBUTING.md
  • install.ps1
  • install.sh
  • LICENSE
  • Makefile
  • MANIFESTO.md
  • NOTICE
  • PRINCIPLES.md
  • pyproject.toml
  • README.md
  • SECURITY.md
  • SUPPORT.md

# Installation Guide

1. Get the code
git clone https://github.com/microsoft/apm

Downloads the entire project code from GitHub to your computer.

cd apm

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
Prerequisites
  • Homebrew A package manager for macOS/Linux.
  • Python 3 Python is required to use pip.
curl -sSL https://aka.ms/apm-unix | sh

Downloads and runs the official install script in one line β€” this handles the full setup automatically.

irm https://aka.ms/apm-windows | iex

Downloads and runs the official install script via PowerShell β€” this handles the full setup automatically.

brew install microsoft/apm/apm

Installs the pre-built package via Homebrew β€” no source build required.

pip install apm-cli

Installs the package published on PyPI directly β€” no need to clone the source.

βœ… After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Node.js

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
⚠️ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.
cd packages/apm-contributor-dashboard/client

This project's files live in a subfolder, so move into it first.

npm install

Downloads and installs the libraries listed in package.json.

npm start

Starts the development/run server.

βœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

4. Python

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.
pip install apm-cli

Installs the package published on PyPI directly β€” no need to clone the source.

βœ… If it runs without errors and prints output in the terminal, it worked.

Pulled directly from this repo's README.

5. Make

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).
make

Compiles the code based on the generated build configuration to produce an executable.

βœ… If it finishes without errors, it worked. Try running the generated executable directly.
// repository documentation