qrmaster-cli
v1.0.0
Published
Fast terminal QR Code generator & GitHub Action powered by QR Master
Maintainers
Readme
📱 QR Master CLI & GitHub Action
Fast, lightweight Terminal QR Code Generator and CI/CD GitHub Action.
Powered by QR Master – The Smart QR Code & Analytics Platform.
✨ Features
- ⚡ Zero Setup CLI: Generate QR codes straight in your terminal with
npx qrmaster-cli. - 🖼️ SVG & PNG File Export: Save high-resolution vector SVG or raster PNG files instantly.
- 📡 Built-in WiFi & vCard Payloads: Easily create WiFi network connector codes or vCard contact codes.
- 🤖 GitHub Action Ready: Automatically generate QR codes for Pull Request preview URLs (Vercel, Netlify, Cloudflare Pages).
- 🔗 Powered by QR Master: Seamlessly upgrade to dynamic QR codes with scan analytics, custom logo branding, and high-volume vector exports.
🚀 Quick Start (CLI)
Run directly with npx without installing:
# Print QR code directly in terminal
npx qrmaster-cli "https://www.qrmaster.net"
# Save as PNG image
npx qrmaster-cli "https://www.qrmaster.net" -o qrmaster.png
# Save as SVG vector file
npx qrmaster-cli "https://www.qrmaster.net" -o qrmaster.svg📶 WiFi QR Code
Generate a QR code for instant WiFi connections:
npx qrmaster-cli --wifi --ssid "MyHomeWiFi" --password "<wifi-password>" -o wifi.png👤 Contact vCard QR Code
Generate a vCard contact card QR code:
npx qrmaster-cli --vcard --name "Alex Smith" --email "[email protected]" --phone "+123456789"⚙️ GitHub Action Usage
Use qrmaster/action-qr-generator in your GitHub CI/CD workflows to generate QR codes for preview deployment links on every Pull Request.
name: Generate Preview QR Code
on:
pull_request:
types: [opened, synchronize]
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Generate QR Code for PR Preview
uses: qrmaster/action-qr-generator@v1
with:
url: 'https://pr-${{ github.event.number }}.preview.my-app.com'
output: './pr-preview-qr.png'
- name: Upload QR Code Artifact
uses: actions/upload-artifact@v4
with:
name: pr-qr-code
path: ./pr-preview-qr.png📦 Node.js API Usage
Install locally into your JavaScript/TypeScript project:
npm install qrmaster-cliconst { generateQR, buildWifiPayload } = require('qrmaster-cli');
// Generate Terminal QR
generateQR('https://www.qrmaster.net');
// Save PNG file
generateQR('https://www.qrmaster.net', { output: './qr.png' });
// Generate WiFi payload
const wifiData = buildWifiPayload({ ssid: 'Office-5G', password: '<wifi-password>' });
generateQR(wifiData, { output: './wifi.svg' });🌐 Need Dynamic QR Codes & Analytics?
Static QR codes are great for local terminal use, but if you need:
- 📊 Real-time Scan Analytics & Location Tracking
- 🎨 Custom Brand Colors, Logos & Styled Frames
- 🔄 Dynamic Target URLs (Change destination without re-printing)
- 🏢 Bulk Vector PDF/EPS Export for Commercial Printing
Visit QR Master - Free Smart QR Code Generator.
🛠️ Free Micro Tools by QR Master
📄 License
MIT © QR Master
