https://github.com/kasundularaam/ipqr
A cross-platform CLI tool that generates QR codes for local server URLs with automatic IP detection - perfect for quick mobile access to development servers.
https://github.com/kasundularaam/ipqr
ascii-art cli-tool command-line cross-platform development-tools ip-detection local-development local-server mobile-access networking pypi-package python qr-code qrcode-generator server-url
Last synced: 5 months ago
JSON representation
A cross-platform CLI tool that generates QR codes for local server URLs with automatic IP detection - perfect for quick mobile access to development servers.
- Host: GitHub
- URL: https://github.com/kasundularaam/ipqr
- Owner: kasundularaam
- Created: 2024-08-18T19:59:04.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2025-09-10T08:53:18.000Z (9 months ago)
- Last Synced: 2025-09-25T04:46:58.345Z (8 months ago)
- Topics: ascii-art, cli-tool, command-line, cross-platform, development-tools, ip-detection, local-development, local-server, mobile-access, networking, pypi-package, python, qr-code, qrcode-generator, server-url
- Language: Python
- Homepage:
- Size: 9.77 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 📱 IPQR 🖥️
[](https://pypi.org/project/ipqr/)
[](https://pypi.org/project/ipqr/)
[](https://opensource.org/licenses/MIT)
[](https://pypi.org/project/ipqr/)
[](https://github.com/kasundularaam/ipqr/stargazers)
IPQR is a cross-platform command-line tool that generates QR codes for your local server URLs. It automatically detects your local IP address and creates a QR code that can be scanned to quickly access your local server from mobile devices. No more typing long IP addresses on your phone! 🚀
## 🌟 Features
- 🔍 Automatic local IP detection
- 🎨 ASCII QR code generation
- 🔢 Custom port support
- 🚀 Easy to use command-line interface
- 🐧 Cross-platform support (Windows, macOS, Linux)
## 🛠️ Installation
You can install IPQR easily using pip:
```
pip install ipqr
```
This works on Windows, macOS, and Linux!
## 🚀 Usage
### Basic Usage
To use IPQR with the default port (8000):
```
ipqr
```
### Custom Port
To specify a custom port:
```
ipqr -p 5000
```
or
```
ipqr --port 5000
```
## 📖 Example
Here's what you'll see when you run IPQR:
```
$ ipqr
Local server URL: http://192.168.1.100:8000
Scan this QR code to access the local server:
███████████████████████████████
███████████████████████████████
████ ▄▄▄▄▄ █ █ █▀█▄█ ▄▄▄▄▄ ████
████ █ █ █▄█▀██▀ █ █ █ ████
████ █▄▄▄█ █▀█ █▀██ █▄▄▄█ ████
████▄▄▄▄▄▄▄█ █ ▀ █▄█▄▄▄▄▄▄▄████
████ ▀▄██▄▀▀▀█▄▀▀ █▄█▀ ▀▄▀████
████▀▀▀██▀▀▄▀ ▀▀▀▀ ▀█▀ ▀█▀████
████ ▀▄▀▀▄▄▀▀▀██▀▀▀█▀▀▄▀▀▄ ████
████▄██▄▄▄▄▀▀▀▄█ ▄▀▄▀▄▄▄▀▀▄████
████ ▄▄▄▄▄ █▄█▀ ▀▄█ █ █▄█ █████
████ █ █ █ █▀▀▄▀▀█▄ ▄▀█████
████ █▄▄▄█ █▀█ █▀▀ █▄█▄▀███████
████▄▄▄▄▄▄▄█▄███▄█▄██▄██▄██████
███████████████████████████████
███████████████████████████████
```
Just scan the QR code with your mobile device, and you're good to go! 📱✨
## 🐧 Linux Users
IPQR is fully compatible with Linux systems! It uses smart IP detection methods that work across different Linux distributions. If you encounter any issues, please report them on our GitHub page.
## 🤝 Contributing
Contributions, issues, and feature requests are welcome! Feel free to check [issues page](https://github.com/kasundularaam/ipqr/issues).
## 📜 License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## 🙏 Acknowledgements
- Thanks to the creators of [qrcode](https://github.com/lincolnloop/python-qrcode) and [netifaces](https://github.com/al45tair/netifaces) libraries.
- Inspired by the need to quickly share local server addresses during development.
## 🚀 About the Author
Created with ❤️ by Kasun Dulara. Connect with me on [GitHub](https://github.com/kasundularaam).
Happy coding! 💻✨