wg-tui 0.3.2

A terminal user interface for managing WireGuard VPN tunnels
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64

# 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

```bash
cargo install wg-tui
```

### For Linux

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

## Usage

```bash
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](LICENSE) for details.