Skip to content

Installation

Renderflow is distributed through multiple package channels and can also be built from source.

Requirements

  • Rust 1.94+ for source builds
  • Pandoc for document rendering
  • Tectonic for PDF output
  • FFmpeg for audio/image conversion

Note

Package manager installs may already pull some dependencies for you, but the runtime still needs the external tools required by the outputs you choose.

Cargo

Install from crates.io:

cargo install renderflow

To install from a local checkout instead:

cargo install --path .

Homebrew

brew install egohygiene/tap/renderflow

If Homebrew refuses to use the third-party tap, trust and tap it explicitly:

brew trust egohygiene/renderflow
brew tap egohygiene/renderflow https://github.com/egohygiene/renderflow
brew install renderflow

Portable install script (macOS/Linux)

Use the first-party installer to auto-detect OS/architecture, download the matching release asset, verify SHA256 checksums, and install renderflow:

curl -fsSL https://raw.githubusercontent.com/egohygiene/renderflow/main/scripts/install.sh | sh

Or with wget:

wget -qO- https://raw.githubusercontent.com/egohygiene/renderflow/main/scripts/install.sh | sh

Optional environment variables:

  • RENDERFLOW_VERSION (default: latest) — install a specific release (for example 0.2.1 or v0.2.1)
  • RENDERFLOW_INSTALL_DIR (default: /usr/local/bin, fallback: ~/.local/bin)

Scoop (Windows)

Renderflow ships a Scoop manifest in pkg/scoop/renderflow.json.

scoop bucket add egohygiene https://github.com/egohygiene/renderflow
scoop install renderflow

AUR (Arch Linux)

Stable package:

yay -S renderflow

Git package:

yay -S renderflow-git

Snap

snap install renderflow --classic

Binary downloads

Prebuilt binaries are published on the GitHub Releases page.

Typical assets include:

  • renderflow-x86_64-unknown-linux-musl
  • renderflow-x86_64-unknown-linux-gnu
  • renderflow-aarch64-unknown-linux-gnu
  • renderflow-aarch64-apple-darwin
  • renderflow-x86_64-apple-darwin
  • renderflow-x86_64-pc-windows-msvc.exe

Download the binary for your platform, place it on your PATH, and make it executable on Unix-like systems:

chmod +x renderflow-*
mv renderflow-* /usr/local/bin/renderflow

From source

git clone https://github.com/egohygiene/renderflow.git
cd renderflow
cargo build --release
cargo install --path .

Verify the install

renderflow --version
renderflow version
renderflow env
renderflow doctor
renderflow --help

Upgrade

Use your package manager's native upgrade flow when installed from a package channel.

Examples:

brew upgrade renderflow
scoop update renderflow
snap refresh renderflow

If you installed with the portable installer, re-run the installer command to fetch the latest release or set RENDERFLOW_VERSION for a pinned upgrade.

Uninstall

Package-manager uninstall examples:

brew uninstall renderflow
scoop uninstall renderflow
snap remove renderflow

Portable installer uninstall:

rm -f /usr/local/bin/renderflow
# or:
rm -f ~/.local/bin/renderflow

Additional distribution targets (status)

Target Status
Docker / OCI images Planned
Dev Container (.devcontainer) Available
GitHub Codespaces Supported via Dev Container
Nix / Nix Flakes Planned
Alpine package Planned
Winget Planned
pkgx Planned
mise Planned
asdf Planned