{"id":14044666,"url":"https://github.com/muqiuq/wgcfghelp","last_synced_at":"2026-04-04T18:34:59.515Z","repository":{"id":229192060,"uuid":"776021839","full_name":"muqiuq/wgcfghelp","owner":"muqiuq","description":"Wireguard Config Helper","archived":false,"fork":false,"pushed_at":"2024-09-09T11:46:19.000Z","size":79,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-09-09T13:56:13.205Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/muqiuq.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-03-22T14:19:18.000Z","updated_at":"2024-09-09T11:44:43.000Z","dependencies_parsed_at":"2024-05-03T12:10:24.477Z","dependency_job_id":null,"html_url":"https://github.com/muqiuq/wgcfghelp","commit_stats":null,"previous_names":["muqiuq/wgcfghelp"],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/muqiuq%2Fwgcfghelp","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/muqiuq%2Fwgcfghelp/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/muqiuq%2Fwgcfghelp/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/muqiuq%2Fwgcfghelp/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/muqiuq","download_url":"https://codeload.github.com/muqiuq/wgcfghelp/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":227822322,"owners_count":17825025,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-12T09:02:46.351Z","updated_at":"2026-04-04T18:34:59.465Z","avatar_url":"https://github.com/muqiuq.png","language":"C#","funding_links":[],"categories":["Projects"],"sub_categories":["User Interface"],"readme":"# WgCfgHelp - Wireguard Config Helper\n\nWireguard 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.\n\n## ⭐ Features\n - Manage RoadWarrior WireGuard configuration in a single YAML file\n - Bulk client access configuration generator\n - Generate QR Codes images alongside client config files\n - Outputs *[WgQuick](https://www.man7.org/linux/man-pages/man8/wg-quick.8.html) config files* or *MirkoTik commands*\n\n## 🧸 Motivation\n - I needed to create multiple client access configuration files.\n - I was looking for a tool that consisted of a single binary (with no dependencies) and ran on any operating system.\n - Previously, I used Python scripts to accomplish this, but I wanted a tool I could share with other IT colleagues.\n\n## 🚀 Upcoming features\n - Sync configuration with MikroTik Router\n - Generate site configuration from existing WgQuick configuration file\n\n## 🚧 Still In development\n\nThis 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**! \n\n## 🔧 Quick start\n\n### Requirements\n - [WireGuard](https://www.wireguard.com/install/)\n   - On macOS: Using homebrew\n   - On Windows: Using Installer\n   - On Linux: Using package manager\n\n### Steps\n\n 1. Download latest release\n\nLinux / MacOS (bash / zsh)\n```bash\n# Linux arm64\ncurl -L https://github.com/muqiuq/wgcfghelp/releases/latest/download/WgCfgHelp.CLI.linux-arm64 -o wgcfghelp \u0026\u0026 chmod +x wgcfghelp\n```\n```bash\n# Linux x64\ncurl -L https://github.com/muqiuq/wgcfghelp/releases/latest/download/WgCfgHelp.CLI.linux-x64 -o wgcfghelp \u0026\u0026 chmod +x wgcfghelp\n```\n```bash\n# MacOs x64 (works for arm64 too on macOS Sonoma 14.x)\ncurl -L https://github.com/muqiuq/wgcfghelp/releases/latest/download/WgCfgHelp.CLI.osx-x64  -o wgcfghelp \u0026\u0026 chmod +x wgcfghelp\n```\n\nWindows (PowerShell)\n```powershell\n# Windows x64\n$ProgressPreference = 'SilentlyContinue'; Invoke-WebRequest -Uri \"https://github.com/muqiuq/wgcfghelp/releases/latest/download/WgCfgHelp.CLI.x64.exe\" -OutFile \"wgcfghelp.exe\"; $ProgressPreference = 'Continue';\n```\n\n```powershell\n# Windows arm64\n$ProgressPreference = 'SilentlyContinue'; Invoke-WebRequest -Uri \"https://github.com/muqiuq/wgcfghelp/releases/latest/download/WgCfgHelp.CLI.arm64.exe\" -OutFile \"wgcfghelp.exe\"; $ProgressPreference = 'Continue';\n```\n\n 2. Create new site (this will create a yaml file CompanyXYRoadwarrior.yaml)\n```bash\n./wgcfghelp gen-site CompanyXYRoadwarrior \"192.168.9.0/24,192.168.10.0/24\" example.com:13328\n```\n\n 3. Create a folder to store the client config files\n```bash\nmkdir configfiles\n```\n\n 4. Create 5 new clients with configuration file and QRCodes\n```bash\n# this will output 192.168.9.2.conf and 192.168.9.2.png in the configfiles folder\n./wgcfghelp gen-client ./CompanyXYRoadwarrior.yaml -o -b ./configfiles 192.168.9.2 --qrcode -n 5\n```\n\n 5. Create server configuration \n```bash\n# this will output 192.168.9.1_24.conf\n./wgcfghelp gen-server ./CompanyXYRoadwarrior.yaml 192.168.9.1 -o\n```\n 6. Done. The files can now be distributed\n\n## ⌨️ Usage\n```bash\n./wgcfghelp --help\n\n# or for help of specific verb\n./wgcfghelp gen-site --help\n```\n\n## Copyright\n\n\"WireGuard\" and the \"WireGuard\" logo are registered trademarks of Jason A. Donenfeld.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmuqiuq%2Fwgcfghelp","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmuqiuq%2Fwgcfghelp","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmuqiuq%2Fwgcfghelp/lists"}