Git Product home page Git Product logo

wifiqr's Introduction

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

wifiqr's People

Contributors

arcanericky avatar reugn avatar rouxantoine avatar

Stargazers

avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar

Watchers

avatar avatar avatar avatar avatar avatar

Forkers

lucasepe dendisuhubdy ali-zohrevand cloudxo jhidalgo3 arcanericky wuchunfu goddard82 patricksanders ilium007 alexandregv renowncoder metilluyoc

wifiqr's Issues

BUG: Does not accept spaces in SSID or Password

Greetings! Per my comment on reddit regarding a bug I found today:

There seems to be a bug when using spaces in either the network name or the password:

$ go run github.com/reugn/wifiqr/cmd/wifiqr@latest
Enter the name of the wireless network (SSID):
one two three
Enter the network key (password):

(qr code omitted for brevity)

bash-5.1$ three
bash: three: command not found
bash-5.1$

Notice that it did not ask me for the password. Scanning the generated QR code shows that it used one as the SSID and two as the password.

Document use of go install in readme over go get

go install (https://go.dev/ref/mod#go-install) is recommended as the way to install binaries rather than go get.

If I run go get github.com/reugn/wifiqr from the README.md I see the following output:

go: go.mod file not found in current directory or any parent directory.
	'go get' is no longer supported outside a module.
	To build and install a command, use 'go install' with a version,
	like 'go install example.com/cmd@latest'
	For more information, see https://golang.org/doc/go-get-install-deprecation
	or run 'go help get' or 'go help install'.

What do you think about updating the readme to go install github.com/reugn/wifiqr/cmd/wifiqr@latest, it will install wifiqr to the go bin folder.

Note: I tried go install github.com/reugn/wifiqr@latest but get the following output:

package github.com/reugn/wifiqr is not a main package

Looking at other projects (e.g. https://github.com/knipferrc/fm) a simple main.go at the root should do the trick to make it work.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.