INSTALL

Two runtimes. One simple experience.

Choose the runtime already on your computer. Both official packages generate the same QRB1 animated QR stream.

Py

Python

Requires Python 3.10 or later

Recommended
  1. Install QRBeam
    $ python3 -m pip install --upgrade qrbeam
  2. Send a file
    $ qrbeam send ./example.zip
View package on PyPI
JS

Node.js

Requires Node.js 20 or later

  1. Install QRBeam globally
    $ npm install --global qrbeam
  2. Send a file
    $ qrbeam send ./example.zip
View package on npm
USAGE

Make your first transfer

QRBeam opens a local player in your browser. Point your iPhone’s rear camera at the screen.

1
Choose a file

Files must be 5 MiB or smaller.

2
Run the command

qrbeam send FILE

3
Keep the image clear

Use full screen, raise brightness, and hold the phone steady.

4
Wait for verification

SHA-256 verifies the file when complete.

COMMAND OPTIONS

Common options

--profile safeDefault 6 fps mode for handheld scanning
--profile fast10 fps for a fixed phone and bright screen
--port 8765Change the local player port
--no-openDo not open the browser automatically