Getting Started

Installation

Shell installer, release binary, cargo install, and source build paths.

Option A: Shell Installer

Use the POSIX shell installer on Linux x86_64 or Apple Silicon macOS.

curl -fsSL https://agentprey.com/install | shagentprey --helpagentprey scan --helpagentprey init

Install a Specific Version

curl -fsSL https://agentprey.com/install | sh -s -- --version <version>

The installer places agentprey in ~/.local/bin by default. On unsupported targets, use Cargo instead.

Option B: crates.io

Use Cargo as the cross-platform fallback.

cargo install agentprey --lockedagentprey --helpagentprey scan --helpagentprey init

Update Existing Cargo Install

cargo install agentprey --locked --force

Pin a Cargo Version

cargo install agentprey --locked --version <version> --force

Option C: Release Binary

Download and install a release archive manually.

# 1) download and extract a release archive from:# https://github.com/agentprey/agentprey/releases# 2) move binary into your PATHsudo install -m 0755 ./agentprey /usr/local/bin/agentprey# 3) run globallyagentprey --helpagentprey scan --helpagentprey init

Option D: Build From Source

git clone https://github.com/agentprey/agentprey.gitcd agentpreycargo build --manifest-path cli/Cargo.toml --releasesudo install -m 0755 ./cli/target/release/agentprey /usr/local/bin/agentpreyagentprey --helpagentprey scan --help

Verification Steps

These checks work from a normal installed binary and do not require the repo checkout.

agentprey --helpagentprey center --helpagentprey scan --helpagentprey init --help

← Previous

Introduction

Quickstart