Skip to content

Installation

Terminal window
cargo install scythe-cli

cargo-binstall is also supported and downloads the prebuilt binary instead of compiling from source:

Terminal window
cargo binstall scythe-cli

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.

Terminal window
npm install --save-dev scythe-cli
npx scythe --version

Supports Linux (x64/arm64, glibc only), 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).

Terminal window
pip install scythe-sql
scythe --version

pip 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.

Terminal window
brew install Goldziher/tap/scythe

Pre-built binaries are available for macOS (arm64, x86_64) and Linux (x86_64, arm64). No Rust toolchain needed.

Terminal window
git clone https://github.com/Goldziher/scythe.git
cd scythe
cargo install --path crates/scythe-cli

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.15.0
hooks:
- id: scythe-fmt
- id: scythe-lint

See Pre-commit Hooks for all available hooks and configuration.

Terminal window
scythe --version