Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ curl -sSL https://raw.githubusercontent.com/microsoft/apm/main/install.sh | sh
#### Windows

```powershell
powershell -ExecutionPolicy Bypass -c "irm https://raw.githubusercontent.com/microsoft/apm/main/install.ps1 | iex"
irm https://raw.githubusercontent.com/microsoft/apm/main/install.ps1 | iex
```

Native release binaries are published for macOS, Linux, and Windows x86_64. `apm update` reuses the matching platform installer.
Expand Down
49 changes: 25 additions & 24 deletions docs/src/content/docs/getting-started/installation.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,41 @@
---
title: "Installation"
description: "Install APM on macOS, Linux, or from source."
description: "Install APM on macOS, Linux, Windows, or from source."
sidebar:
order: 1
---

## Requirements

- macOS or Linux (x86_64 or ARM64)
- macOS, Linux, or Windows (x86_64 or ARM64)
- [git](https://git-scm.com/) for dependency management
- Python 3.10+ (only for pip or from-source installs)

## Quick install (recommended)

**macOS / Linux:**

```bash
curl -sSL https://raw.githubusercontent.com/microsoft/apm/main/install.sh | sh
```

On Windows PowerShell:
**Windows (PowerShell):**

```powershell
powershell -ExecutionPolicy Bypass -c "irm https://raw.githubusercontent.com/microsoft/apm/main/install.ps1 | iex"
irm https://raw.githubusercontent.com/microsoft/apm/main/install.ps1 | iex
```

This script automatically:
- Detects your platform (macOS/Linux/Windows, Intel/ARM)
- Downloads the latest binary
- Installs to `/usr/local/bin/` on macOS/Linux
- Installs under `%LOCALAPPDATA%\Programs\apm\` on Windows and adds a user-level `apm` shim to `PATH`
- Verifies installation
The installer automatically detects your platform (macOS/Linux/Windows, Intel/ARM), downloads the latest binary, and adds `apm` to your `PATH`.

## Package managers

**Homebrew (macOS/Linux):**

```bash
brew install microsoft/apm/apm
```

### Windows Package Manager (Scoop)
**Scoop (Windows):**

```powershell
scoop bucket add apm https://github.com/microsoft/scoop-apm
Expand Down Expand Up @@ -72,14 +77,14 @@ sudo cp -r apm-darwin-arm64/* /usr/local/lib/apm/
sudo ln -sf /usr/local/lib/apm/apm /usr/local/bin/apm
```

Replace `apm-darwin-arm64` with the archive name for your platform:
Replace `apm-darwin-arm64` with the archive name for your macOS or Linux platform:

| Platform | Archive name |
|--------------------|----------------------|
| macOS Apple Silicon | `apm-darwin-arm64` |
| macOS Intel | `apm-darwin-x86_64` |
| Linux x86_64 | `apm-linux-x86_64` |
| Linux ARM64 | `apm-linux-arm64` |
| Platform | Archive name |
|---------------------|-----------------------|
| macOS Apple Silicon | `apm-darwin-arm64` |
| macOS Intel | `apm-darwin-x86_64` |
| Linux x86_64 | `apm-linux-x86_64` |
| Linux ARM64 | `apm-linux-arm64` |

## From source (contributors)

Expand Down Expand Up @@ -117,7 +122,7 @@ apm --version

## Troubleshooting

### `apm: command not found`
### `apm: command not found` (macOS / Linux)

Ensure `/usr/local/bin` is in your `PATH`:

Expand All @@ -131,7 +136,7 @@ If missing, add it to your shell profile (`~/.zshrc`, `~/.bashrc`, etc.):
export PATH="/usr/local/bin:$PATH"
```

### Permission denied during install
### Permission denied during install (macOS / Linux)

Use `sudo` for system-wide installation, or install to a user-writable directory instead:

Expand All @@ -140,10 +145,6 @@ mkdir -p ~/bin
# then install the binary to ~/bin/apm and add ~/bin to PATH
```

### Verify Installation

Check what runtimes are available:

### Authentication errors when installing packages

If `apm install` fails with authentication errors for private repositories, ensure you have a valid GitHub token configured:
Expand Down
10 changes: 9 additions & 1 deletion docs/src/content/docs/getting-started/quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,17 +9,25 @@ Three commands. Three minutes. Your AI agent learns your project's standards aut

## Install APM

**macOS / Linux:**

```bash
curl -sSL https://raw.githubusercontent.com/microsoft/apm/main/install.sh | sh
```

**Windows (PowerShell):**

```powershell
irm https://raw.githubusercontent.com/microsoft/apm/main/install.ps1 | iex
```

Verify it worked:

```bash
apm --version
```

For Homebrew, pip, or manual install, see the [Installation guide](../installation/).
For Homebrew (macOS/Linux), Scoop (Windows), pip, or manual install, see the [Installation guide](../installation/).

## Start a project

Expand Down
21 changes: 16 additions & 5 deletions docs/src/content/docs/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ hero:
variant: minimal
---

import { Card, CardGrid } from '@astrojs/starlight/components';
import { Card, CardGrid, Tabs, TabItem } from '@astrojs/starlight/components';

**An open-source dependency manager for AI agents.** Think `package.json`, `requirements.txt`, or `Cargo.toml` — but for AI agent configuration.

Expand All @@ -41,11 +41,22 @@ APM fixes this. You declare your project's agent configuration once in `apm.yml`

## Quick Start

```bash
# Install APM
curl -sSL https://raw.githubusercontent.com/microsoft/apm/main/install.sh | sh
<Tabs>
<TabItem label="macOS / Linux">
```bash
curl -sSL https://raw.githubusercontent.com/microsoft/apm/main/install.sh | sh
```
</TabItem>
<TabItem label="Windows">
```powershell
irm https://raw.githubusercontent.com/microsoft/apm/main/install.ps1 | iex
```
</TabItem>
</Tabs>

Then add packages to your project:

# Add packages to your project
```bash
apm install microsoft/apm-sample-package
apm install anthropics/skills/skills/frontend-design
```
Expand Down
Loading
Loading