Skip to content

Getting Started

Installation

From Source

Requires Go 1.21+ and Xcode Command Line Tools (for cgo/libproc).

git clone https://github.com/plexusone/workloadguard.git
cd workloadguard
make install

This installs:

  • Binary to ~/bin/workloadguard
  • Default config to ~/.config/workloadguard/config.toml

As a launchd Service

To run WorkloadGuard automatically at login:

make install-launchd
launchctl bootstrap gui/$UID ~/Library/LaunchAgents/com.plexusone.workloadguard.plist

To stop and uninstall:

make uninstall-launchd

Quick Start

One-shot Check

See current system state and policy evaluation without starting the daemon:

workloadguard check --config ~/.config/workloadguard/config.toml

Text output:

workloadguard check -o text

Dry Run

Test the daemon without terminating anything:

workloadguard run --dry-run

Production Run

Start the daemon:

workloadguard run

With Prometheus metrics:

workloadguard run --metrics --addr :9090

With the JSON API and WebSocket server:

workloadguard run --api --addr :9090

Both can be enabled together on the same address — see the JSON API Guide.

Next Steps