omarchy-vpn

README

omarchy-vpn

A blazing fast WireGuard VPN manager for your terminal.
Built with Bubble Tea v2 + Lip Gloss v2 + Bubbles v2

Install · Usage · Keys · Configs

---

Features

• Single-screen dashboard — two-panel layout, no menus to navigate
• Live connection stats — endpoint, transfer, handshake refreshing every second
• Config preview — highlight a config to see its details before connecting
• Multiple tunnels — connect to several sites at once when their AllowedIPs don't overlap; overlapping configs (e.g. two full tunnels) switch automatically
• Inline operations — rename and delete configs without leaving the dashboard
• Built-in file picker — browse and import .conf / .wg files natively
• Catppuccin Mocha — terminal colors with nerd font icons
• Persistent connections — quit the TUI, VPN stays connected
• NetBird aware — if NetBird is installed, toggle it from the same dashboard alongside your WireGuard tunnels
• Waybar integration — status icon with connection details tooltip, click to launch TUI
• Zero config — passwordless via sudoers, just run omarchy-vpn

Installation

AUR

yay -S omarchy-vpn

Or with any AUR helper. Installs dependencies (wireguard-tools, systemd-resolvconf) and sets up sudoers automatically.

From source

git clone https://github.com/limehawk/omarchy-vpn.git
cd omarchy-vpn
go build -o omarchy-vpn .
sudo install -Dm755 omarchy-vpn /usr/bin/omarchy-vpn

You'll need to manually create /etc/sudoers.d/omarchy-vpn — see the PKGBUILD for the required rules.

Usage

omarchy-vpn

That's the whole interface. Everything happens on one screen.

Keybindings

Navigation

Key	Action
j / ↓	Move down
k / ↑	Move up

Connection

Key	Action
Enter	Connect to selected config
d	Disconnect selected tunnel

Config Management

Key	Action
i	Import config (opens file picker)
r	Rename selected config (inline)
x	Delete selected config (with confirmation)

General

Key	Action
?	Toggle help overlay
q	Quit (VPN stays connected)
Ctrl+C	Force quit

Adding Configs

Via the app

Press i to open the file picker. Navigate to your .conf or .wg file and select it. The config is validated, sanitized, and copied to /etc/wireguard/.

Manual

sudo cp *.conf /etc/wireguard/
sudo chmod 600 /etc/wireguard/*.conf

Waybar

The package automatically adds a VPN status module to waybar on install and removes it on uninstall. The icon shows connection state and the tooltip displays endpoint and transfer stats. Click to launch the TUI.

If you need to manually manage the waybar module:

omarchy-vpn --setup-waybar    # Add module to waybar config + style
omarchy-vpn --remove-waybar   # Remove module from waybar config + style

How It Works

omarchy-vpn is a TUI wrapper around wg-quick and wg show. Configs live in /etc/wireguard/ as standard WireGuard .conf files. The app manages them with passwordless sudo via a sudoers file installed by the package.

Connect runs wg-quick up <config>. Disconnect runs wg-quick down <config>. The VPN runs in the kernel — closing the TUI doesn't affect your connection.

Multiple tunnels can be active at once. When you connect to a config, only active tunnels whose AllowedIPs overlap the new config's routes are brought down first — tunnels routing disjoint subnets stay connected. Two full-tunnel configs (0.0.0.0/0) always overlap, so connecting one switches away from the other, same as before.

Requirements

• Go 1.21+ (build only)
• wireguard-tools — wg-quick and wg
• systemd-resolvconf — DNS resolution for WireGuard tunnels
• A terminal with nerd font support (for icons)

Built With

• Bubble Tea v2 — TUI framework
• Bubbles v2 — Components (filepicker, help, spinner, textinput)
• Lip Gloss v2 — Terminal styling
• Catppuccin Mocha — Color palette

License

MIT