qrfi
TypeScript icon, indicating that this package has built-in type declarations

0.1.2 • Public • Published

qrfi

Build Status npm version

qrfi is a CLI Wi-Fi QR Code Generator. You can scan and configure Wi-Fi connection with QR Code.

Prerequisites

CLI

Node.js > 8

Scanning device

  • Android
  • iOS 11+

install

$ npm install qrfi --global

NOTE: Also you can use qrfi with npxcommand.

Usage

$ qrfi YOUR-SSID -p YOUR-PASSWORD
# or you can drain SSID from stdin 
echo YOUR-SSID | qrfi -p YOUR-PASSWORD
# export png as stdout 
$ qrfi YOUR-SSID -p YOUR-PASSWORD --format png > qr.png

With npx:

$ npx qrfi YOUR-SSID -p YOUR-PASSWORD
# or you can drain SSID from stdin 
echo YOUR-SSID | npx qrfi -p YOUR-PASSWORD

screenshot

options

$ qrfi -h
Usage: qrfi [ssid] [options]
 
A CLI Wi-Fi QR Code Generator.
 
Options:
  -V, --version                      output the version number
  -t, --authentication-type <value>  Optional. One of WEP, WPA, nopass. Default value is WPA.
  -p, --password <value>             Optional.
  -H, --hidden                       Optional. The SSID is hidden or not. Default value is `false`.
  -f, --format <value>               Optional. ascii as default, png or svg.
  -h, --help                         output usage information
 
Examples:
  $ qrfi YOUR-SSID -p YOUR-PASSWORD
  $ qrfi YOUR-SSID -p YOUR-PASSWORD -f png > qr.png
  $ echo YOUR-SSID | qrfi -p YOUR-PASSWORD

development

$ git clone git@github.com:kamataryo/qrfi.git
cd qrfi
$ yarn
$ npm test

contributions

Issues and pull requests are welcome.

/qrfi/

    Package Sidebar

    Install

    npm i qrfi

    Weekly Downloads

    1

    Version

    0.1.2

    License

    MIT

    Unpacked Size

    36.7 kB

    Total Files

    15

    Last publish

    Collaborators

    • kamataryo