🚧 DevGuard & this page is under active development. Visit the DevGuard Repo →

Installation Guide

This guide covers installing all DevGuard components:

DevGuard Scanner - CLI tool for security scanning
DevGuard CLI - Management tool for advanced operations
DevGuard Platform - Backend API and web UI (self-hosted)

DevGuard Scanner

The scanner is the primary tool for running security scans. It’s a standalone binary with no dependencies.

System Requirements

OS: Linux (x86_64, arm64), macOS (Intel, Apple Silicon), Windows (x86_64)
Network: Access to your used DevGuard Instance

Installation Methods

Go Install (Recommended)

Requires Go 1.21 or later.

# Install latest version
go install github.com/l3montree-dev/devguard/cmd/devguard-scanner@latest
 
# Install specific version
go install github.com/l3montree-dev/devguard/cmd/devguard-scanner@v1.0.0
 
# Ensure Go bin is in PATH
export PATH="$PATH:$(go env GOPATH)/bin"

Verify installation:

devguard-scanner --version

Tip: Add the PATH export to your ~/.bashrc or ~/.zshrc for permanent access

Docker

# Pull latest image
docker pull ghcr.io/l3montree-dev/devguard-scanner:latest
 
# Run scanner (mount current directory)
docker run --rm \
  -v $(pwd):/app \
  ghcr.io/l3montree-dev/devguard-scanner:latest \
  sca

Create convenient alias:

# Add to ~/.bashrc or ~/.zshrc
alias devguard-scanner='docker run --rm -v $(pwd):/app ghcr.io/l3montree-dev/devguard-scanner:latest'
 
# Now use like normal CLI
devguard-scanner sca

Docker Compose example:

services:
  scanner:
    image: ghcr.io/l3montree-dev/devguard-scanner:latest
    volumes:
      - ./:/app
    working_dir: /app
    command: sca

Binary Release

Download pre-built binaries from GitHub Releases.

Linux (x86_64):

curl -L https://github.com/l3montree-dev/devguard/releases/latest/download/devguard-scanner_Linux_x86_64.tar.gz | tar xz
sudo mv devguard-scanner /usr/local/bin/

macOS (Intel):

curl -L https://github.com/l3montree-dev/devguard/releases/latest/download/devguard-scanner_Darwin_x86_64.tar.gz | tar xz
sudo mv devguard-scanner /usr/local/bin/

macOS (Apple Silicon):

curl -L https://github.com/l3montree-dev/devguard/releases/latest/download/devguard-scanner_Darwin_arm64.tar.gz | tar xz
sudo mv devguard-scanner /usr/local/bin/

Windows:

# Download from https://github.com/l3montree-dev/devguard/releases
# Extract devguard-scanner.exe
# Move to C:\Program Files\DevGuard\
# Add to PATH

Verify installation:

devguard-scanner --version

Build from Source

Requires Go 1.21 or later.

# Clone repository
git clone https://github.com/l3montree-dev/devguard
cd devguard
 
# Build scanner
make devguard-scanner
 
# Install to system
sudo cp devguard-scanner /usr/local/bin/
 
# Or add to PATH
export PATH="$PATH:$(pwd)"

Verify:

devguard-scanner --version

Run directly from source (development):

go run ./cmd/devguard-scanner/main.go --help

DevGuard CLI

The CLI tool provides additional management capabilities for vulnerability databases, licenses, and advanced operations.

# Install latest version
go install github.com/l3montree-dev/devguard/cmd/devguard-cli@latest
 
# Verify
devguard-cli --version

# Pull image
docker pull ghcr.io/l3montree-dev/devguard-cli:latest
 
# Create alias
alias devguard-cli='docker run --rm -v $(pwd):/work ghcr.io/l3montree-dev/devguard-cli:latest'

DevGuard Platform (Self-Hosted)

The platform provides centralized vulnerability management, web UI, and API.

Prerequisites

A Kuberntes Cluster or Docker and Docker Compose
About 2GB+ RAM
About 20GB+ disk space

Deployment Options

See the Helm Deployment Guide for Kubernetes installation instructions.

Next Steps

Quick Start Guide - Run your first scan
Core Concepts - Understand DevGuard architecture

💡

Need help? Join our discussions or check out the matrix chat.

Quickstart Your First Scan