Connect your Omarchy desktop to an Android phone or a Mac over your local network, or through Tailscale when you are away. Share files and clipboard text, read phone notifications, control media, and use your phone as a camera or microphone.

Flux includes a CLI, a background daemon, a native Qt window, an Omarchy shell plugin, a native Android app, and a native macOS app. The desktop opens the network connections, so the default Omarchy firewall needs no new inbound rule.

https://github.com/user-attachments/assets/4b8445fe-6734-4100-b200-92f57e1b353a

Install locally · Set up Android · Set up macOS · Read the docs · Use with agents

What you can do

Task	Guide
Send files, clipboard text, and links between devices	Everyday use
Read notifications, send SMS, control media, and run desktop commands from your phone	CLI reference
Sync Do Not Disturb and pause media during calls	Phone integration
Scan text, send photos, and use the phone as a webcam or microphone	Camera and streams
Show the phone screen in a desktop window	Screen mirror
Approve sudo with the phone's fingerprint sensor	Fingerprint approval
Reach your phone away from home through Tailscale	Connect through Tailscale
See herdr coding agents on the phone, read their output, and answer them	herdr agents

Flux for Android requires Android 10 or later. Flux for Android is the supported phone app.

Flux for macOS requires macOS 14 or later. It connects a Mac in the place of a phone and offers the features that macOS allows. See Flux for macOS for the feature list.

Clone and install

On Omarchy or Arch Linux, install the build tools:

sudo pacman -Syu --needed base-devel git go cmake ninja

Clone this repository and setup:

git clone https://github.com/bjarneo/flux.git
cd flux/dist/arch
makepkg -si
flux-cli setup
flux-cli doctor
flux-cli open

The package includes the Qt app, CLI, daemon, shell plugin, approval helper, desktop entry, icons, and system files. Run flux-cli setup as your desktop user after installation. The short name flux also works when no other program, such as fluxcd, uses that name.

The install guide covers dependencies, source builds, user-only installation, updates, and removal.

Connect your phone

1. Install Flux for Android.
2. Connect the phone and desktop to the same local network.
3. Open the desktop window with flux-cli open.
4. Select + Pair new device.
5. Compare the 8-character verification key on both screens.
6. Accept the matching request on the phone.

You can also start the pair request from a terminal:

flux-cli pair "Pixel 8"

To connect a Mac, build the app and follow Pair a Mac.

Use it from your terminal

flux-cli status
flux-cli send "$HOME/Downloads/report.txt"
flux-cli clip
flux-cli url https://omarchy.org
flux-cli ring
flux-cli notify --run -- make test

To select one of multiple connected phones, add --device:

flux-cli --device "Pixel 8" send "$HOME/Downloads/report.txt"

See the CLI reference for commands and script examples.

Build and release

make build test vet
make android

GitHub Actions builds the complete Arch package and Android APKs for pull requests and the main branch. Stable version tags produce a signed APK, an Arch package, an AUR recipe, and checksums. The optional AUR job publishes the tested recipe after the GitHub release succeeds.

On a Mac with Xcode and XcodeGen, test, build, and install the macOS app:

make test-macos macos
make install-macos

GitHub Actions does not build the macOS app.

See development for local checks and releases for keys, secrets, tags, and artifacts.

Documentation

• Install and update
• Android build and setup
• macOS build and setup
• CLI reference
• Configuration and data paths
• Everyday use
• Camera, microphone, and screen
• Omarchy shell integration
• Troubleshoot Flux
• Architecture and IPC
• Agent skill

The documentation index lists all topics.