Wi-Fi QR Code Generator (Node.js)

A professional Node.js CLI tool for generating Wi-Fi QR codes with custom styling. Features both interactive prompts and command-line flags with POSIX-style options.

✨ Features

• 🎯 Interactive Mode: Guided prompts for easy use
• ⚡ Command-line Flags: POSIX-style short and long options
• 🎨 Custom Styling: Square and circular module styles
• 🌈 Color Customization: 6 predefined colors + custom hex colors
• 📱 iOS Compatible: Optimized QR format for iPhone scanning
• 🖥️ Terminal Display: Built-in terminal QR code viewer
• 💾 File Output: High-quality PNG generation
• 🔒 Security Support: WPA/WPA2/WPA3, WEP, and Open networks

🚀 Installation

Prerequisites

• Node.js 14.0.0 or higher
• npm (comes with Node.js)

Install Dependencies

npm install

Make Executable (Unix/Linux/macOS)

chmod +x wifi-qr.js

📖 Usage

Interactive Mode

./wifi-qr.js

Command-line Flags

Short Flags (Quick Usage)

# Terminal display
./wifi-qr.js -s MyWiFi -p mypassword123

# Save to file
./wifi-qr.js -s MyWiFi -p mypassword123 -o my-wifi

# Circle style
./wifi-qr.js -s MyWiFi -p mypassword123 --style circle -o my-wifi-circle

Long Flags (Readable)

# Terminal display
./wifi-qr.js --ssid MyWiFi --password mypassword123

# Save to file
./wifi-qr.js --ssid MyWiFi --password mypassword123 --output my-wifi

# Circle style with hidden network
./wifi-qr.js --ssid MyWiFi --password mypassword123 --style circle --hidden --output my-wifi

Mixed Flags (Flexible)

./wifi-qr.js -s MyWiFi --password mypassword123 --style circle -o my-wifi

Available Options

Short	Long	Description	Default
-s	--ssid	Wi-Fi network name (SSID)	required
-p	--password	Wi-Fi password	required for secured networks
-t	--security	Security type: wpa, wep, open	wpa
-H	--hidden	Hidden network flag	false
-S	--style	QR style: square, circle	square
-c	--color	QR color: predefined or hex code	black
-o	--output	Output filename (without extension)	terminal display
-h	--help	Show help message
-V	--version	Show version number

🎨 QR Code Styles

Square Style (Default)

• Description: Classic square modules
• Compatibility: Maximum compatibility with all scanners
• Use Case: Production environments, maximum reliability

Circle Style

• Description: Square corner patterns + circular data modules
• Compatibility: High compatibility (corners preserved for scanning)
• Use Case: Aesthetic designs while maintaining reliability

🌈 QR Code Colors

Predefined Colors

Color	Hex Code	Description	Use Case
black	#000000	Classic black (default)	Maximum compatibility
blue	#0066CC	Professional blue	Corporate branding
green	#00AA00	Nature green	Environmental themes
red	#CC0000	Attention red	Important/urgent networks
purple	#6600CC	Creative purple	Artistic/creative projects
orange	#FF6600	Energetic orange	Dynamic/energetic themes

Custom Colors

