Skip to content

A terminal user interface for managing WireGuard VPN tunnels.

License

Notifications You must be signed in to change notification settings

excoffierleonard/wg-tui

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

48 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

wg-tui

A terminal user interface for managing WireGuard VPN tunnels.

Features

  • List and manage WireGuard tunnels
  • Start/stop tunnels with a single keypress
  • View tunnel details (peers, endpoints, transfer statistics)
  • Create new client and server tunnels
  • Add peers to server configs and generate client configs
  • Import tunnels from .conf files or zip archives
  • Export all tunnels to a zip archive
  • Show peer configs and QR codes for easy onboarding
  • Delete tunnels

Requirements

  • Linux
  • WireGuard tools (wg, wg-quick)
  • ip command (iproute2)
  • Root privileges (the application will prompt for sudo if needed)

Installation

With Cargo

cargo install wg-tui

For Linux

curl -fsSL https://raw.githubusercontent.com/excoffierleonard/wg-tui/main/scripts/install.sh | sh

Usage

wg-tui

Keybindings

Key Action
j / Down Move selection down
k / Up Move selection up
Enter / Space Toggle tunnel (start/stop)
d Toggle details panel
a Add/import tunnel (menu)
p Add peer to selected server tunnel
e Export all tunnels to zip
x Delete selected tunnel
r Refresh tunnel list
g Jump to first tunnel
G Jump to last tunnel
? Show help
q / Esc Quit

License

MIT License - see LICENSE for details.