Skip to main content

A simple wakeonlan implementation.

Project description

wake

A simple wakeonlan implementation for waking defined hosts.

Requirements

  • Python 3.10.x, 3.11.x
  • Linux / macOS

Note: wake is not tested on Windows.

Installation

pip install py-wake-cli

Usage

Usage: wake [OPTIONS] COMMAND [ARGS]...

  A simple wakeonlan implementation.

Options:
  --version  Show the version and exit.
  --help     Show this message and exit.

Commands:
  host  Wake the specified host(s).
  show  Show all hosts.

Examples

Examples use the configuration shown in Configuration

Wake a specific host:

$ wake host abcd
Waking host "abcd"

Wake all hosts:

$ wake host --all
Waking host "abcd"
Waking host "wxyz"

Show hosts:

$ wake show
Hostname    MAC Address        IP Address         Port
----------  -----------------  ---------------  ------
abcd        AA:BB:CC:DD:EE:FF  255.255.255.255       9
wxyz        00:11:22:33:44:55  192.168.0.255         7

Configuration

Hosts should be defined in the file ~/.config/wake.toml. Every host must have a name and mac value; ip and port are optional. ip is an IPv4 address. Optional valid MAC address separators are :, -, and .. The number of characters between separators does not matter. Example formats:

  • AA:00:BB:11:CC:22
  • AA-00-BB-11-CC-22
  • AA00.BB11.CC22
  • AA00BB11CC22

Example configuration:

[[ hosts ]]
name = "abcd"
mac = "AABBCCDDEEFF"

[[ hosts ]]
name = "wxyz"
mac = "00:11:22:33:44:55"
ip = "192.168.0.255"
port = 7

License

Wake is released under the MIT License

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

py_wake_cli-2.0.5.tar.gz (5.5 kB view hashes)

Uploaded Source

Built Distribution

py_wake_cli-2.0.5-py3-none-any.whl (6.3 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page