Skip to content

stefan-crowhurst/qrnum

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

46 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

qrnum

A terminal-based QR code generator for phone numbers, supporting both Tel/PSTN and WhatsApp links.

Development

For details on how to develop/contribute to this solution see the contributing doc

Install

Run the following in your terminal:

curl -fsSL https://raw.githubusercontent.com/stefan-crowhurst/qrnum/master/scripts/install.sh | bash

Or to install a specific version:

curl -fsSL https://raw.githubusercontent.com/stefan-crowhurst/qrnum/master/scripts/install.sh | bash -s -- --version 1.0.0

Prerequisites

To copy QR codes as images to your clipboard, you need:

  • Linux: Install xclip
    # Debian/Ubuntu
    sudo apt-get install xclip
    # Fedora
    sudo dnf install xclip
    # Arch
    sudo pacman -S xclip
  • macOS: No additional requirements
  • Windows: No additional requirements

Note: Text paste (Ctrl+V) works without any additional tools using OpenTUI's built-in paste handling.

Usage

Interactive TUI Mode

qrnum

CLI Mode

qrnum +1234567890              # Generate tel: QR code
qrnum -w +1234567890           # Generate WhatsApp QR code
qrnum --help                   # Show help

Keyboard Shortcuts

Shortcut Action
Enter Submit input / Select menu option
Esc Cancel/Go back (when in input mode)
Ctrl+Q Quit the application
Ctrl+C Copy QR code as image
Ctrl+V Paste clipboard text into input field
Shift+Insert Paste clipboard text (alternative)

Mouse Support

  • Right-click on QR code to copy as image
  • Right-click when input field focused to paste text

Known Limitations

  1. Image clipboard requires platform tools - Linux users must install xclip (text paste works natively via OpenTUI)
  2. Image copying - Image copying, at least in my experience during development has been a little bit iffy, especially when there are things like WSL thrown into the mix to complicate narrowing things down, it may be more reliable to use your platform's screenshot/snipping tool instead. This is probably the main slop artifact in this codebase as it was more of an "eh, let's see what it turns out" kinda feature rather than anything core.
  3. Mac support - This has not been tested on a Mac during development so I can't guarantee it'll be perfect, fixes are welcomed

License

MIT

About

TUI & CLI for converting phone numbers to QR codes

Resources

License

Contributing

Stars

Watchers

Forks

Packages

 
 
 

Contributors