https://github.com/reugn/wifiqr

Create a QR code with your Wi-Fi login details
https://github.com/reugn/wifiqr

cli cli-app cli-tool command-line-tool credentials golang qr qr-generator qrcode qrcode-generator terminal utility wifi wifi-password

Last synced: about 2 months ago
JSON representation

Create a QR code with your Wi-Fi login details

• Host: GitHub
• URL: https://github.com/reugn/wifiqr
• Owner: reugn
• License: mit
• Created: 2020-12-08T15:43:55.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2024-05-19T07:45:57.000Z (4 months ago)
• Last Synced: 2024-06-18T21:50:34.857Z (3 months ago)
• Topics: cli, cli-app, cli-tool, command-line-tool, credentials, golang, qr, qr-generator, qrcode, qrcode-generator, terminal, utility, wifi, wifi-password
• Language: Go
• Homepage: https://pkg.go.dev/github.com/reugn/wifiqr
• Size: 54.7 KB
• Stars: 256
• Watchers: 6
• Forks: 13
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-go-extra - wifiqr - Fi login details|211|11|0|2020-12-08T15:43:55Z|2022-07-09T17:46:52Z| (Utilities / Fail injection)

README

        
# Wi-Fi QR Code Generator



[![Test Status](https://github.com/reugn/wifiqr/workflows/Test/badge.svg)](https://github.com/reugn/wifiqr/actions?query=workflow%3ATest)

[![PkgGoDev](https://pkg.go.dev/badge/github.com/reugn/wifiqr)](https://pkg.go.dev/github.com/reugn/wifiqr)

[![Go Report Card](https://goreportcard.com/badge/github.com/reugn/wifiqr)](https://goreportcard.com/report/github.com/reugn/wifiqr)

[![codecov](https://codecov.io/gh/reugn/wifiqr/branch/main/graph/badge.svg)](https://codecov.io/gh/reugn/wifiqr)

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](https://github.com/reugn/wifiqr/releases).

### Build from Source

Download and [install Go](https://golang.org/doc/install).

Install the application:

```sh

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

```

See the [go install](https://go.dev/ref/mod#go-install) instructions for more information about the command.

## Usage

```text

$ 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

```sh

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

```

## License

MIT