wol-cli 0.1.0

Wake-on-LAN magic packet sender with VLAN support

wol-cli

A Wake-on-LAN magic packet sender with VLAN support.

Features

• UDP Broadcast: Standard Wake-on-LAN via UDP broadcast
• Directed Broadcast: Auto-compute broadcast address from CIDR notation
• 802.1Q VLAN Support: Send tagged Ethernet frames directly (Linux only, requires root)

Installation

From PyPI

pip install wol-cli

From GitHub Releases (standalone binary)

Download the appropriate binary for your platform from the Releases page:

• wol-linux-amd64 - Linux x86_64
• wol-windows-amd64.exe - Windows x86_64
• wol-macos-amd64 - macOS x86_64

From source

pip install .

For development:

pip install -e ".[dev]"

Usage

Plain UDP Broadcast (same subnet)

wol AA:BB:CC:DD:EE:FF

Directed Broadcast

Auto-computes the broadcast address from a CIDR network:

wol AA:BB:CC:DD:EE:FF --network 192.168.10.0/24

802.1Q Tagged Frame (Linux only)

Send a VLAN-tagged raw Ethernet frame (requires root):

sudo wol AA:BB:CC:DD:EE:FF --vlan-id 10 --interface eth0

Options

Option	Description
--ip IP	Explicit broadcast/unicast IP (default: 255.255.255.255)
--port PORT	UDP port (default: 9)
--network CIDR	Subnet for directed broadcast (e.g., 192.168.10.0/24)
--vlan-id ID	802.1Q VLAN ID (1-4094)
--interface IFACE	Network interface for 802.1Q mode
--version	Show version

Library Usage

from wol_cli import send_udp, send_dot1q, build_magic_packet

# Send via UDP broadcast
send_udp("AA:BB:CC:DD:EE:FF")

# Send via directed broadcast
send_udp("AA:BB:CC:DD:EE:FF", ip="192.168.10.255")

# Build a magic packet manually
packet = build_magic_packet("AA:BB:CC:DD:EE:FF")

Development

Install development dependencies:

pip install -e ".[dev]"

Run tests:

pytest -v

Run linter:

ruff check src/ tests/

Run type checker:

mypy src/

Releasing

Releases are automated via GitHub Actions. To create a new release:

1. Update the version in pyproject.toml and src/wol_cli/__init__.py
2. Commit the changes
3. Create and push a tag:

   git tag v0.1.0
   git push origin v0.1.0
   

The workflow will automatically:

• Run tests
• Build binaries for Linux, Windows, and macOS
• Build the Python package
• Publish to PyPI
• Create a GitHub release with all artifacts

PyPI Setup

To enable PyPI publishing, add a PYPI_API_TOKEN secret to your repository:

1. Go to PyPI Account Settings
2. Create an API token
3. Add it as a repository secret named PYPI_API_TOKEN

License

MIT