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.
npm install --save-dev scythe-clinpx scythe --versionSupports 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).
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-cliPre-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.15.0 hooks: - id: scythe-fmt - id: scythe-lintSee Pre-commit Hooks for all available hooks and configuration.
Verify Installation
Section titled “Verify Installation”scythe --version