Skip to main content

Prerequisites

You need the following before you install Crypto Finder:
  • A scanner, either OpenGrep (recommended) or Semgrep. The Docker images include both.
    Crypto Finder uses OpenGrep as its default scanner. OpenGrep 1.12.1 is the minimum supported version. With any version other than 1.30.2, Crypto Finder runs the opengrep CLI instead of the faster default core mode. See OpenGrep execution mode.
  • Go 1.25+ and Git, but only if you build from source or install with the Go package manager.

Installation

Go

If you have Go installed, install Crypto Finder from its package path:
To verify the installation, run:

Docker

Crypto Finder has three Docker images. The larger images include more tooling:
Docker usage compares the images in full and covers dependency-scanning workflows.

Build from source

Windows

  1. Open PowerShell and run:
  1. Optionally, add the folder to your PATH:
Note: Restart PowerShell after you change the PATH, so the change takes effect.
  1. Verify the installation:

macOS

  1. Clone, compile, and install:
  1. Verify the installation:

Linux

  1. Clone, compile, and install:
  1. Verify the installation: