Sign inSign up

vigilnz/cli

By vigilnz

•Updated about 1 month ago

Scan your local projects for security vulnerabilities

Image
Security
0

135

vigilnz/cli repository overview

⁠Vigilnz CLI

Scan your source code and Docker images for security issues with the Vigilnz CLI.

Vigilnz detects:

  • Vulnerable dependencies (SCA)
  • Hardcoded secrets
  • Insecure code patterns (SAST)
  • Infrastructure-as-code misconfigurations (IaC)
  • Software Bill of Materials (SBOM)
  • Docker image vulnerabilities

Scan results are available in your Vigilnz dashboard.

⁠Quick Start

⁠Authentication

Create an API key from your Vigilnz account.

You can provide the API key in two ways.

⁠Option 1: Set the API key as an environment variable

Linux / macOS:

export VIGILNZ_API_KEY="<apikey>"

Windows PowerShell:

$env:VIGILNZ_API_KEY="<apikey>"

Windows Command Prompt:

set VIGILNZ_API_KEY=<apikey>

Then use the variable in your Docker command.

⁠Scan your project

Linux / macOS:

docker run --rm \
  -e VIGILNZ_API_KEY \
  -v "$PWD:/workspace:ro" \
  vigilnz/cli:0.0.1 scan

Windows PowerShell:

docker run --rm `
  -e VIGILNZ_API_KEY `
  -v "${PWD}:/workspace:ro" `
  vigilnz/cli:0.0.1 scan

Windows Command Prompt:

docker run --rm -e VIGILNZ_API_KEY -v "%cd%:/workspace:ro" vigilnz/cli:0.0.1 scan
⁠Option 2: Pass the API key directly

You can also provide the API key directly in the Docker command.

Linux / macOS:

docker run --rm \
  -e VIGILNZ_API_KEY="<apikey>" \
  -v "$PWD:/workspace:ro" \
  vigilnz/cli:0.0.1 scan

Windows PowerShell:

docker run --rm `
  -e VIGILNZ_API_KEY="<apikey>" `
  -v "${PWD}:/workspace:ro" `
  vigilnz/cli:0.0.1 scan

Windows Command Prompt:

docker run --rm -e VIGILNZ_API_KEY="<apikey>" -v "%cd%:/workspace:ro" vigilnz/cli:0.0.1 scan

Your project is mounted as read-only, so Vigilnz does not modify your source code.

⁠Scan a Docker Image

Scan a Docker image already available on your machine.

Linux / macOS:

docker run --rm \
  -e VIGILNZ_API_KEY \
  -v /var/run/docker.sock:/var/run/docker.sock \
  --group-add 0 \
  vigilnz/cli:0.0.1 scan-image <image>

Windows PowerShell:

docker run --rm `
  -e VIGILNZ_API_KEY `
  -v /var/run/docker.sock:/var/run/docker.sock `
  --group-add 0 `
  vigilnz/cli:0.0.1 scan-image <image>

Windows Command Prompt:

docker run --rm -e VIGILNZ_API_KEY -v /var/run/docker.sock:/var/run/docker.sock --group-add 0 vigilnz/cli:0.0.1 scan-image <image>

Example:

docker run --rm \
  -e VIGILNZ_API_KEY \
  -v /var/run/docker.sock:/var/run/docker.sock \
  --group-add 0 \
  vigilnz/cli:0.0.1 scan-image alpine:3.19

Docker image scanning requires access to the host Docker socket. The CLI does not use Docker-in-Docker and does not require --privileged.

⁠Supported Scans

ScanDescription
SASTDetect insecure code patterns
SecretDetect hardcoded secrets and credentials
SCADetect vulnerable dependencies
IaCDetect infrastructure-as-code misconfigurations
SBOMGenerate a software bill of materials
ContainerScan Docker images for vulnerabilities

⁠Common Commands

⁠Check Authentication
docker run --rm \
  -e VIGILNZ_API_KEY \
  vigilnz/cli:0.0.1 whoami
⁠Show Help
docker run --rm vigilnz/cli:0.0.1 --help
⁠Scan Specific Types
docker run --rm \
  -e VIGILNZ_API_KEY \
  -v "$PWD:/workspace:ro" \
  vigilnz/cli:0.0.1 scan --scan-types secret,sca
⁠JSON Output
docker run --rm \
  -e VIGILNZ_API_KEY \
  -v "$PWD:/workspace:ro" \
  vigilnz/cli:0.0.1 scan --json > report.json

⁠CI/CD

Use Vigilnz CLI in your CI/CD pipelines to automatically detect security issues before deployment.

docker run --rm \
  -e VIGILNZ_API_KEY \
  -v "$PWD:/workspace:ro" \
  vigilnz/cli:0.0.1 scan \
  --fail-on high \
  --remote

--fail-on high returns a non-zero exit code when high or critical findings are detected.

⁠Version

Current release: 0.0.1

For CI/CD pipelines, use a specific version such as vigilnz/cli:0.0.1 instead of latest to ensure consistent builds.

⁠Platform

Currently supported:

  • Linux AMD64
  • Linux ARM64

⁠Links

⁠License

Unlicensed

Tag summary

Content type

Image

Digest

sha256:2a6332640…

Size

56.8 MB

Last updated

about 1 month ago

docker pull vigilnz/cli:0.0.1