Skip to main content
The init command creates and configures the Panguard environment on your machine. It generates the default configuration file, sets up data directories, and detects your operating system and installed services for optimal defaults.

Usage

panguard init [options]

Options

--config
string
Path to a custom configuration file. If provided, init will merge your custom settings with detected defaults instead of creating a new file from scratch.
--lang
string
default:"en"
Set the default language for CLI output and notifications.

Examples

panguard init

What init Does

  1. Detects the OS and environment — identifies Linux distro, macOS version, or WSL setup
  2. Creates configuration directory~/.panguard/ with default config.yaml
  3. Sets up data directories — separate directories for Guard, Trap, and Scan data
  4. Detects running services — identifies web servers, databases, and other services to tailor scan and guard defaults
  5. Validates authentication — confirms you are logged in or prompts you to run panguard login
You only need to run init once per machine. Re-running it is safe — existing configuration will not be overwritten unless you explicitly provide a new config file.

Plan Requirements

Available on all plans including Community (Free).