{"id":23919481,"url":"https://github.com/deemkeen/qurl","last_synced_at":"2025-09-25T11:04:13.733Z","repository":{"id":265291031,"uuid":"895614482","full_name":"deemkeen/qurl","owner":"deemkeen","description":"a simple cli, that provides qr-code-based file \u0026 data sharing","archived":false,"fork":false,"pushed_at":"2024-11-29T19:51:15.000Z","size":16,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-05T14:52:28.899Z","etag":null,"topics":["cli","golang","qrcode","tui","usability"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/deemkeen.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-11-28T14:37:53.000Z","updated_at":"2024-12-02T08:39:54.000Z","dependencies_parsed_at":"2024-11-28T19:23:33.472Z","dependency_job_id":null,"html_url":"https://github.com/deemkeen/qurl","commit_stats":null,"previous_names":["deemkeen/qurl"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deemkeen%2Fqurl","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deemkeen%2Fqurl/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deemkeen%2Fqurl/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deemkeen%2Fqurl/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/deemkeen","download_url":"https://codeload.github.com/deemkeen/qurl/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240378928,"owners_count":19792040,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","golang","qrcode","tui","usability"],"created_at":"2025-01-05T14:52:36.650Z","updated_at":"2025-09-25T11:04:08.689Z","avatar_url":"https://github.com/deemkeen.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# qURL\n\nqURL is a simple command-line tool that allows you to quickly transfer files or text between devices using QR codes.\n\n## Features\n\n- Bi-directional file and text sharing\n- Easy file upload via web interface\n- Direct QR code generation for short text\n- No app installation required on mobile device\n- Clean and responsive web interface\n- Cross-platform (Windows, macOS, Linux)\n\n## Requirements\n\n- Go 1.23 or higher\n\n## Installation\n\n```bash\n# Clone the repository\ngit clone \u003cthis repo\u003e\n\ncd qurl\n\n# Build the binary\n./build.sh\n\n# Optional: Copy binary to your PATH to run from anywhere\nsudo cp qurl /usr/local/bin/\n```\n\n## Usage\n\n### Receiving Files/Text\n\n1. Run the `qurl` binary in your terminal:\n```bash\n./qurl\n```\n\n2. A QR code will appear in your terminal\n\n3. Scan the QR code with your mobile device's camera\n\n4. Your browser will open with two options:\n   - Upload a file by clicking \"Choose File\"\n   - Share text by typing in the text area\n\n5. Click \"Upload\" to send the file or text to your terminal\n\n### Sharing Files/Text\n\nShare a file:\n```bash\n./qurl -f path/to/file.txt\n```\n\nShare text (two methods):\n```bash\n# For text under 200 characters - generates direct QR code\n./qurl -t \"Quick message to share\"\n\n# For longer text - creates temporary web server\n./qurl -t \"$(cat long_text.txt)\"\n```\n\n## Environment Variables\n\n- `HOST_ADDR`: Set a specific IP address or hostname (default: auto-detect)\n- `HOST_PORT`: Set a specific port (default: 8081)\n\nExample:\n```bash\nHOST_ADDR=192.168.1.100 HOST_PORT=3000 ./qurl\n```\n\n## Notes\n\n- The server automatically shuts down after successful transfer\n- The upload URL contains a random suffix for basic security\n- Works on any device with a browser and camera\n- No need to be on the same Wi-Fi network as long as the device can reach the host IP\n- Short text messages (\u003c200 chars) are encoded directly in QR code without server\n- Longer text and files are shared via temporary web server\n\n## Similar Projects\n\nAfter development of qURL, similar projects were discovered:\n- [qrcp](https://github.com/claudiodangelis/qrcp.git) - A tool for transferring files over Wi-Fi from your computer to your mobile device by scanning a QR code\n\n## Credits\n\nQR code generation is powered by [github.com/skip2/go-qrcode](https://github.com/skip2/go-qrcode)\n\n## License\n\nMIT License\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdeemkeen%2Fqurl","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdeemkeen%2Fqurl","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdeemkeen%2Fqurl/lists"}