README.md (2563B)
1 # ⚡ clndash 2 3 Your Core Lightning dashboard, **without the server nonsense**. 4 5 clndash is a weird little experiment: a [notedeck][notedeck] app that talks to your node **directly over the Lightning Network** using [lnsocket][lnsocket] + [Commando][commando] RPCs. 6 7 No HTTP. No nginx. No VPS. 8 Just open clndash, point it at your node, and boom — you’re in. 9 10 <img src="https://jb55.com/s/476285c50d06c3ce.png" width="50%" /> 11 12 --- 13 14 ## 🤯 Why? 15 16 Because sometimes you just want to *see your channels* and *check invoices* without SSH-ing into a box and typing `lightning-cli`. 17 18 And because LN is already a secure, encrypted connection layer — why not just use that? 19 20 --- 21 22 ## 🔥 Features (as of today) 23 24 * **Plug-and-play LN connection** – powered by [lnsocket][lnsocket] 25 * **Commando RPC** – all dashboard data is fetched directly from your CLN node over Lightning 26 * **Channel overview** – total capacity, inbound/outbound liquidity, largest channel, and pretty bars 27 * **Invoices** – shows recent paid invoices (with zap previews if they came from Nostr) 28 * **No extra daemons** – you don’t need to run a server to use it 29 30 --- 31 32 ## 🪄 Nostr Bonus 33 34 Because it’s a notedeck app, clndash can **render zaps** inline. 35 Yes, your Core Lightning dashboard can now show you when someone on Nostr just sent you sats and why. 36 37 --- 38 39 ## 🏗 Still Baking 40 41 This is WIP. 42 You’ll probably hit bugs. UI might be janky. Some features may vanish or suddenly mutate. 43 44 If you’re reading this and still excited — you’re the exact audience. 45 46 --- 47 48 ## 🛠 How to connect 49 50 1. Get your node’s **public address** (host\:port) and a **Commando rune** with safe permissions. 51 2. Set them as environment variables: 52 53 ```bash 54 export CLNDASH_ID="03f3c108ccd536b8526841f0a5c58212bb9e6584a1eb493080e7c1cc34f82dad71" 55 export CLNDASH_HOST="node.example.com:9735" 56 export CLNDASH_RUNE="your_rune_here" 57 ``` 58 3. Run clndash inside notedeck by calling notedeck with the `--clndash` argument. 59 4. Bask in the glow of real-time LN data over an LN connection. 60 61 --- 62 63 ## ⚠️ Disclaimer 64 65 * Don’t give it a rune that can spend your funds. 66 * Don’t blame me if you break something — this is experimental territory. 67 * If it connects on the first try, buy yourself a beer. 68 69 --- 70 71 If you like living on the edge of LN/Nostr tooling, you’ll like this. 72 If you don’t… you’ll probably want to wait a bit. 73 74 75 [commando]: https://docs.corelightning.org/reference/commando 76 [lnsocket]: https://github.com/jb55/lnsocket-rs 77 [notedeck]: https://github.com/damus-io/notedeck