Installation

Requirements

  • Rust 1.75 or later (for building from source)
  • Any modern OS: Linux, macOS, Windows

Install with Cargo

The recommended way to install aphid is via Cargo:

cargo install aphid --locked

This compiles and installs the latest release from crates.io. The aphid binary is placed in ~/.cargo/bin/, which should already be on your PATH if you installed Rust via rustup.

Build from source

See Development Setup for prerequisites and detailed instructions on getting the toolchain ready. Once you have Rust installed:

git clone https://github.com/LHelge/aphid
cd aphid
cargo install --path .

Verify

aphid --version

Usage

aphid                          # start a dev server on :3000 (default command)
aphid serve                    # explicit form, same as `aphid`
aphid serve --port 8080        # custom port
aphid build                    # render the site into dist/ (use this in CI)
aphid --config path/to/aphid.toml build   # use a custom config

See CLI reference for the full command reference and Configuration for the aphid.toml reference.

Linked from