https://github.com/valentin271/wtui

A WireGuard client TUI
https://github.com/valentin271/wtui

ratatui rust tui vpn wireguard

Last synced: 19 days ago
JSON representation

A WireGuard client TUI

• Host: GitHub
• URL: https://github.com/valentin271/wtui
• Owner: Valentin271
• Created: 2024-07-14T15:54:38.000Z (6 months ago)
• Default Branch: master
• Last Pushed: 2024-11-12T20:53:55.000Z (about 2 months ago)
• Last Synced: 2024-11-12T21:34:54.028Z (about 2 months ago)
• Topics: ratatui, rust, tui, vpn, wireguard
• Language: Rust
• Homepage:
• Size: 31.3 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# wtui

A [WireGuard](https://www.wireguard.com/) client interface.

## Features

- List Interfaces/Connections

- See connection status (connected/disconnected, bytes received/sent)

- Actions to connect & disconnect

- List most of configuration (address, MTU, endpoint, allowed IPs, DNS)

- Copy public key

## TODO

- [ ] Available action help popup

# Usage

To use, simply run `wtui`.  

You'll very likely need root permission to (1) read WireGuard configuration files and (2) alter

network interfaces and routes.

## Keymap

| Key         | Action          |

| ----------- | --------------- |

| `j`, `Down` | Down            |

| `k`, `Up`   | Up              |

| `c`         | Connect         |

| `d`         | Disconnect      |

| `D`         | Disconnect all  |

| `y`         | Yank public key |

| `?`\*       | Help            |

\*: Soon, see TODO section

# Limitations/Caveats

- Works only with single peer configurations

- Unit tests require `wg` to be installed