{"name":"wireguard-tools: Essential Utilities for WireGuard VPN Configuration","description":"wireguard-tools provides the core userspace utilities for configuring WireGuard VPN tunnels across multiple operating systems. This project includes the `wg` and `wg-quick` tools, simplifying the setup and management of secure network connections. It supports Linux, OpenBSD, FreeBSD, macOS, Windows, and Android, making it a versatile solution for WireGuard users.","github":"https://github.com/wireguard/wireguard-tools","url":"https://osrepos.com/repo/wireguard-wireguard-tools","source":"osrepos.com","sourceDescription":"This repository profile is provided by osrepos.com, an open source repository discovery platform.","repositoryProfile":"https://osrepos.com/repo/wireguard-wireguard-tools","generatedFor":"open source discovery and AI-assisted research","markdown":"https://osrepos.com/repo/wireguard-wireguard-tools.md","json":"https://osrepos.com/repo/wireguard-wireguard-tools.json","topics":["WireGuard","Networking","VPN","C","Utilities","Open Source","Linux","Security"],"keywords":["WireGuard","Networking","VPN","C","Utilities","Open Source","Linux","Security"],"stars":null,"summary":"wireguard-tools provides the core userspace utilities for configuring WireGuard VPN tunnels across multiple operating systems. This project includes the `wg` and `wg-quick` tools, simplifying the setup and management of secure network connections. It supports Linux, OpenBSD, FreeBSD, macOS, Windows, and Android, making it a versatile solution for WireGuard users.","content":"## Introduction\n\n`wireguard-tools` provides the essential userspace utilities for configuring [WireGuard](https://www.wireguard.com/ \"WireGuard Official Website\" target=\"_blank\" rel=\"noopener\") VPN tunnels. This project includes the primary command-line tools, [`wg(8)`](https://git.zx2c4.com/wireguard-tools/about/src/man/wg.8 \"wg(8) man page\" target=\"_blank\" rel=\"noopener\") and [`wg-quick(8)`](https://git.zx2c4.com/wireguard-tools/about/src/man/wg-quick.8 \"wg-quick(8) man page\" target=\"_blank\" rel=\"noopener\"), which are crucial for setting up and managing WireGuard interfaces. It offers broad compatibility, supporting various operating systems including Linux, OpenBSD, FreeBSD, macOS, Windows, and Android. While this GitHub repository serves as a mirror, the official development takes place at [git.zx2c4.com/wireguard-tools](https://git.zx2c4.com/wireguard-tools \"Official wireguard-tools Git Repository\" target=\"_blank\" rel=\"noopener\").\n\n## Installation\n\nBuilding and installing `wireguard-tools` is straightforward.\n\nTo build the tools:\n\nbash\ncd src\nmake\n\n\nThere are no external dependencies beyond a standard C compiler and libc.\n\nTo install the tools:\n\nbash\nmake install\n\n\nThe installation process can be customized using several environment variables. For instance, `PREFIX` defaults to `/usr`, `BINDIR` to `$(PREFIX)/bin`, and `MANDIR` to `$(PREFIX)/share/man`. Other variables like `WITH_BASHCOMPLETION`, `WITH_WGQUICK`, and `WITH_SYSTEMDUNITS` allow you to control the installation of bash completion files, the `wg-quick(8)` script, and systemd units, respectively. These can be set to `yes` or `no` to force or prevent their installation, overriding auto-detection.\n\n## Examples\n\nThe `contrib/` subdirectory within the repository contains various scripts and examples. While not all are intended for direct production use, they serve as valuable inspiration and starting points for developing custom tools or integrating WireGuard into existing systems. Each subdirectory typically includes its own `README` for more specific guidance.\n\n## Why Use It\n\n`wireguard-tools` is indispensable for anyone using WireGuard, offering the foundational command-line interface to manage VPN connections. Its cross-platform support ensures a consistent experience across different environments. The `wg-quick` utility is particularly useful for rapid deployment and configuration, providing a simple way to get WireGuard tunnels up and running with minimal effort. For advanced users and distributors, the flexibility to integrate `wg(8)` directly into network managers or to customize installation options makes it a robust and adaptable solution.\n\n## Links\n\n*   **GitHub Mirror:** [https://github.com/WireGuard/wireguard-tools](https://github.com/WireGuard/wireguard-tools \"wireguard-tools GitHub Mirror\" target=\"_blank\" rel=\"noopener\")\n*   **Official Repository:** [https://git.zx2c4.com/wireguard-tools](https://git.zx2c4.com/wireguard-tools \"Official wireguard-tools Git Repository\" target=\"_blank\" rel=\"noopener\")\n*   **WireGuard Official Website:** [https://www.wireguard.com/](https://www.wireguard.com/ \"WireGuard Official Website\" target=\"_blank\" rel=\"noopener\")\n*   **`wg(8)` Man Page:** [https://git.zx2c4.com/wireguard-tools/about/src/man/wg.8](https://git.zx2c4.com/wireguard-tools/about/src/man/wg.8 \"wg(8) man page\" target=\"_blank\" rel=\"noopener\")\n*   **`wg-quick(8)` Man Page:** [https://git.zx2c4.com/wireguard-tools/about/src/man/wg-quick.8](https://git.zx2c4.com/wireguard-tools/about/src/man/wg-quick.8 \"wg-quick(8) man page\" target=\"_blank\" rel=\"noopener\")","metrics":{"detailViews":9,"githubClicks":16},"dates":{"published":null,"modified":"2026-06-04T07:47:56.000Z"}}