Skip to content

aashish-thapa/wlctl

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

282 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

wlctl

WiFi TUI for NetworkManager.

CI Crates.io Downloads License

demo

Why

impala is a great wifi TUI but it talks to iwd. If your distro already runs NetworkManager (most do β€” GNOME, KDE, Ubuntu, Fedora, Pop, …), you can't drop impala in without ripping the stack out. wlctl keeps the impala UX and points it at NetworkManager, so it just works alongside what your DE is already doing.

Features

  • Station and Access Point modes
  • WPA Enterprise (802.1X)
  • Multiple adapters β€” pick which one to drive, switch on the fly
  • VPN connections β€” toggle, manage autoconnect, and delete saved VPN / WireGuard profiles, like nmtui; an active tunnel shows as a badge in the top-right
  • wlctl doctor β€” walks rfkill, driver, association, IP, DHCP, gateway, DNS, internet
  • QR code sharing, hidden networks, speed test
  • Vim keys, every binding configurable

Install

# crates.io
cargo install wlctl

# Arch (AUR)
yay -S wlctl-bin

# Nix (run without installing)
nix run github:aashish-thapa/wlctl

# from source
git clone https://github.com/aashish-thapa/wlctl && cd wlctl
cargo build --release

On NixOS, add the flake as an input and use wlctl.packages.${system}.default, or drop it into a shell with nix shell github:aashish-thapa/wlctl.

Needs NetworkManager running. Nerd Fonts optional, for icons.

Usage

wlctl to launch the TUI. wlctl doctor when something's broken and you want to know which layer.

Global

Action Key
Switch panel Tab / Shift+Tab
Move j k / arrows
Switch adapter mode (Station ↔ AP) Ctrl+R
VPN connections v
Quit q / Ctrl+C
Dismiss popup Esc

Known networks

Action Key
Connect / disconnect Space or Enter
Toggle auto-connect t
Forget network d
Make this the internet path u
Show all a
QR share p
Speed test (needs speedtest-cli) Shift+S

When both WiFi and Ethernet are up, the link NetworkManager is actually routing internet over is highlighted in green, and the box footer spells it out (σ°–Ÿ Internet: WiFi Β· <ssid>). Press u on the Ethernet row or the connected WiFi to switch the default route to it (the other link stays up).

The Device box footer shows the active adapter's LAN IP (e.g. 󰩟 wlan0 · 192.168.1.20) so you can SSH in without running ip addr.

New networks

Action Key
Connect / disconnect Space or Enter
Connect to hidden h
Filter by name /
Show all a

Press / to filter the scan list by SSID as you type; Enter keeps the filter, Esc clears it.

VPN connections (open with v)

Action Key
Toggle on / off Space or Enter
Toggle autoconnect a
Delete profile (confirm y/n) d
Import a WireGuard config i
Close Esc

The selected tunnel's assigned IP and uptime show below the list while it's up.

Importing WireGuard configs: press i, then either paste the whole config (most providers β€” Proton, Mullvad β€” just hand you the text) or type a path to a .conf file, and press Enter. wlctl parses it and creates a NetworkManager profile β€” no nmcli needed. Pasted configs are named after the server endpoint; file imports after the file name. ~ is expanded in paths. The profile is added without auto-connecting; toggle it on with Enter. OpenVPN .ovpn files aren't supported here β€” import those with nmcli connection import type openvpn file <path> (requires the NetworkManager-openvpn plugin).

Device panel

Action Key
Adapter info i
Toggle power o
Doctor ?

Station mode

Action Key
Scan s

Access Point mode

Action Key
Start AP n
Stop AP x

Config

~/.config/wlctl/config.toml. All keys rebindable.

switch = "r"
mode = "station"
esc_quit = false
vpn = "v"

[device]
infos = "i"
toggle_power = "o"
doctor = "?"

[station]
toggle_scanning = "s"

[station.known_network]
toggle_autoconnect = "t"
remove = "d"
show_all = "a"
share = "p"
speed_test = "S"
prefer = "u"

[station.new_network]
show_all = "a"
connect_hidden = "h"
filter = "/"

[access_point]
start = "n"
stop = "x"

vs. impala

impala wlctl
Backend iwd NetworkManager
Coexists with default desktop network stack no yes
Multi-adapter selector β€” yes
VPN connection toggle β€” yes
doctor subcommand β€” yes

Credits

Forked from pythops/impala. UI and architecture are theirs.

License

GPLv3

About

πŸ›œ TUI for managing wifi/ethernet/vpn on Linux with Network Manager

Topics

Resources

License

Stars

122 stars

Watchers

2 watching

Forks

Sponsor this project

Packages

 
 
 

Contributors

Languages