Skip to content

Latest commit

 

History

History
66 lines (45 loc) · 2.09 KB

README.md

File metadata and controls

66 lines (45 loc) · 2.09 KB
Raw

Wi-Fi QR Code Generator

Test Status PkgGoDev Go Report Card codecov

Create a QR code with your Wi-Fi login details.

Use Google Lens or other application to scan it and connect automatically.

Installation

Choose a binary from the releases.

Build from Source

Download and install Go.

Install the application:

go install github.com/reugn/wifiqr/cmd/wifiqr@latest

See the go install instructions for more information about the command.

Usage

$ wifiqr --help
wifiqr is a WiFi QR code generator

It is used to create a QR code containing the login details such as
the name, password, and encryption type. This QR code can be scanned
using Google Lens or other QR code reader to connect to the network.
It is Android and iOS compatible.

If the options necessary for creating the QR code are not given on
the command line, the user will be prompted for the information.

Usage:
  wifiqr [flags]

Flags:
  -h, --help              help for wifiqr
      --hidden            Hidden SSID
  -k, --key string        Wireless password (pre-shared key / PSK)
  -o, --output string     PNG file for output (default stdout)
  -p, --protocol string   Wireless network encryption protocol (WPA2, WPA, WEP, NONE). (default "WPA2")
  -s, --size int          Image width and height in pixels (default 256)
  -i, --ssid string       Wireless network name
  -v, --version           version for wifiqr

Usage Example

./wifiqr --ssid some_ssid --key 1234 --output qr.png --size 128

License

MIT