lg-dev-manager-bridge 1.0.0 → 1.0.1

package/README.md

@@ -1,39 +1,157 @@
-# lg-dev-manager-bridge
+# 📺 LG Dev Manager
 
-The local bridge for **[LG Dev Manager](https://lg.scoty.uk)** — manage LG webOS TVs (rooted or in Developer
-Mode) from your browser: install and update apps, the webOS Homebrew repository, files, a shell, logs and more.
+Manage LG webOS TVs from your browser — rooted (Homebrew Channel) or in Developer Mode. Install apps from the
+webOS Homebrew repository or from an IPK file, update them, install any build of [Litefin](#litefin-in-one-click)
+in one click, browse the TV's files, open a shell, take screenshots, renew the Dev Mode session and dig into logs and
+the luna bus.
 
-Browsers can't speak SSH, so this small program does it for the web app, on your own computer.
+🌐 **Open it:** https://lg.scoty.uk — then run the bridge on your computer (one command, below).
+
+A web rebuild of [webosbrew/dev-manager-desktop](https://github.com/webosbrew/dev-manager-desktop), styled after
+[Adminator](https://github.com/puikinsh/adminator-admin-dashboard).
+
+> ⚠️ **Note:** LG Dev Manager is an independent, community project. It is not affiliated with, endorsed by or supported
+> by LG Electronics. LG and webOS are trademarks of LG Electronics. Rooting a TV or using Developer Mode is at your own
+> risk.
+
+### 🎬 Add a TV, install an app and update it
+
+![Adding the Living Room TV with the wizard, installing Moonfin 2.8.2 from an IPK file and updating it to 2.9.0 from the Homebrew repository](https://raw.githubusercontent.com/Scoty/lg-dev-manager/main/docs/demo-basic.webp)
+
+### 🐞 Debug tools on a rooted TV
+
+![Switching to the Bedroom TV and going through the system log, log levels, kernel log, crash reports and the luna monitor](https://raw.githubusercontent.com/Scoty/lg-dev-manager/main/docs/demo-advanced.webp)
+
+## 🚀 Get started
+
+**You need [Node.js](https://nodejs.org) 22.12 or newer** (any current LTS — 22 or 24). The same version works
+for npx and for running from the source code.
+
+1. Install Node.js if you don't have it (`node --version` shows yours).
+2. In a terminal, start the bridge:
+
+   ```bash
+   npx lg-dev-manager-bridge@latest
+   ```
+
+   It prints a **pairing token**. Keep the terminal open while you use the app (Ctrl+C stops it).
+3. Open **https://lg.scoty.uk**, or the local page the bridge serves at **http://localhost:5199** — they are the
+   same app. On the **Bridge** page, paste the token.
+4. On **Devices → Add a TV**, pick your TV from the scan. Rooted TVs log in as root (Homebrew Channel's SSH server);
+   other TVs use the Developer Mode app and its passphrase.
+
+🍎 On macOS, the first time the bridge looks for your TV, the system asks whether your terminal may find devices on the
+local network — choose **Allow**. 📱 Phones and tablets aren't supported: the bridge has to run on the same computer
+as the browser.
+
+Which page to use is up to you. 🌐 **lg.scoty.uk** always has the latest version and needs nothing installed besides the
+bridge. 🏠 **http://localhost:5199** is served from your computer by the bridge itself, so it works even when the
+website can't be reached. Each keeps its own list of TVs (browsers store them per site); use **Export backup** / **Import backup** on
+the Devices page to move them.
+
+## 🔧 How it works
+
+Browsers can't open SSH connections, so the app comes in two parts:
 
-```bash
-npx lg-dev-manager-bridge@latest
 ```
+ Browser (lg.scoty.uk or localhost:5199)        Your computer                      Your TV
+ ┌──────────────────────────────────┐   WebSocket   ┌────────────────────┐   SSH / SFTP   ┌──────────────┐
+ │ Web app — your TVs, keys and     │ ────────────▶ │ Bridge             │ ─────────────▶ │ webOS        │
+ │ passwords are stored only here   │  127.0.0.1    │ (npx …, Node.js)   │                │ (port 22 or  │
+ └──────────────────────────────────┘  + token      └────────────────────┘                │  9922)       │
+                                                                                          └──────────────┘
+```
+
+- 🖥️ **The web app** is a static site. Saved TVs — names, addresses, keys and passwords — live only in your browser's
+  storage. They are never sent to the website; each request sends them to your own bridge, and only to it.
+- 🌉 **The bridge** is a small Node.js program that does the SSH, SFTP and HTTP work the browser can't. It listens on
+  `127.0.0.1` only (nothing else on your network can reach it), accepts only the app's own pages, needs the pairing
+  token, and keeps nothing on disk except that token. It offers fixed operations — list apps, install, read a log —
+  never a general "connect anywhere" tunnel.
+- 📦 **Homebrew repository and Litefin releases** are fetched by the bridge, so the site itself talks to no one but your
+  bridge. Downloads are checked against their published SHA-256 whenever one is published.
 
-Then open **https://lg.scoty.uk** (or the local copy at **http://localhost:5199**), go to **Bridge** and paste the
-pairing token it printed. Needs Node.js 22 or newer.
+🔄 The bridge tells the site its version; when a newer one is out, the app says so. Update by running
+`npx lg-dev-manager-bridge@latest` again.
 
-## Safety
+## ✨ What it does
 
-- Listens on `127.0.0.1` only; other devices on your network can't reach it.
-- Accepts connections only from the app's own pages, and only with the pairing token (kept in
-  `~/.lg-dev-manager/bridge.json`, readable only by you).
-- Stores nothing else: your TVs' addresses, keys and passwords stay in your browser and are sent with each request.
-- Offers fixed operations (list apps, install, read a log…), never a general network tunnel.
+- 📡 **Devices** — network scan, add rooted or Developer Mode TVs (key fetched from the TV's key server, or a new key
+  made for it), edit, test, export / import.
+- 📦 **Apps** — installed apps with update badges; install IPK files (drag and drop); the webOS **Homebrew repository**
+  with search, details, install and update; the **Litefin repo** with every webOS build of the latest releases
+  (see [below](#litefin-in-one-click)).
+- 📁 **Files** — browse, upload, download, preview, rename, delete over SFTP.
+- 💻 **Terminal** — full shell in tabs, plus a simple mode for TVs without a terminal.
+- ℹ️ **Device info** — model, webOS and firmware, Homebrew Channel status and update, screenshots, Dev Mode session
+  countdown and renewal.
+- 🐞 **Debug** — live system log and kernel log, PmLog levels, crash reports, luna bus monitor (rooted TVs).
+- 🧾 **Console** — every command the bridge runs on the TV, live, with the option to type your own.
 
-## Options
+🌗 Light and dark themes, a command palette (⌘K / Ctrl K), and no analytics or tracking.
+
+<a id="litefin-in-one-click"></a>
+
+## 🍿 Litefin in one click
+
+This app started with one itch. [Litefin](https://github.com/MoazSalem/litefin), a lightweight Jellyfin client for
+LG TVs, publishes a separate IPK for each generation of webOS (Modern, Normal, Legacy, Ultra Legacy) on every
+release, and the Homebrew repository carries only one of them. Updating used to mean opening the GitHub releases,
+downloading the right IPK by hand and installing it through the desktop webOS Dev Manager.
+
+👉 **Apps → Litefin repo** does all of that in one click:
+
+- It lists the last five Litefin releases with every webOS build side by side, read straight from GitHub by the
+  bridge (pre-releases are skipped).
+- It suggests the right build for the active TV from its webOS version, and shows which version is installed and
+  whether a newer one is out.
+- **Install** downloads that build, checks it against GitHub's SHA-256 when one is published, and installs it on the TV
+  — through Homebrew Channel on a rooted TV, or the Developer Mode installer otherwise. All builds are the same app,
+  so switching builds or versions simply replaces it.
+
+## 🛠️ Run the bridge from the source code
+
+Prefer not to use npx? Run it from a clone — it's the same bridge, and it serves the local page too:
+
+```bash
+git clone https://github.com/Scoty/lg-dev-manager.git
+cd lg-dev-manager
+corepack enable      # once, to get pnpm
+pnpm install
+pnpm build
+pnpm bridge          # same as: node apps/bridge/dist/cli.js
+```
+
+This needs Node.js 22.12 or newer, the same as npx (the project itself is developed on Node 24, see `.nvmrc`).
+To update: `git pull`, `pnpm install`, `pnpm build`, then `pnpm bridge`.
+
+Bridge options (`npx lg-dev-manager-bridge --help`):
 
 | Option | |
 |---|---|
 | `--port <n>` | Port to listen on (default 5199) |
 | `--no-ui` | Don't serve the local page |
-| `--web-root <dir>` | Serve the web app from another folder |
 | `--allow-origin <url>` | Also accept another origin, e.g. a self-hosted copy of the web app |
 | `--reset-token` | Make a new pairing token (un-pairs every browser) |
-| `--version`, `--help` | |
 
-Source, documentation and the from-source instructions: https://github.com/Scoty/lg-dev-manager
+## 🧪 Development
+
+```bash
+pnpm install
+pnpm dev            # web app (Vite, http://localhost:5173) + bridge with --dev
+pnpm test           # unit and integration tests (against a mock TV)
+pnpm e2e            # Playwright: built app + real bridge + mock TVs + fake Homebrew repo
+pnpm dev:rig        # the same rig to try by hand: http://127.0.0.1:5299, token e2e-token
+pnpm lint && pnpm typecheck
+```
+
+`tools/mock-tv` fakes webOS TVs (SSH, luna-send, key server, logs) so everything can be tested without a TV.
+Contributors, human or AI: read [AGENTS.md](https://github.com/Scoty/lg-dev-manager/blob/main/AGENTS.md) and [PLAN.md](https://github.com/Scoty/lg-dev-manager/blob/main/PLAN.md) first.
+
+## 📄 License
 
-Apache-2.0 — see LICENSE and NOTICE (credits the original
-[dev-manager-desktop](https://github.com/webosbrew/dev-manager-desktop) and Adminator).
+[Apache-2.0](https://github.com/Scoty/lg-dev-manager/blob/main/LICENSE). You may use, change and share the app and its code freely, including commercially, as long
+as you keep the license and the [NOTICE](https://github.com/Scoty/lg-dev-manager/blob/main/NOTICE) file that credits its authors — this project, the original
+[dev-manager-desktop](https://github.com/webosbrew/dev-manager-desktop) by the webOS Homebrew team, and Adminator.
 
 Not affiliated with or endorsed by LG Electronics. LG and webOS are trademarks of LG Electronics.

package/dist/cli.js

@@ -837,7 +837,7 @@ import { platform } from "os";
 import { randomUUID as randomUUID2 } from "crypto";
 
 // src/version.ts
-var BRIDGE_VERSION = "1.0.0";
+var BRIDGE_VERSION = "1.0.1";
 
 // src/ssh/logged.ts
 import { randomUUID } from "crypto";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "lg-dev-manager-bridge",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Local bridge for LG Dev Manager: lets the web app at lg.scoty.uk (or its local copy) manage LG webOS TVs over SSH",
   "license": "Apache-2.0",
   "author": "Scoty (https://github.com/Scoty)",
@@ -34,7 +34,7 @@
     "README.md"
   ],
   "engines": {
-    "node": ">=22"
+    "node": ">=22.12"
   },
   "dependencies": {
     "ssh2": "^1.17.0",
@@ -49,8 +49,8 @@
     "tsx": "^4.20.0",
     "typescript": "^5.9.0",
     "vitest": "^4.1.11",
-    "@lgdm/mock-tv": "1.0.0",
-    "@lgdm/protocol": "1.0.0"
+    "@lgdm/mock-tv": "1.0.1",
+    "@lgdm/protocol": "1.0.1"
   },
   "scripts": {
     "dev": "tsx watch src/cli.ts --dev",