Installation

Homebrew (macOS and Linux)

The easiest way to install Vypher on macOS and Linux.

brew install vypher-io/tap/vypher

To update to the latest version:

brew upgrade vypher-io/tap/vypher

---

Scoop (Windows)

The easiest way to install Vypher on Windows.

scoop bucket add vypher-io https://github.com/vypher-io/scoop-bucket
scoop install vypher

To update to the latest version:

scoop update vypher

---

Docker

No installation required. Mount the directory you want to scan as a volume:

docker run --rm -v "$(pwd)":/scan pseudocoding/vypher scan --target /scan

See Integrations for more Docker usage examples.

---

Go Install

Requires Go 1.20+.

go install github.com/vypher-io/cli@latest

The vypher binary will be placed in $(go env GOPATH)/bin. Make sure that directory is on your PATH:

export PATH="$PATH:$(go env GOPATH)/bin"

---

Build from Source

git clone https://github.com/vypher-io/cli.git
cd cli
go build -o vypher .

Move the binary somewhere on your PATH:

mv vypher /usr/local/bin/vypher

---

Verify Installation

vypher --help

You should see output like:

Vypher is a CLI tool designed to scan directories for Personally Identifiable Information (PII)
and Protected Health Information (PHI) with a focus on finance and healthcare data.

Usage:
  vypher [command]

Available Commands:
  scan        Scan a directory for PII/PHI
  help        Help about any command

Flags:
  -c, --config string   config file (e.g. .vypher.yaml)
  -h, --help            help for vypher