https://github.com/kamataryo/qrfi

qrfi is a CLI Wi-Fi QR Code Generator.
https://github.com/kamataryo/qrfi

Last synced: 2 months ago
JSON representation

qrfi is a CLI Wi-Fi QR Code Generator.

• Host: GitHub
• URL: https://github.com/kamataryo/qrfi
• Owner: kamataryo
• Created: 2019-08-26T05:43:35.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-01-07T04:18:53.000Z (about 2 years ago)
• Last Synced: 2024-10-28T16:08:52.233Z (3 months ago)
• Language: TypeScript
• Homepage:
• Size: 771 KB
• Stars: 2
• Watchers: 3
• Forks: 1
• Open Issues: 4
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# qrfi

[![Build Status](https://travis-ci.org/kamataryo/qrfi.svg?branch=master)](https://travis-ci.org/kamataryo/qrfi)

[![npm version](https://badge.fury.io/js/qrfi.svg)](https://badge.fury.io/js/qrfi)

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

![](./social.png)

## Prerequisites

### CLI

Node.js > 8

### Scanning device

- Android

- iOS 11+

## install

```shell

$ npm install qrfi --global

```

NOTE: Also you can use qrfi with `npx`command.

## Usage

```shell

$ 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`:

```shell

$ npx qrfi YOUR-SSID -p YOUR-PASSWORD

# or you can drain SSID from stdin

$ echo YOUR-SSID | npx qrfi -p YOUR-PASSWORD

```

![screenshot](screenshot.png)

### options

```shell

$ qrfi -h

Usage: qrfi [ssid] [options]

A CLI Wi-Fi QR Code Generator.

Options:

  -V, --version                      output the version number

  -t, --authentication-type   Optional. One of WEP, WPA, nopass. Default value is WPA.

  -p, --password              Optional.

  -H, --hidden                       Optional. The SSID is hidden or not. Default value is `false`.

  -f, --format                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

```shell

$ git clone [email protected]:kamataryo/qrfi.git

$ cd qrfi

$ yarn

$ npm test

```

## contributions

Issues and pull requests are welcome.