Install

Five minutes, no yak-shaving.

Folio is a single Rust binary with one optional runtime dependency (typst, only required for PDF export). It has no server, no database, no runtime config file. Put the binary on your PATH and you're done.

Recommended

Pre-compiled binary.

The simplest path. Download the archive for your platform, extract, install.

Linux x86_64

curl -LO https://wgit.dev/wavelet/folio/releases/v0.1.0/folio-0.1.0-x86_64-linux.tar.gz
tar -xzf folio-0.1.0-x86_64-linux.tar.gz
sudo install folio /usr/local/bin/
folio --version
folio 0.1.0

macOS (arm64 / Intel)

curl -LO https://wgit.dev/wavelet/folio/releases/v0.1.0/folio-0.1.0-aarch64-darwin.tar.gz
tar -xzf folio-0.1.0-aarch64-darwin.tar.gz
sudo install folio /usr/local/bin/

FreeBSD

fetch https://wgit.dev/wavelet/folio/releases/v0.1.0/folio-0.1.0-x86_64-freebsd.tar.gz
tar -xzf folio-0.1.0-x86_64-freebsd.tar.gz
doas install folio /usr/local/bin/

Windows

Download folio-0.1.0-x86_64-windows.zip, extract folio.exe, put it in a directory on your PATH (a common choice is %LOCALAPPDATA%\Programs\folio).

Binaries are cross-compiled with cargo-forge and produced for every tagged release. If your platform isn't in the list, build from source.

Alternative

From source.

Requires Rust 1.75 or newer and a C toolchain. folio-repo vendors libgit2, so there's no system git2 dependency at build time.

git clone https://wgit.dev/wavelet/folio.git
cd folio
cargo install --path folio-cli
folio --version
folio 0.1.0

cargo install puts the binary at ~/.cargo/bin/folio, which is typically already on your PATH if you've installed cargo. On Windows, it's %USERPROFILE%\.cargo\bin\folio.exe.

Optional

PDF export with typst.

Folio's export subcommand shells out to the typst typesetter to render datasheets as PDFs. If you don't need PDF export, you can skip this step — everything else Folio does works without it.

macOS (Homebrew)

brew install typst

FreeBSD

pkg install typst

Debian / Ubuntu

apt install typst     # Debian 13+, Ubuntu 24.04+
# or download a release binary from https://github.com/typst/typst/releases

Windows

Download typst-x86_64-pc-windows-msvc.zip from the typst releases page and add typst.exe to your PATH.

Verify:

typst --version
typst 0.14.2

Verify

Run doctor on an empty repo.

A quick sanity check that everything is wired up:

mkdir /tmp/folio-test && cd /tmp/folio-test
folio init --tier open .
folio doctor
folio doctor

  ok    git repository: opened at /tmp/folio-test
  ok    .folio/config.toml: present, tier=Open
  ok    datasheets/ structure: 0 datasheet(s)
  ok    typst (for `folio export`): available: typst 0.14.2
  ok    working tree: clean
  ok    last checkpoint: 0 day(s) ago

all checks passed

If you see that, you're ready to go through the tutorial.

Next

What to do after installing.

Start the tutorial Browse features

If something goes wrong: try folio --version to confirm the binary is on your PATH. Try folio doctor inside a newly-initialized repo to see where the stack breaks. File an issue with the output of both commands.