Installation

System Requirements

  • OS: macOS, Linux, Windows (WSL recommended)

  • Rust: 1.75+ (for building from source)

  • Terminal: 256-color support recommended

Install from Source

# Clone the repository
git clone https://github.com/eonseed/perspt.git
cd perspt

# Build in release mode
cargo build --release

# The binary is at target/release/perspt
# Optionally, copy to your PATH:
cp target/release/perspt ~/.local/bin/

Install with Cargo

cargo install --path .

Verify Installation

perspt --version
# perspt 0.5.6

perspt --help

Provider Setup

Set at least one API key:

export GEMINI_API_KEY="your-key"

See Providers for all supported providers.

Agent Mode Prerequisites

For agent mode, install the tool binaries for your target language:

# uv (package manager + project init)
curl -LsSf https://astral.sh/uv/install.sh | sh

# ty (type checker / LSP)
pip install ty

# pytest (test runner)
pip install pytest

Optional: Documentation Build

To build the documentation locally:

# Install uv (Python package manager)
curl -LsSf https://astral.sh/uv/install.sh | sh

# Build HTML docs
cd docs/perspt_book && uv run make html

# Open in browser
open docs/perspt_book/build/html/index.html