Git Product home page Git Product logo

pwsqr's Introduction

PWSQR

pwsqr Gem

Simple QR interface to pws gem. Helps to use your passwords on a smartphone.

Installation

PWS gem required to use this tool and will be installed as a dependency if you don't have one already.

$ gem install pwsqr

Usage

This gem helps you securely and easily copy/send passwords from CLI (pws tool) to your mobile devices using QR codes.

When pwsqr works online it tries to use onetimesecret.com service to store your password privately behind the QR code with a short URL.

To use this feature, run pwsqr with pwsqr --init command first and setup your email address and API key in the newly generated config file in your $HOME directory: ~/.pwsqr

If you want to generate config file from scratch delete the old one before running pwsqr --init

$ pwsqr --help


    ======================================================
            Command-line QR tool for PWS gem ๐Ÿ“ฒ
    ======================================================

    Usage:
      pwsqr [--offline | --email] [--namespace <namespace>] <key>
      pwsqr --version
      pwsqr --help
      pwsqr --init

    Options:
      --version, -v                              Show the current app version
      --help, -h                                 Show this message
      --init                                     Initialise new configuration (won't break the old one)
      --namespace <namespace>, -n <namespace>    Use custom pws namespace
      --offline, -o                              Force local password usage (force offline usage,
                                                 mind the length of the password and terminal history)
      --email, -e                                Send a friendly email containing the secret link
# Home
$ pwsqr twitter # get twitter password (online/QR)
$ pwsqr -e twitter # get twitter password (online/email)
$ pwsqr -o twitter # get twitter password (offline/QR)

# Work
$ pwsqr -n work -o github # get github password (offline/work namespace/QR)
$ pwsqr -n work github # get github password (online/work namespace/QR)
$ pwsqr -n work -e github # get github password (online/work namespace/email)

Then you check your email (if you used --email / -e flag) or scan QR-code with any QR scanner (I use really fast one: Optiscan QR Code Reader โš ๏ธ this is not an advert)

To-Do

  • Testing
  • Configure CI
  • Code documenting

Contributing

See contributing.md

License / Copyrights

pwsqr's People

Contributors

smileart avatar smileart-levelup avatar

Stargazers

Dmytro Shcherbyna avatar Jan Lelis avatar Ivan Kotelnikov avatar Michael Bodnarchuk avatar

Watchers

James Cloos avatar

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.