• Hex Format: Use any hex color code (e.g., #FF5733, #f57)
• Validation: Supports both 3-digit and 6-digit hex codes
• Interactive Mode: Select "custom" to enter your own hex code

🎨 Visual Style Examples

Compare all 5 QR code styles side by side. All examples use: Demo-WiFi / demo123

Square	Rounded	Dots	Classy	Extra-Rounded
Classic Squares Black (#000000)	Smooth Corners Blue (#0066CC)	Circular Dots Green (#00AA00)	Elegant Tapered Purple (#6600CC)	Soft Bubbles Orange (#FF6600)
--style square --color black	--style rounded --color blue	--style dots --color green	--style classy --color purple	--style extra-rounded --color orange

Style Characteristics

Style	Description	Best For	Compatibility
Square	Traditional sharp-edged modules	Corporate, legacy devices	⭐⭐⭐⭐⭐ Maximum
Rounded	Smooth rounded corners	Modern aesthetic + reliability	⭐⭐⭐⭐⭐ High
Dots	Perfect circular data modules	Minimalist, social media	⭐⭐⭐⭐ Good
Classy	Elegant tapered shapes	Professional, luxury brands	⭐⭐⭐⭐ Good
Extra-Rounded	Very soft bubble-like modules	Playful, children's apps	⭐⭐⭐ Moderate

Generate Your Own

# Try different combinations
./wifi-qr.js -s "Your-WiFi" -p "your-password" --style rounded --color blue -o my-qr
./wifi-qr.js -s "Your-WiFi" -p "your-password" --style dots --color "#FF5733" -o custom-qr

🔒 Security Types

Type	Description	Use Case
wpa	WPA/WPA2/WPA3	Most modern networks (recommended)
wep	WEP (legacy)	Older networks (not recommended)
open	No password	Public networks

📱 Output Options

Terminal Display (Default)

• Displays QR code directly in terminal
• Great for quick testing and verification
• Works in any terminal environment

File Output

• High-quality PNG files (512x512 pixels)
• Professional styling with proper borders
• Optimized for printing and sharing

🛠️ Examples

Basic Usage

# Interactive mode - prompts for all information
./wifi-qr.js

# Quick terminal display
./wifi-qr.js -s "My Home WiFi" -p "password123"

# Save to file
./wifi-qr.js -s "My Home WiFi" -p "password123" -o home-wifi

Advanced Usage

# Hidden network with circle style
./wifi-qr.js -s "Hidden-Network" -p "secret123" --hidden --style circle -o hidden-wifi

# Open network (no password)
./wifi-qr.js -s "Public-WiFi" --security open -o public-wifi

# WEP network (legacy)
./wifi-qr.js -s "Old-Router" -p "12345" --security wep -o legacy-wifi

# Blue circle QR code
./wifi-qr.js -s "Corporate-WiFi" -p "password123" --style circle --color blue -o corporate-wifi

# Custom hex color with style
./wifi-qr.js -s "Creative-Space" -p "artpass" --color "#FF5733" --style circle -o creative-wifi

Color Examples

# Predefined colors
./wifi-qr.js -s "MyWiFi" -p "pass123" --color blue -o blue-qr
./wifi-qr.js -s "MyWiFi" -p "pass123" --color green --style circle -o green-circle
./wifi-qr.js -s "MyWiFi" -p "pass123" -c red -o red-qr

# Custom hex colors
./wifi-qr.js -s "MyWiFi" -p "pass123" --color "#FF5733" -o orange-red
./wifi-qr.js -s "MyWiFi" -p "pass123" -c "#f57" --style circle -o short-hex
./wifi-qr.js -s "MyWiFi" -p "pass123" --color "#00FFFF" -o cyan-qr

# Colors with other options
./wifi-qr.js -s "HiddenNet" -p "secret" --hidden --color purple --style circle -o purple-hidden

Mixed Flag Styles

# Short and long flags combined
./wifi-qr.js -s "MyWiFi" --password "mypass123" --style circle --color blue -o styled-wifi

# All long flags
./wifi-qr.js --ssid "MyWiFi" --password "mypass123" --security wpa --style circle --color green --output styled-wifi

# Mix of short and long with custom color
./wifi-qr.js -s "MyWiFi" --password "mypass123" -c "#FF5733" --style circle -o custom-styled

🔧 Development

Run Tests

npm test

View Help

npm run help

Start Application

npm start

📋 Wi-Fi QR Code Format

The generated QR codes use the standard Wi-Fi QR format optimized for iOS devices:

WIFI:S:<SSID>;T:<SECURITY>;P:<PASSWORD>;;

Field Order: The S, T, P order is critical for iOS compatibility.

🐛 Troubleshooting

QR Code Won't Scan

1. Try square style: More compatible with older scanners
2. Check password: Ensure no special characters are causing issues
3. Verify network name: SSID must match exactly
4. Test security type: Try different security options

Command Not Found

# Make sure the script is executable
chmod +x wifi-qr.js

# Or run with node directly
node wifi-qr.js --help

Module Import Errors

# Ensure all dependencies are installed
npm install

# Check Node.js version
node --version  # Should be 14.0.0 or higher

📦 Dependencies

• commander: POSIX-style CLI argument parsing
• inquirer: Interactive command-line prompts
• @loskir/styled-qr-code-node: Professional QR code generation with styling
• qrcode-terminal: Terminal QR code display
• chalk: Colorful terminal output

📄 License

MIT License

---

Made with ❤️ for seamless Wi-Fi sharing