Installation

Requirements

Install at least one supported agent CLI and sign in to it before using AMF:

Claude Code
Codex
OpenCode
Pi (pi must be available in PATH)

Release bundles include tmux. A source installation requires tmux in PATH. Git is required for branch and worktree features, but AMF can manage non-git directories without it.

Optional tools:

An authenticated GitHub CLI (gh) enables PR triage, AI review, posting final-review feedback, and the dashboard's open/merged/closed PR badge.
A Nerd Font provides the best icon rendering.
The code command enables VS Code sessions.

Release bundle (recommended)

Download the archive for your platform from GitHub Releases, extract it, and place amf somewhere in your PATH.

Platform	Archive
Linux x86_64, most portable	`amf-x86_64-unknown-linux-musl.tar.gz`
Linux x86_64, glibc	`amf-x86_64-unknown-linux-gnu.tar.gz`
Linux aarch64	`amf-aarch64-unknown-linux-gnu.tar.gz`
macOS, Apple Silicon	`amf-aarch64-apple-darwin.tar.gz`

For example, on Linux x86_64:

curl -L https://github.com/eldridgerdev/agent-mainframe/releases/latest/download/amf-x86_64-unknown-linux-musl.tar.gz -o amf.tar.gz
tar -xzf amf.tar.gz
sudo mv amf-x86_64-unknown-linux-musl /opt/amf
sudo ln -s /opt/amf/amf /usr/local/bin/amf

On macOS with Apple Silicon:

curl -L https://github.com/eldridgerdev/agent-mainframe/releases/latest/download/amf-aarch64-apple-darwin.tar.gz -o amf.tar.gz
tar -xzf amf.tar.gz
sudo install -m 755 amf-aarch64-apple-darwin/amf /usr/local/bin/amf

Install from crates.io

Install the agent-mainframe crate with Cargo:

cargo install agent-mainframe --locked

The crate installs the amf binary. Make sure ~/.cargo/bin is in your PATH, then run:

amf

This source installation requires Rust, a C compiler, and tmux.

If you don't already have Rust and Cargo installed, install them with rustup:

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

Restart your shell (or run source "$HOME/.cargo/env") so cargo is on your PATH, then re-run the cargo install command above.

Build from source

Building uses the current stable Rust toolchain, a C compiler, and tmux. See "Install from crates.io" above for installing Rust via rustup if needed.

git clone https://github.com/eldridgerdev/agent-mainframe
cd agent-mainframe
cargo install --path . --locked

Upgrade

amf upgrade
amf -V

See the project's CHANGELOG for release notes and migration guidance.