You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
A CLI utility for sending wake-on-lan magic packets to wake up a computer in a LAN given its MAC address. Find [zig-wol](https://github.com/rito1998/zig-wol) also on [Codeberg](https://codeberg.org/rito/zig-wol).
3
+
# zwol
6
4
5
+
A CLI utility for sending wake-on-lan magic packets to wake up a computer in a LAN given its MAC address. Find [zwol](https://github.com/rito1998/zwol) also on [codeberg](https://codeberg.org/rito/zwol).
7
6
8
7
## Features
9
8
@@ -12,44 +11,44 @@ A CLI utility for sending wake-on-lan magic packets to wake up a computer in a L
12
11
13
12
## Installation
14
13
15
-
Pre-compiled binaries of [zig-wol](https://github.com/rito1998/zig-wol) are distributed with [releases](https://github.com/rito1998/zig-wol/releases). The installation scripts below download the latest release for your processor architecture and **install** the program at `C:\Users\%username%\.zig-wol` on Windows and `/home/$USER/.zig-wol` on Linux and macOS. To **uninstall**zig-wol, simply delete this folder.
14
+
Pre-compiled binaries of [zwol](https://github.com/rito1998/zwol) are distributed with [releases](https://github.com/rito1998/zwol/releases). The installation scripts below download the latest release for your processor architecture and **install** the program at `C:\Users\%username%\.zwol` on Windows and `/home/$USER/.zwol` on Linux and macOS. To **uninstall**zwol, simply delete this folder.
Wake a machine on the LAN by broadcasting a magic packet: replace `<MAC>` with the target MAC (e.g. `9A-63-A1-FF-8B-4C`).
38
37
39
38
```sh
40
-
zig-wol wake <MAC>
39
+
zwol wake <MAC>
41
40
```
42
41
43
42
Create an alias for a MAC address, list all aliases, or remove one.
44
43
45
44
```sh
46
-
zig-wolalias<NAME><MAC> --broadcast <ADDR:PORT># create an alias and set its broadcast
47
-
zig-wol wake <NAME># wake a machine by alias
45
+
zwolalias<NAME><MAC> --broadcast <ADDR:PORT># create an alias and set its broadcast
46
+
zwol wake <NAME># wake a machine by alias
48
47
```
49
48
50
49
The optional `--broadcast` (e.g. 192.168.0.255:9) is important if there are multiple network interfaces. Setting the correct subnet broadcast address ensures the OS chooses the right network interface. If not specified, 255.255.255.255:9 is used.
51
50
52
-
Use `zig-wol ping` to ping all machines by their FQDNs (if defined on alias creation) and display the result.
51
+
Use `zwol ping` to ping all machines by their FQDNs (if defined on alias creation) and display the result.
53
52
54
53
```sh
55
54
🟢 office-server
@@ -59,7 +58,7 @@ Use `zig-wol ping` to ping all machines by their FQDNs (if defined on alias crea
59
58
🔴 coffee-machine
60
59
```
61
60
62
-
Run `zig-wol help` to display all subcommands and `zig-wol <subcommand> --help` to display specific options.
61
+
Run `zwol help` to display all subcommands and `zwol <subcommand> --help` to display specific options.
63
62
64
63
## Build
65
64
@@ -70,8 +69,8 @@ Run `zig-wol help` to display all subcommands and `zig-wol <subcommand> --help`
70
69
### 1. Clone the Repository
71
70
72
71
```sh
73
-
git clone https://github.com/rito1998/zig-wol.git
74
-
cdzig-wol
72
+
git clone https://github.com/rito1998/zwol.git
73
+
cdzwol
75
74
```
76
75
77
76
### 2. Build the Application
@@ -87,7 +86,7 @@ This command compiles the source code and places the executable in the `zig-out/
87
86
It is possible to use the wake-on-lan functionality of this project as a library.
Use the subcommand **relay** to make zig-wol work as a beacon that listens on a port for inbound wake-on-lan magic packets, for example coming from a router, and relays them, usually to the LAN broadcast in order to wake devices.
111
+
Use the subcommand **relay** to make zwol work as a beacon that listens on a port for inbound wake-on-lan magic packets, for example coming from a router, and relays them, usually to the LAN broadcast in order to wake devices.
113
112
114
113
```sh
115
-
zig-wol relay 192.168.0.10:9999 192.168.0.255:9
114
+
zwol relay 192.168.0.10:9999 192.168.0.255:9
116
115
```
117
116
118
-
A realistic example usage, using the command above as a reference, is to have a home LAN comprised of one or more powerful machines that need to be woken remotely and an always-on low-power machine, like a Raspberry Pi, that runs the `zig-wol relay` repeater.
119
-
Enable port-forwarding in the router settings to forward inbound traffic from some specific port of choice to 9999/udp of the Raspberry Pi, then zig-wol relay service relays the magic packets on the local subnet broadcast allowing to wake the other machines from outside the LAN, provided the router public address is known.
117
+
A realistic example usage, using the command above as a reference, is to have a home LAN comprised of one or more powerful machines that need to be woken remotely and an always-on low-power machine, like a Raspberry Pi, that runs the `zwol relay` repeater.
118
+
Enable port-forwarding in the router settings to forward inbound traffic from some specific port of choice to 9999/udp of the Raspberry Pi, then zwol relay service relays the magic packets on the local subnet broadcast allowing to wake the other machines from outside the LAN, provided the router public address is known.
120
119
121
120

122
121
123
122
### As a service on Linux
124
123
125
-
Ensure you have zig-wol and set net permissions to the binary.
124
+
Ensure you have zwol and set net permissions to the binary.
0 commit comments