Installation

Get started with Vypher by choosing the installation method that works best for your environment.

macOS (Homebrew) - Recommended

The easiest way to install Vypher on macOS is using our one-line installer:


curl -fsSL https://raw.githubusercontent.com/vypher-io/vypher/main/packaging/homebrew/install.sh | bash

Or install via Homebrew directly:


# Add the Vypher tap
brew tap vypher-io/vypher
 
# Install Vypher
brew install vypher

Updating via Homebrew


brew update && brew upgrade vypher

Pre-built Binaries

Download the latest release for your platform from GitHub Releases .

Linux


# Download for Linux x64
wget https://github.com/vypher-io/vypher/releases/latest/download/vypher-linux-amd64.tar.gz
 
# Extract and install
tar -xzf vypher-linux-amd64.tar.gz
sudo mv vypher /usr/local/bin/

Windows

Download vypher-windows-amd64.zip from the releases page
Extract the archive
Add the vypher.exe location to your PATH environment variable

macOS (Manual)


# Download for macOS
wget https://github.com/vypher-io/vypher/releases/latest/download/vypher-darwin-amd64.tar.gz
 
# Extract and install
tar -xzf vypher-darwin-amd64.tar.gz
sudo mv vypher /usr/local/bin/

Docker

Run Vypher using Docker without installing it locally:


# Pull the latest image
docker pull ghcr.io/vypher-io/vypher:latest
 
# Scan a directory (mount your local directory)
docker run --rm -v /path/to/scan:/data ghcr.io/vypher-io/vypher:latest scan /data

Docker Compose

Create a docker-compose.yml file:


version: '3.8'
services:
  vypher:
    image: ghcr.io/vypher-io/vypher:latest
    volumes:
      - ./data:/data
    command: scan /data --output-format json --output-file /data/results.json

Run with:


docker-compose run vypher

Build from Source

If you have Go 1.21+ installed, you can build Vypher from source:


# Clone the repository
git clone https://github.com/vypher-io/vypher.git
cd vypher
 
# Build the binary
go build -o bin/vypher ./cmd/vypher
 
# Install to system PATH (optional)
sudo mv bin/vypher /usr/local/bin/

Development Build

For development with all dependencies:


# Install dependencies
go mod download
 
# Run tests
go test ./...
 
# Build with version info
go build -ldflags "-X main.version=dev -X main.buildDate=$(date)" -o bin/vypher ./cmd/vypher

Verify Installation

Check that Vypher is installed correctly:


# Check version
vypher version
 
# List available commands
vypher --help
 
# List available detectors
vypher list-detectors

System Requirements

Memory: Minimum 1GB RAM (2GB+ recommended for large repositories)
Disk Space: 50MB for binary + space for scan results
Operating System:
- macOS 10.15+ (Catalina)
- Linux (most distributions)
- Windows 10+

Troubleshooting

Permission Denied (macOS/Linux)

If you get a “permission denied” error:


chmod +x vypher

Command Not Found

Ensure the binary is in your PATH:


# Check current PATH
echo $PATH
 
# Add to PATH temporarily
export PATH=$PATH:/path/to/vypher
 
# Add to PATH permanently (add to ~/.bashrc or ~/.zshrc)
echo 'export PATH=$PATH:/usr/local/bin' >> ~/.bashrc

Homebrew Issues

If Homebrew installation fails:


# Update Homebrew
brew update
 
# Clear cache
brew cleanup
 
# Try installation again
brew install vypher-io/vypher/vypher

Next Steps

Once installed, proceed to the Quick Start Guide to learn basic usage, or check out the Configuration Guide for advanced setup options.