Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Installation

Prerequisites

  • Windows x64 or ARM64
  • Git for Windows, which provides Git Bash
  • no administrator rights

Install script

In Git Bash:

curl -fsSL https://raw.githubusercontent.com/haba713/paku/master/install.sh | sh

The script downloads the latest release binary for your machine (x64 or ARM64), checks its SHA-256 checksum and installs it as ~/.local/bin/paku.exe.

curl | sh runs whatever the server returns. The script is about 50 lines; to read it first:

curl -fsSL https://raw.githubusercontent.com/haba713/paku/master/install.sh | less

Install a specific release

Set PAKU_VERSION:

curl -fsSL https://raw.githubusercontent.com/haba713/paku/master/install.sh | PAKU_VERSION=v0.1.0 sh

Add paku to PATH

If ~/.local/bin is not on your PATH yet, the script prints how to add it. Add it to Git Bash’s PATH in ~/.bashrc, then open a new Git Bash window:

echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.bashrc

Avoid adding ~/.local/bin to the Windows user PATH for cmd and PowerShell: msys programs such as rsync need DLLs from Git’s usr\bin (msys-2.0.dll, msys-iconv-2.dll, …), which only Git Bash has on its PATH, so they fail to start there. Native Windows packages (mingw-w64-ucrt-x86_64-*, mingw-w64-clang-aarch64-*) keep their DLLs next to the program and would work, but the same directory holds both kinds.

Manual installation

  1. Download paku-x86_64.exe (x64) or paku-aarch64.exe (ARM64) and SHA256SUMS from the latest release.

  2. Verify:

    sha256sum -c --ignore-missing SHA256SUMS
    
  3. Copy the binary to ~/.local/bin/paku.exe.

Build from source

Only a Rust toolchain is needed; no Visual Studio:

rustup toolchain install stable-x86_64-pc-windows-gnu --profile minimal
export RUSTUP_TOOLCHAIN=stable-x86_64-pc-windows-gnu
git clone https://github.com/haba713/paku.git
cd paku && cargo build --release && cargo test --workspace
mkdir -p ~/.local/bin && cp target/release/paku.exe ~/.local/bin/

Code signing

The release binaries are not code-signed yet. On Windows 11 with Smart App Control enabled, Windows may block them.