Skip to content

Installation

Jump to bottom
a.metwalli edited this page Feb 6, 2026 · 1 revision

Installation

Floe ships as a CLI (floe). The recommended install is Homebrew. If Homebrew is unavailable, you can install from source with Cargo. Docker is also supported.

Homebrew (recommended)

brew tap malon64/floe
brew install floe
floe --version

Cargo (from source)

Prereqs:

  • Rust toolchain (stable)
  • A C/C++ toolchain in PATH

Install:

cargo install floe-cli
floe --version

Build from a local checkout:

cargo build --release
./target/release/floe --version

Docker (GHCR)

Pull the latest image:

docker pull ghcr.io/malon64/floe:latest

Run (mount the current directory to /work):

docker run --rm -v "$PWD:/work" ghcr.io/malon64/floe:latest run -c /work/example/config.yml

Notes:

  • CLI arguments are identical to local usage.
  • Provide cloud credentials via environment variables or runtime identity.

Verification

floe --version
floe validate -c example/config.yml

Clone this wiki locally