Getting Started

Installation

Release binary, cargo install, and source build paths.

Option A: Release Binary

Use a release binary.

bash

# 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 B: crates.io

Install from crates.io.

bash

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

Update Existing Install

bash

cargo install agentprey --locked --force

Pin a Version

bash

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

Option C: Build From Source

bash

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.

bash

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

← Previous

Introduction

Quickstart