Skip to main content

​
Prerequisites

Before installing Crypto Finder, ensure you have the following:
  • Scanner: Crypto Finder requires either OpenGrep or Semgrep
    Note: OpenGrep is the default scanner used by Crypto Finder.
  • Go 1.25+ and Git: Only required if building from source or installing via the Go package manager.

​
Installation

​
Go

If you have Go installed, install Crypto Finder directly. 
go install github.com/scanoss/crypto-finder/cmd/crypto-finder@latest
Verify Installation 
crypto-finder

​
Docker

Docker provides a complete, pre-configured environment with all scanners and dependencies included. 
# Full image with scanners included (recommended)
docker pull ghcr.io/scanoss/crypto-finder:latest

# Slim image (bring your own scanner)
docker pull ghcr.io/scanoss/crypto-finder:latest-slim

​
Build from Sources

​
Windows

  1. Open PowerShell and run: 
    git clone https://github.com/scanoss/crypto-finder.git
cd crypto-finder
go build -o crypto-finder.exe ./cmd/crypto-finder
  2. Add to PATH (Optional) 
    $currentPath = (Get-Location).Path
[Environment]::SetEnvironmentVariable("PATH", "$env:PATH;$currentPath", [EnvironmentVariableTarget]::User)
    Note: You’ll need to restart PowerShell after modifying the PATH.
  3. Verify Installation 
    # If added to PATH
crypto-finder

# Or run from current directory
.\crypto-finder.exe

​
macOS

  1. Clone, compile and install 
    git clone https://github.com/scanoss/crypto-finder.git
cd crypto-finder
make build
sudo make install
  2. Verify Installation 
    crypto-finder

​
Linux

  1. Clone, compile and install 
    git clone https://github.com/scanoss/crypto-finder.git
cd crypto-finder
make build
sudo make install
  2. Verify Installation 
    crypto-finder