Installation Guide

This guide covers installing all DevGuard components:

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

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

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

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