Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 

Repository files navigation

ChevronQR

A lightweight, privacy-focused, 100% offline CLI tool to generate and decode QR codes.

Many free online QR generators track user data, inject third-party ad redirects, or lock features behind sudden paywalls. ChevronQR runs entirely on your local machine—ensuring your URLs, Wi-Fi credentials, and messages remain private and ad-free.


Features

  • Multi-Format Generation: Create standard .png images or infinitely scalable vector .svg files.
  • Custom Branding: Embed a custom logo/image perfectly into the center of your QR codes (powered by High Error Correction Level).
  • Data Helper Templates: Easily format complex strings for Wi-Fi networks and pre-composed emails.
  • Offline Scanner: Decode existing QR code images back into plaintext directly inside your terminal.
  • Cross-Platform: Native support for both Linux and Windows.

Installation & Setup (Linux / Kali)

1. Install System Dependencies

Instead of using Python virtual environments, install required packages via your system package manager:

sudo apt update
sudo apt install python3-qrcode python3-pyzbar python3-pil libzbar0

2. Clone the Project

git clone https://github.com/YOUR_USERNAME/ChevronQR.git
cd ChevronQR

3. Make ChevronQR a Global Command

To run ChevronQR from anywhere in your terminal:

Open your shell configuration file:

nano ~/.bashrc

If you're using Zsh, edit ~/.zshrc instead.

Add the following line (adjust path accordingly):

alias ChevronQR="python3 /home/kali/Desktop/ChevronQR/ChevronQR.py"

Save and exit:

  • CTRL + O → Enter
  • CTRL + X

Reload configuration:

source ~/.bashrc

Now you can run:

ChevronQR -help

Usage Examples

1. Standard URL / Plain Text Generation

ChevronQR -gen "https://stargate.fandom.com" -o cQR.png

2. Wi-Fi QR Code

ChevronQR -gen "Destiny" \
  --type wifi \
  --wifi-pass "9Chevron" \
  --logo star_uni.png \
  -o wifi_setup.png

3. Pre-formatted Email Setup

ChevronQR -gen "jack.oneill@sgc.mil" \
  --type email \
  --email-sub "Mission Debrief" \
  --email-body "It's O'Neill, with two L's." \
  -o email.png

4. QR Code with Custom Logo

ChevronQR -gen "Destiny" \
  --type wifi \
  --wifi-pass "9Chevron" \
  --logo star_uni.png \
  -o wifi_setup.png

5. Decode / Read an Existing QR Code

ChevronQR -show wifi_setup.png

Important Note on Linux Special Characters (!)

In Linux shells (Bash/Zsh), the exclamation mark (!) is used for history expansion.

If used inside double quotes, it may cause errors like dquote>.

Solutions:

  • Escape it using a backslash:
--email-body "Check this out\!"

License

This project is licensed under the MIT License.

About

Offline CLI tool for generating and decoding QR codes without tracking, ads, or paywalls. Supports PNG/SVG, Wi-Fi & Email templates, and custom center logo embedding.

Topics

Resources

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages