omabeam 0.1.0

Beam text, links, or one file to a phone with a QR code
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63

# OmaBeam

**No app. No account. No cloud. Scan and go.**

OmaBeam is a lightweight CLI for Omarchy that beams text, links, or one file
from your computer to a phone on the same local network using a QR code.

## Install

Install OmaBeam through `mise`, included with Omarchy:

```sh
mise use --global cargo:omabeam
```

OmaBeam uses `wl-paste` from `wl-clipboard` for the Wayland clipboard and `ip`
from `iproute2` to find the local network address. Both are included with
Omarchy.

## Usage

Share the current clipboard:

```sh
omabeam
```

Share piped text or a URL:

```sh
echo "hello" | omabeam
```

Share one file:

```sh
omabeam photo.jpg
```

Text and URLs are encoded directly in the terminal QR code. File sharing runs
in the foreground until you press <kbd>Ctrl</kbd>+<kbd>C</kbd>. Formats that the
phone browser supports are shown inline; other files are downloaded.

## Firewall

File sharing uses TCP port `61234`. If a firewall blocks the connection, allow
that port only from your trusted LAN. Replace these example network values:

```sh
interface=wlp0s20f3
subnet=192.168.1.0/24
sudo ufw allow in on "$interface" from "$subnet" to any port 61234 proto tcp
```

## Privacy

OmaBeam uploads nothing. The temporary server binds only to the current LAN
address, exposes only the selected regular file, and protects its URL with a
new random route token each time it runs.

## License

[MIT](LICENSE)