Install
Pre-built binaries
Section titled “Pre-built binaries”Download from GitHub Releases — no Rust or Homebrew required.
# Apple Silicon (M1/M2/M3/M4)curl -L https://github.com/robertlangdonn/vcfkit/releases/latest/download/vcfkit-aarch64-apple-darwin.tar.gz | tar xzsudo mv vcfkit /usr/local/bin/
# Intel Maccurl -L https://github.com/robertlangdonn/vcfkit/releases/latest/download/vcfkit-x86_64-apple-darwin.tar.gz | tar xzsudo mv vcfkit /usr/local/bin/# x86_64 (most servers and desktops)curl -L https://github.com/robertlangdonn/vcfkit/releases/latest/download/vcfkit-x86_64-unknown-linux-musl.tar.gz | tar xzsudo mv vcfkit /usr/local/bin/
# ARM64 (e.g. Graviton, Raspberry Pi)curl -L https://github.com/robertlangdonn/vcfkit/releases/latest/download/vcfkit-aarch64-unknown-linux-musl.tar.gz | tar xzsudo mv vcfkit /usr/local/bin/Windows
Section titled “Windows”Download vcfkit-x86_64-pc-windows-msvc.zip from GitHub Releases, extract, and add the folder to your PATH.
Or with PowerShell:
$url = "https://github.com/robertlangdonn/vcfkit/releases/latest/download/vcfkit-x86_64-pc-windows-msvc.zip"Invoke-WebRequest $url -OutFile vcfkit.zipExpand-Archive vcfkit.zip -DestinationPath $env:LOCALAPPDATA\vcfkit# Add $env:LOCALAPPDATA\vcfkit to your PATH via System Settings > Environment VariablesInstall script (macOS / Linux)
Section titled “Install script (macOS / Linux)”curl -fsSL https://vcfkit.dev/install.sh | shFrom crates.io
Section titled “From crates.io”cargo install vcfkit-cliRequires Rust 1.75+. Install Rust from rustup.rs if needed.
Build from source
Section titled “Build from source”git clone https://github.com/robertlangdonn/vcfkitcd vcfkitcargo build --release./target/release/vcfkit --versionShell completions
Section titled “Shell completions”# Bashvcfkit completions bash >> ~/.bashrc
# Zshvcfkit completions zsh >> ~/.zshrc
# Fishvcfkit completions fish > ~/.config/fish/completions/vcfkit.fishVerify install
Section titled “Verify install”echo '##fileformat=VCFv4.2#CHROM POS ID REF ALT QUAL FILTER INFOchr1 100 . A T . . .' | vcfkit filter -e 'POS > 50'Expected: the header lines followed by the variant, plus a stats summary.
Requirements
Section titled “Requirements”- No runtime dependencies — single static binary
- Reference FASTA files for
normalize(-r/--ref) — download from UCSC or Ensembl - Chain files for
liftover(--chain) — see liftover docs ANTHROPIC_API_KEYforfilter --ask— see filter docs