amnesialabs/zen-bridge

Zen's bridge client for macOS 💬🗳

Zen Bridge

💬🗳 A performant headless iMessage client for macOS, built for Zen Client –

• Open source and ridiculously simple Node-based API, based upon the pioneering code of its predecessor.
• Automatically shares new messages with Zen peers (eg. Zen Client), and even other Bridges 🤷‍♂️
• Runs on outdated macOS hardware (OS X/macOS 10.10 and up, wipe dust off your old Mac mini)!
• Supports raw file transfers.
• A GUI wrapper for Zen Bridge is in the works!

Links

• See releases for a detailed version history.
• Please open an issue if anything is missing or unclear in this documentation.

Table of Contents (click to expand)

• Installation
• Usage
• Contributing
• License

Visual Demonstration

This gif shows a dev installing and running this project from scratch on macOS 10.15.3's Terminal.app, with Node v.12.16.3 pre-installed –

Installation

Use the package manager npm to install Zen Bridge's dependencies.

git clone https://github.com/AmnesiaLabs/zen-bridge
cd zen-bridge
npm i

Usage

node index.js <relay> <secret pairing uuid>

A common launch command may look like:

$ node index.js https://relay.amnesia.software 84ee59a9-8765-47fd-b161-3bc19f3a846c
https://relay.amnesia.software 84ee59a9-8765-47fd-b161-3bc19f3a846c
Actively listening for activity... Press Control + C to quit.
Connected to relay with secret UUID: 84ee59a9-8765-47fd-b161-3bc19f3a846c
iMessage database successfully mounted to service!
Successfully connected into UUID room.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

GNU General Public License v3.0