WifiWand Documentation Index

July 10, 2026 · View on GitHub

This directory contains end-user and operator documentation for WifiWand (gem name: wifi-wand).

Getting Started

Installation & Quick Start - Basic setup and common command overview.
macOS Quick Start - Crucial one-time setup steps for macOS users (Sonoma and later).
Ubuntu Setup & Requirements - Requirements and configuration for Ubuntu systems.
Security Notes - Local WiFi password exposure surfaces and precautions.

Event Logging (log) - Monitor WiFi state changes and detect connectivity issues in real-time.
Status Command (s) - Detailed explanation of the connectivity status display and checks.
Info Command (i) - Reference for the detailed network configuration output.
Connectivity Checking (ci) - How to use WifiWand for automated internet health checks.
DNS Configuration (na) - Managing nameservers and custom DNS settings.

Use wifiwand --help as the canonical command reference. Commands without dedicated guide pages include:

connect / co - Join a WiFi network by SSID, optionally with a password.
disconnect / d - Disassociate from the current WiFi network without powering WiFi off.
forget / f - Remove saved preferred networks.
till / t - Wait for WiFi power, association, or internet reachability states.
cycle / cy - Toggle WiFi off and back on, or on and back off, depending on the starting state.
qr - Generate Wi-Fi QR codes for terminal or file output.
public_ip / pi - Query public IP address and country information.
ropen / ro - Open useful network troubleshooting web resources.
random_mac / rmac - Generate a random locally administered unicast MAC address.

macOS Helper App Details - End-user guidance for the native helper used on macOS 14+.

Environment Variables - Configuring WifiWand via the environment (including WIFIWAND_OPTS).

Version 3 Breaking Changes - Canonical upgrade and migration guide for version 3 API, CLI, and behavior changes.
Release Notes - Release notes for all versions, including current unreleased changes.
Version 3.0 Changes - Broader summary of major improvements and non-breaking changes in version 3.0.

If you are contributing to WifiWand or working on the native helper, please see the Developer Documentation Index.