easywireguard 0.1.0

make wireguard easy - interfaces, keys and full-mesh configs in one CLI + TUI
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

# easywireguard (`ewg`)

WireGuard without the hand-editing: manage live interfaces wherever their
`.conf` files live, and generate full-mesh configs from one manifest. Pure Rust,
no `wg` binary required for keys or generation.

```bash
cargo install easywireguard
```

## Run interfaces (this box)

```bash
ewg                      # interactive TUI: list + toggle up/down
ewg list                 # every .conf you can bring up, with up/down state
ewg status               # only what's currently up
ewg up <name>            # bring one up   (found across your registered dirs)
ewg down <name>          # bring one down

ewg dir add <path>       # register where .conf files live (not just /etc/wireguard)
ewg dir                  # list registered dirs   (-v shows .conf counts)
ewg dir rm <path>
```

Reading `/etc/wireguard` needs root; `ewg` auto-elevates with `sudo` when a dir
isn't readable (set `EWG_NO_SUDO=1` to disable). Point at other dirs with
`--dir` or `$EWG_DIR`.

## Keys

```bash
ewg key                  # a private + public keypair (wg-compatible)
ewg psk                  # a preshared key
ewg pubkey <PRIVATE>     # derive a public key
```

## Mesh (design then generate)

Describe every node once, then generate each node's config as "all peers minus
itself".

```bash
ewg mesh add houseA --address 10.10.0.1/24 --pubkey <PUB> \
    --endpoint vpn-a:51820 --private <PRIV> -m mesh.toml
ewg mesh                 # list nodes   (-v verbose, --json machine-readable)
ewg mesh rm houseA
ewg mesh gen -o out/     # writes out/houseA.conf, ... (peers routed by /32)
```

`--private` is optional: omit it for a public-only manifest and paste keys in
later. `mesh list --json` never includes private keys.