Installation
Cargo (Rust)
Section titled “Cargo (Rust)”cargo install scythe-clicargo-binstall is also supported and downloads the prebuilt binary instead of compiling from source:
cargo binstall scythe-clinpm (Node.js)
Section titled “npm (Node.js)”For Node.js projects, install scythe as a pinned dev dependency – no Rust toolchain required. A postinstall step downloads the prebuilt binary matching your platform and verifies its checksum.
pnpm add --save-dev scythe-clipnpm exec scythe --versionSupports Linux (x64/arm64, glibc 2.28 or newer), macOS (x64/arm64), and Windows (x64, with x64
emulation on ARM64). See the
scythe-cli README for supported
environment variables (proxy configuration, SCYTHE_BINARY, SCYTHE_CACHE_DIR).
pip (Python)
Section titled “pip (Python)”pip install scythe-sqlscythe --versionpip install does not run code for a wheel install, so the binary is downloaded (and its checksum
verified) on first invocation of scythe, then cached and reused. In a Dockerfile, warm the cache
at build time with pip install scythe-sql && scythe --version. See the
scythe-sql README for supported
environment variables.
Homebrew (macOS/Linux)
Section titled “Homebrew (macOS/Linux)”brew install Goldziher/tap/scythePre-built binaries are available for macOS (arm64, x86_64) and Linux (x86_64, arm64). No Rust toolchain needed.
From Source
Section titled “From Source”git clone https://github.com/Goldziher/scythe.gitcd scythecargo install --path crates/scythe-cliGitHub Actions
Section titled “GitHub Actions”Use the moving v0 action to install the latest scythe release, verify its checksum, and add it to
PATH:
steps: - uses: actions/checkout@v4 - name: Install scythe id: scythe uses: Goldziher/scythe@v0 - run: scythe --versionv0 tracks the latest compatible action implementation. By default, the action resolves the latest
scythe GitHub release using github.token and caches the installed binary by version, operating
system, and runner architecture. Pin the CLI version independently when reproducibility matters:
- name: Install scythe 0.20.1 without caching id: scythe uses: Goldziher/scythe@v0 with: version: 0.20.1 cache: false- run: scythe checkThe version input accepts 0.20.1 or v0.20.1; omit it or pass latest to resolve the latest
release. Set github-token only when the default workflow token cannot read release metadata.
Every download is checked against the release’s SHA-256 checksum file before installation. The action supports native x64 and ARM64 Linux and macOS runners. Windows x64 and ARM64 runners install the x64 Windows binary; Windows ARM64 therefore requires x64 emulation.
The step exposes these outputs:
| Output | Value |
|---|---|
version |
Installed version without the v prefix |
target |
Installed Rust target triple |
install-dir |
Directory added to PATH |
Reference them through the step id, for example ${{ steps.scythe.outputs.version }}.
Prebuilt archives
Section titled “Prebuilt archives”Every release publishes five archives plus scythe_<version>_checksums.txt, which lists the SHA-256
of each one. cargo binstall, the npm package, the PyPI package and the GitHub Action all install
from these assets.
| Archive | Platform |
|---|---|
scythe-x86_64-unknown-linux-gnu.tar.gz |
Linux x64, glibc 2.28 or newer |
scythe-aarch64-unknown-linux-gnu.tar.gz |
Linux arm64, glibc 2.28 or newer |
scythe-x86_64-apple-darwin.tar.gz |
macOS x64 |
scythe-aarch64-apple-darwin.tar.gz |
macOS Apple silicon |
scythe-x86_64-pc-windows-msvc.zip |
Windows x64 |
Each archive is built natively on its own runner for its own target. There are no musl, 32-bit or Windows ARM64 builds; Windows ARM64 runs the x64 zip under emulation.
version=0.20.1base="https://github.com/Goldziher/scythe/releases/download/v${version}"curl -fsSLO "${base}/scythe-x86_64-unknown-linux-gnu.tar.gz"curl -fsSLO "${base}/scythe_${version}_checksums.txt"# --ignore-missing: the checksum file covers all five archives, only one was downloadedsha256sum --check --ignore-missing "scythe_${version}_checksums.txt"tar -xzf scythe-x86_64-unknown-linux-gnu.tar.gz./scythe --versionThe Linux and macOS archives contain, flat at the root: scythe, scythe-pg15-parser,
scythe-pg18-parser, pg-parser-manifest.json, THIRD_PARTY_LICENSES.txt, PARSER_PROTOCOL.md,
CHANGELOG.md, LICENSE and README.md. The two parser helpers are the pinned PostgreSQL 15 and
PostgreSQL 18 grammars that scythe audit --cluster-scope executes; keep them in the same directory
as scythe, or point SCYTHE_PG_PARSER_DIR at them. See the
cluster-scope gate.
The Windows zip carries scythe.exe and, in place of the two helpers, a
PARSER_HELPERS_UNAVAILABLE.txt notice, because upstream libpg_query needs POSIX socket headers
Windows does not provide. Every command works there except scythe audit --cluster-scope, which
exits 1 with a missing-helper error instead of running an unchecked gate.
Pre-commit / prek
Section titled “Pre-commit / prek”If you only need scythe for pre-commit hooks, add it directly to your .pre-commit-config.yaml:
repos: - repo: https://github.com/Goldziher/scythe rev: v0.20.3 hooks: - id: scythe-fmt - id: scythe-lintSee Pre-commit Hooks for all available hooks and configuration.
Verify Installation
Section titled “Verify Installation”scythe --version