wg-toggle 1.0.0

Toggle Wireguard connection state
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
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119

# 🔐 Waybar WireGuard VPN Toggle (Rust)

A lightweight, fast, and minimal Rust-based utility for managing WireGuard VPNs via NetworkManager (`nmcli`). Built for integration into Waybar as a `custom` module, it allows users to:

- Toggle VPN on/off with a click
- Rotate between configured VPNs via scroll or right-click
- Display current VPN status in Waybar
- Output proper JSON for color and icon styling

---

## 📦 Features

- 🚀 Written in Rust for speed and safety
- 🧠 Remembers current VPN between reboots (`/tmp/wg-current`)
- 🖱️ Scroll or right-click to cycle through VPN configs
- 🎨 Emits Waybar-compatible JSON for visual theming

---

## 🛠 Dependencies

- [`NetworkManager`](https://wiki.archlinux.org/title/NetworkManager)
- WireGuard support via `nmcli` (import `.conf` files with `nmcli connection import`)
- [`waybar`](https://github.com/Alexays/Waybar) with `custom` module support

---

## 🔧 Installation

### 1. Clone and build

```bash
git clone https://github.com/yourusername/wg-waybar-toggle
cd wg-waybar-toggle
cargo build --release
```

### 2. Move binary to somehwere in your `$PATH`:

```bash
cp target/release/wg-toggle ~/.local/vin/
```

## 🖼️ Waybar Integration

### Example module config:

```json
"custom/wg": {
  "exec": "~/.local/bin/wg-toggle --status",
  "return-type": "json",
  "interval": 10,
  "on-click": "~/.local/bin/wg-toggle",
  "on-click-right": "~/.local/bin/wg-toggle next",
  "on-scroll-up": "~/.local/bin/wg-toggle previous",
  "on-scroll-down": "~/.local/bin/wg-toggle next",
  "tooltip": true
}
```

### Example CSS:

```css
#custom-wg.active {
  background-color: #a6e3a1;
  color: #1e1e2e;
}

#custom-wg.inactive {
  background-color: #45475a;
  color: #cdd6f4;
}
```

## ⚙️ Behavior

| Action           | Result                        |
|------------------|-------------------------------|
| Left Click       | Toggle current VPN on/off     |
| Scroll Up        | Switch to previous VPN config |
| Scroll Down      | Switch to next VPN config     |
| Right Click      | Switch to next VPN config     |
| Auto-refresh     | Show current VPN status       |

## 📁 VPN Configuration

Use `nmcli` to import `.conf` files:

```bash
nmcli connection import type wireguard file wg-home.conf
nmcli connection import type wireguard file wg-work.conf
```

Names must be valid Linux interface names (`<=15` characters, no spaces).

## 🧪 Debugging

To test the output:

```bash
~/.local/bin/wg-toggle --status
~/.local/bin/wg-toggle
~/.local/bin/wg-toggle next
```

## 🪪 License

MIT

## 🤝 Contributing

Pull requests and suggestions are very welcome!  
If you'd like to improve the script, support more VPN managers, or enhance the Waybar integration, feel free to open an issue or PR.

Please ensure any code contributions:
- Are formatted with `rustfmt`
- Include basic error handling
- Preserve existing CLI behavior