Skip to content

Latest commit

 

History

History
124 lines (79 loc) · 3.56 KB

readme.md

File metadata and controls

124 lines (79 loc) · 3.56 KB
Raw

qrpwd logo

qrpwd - Encode to QR-Code

Online tool: Encode - Decode

qrpwd is a command-line tool that allows you to encode and decode textual information with strong encryption using a given password in a QR code. The tool is designed to be secure and convenient, making it ideal for storing sensitive information such as 2-factor authentication (2FA) backup codes.

Test QR Code

To decode the QR code online, you can use the following link: https://qrpwd.franzai.com/. Simply upload the test.png file and enter the password "test" to decode the message.

Installation

To install qrpwd, follow these steps:

  1. Clone the repository or download the source files.
  2. Navigate to the project directory.
  3. Run npm install to install the dependencies.
  4. Run npm link to make it a global command line tool.

Usage

Encode

To encode a message:

qrpwd encode -m "your message" -p your_password -o output.png

To encode a file:

qrpwd encode -i input.txt -p your_password -o output.png

Decode

To decode an encrypted QR code:

qrpwd decode -i input.png -p your_password

Parameters

The qrpwd CLI has two commands: encode and decode.

The qrpwd encode command has the following options:

  • -m or --message: Message to encode
  • -i or --input: Input file to encode
  • -p or --password: Password to encrypt data
  • -o or --output: Output QR code file
  • -u or --unprotected: Do not use password protection
  • -d or --debug: Enable debug mode for error reporting

The qrpwd decode command has the following options:

  • -i or --input: Input QR code file
  • -p or --password: Password to decrypt data
  • -s or --silent: Suppress console output
  • -o or --output: Output decoded data file
  • -d or --debug: Enable debug mode for error reporting

Both commands also have a help option that displays help for the command.

For more information, refer to the GitHub repository.

Use Cases

Here are some possible use cases for qrpwd:

  • Creating QR codes for events or promotions that require a password for access.
  • Generating QR codes for Wi-Fi networks that require a password for access.
  • Creating QR codes for password protected contact information that can be easily shared with others.
  • Generating QR codes for URLs that require a password for access.
  • Creating QR codes for loyalty programs that require a password for access.
  • Generating QR codes for surveys or feedback forms that require a password for access.

Local Server Setup for the Web Version

To serve qrpwd-web locally on port 3000:

Using Python

If you have Python installed, you can start a simple HTTP server.

  1. Navigate to the directory containing index.html, usually the root qrpwd directory

  2. Run the following command:

    python -m http.server 3000

    For Python 2.x, use:

    python -m SimpleHTTPServer 3000

Using Node.js

If you prefer Node.js, you can use the http-server package.

  1. Install http-server globally (if not installed):

    npm install -g http-server

  2. Navigate to the directory containing index.html.

  3. Run the following command:

    http-server -p 3000

The server will start at http://localhost:3000. Navigate to this URL in your web browser to view the project.