cunΔ«cu(1)

πŸ“¦ version 0.12.0, in nixos 26.05, nixpkgs unstable

πŸ’… cunΔ«cu β€” the wg show page, bestie edition

okay so real talk, this is the manual for cunicu-wg-show, which lives inside the cunΔ«cu manual (cunΔ«cu(1)). grab a strawberry drink πŸ“ and let's get into it.

✨ NAME ✨

cunicu-wg-show β€” shows the current WireGuard configuration and runtime info of the [interface] you point at 🫢

🌸 SYNOPSIS 🌸

cunicu wg show { interface-name | all | interfaces } [{ public-key |
private-key | listen-port | fwmark | peers | preshared-keys | endpoints |
allowed-ips | latest-handshakes | transfer | persistent-keepalive |
dump }] [flags]

πŸ¦‹ DESCRIPTION πŸ¦‹

Shows the current WireGuard configuration and runtime information of the specified [interface]. iconic behaviour, no notes πŸ’…

If you don't give it an [interface], then [interface] defaults to 'all'. generous queen ✨

If you do say 'interfaces', it prints a list of all WireGuard interfaces, one per line, and then it quits. like, it's done, bye πŸ‘‹

If you give no options after the interface spec, it prints a list of all attributes in a visually pleasing way, meant for the terminal. pretty mode πŸŽ€ Otherwise it prints the info you asked for grouped by newlines and tabs β€” that's the script-friendly, machine-munchable mode.

For that script-friendly display: if 'all' is specified, then the first field for all categories of information is the interface name. so you always know who's who πŸ‘‘

If 'dump' is specified, then several lines get printed 😭 and here's the deets:

  • the first line contains, in order, separated by tab: private-key, public-key, listen-port, fwmark
  • subsequent lines are printed for each peer and contain, in order, separated by tab: public-key, preshared-key, endpoint, allowed-ips, latest-handshake, transfer-rx, transfer-tx, persistent-keepalive
ngl if you're scripting against dump, keep the column order exactly like that. fr fr, it's tab-separated and order matters πŸ’€

πŸ’– OPTIONS πŸ’–

  • -h, --help[=false] β€” help for show. classic, we love a help flag 🫢
  • -s, --rpc-socket="/run/cunicu.sock" β€” the Unix control and monitoring socket. default path is literally /run/cunicu.sock, slay πŸ”₯

🌈 OPTIONS INHERITED FROM PARENT COMMANDS 🌈

these bad boys come from the parent command, so you get them for free ✨

  • -q, --color="auto" β€” enables colorization of output (one of: auto, always, never). default is auto β€” let the terminal decide, main character energy πŸ‘‘
  • -l, --log-file=[] β€” path of a file to write logs to πŸ“
  • -d, --log-level=[] β€” log level filter rule (one of: debug, info, warn, error, dpanic, panic, and fatal) and the default is "info". so yes, dpanic and panic and fatal are all real options, and yes you probably don't want them unless you're feeling chaotic πŸ’€πŸ”₯

🧚 SEE ALSO 🧚

and that's the whole page, bestie πŸ’œ source lives at https://github.com/cunicu/cunicu and this one is dated Jan 1980 (iconic vintage timestamp, don't ask πŸŽ€) β€” mwah, go show those interfaces 🌸

πŸ“¦ where this page comes from