Installation

Prerequisites

Before installing Crypto Finder, ensure you have the following:

Scanner: Crypto Finder requires either OpenGrep (recommended) or Semgrep.
Note: OpenGrep is the default scanner used by Crypto Finder.
Go 1.23+ and Git: Required only when building from source or installing via the Go package manager.

Go

If you have Go installed, run the following command to install Crypto Finder from its package path:

go install github.com/scanoss/crypto-finder/cmd/crypto-finder@latest

Verify installation

crypto-finder

Docker

Two Docker images are available: a full image with all scanners pre-installed, and a slim image for use with an externally provided scanner.

# Full image with scanners included (recommended)
docker pull ghcr.io/scanoss/crypto-finder:latest

# Slim image (requires an external scanner; see Prerequisites)
docker pull ghcr.io/scanoss/crypto-finder:latest-slim

Build from Source

Windows

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

Add to PATH (optional):

   $currentPath = (Get-Location).Path
   [Environment]::SetEnvironmentVariable("PATH", "$env:PATH;$currentPath",
   [EnvironmentVariableTarget]::User)

Note: Restart PowerShell after modifying the PATH for the change to take effect.

Verify installation:

   # If added to PATH
   crypto-finder

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

macOS

Clone, compile, and install:

   git clone https://github.com/scanoss/crypto-finder.git
   cd crypto-finder
   make build
   sudo make install

Verify installation:

   crypto-finder

Linux

Clone, compile, and install:

   git clone https://github.com/scanoss/crypto-finder.git
   cd crypto-finder
   make build
   sudo make install

Verify installation:

   crypto-finder

Documentation

Links

Installation

Prerequisites

Installation

Go

Docker

Build from Source

Windows

macOS

Linux

​Prerequisites

​Installation

​Go

​Docker

​Build from Source

​Windows

​macOS

​Linux

Prerequisites

Installation

Go

Docker

Build from Source

Windows

macOS

Linux