README

!Logo

 $ qrcp

Transfer files over Wi-Fi from your computer to a mobile device by scanning a QR code without leaving the terminal.



Join the Telegram channel qrcp_dev or the @qrcp_dev Twitter account for news about the development.

---

 How does it work?

!Screenshot

qrcp binds a web server to the address of your Wi-Fi network interface on a random port and creates a handler for it. The default handler serves the content and exits the program when the transfer is complete. When used to receive files, qrcp serves an upload page and handles the transfer.

The tool prints a QR code that encodes the text:


http://{address}:{port}/{random_path}


Most QR apps can detect URLs in decoded text and act accordingly (i.e., open the decoded URL with the default browser), so when the QR code is scanned, the content will begin downloading by the mobile browser.

 Demo

Send files to mobile:

!screenshot

Receive files from mobile:

!Screenshot

---

 Installation

 Using Go (Latest Development Version)
Requires Go 1.18 or later:
sh
go install github.com/claudiodangelis/qrcp@latest


 Prebuilt Binaries
Download the latest release for your platform from the Releases page.

| Platform    | Instructions                                                                             |
|-------------|------------------------------------------------------------------------------------------|
| Linux   | Extract the .tar.gz archive, move the binary to /usr/local/bin, and set permissions. |
| Windows | Extract the .tar.gz archive and place the .exe file in a directory in your PATH.   |
| macOS   | Extract the .tar.gz archive, move the binary to /usr/local/bin, and set permissions. |

 Package Managers

| Platform    | Package Manager | Command                                        |
|-------------|-----------------|------------------------------------------------|
| Linux   | ArchLinux (AUR) | yay -S qrcp-bin or yay -S qrcp             |
| Linux   | Debian/Ubuntu   | sudo dpkg -i qrcp__linux_x86_64.deb |
| Linux   | CentOS/Fedora   | sudo rpm -i qrcp__linux_x86_64.rpm  |
| Windows | WinGet          | winget install --id=claudiodangelis.qrcp  -e |
| Windows | Scoop           | scoop install qrcp                           |
| Windows | Chocolatey      | choco install qrcp                           |
| macOS   | Homebrew        | brew install qrcp                            |

 Confirm Installation
After installation, verify that qrcp is working:
sh
qrcp --help


---

 Usage

 Send Files

| Action                      | Command Example                   |
|-----------------------------|-----------------------------------|
| Send a file             | qrcp MyDocument.pdf             |
| Send multiple files     | qrcp MyDocument.pdf IMG0001.jpg |
| Send a folder           | qrcp Documents/                 |
| Zip before transferring | qrcp --zip LongVideo.avi        |

 Receive Files

| Action                              | Command Example                  |
|-----------