orb icon indicating copy to clipboard operation
orb copied to clipboard

Orb is a cross-platform (Mac / Windows / OSX / IOS / Android) application for managing an LND / CLN Lightning node. It features bulk payments, an editor, API, App Store, node automation engines and a...

โšก๐Ÿ”ฎ is now Free & Open Source

๐Ÿค—We're pleased to announce that Orb is now fully free ๐Ÿ’ธ and open source๐ŸŽŠ under the GNU GENERAL PUBLIC LICENSE.๐Ÿพ๐Ÿš€๐Ÿ’ฅ

orb

Downloading the Desktop builds โฌ‡๏ธ

Windows and OSX binary builds can be found in the repo's releases page. Please install on your ๐Ÿ’ป๐Ÿ“ฑ not your node.

Downloading the Mobile builds โฌ‡๏ธ

Android

Android users please download the latest APK in the releases page. The Google Play listing is probably out of date.

IOS

You can get Orb IOS using TestFlight (Please consider donating to our Apple dev license fund).

Running Orb from source ๐Ÿ

If you have Python3 & git on a unix-like device:

git clone https://github.com/lightningorb/orb.git
cd orb
pip3 install -r requirements.txt
python3 main.py

With venv

Consider installing Orb's dependencies in a virtual ๐Ÿ“ฆ to keep things clean:

git clone https://github.com/lightningorb/orb.git
cd orb
python3 -m venv venv
. venv/bin/activate
pip3 install -r requirements.txt
python3 main.py

Don't trust: verify๐Ÿ•ต๏ธ

It's prudent to ๐Ÿ”Ž code before running it on a mainnet node:

Documentation

๐Ÿค“Every inch ๐Ÿ“ of ๐Ÿ”ฎ is documented: Read the docs.

Call to action๐Ÿ’ช

Non-devs

Do you believe in โ‚ฟ and โšก and want to help? ๐Ÿ‘Š Then pick any one of these at random:

  • Bookmark ๐Ÿ”– this repo.
  • Use Orb.
  • โญ this repo.
  • Tweet / Note about trying out ๐Ÿ”ฎ.
  • Write a blog post.
  • Create Youtube ๐Ÿ”ฎ tutorial.
  • Find bugs & Log issues.
  • Triage issues.
  • Contribute to the docs.

Devs

  • โžก๏ธ Fork โžก๏ธ Use โžก๏ธ PR ๐Ÿš€