Skip to content

About

The protocol, end-to-end encryption and relay behind Farol Remote.

Resources

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

Farol Remote

Answer your coding agents from your phone. Farol shows its sessions to a phone you paired and types what you reply. Everything is encrypted between the two, so nothing in between can read it.

Relay status

Use it

In Farol on your Mac, open Settings → Remote, turn it on and show the code. Open Farol on your iPhone and scan it. The sessions already open on the Mac appear on the phone, where you can read and answer them while the Mac stays on.

Run agents on a server

The farol-host CLI runs your sessions on a server of your own that stays on, so the Mac can be closed. It exposes the tmux windows on that server, and the phone lists them by the server's name, next to your Mac's. The phone does everything with it that it does with Farol on the Mac.

It stays experimental until three things on the roadmap are done.

With tmux installed on the server:

curl -fsSL https://farol.sh/host.sh | sh
farol-host setup

Every tmux window on that machine is then a session the phone can open, as a tab of Farol on the Mac is. The full steps are in host/README.md, and the Remote docs cover the phone side.

Docs

  • Architecture: the parts, where they live, and the messages between them
  • Security: pairing, the encrypted channel, what the relay sees, and what is not covered yet
  • Testing: what to try with a real Mac, iPhone and agent before Remote goes to testers
  • Roadmap
  • Terms: host, device, session, relay

The Mac, the relay, the phone and the experimental server

What is in this repo

Everything that touches security, in one small place to read.

Folder What it is
Sources/FarolRemote The Swift package the Mac and iPhone apps share: the messages, pairing and the encryption
relay/ The relay, in Go. See relay/README.md
host/ The experimental farol-host and its installer. See host/README.md
Sources/RemoteProbe A phone in a terminal, for testing without the iPhone app
docs/ The pages above, and the diagrams' sources in docs/diagrams

Work on it

swift test                      # the package
cd relay && go test -race ./... # the relay
cd host && go test -race ./... # the farol-host CLI

License

MIT.

About

The protocol, end-to-end encryption and relay behind Farol Remote.

Resources

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages