> ## Documentation Index
> Fetch the complete documentation index at: https://docs.scanoss.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Installation

> Get started with SCANOSS Crypto Finder. Choose from Docker, package managers, or build from source.

## Prerequisites

Before installing Crypto Finder, ensure you have the following:

* **Scanner**: Crypto Finder requires either [OpenGrep (recommended)](https://github.com/opengrep/opengrep)
  or [Semgrep](https://github.com/semgrep/semgrep).
  > **Note:** OpenGrep is the **default scanner** used by Crypto Finder.
* [Go 1.23+](https://go.dev/dl/) and [Git](https://git-scm.com/install/): Required only
  when building from source or installing via the Go package manager.

## Installation

### Go

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

```bash theme={null}
go install github.com/scanoss/crypto-finder/cmd/crypto-finder@latest
```

**Verify installation**

```bash theme={null}
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.

```bash theme={null}
# 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

1. Open PowerShell and run:

```powershell theme={null}
   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):

```powershell theme={null}
   $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.

3. Verify installation:

```powershell theme={null}
   # If added to PATH
   crypto-finder

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

#### macOS

1. Clone, compile, and install:

```bash theme={null}
   git clone https://github.com/scanoss/crypto-finder.git
   cd crypto-finder
   make build
   sudo make install
```

2. Verify installation:

```bash theme={null}
   crypto-finder
```

#### Linux

1. Clone, compile, and install:

```bash theme={null}
   git clone https://github.com/scanoss/crypto-finder.git
   cd crypto-finder
   make build
   sudo make install
```

2. Verify installation:

```bash theme={null}
   crypto-finder
```