Installation¶

This guide covers installing the Amplifier CLI.

Requirements¶

Python 3.11+
UV - Fast Python package manager (recommended)

Install UV¶

# macOS/Linux/WSL
curl -LsSf https://astral.sh/uv/install.sh | sh

# Windows PowerShell
powershell -c "irm https://astral.sh/uv/install.ps1 | iex"

Quick Install¶

Try Without Installing¶

uvx --from git+https://github.com/microsoft/amplifier amplifier

This downloads and runs Amplifier in an isolated environment without permanent installation.

Install Globally¶

uv tool install git+https://github.com/microsoft/amplifier

This installs the amplifier command globally.

First-Time Setup¶

After installation, run:

amplifier init

This opens a combined dashboard to add providers, select a routing matrix, and verify configuration (auto-runs if no config). The dashboard detects env vars and shows them as defaults:

export ANTHROPIC_API_KEY="your-key"
amplifier init

Environment variables detected automatically: ANTHROPIC_API_KEY, OPENAI_API_KEY, AZURE_OPENAI_API_KEY, GOOGLE_API_KEY

Shell Completion¶

Enable tab completion for faster CLI usage:

amplifier --install-completion

This automatically: - Detects your shell (bash, zsh, fish) - Adds completion to your shell config - Safe to run multiple times

After installation:

source ~/.bashrc  # or ~/.zshrc for zsh

Provider Configuration¶

Provider Sources

amplifier provider add … pins the canonical module source for each first-party provider (for example, the OpenAI provider resolves to git+https://github.com/microsoft/amplifier-module-provider-openai@main). Existing installations inherit these canonical URIs at runtime as well, so fresh environments download the provider code via uv automatically. No manual source overrides are required for the built-in providers.

Anthropic (Recommended)¶

export ANTHROPIC_API_KEY="your-key"
amplifier provider add anthropic

OpenAI¶

export OPENAI_API_KEY="your-key"
amplifier provider add openai

Azure OpenAI¶

export AZURE_OPENAI_API_KEY="your-key"
amplifier provider add azure-openai

Google Gemini¶

export GOOGLE_API_KEY="your-key"
amplifier provider add google

Ollama (Local, Free)¶

# Start Ollama server first
ollama serve

# Configure Amplifier
amplifier provider add ollama

No API key needed - runs locally on your machine.

Verify Installation¶

# Check version
amplifier --version

# Test with a simple prompt
amplifier run "Hello, world!"

Next Steps¶

Quick Start Guide - Learn basic commands
Bundle Guide - Configure your agent
Examples - See Amplifier in action

Troubleshooting¶

Command Not Found¶

If amplifier command is not found after installation:

Check UV installation:
```
uv --version
```
Verify tool installation:
```
uv tool list
```
Add to PATH (if needed):
```
export PATH="$HOME/.local/bin:$PATH"
```

API Key Issues¶

If provider setup fails:

Verify environment variable:

echo $ANTHROPIC_API_KEY  # Should print your key

Check provider configuration:
```
amplifier provider list
```
Test provider connectivity:
```
amplifier provider test anthropic
```

Module Loading Errors¶

If modules fail to load:

Reinstall with fresh dependencies:

uv tool uninstall amplifier
uv tool install git+https://github.com/microsoft/amplifier