Install
From crates.io (recommended)
Section titled “From crates.io (recommended)”cargo install vcfkit-clivcfkit --version# vcfkit 0.1.5Requires Rust 1.75+. Install Rust from rustup.rs if needed.
Pre-built binaries
Section titled “Pre-built binaries”Download from GitHub Releases — no Rust required.
Available for:
- macOS (aarch64 / x86_64)
- Linux (x86_64 / aarch64)
- Windows (x86_64)
# macOS examplecurl -L https://github.com/robertlangdonn/vcfkit/releases/latest/download/vcfkit-aarch64-apple-darwin.tar.gz | tar xz./vcfkit --versionBuild 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 output: the header + the variant line + a stats line.
Requirements
Section titled “Requirements”- No runtime dependencies — single static binary
- Reference FASTA files for
normalizeandliftover(not included; download from UCSC or Ensembl) - Chain files for
liftover(see liftover docs)