Penny logoPPenny

Installation

How to install Penny on your system

Install via Shell Script

The easiest way to install Penny is using the install script:

curl --proto '=https' --tlsv1.2 -LsSf https://github.com/frectonz/penny/releases/download/0.0.15/penny-installer.sh | sh

Download Prebuilt Binaries

You can also download prebuilt binaries from the GitHub releases page:

From Source

Requires Rust (2024 edition) and pnpm for the dashboard UI.

git clone https://github.com/frectonz/penny.git
cd penny

# Build the dashboard UI
cd ui && pnpm install && pnpm build && cd ..

# Build penny
cargo build --release

The binary will be at target/release/penny.

Verify Installation

penny --help

On this page