Install

Choose the path that matches your environment.

go install
GitHub Releases
From source

go install github.com/sgoveia/cryptarium/cmd/cryptarium@v0.3.0

Ensure $(go env GOPATH)/bin is on your PATH, then verify:

cryptarium version

Pre-built binaries for linux, darwin, and windows (amd64 / arm64) are attached to each tagged release.Download the archive for your platform, extract cryptarium, and place it on your PATH. Default rule packs are embedded in the binary — you do not need a rules/ directory beside it.

Clone the repository and build with the project Makefile:

git clone https://github.com/sgoveia/cryptarium.git
cd cryptarium
make build   # -> bin/cryptarium
./bin/cryptarium version

GitHub Action

For CI, prefer the published Action rather than installing the binary by hand:

- uses: sgoveia/cryptarium@v0.3.0
  with:
    path: .
    fail-on: critical
    upload-sarif: true

See CI/CD & workflow integration for the DevOps playbook, and GitHub Action for Action inputs. Remote HTTPS scans from a developer machine need git on PATH. The Action typically scans a local workspace checkout (path: .).

Continue to Quickstart for your first scan.

Get started

Concepts

Detectors & rules

Guides

Reference

Install

Install

GitHub Action

Next