WgCfgHelp - Wireguard Config Helper

Wireguard Config Helper is a lightweight CLI tool designed to make Wireguard VPN setup easy and efficient, enabling bulk configuration creation for deployments of any size.

⭐ Features

Manage RoadWarrior WireGuard configuration in a single YAML file
Bulk client access configuration generator
Generate QR Codes images alongside client config files
Outputs WgQuick config files or MirkoTik commands

🧸 Motivation

I needed to create multiple client access configuration files.
I was looking for a tool that consisted of a single binary (with no dependencies) and ran on any operating system.
Previously, I used Python scripts to accomplish this, but I wanted a tool I could share with other IT colleagues.

🚀 Upcoming features

Sync configuration with MikroTik Router
Generate site configuration from existing WgQuick configuration file

🚧 Still In development

This project is currently in development and not yet ready for production use. If you are excited about what we're building and want to contribute, we warmly welcome anyone to join our effort!

🔧 Quick start

Requirements

WireGuard
- On macOS: Using homebrew
- On Windows: Using Installer
- On Linux: Using package manager

Steps

Download latest release

Linux / MacOS (bash / zsh)

# Linux arm64
curl -L https://github.com/muqiuq/wgcfghelp/releases/latest/download/WgCfgHelp.CLI.linux-arm64 -o wgcfghelp && chmod +x wgcfghelp

# Linux x64
curl -L https://github.com/muqiuq/wgcfghelp/releases/latest/download/WgCfgHelp.CLI.linux-x64 -o wgcfghelp && chmod +x wgcfghelp

# MacOs x64 (works for arm64 too on macOS Sonoma 14.x)
curl -L https://github.com/muqiuq/wgcfghelp/releases/latest/download/WgCfgHelp.CLI.osx-x64  -o wgcfghelp && chmod +x wgcfghelp

Windows (PowerShell)

# Windows x64
$ProgressPreference = 'SilentlyContinue'; Invoke-WebRequest -Uri "https://github.com/muqiuq/wgcfghelp/releases/latest/download/WgCfgHelp.CLI.x64.exe" -OutFile "wgcfghelp.exe"; $ProgressPreference = 'Continue';

# Windows arm64
$ProgressPreference = 'SilentlyContinue'; Invoke-WebRequest -Uri "https://github.com/muqiuq/wgcfghelp/releases/latest/download/WgCfgHelp.CLI.arm64.exe" -OutFile "wgcfghelp.exe"; $ProgressPreference = 'Continue';

Create new site (this will create a yaml file CompanyXYRoadwarrior.yaml)

./wgcfghelp gen-site CompanyXYRoadwarrior "192.168.9.0/24,192.168.10.0/24" example.com:13328

Create a folder to store the client config files

mkdir configfiles

Create 5 new clients with configuration file and QRCodes

# this will output 192.168.9.2.conf and 192.168.9.2.png in the configfiles folder
./wgcfghelp gen-client ./CompanyXYRoadwarrior.yaml -o -b ./configfiles 192.168.9.2 --qrcode -n 5

Create server configuration

# this will output 192.168.9.1_24.conf
./wgcfghelp gen-server ./CompanyXYRoadwarrior.yaml 192.168.9.1 -o

Done. The files can now be distributed

⌨️ Usage

./wgcfghelp --help

# or for help of specific verb
./wgcfghelp gen-site --help

Copyright

"WireGuard" and the "WireGuard" logo are registered trademarks of Jason A. Donenfeld.

muqiuq / wgcfghelp