llmtab-desktop 2.0.0

package/README.md

@@ -0,0 +1,48 @@
+# llmtab-desktop
+
+Menu-bar / tray app for [LLMTab](https://github.com/naninanides/llmtab-v2).
+
+This package is a thin launcher. All the application code lives in the
+[`llmtab`](https://www.npmjs.com/package/llmtab) package; `llmtab-desktop`
+only adds the Electron runtime, which is ~200 MB and therefore not something
+to force on people who just want the CLI.
+
+## Install
+
+```sh
+npm i -g llmtab-desktop     # tray app  (pulls llmtab + electron)
+llmtab-desktop
+```
+
+To get the `llmtab` CLI command on your PATH as well, install both — npm only
+links the bins of the package you name:
+
+```sh
+npm i -g llmtab llmtab-desktop
+```
+
+## Platform support
+
+| OS      | status                                                         |
+| ------- | -------------------------------------------------------------- |
+| macOS   | supported — template-image tray icon, popover under the icon   |
+| Linux   | runs, untested; tray appearance depends on your desktop's tray |
+| Windows | runs, untested; tray appearance not tuned                      |
+
+The shell uses macOS tray idioms (`setTemplateImage`, popover positioning
+relative to the menu-bar item). It should start on Linux and Windows but is
+not yet tuned for them. Bug reports with screenshots are welcome.
+
+If you only need the dashboard, `npm i -g llmtab` and run `llmtab` — it serves
+the same UI in your browser with no Electron dependency.
+
+## Uninstall
+
+```sh
+npm rm -g llmtab-desktop
+llmtab uninstall            # optional: also remove ~/.llmtab data
+```
+
+## License
+
+MIT

package/bin.mjs

@@ -0,0 +1,70 @@
+#!/usr/bin/env node
+/**
+ * llmtab-desktop — launches the LLMTab menu-bar shell.
+ *
+ * The shell itself lives in the `llmtab` package (`dist/shell/main.js`); this
+ * package exists only to add the Electron runtime, which is far too large to
+ * force on people who just want the CLI. We locate the installed `llmtab` via
+ * normal Node resolution, so npm/pnpm/yarn layouts all work without guessing
+ * at node_modules paths.
+ */
+import { createRequire } from "node:module";
+import { spawn } from "node:child_process";
+import { existsSync } from "node:fs";
+import path from "node:path";
+
+const require = createRequire(import.meta.url);
+
+function die(message, hint) {
+  console.error(`llmtab-desktop: ${message}`);
+  if (hint) console.error(`  ${hint}`);
+  process.exit(1);
+}
+
+function resolveShellEntry() {
+  let pkgJsonPath;
+  try {
+    pkgJsonPath = require.resolve("llmtab/package.json");
+  } catch {
+    die("cannot find the `llmtab` package.", "Reinstall with: npm i -g llmtab-desktop");
+  }
+  const entry = path.join(path.dirname(pkgJsonPath), "dist", "shell", "main.js");
+  if (!existsSync(entry)) {
+    die(
+      `the installed llmtab has no shell build at ${entry}.`,
+      "This usually means llmtab was installed from source without running its build.",
+    );
+  }
+  return entry;
+}
+
+function resolveElectron() {
+  let electronPath;
+  try {
+    electronPath = require("electron");
+  } catch {
+    die("cannot find the `electron` runtime.", "Reinstall with: npm i -g llmtab-desktop");
+  }
+  // electron's main export is the path to its binary; inside an Electron
+  // runtime it is the API object instead, which means we were run wrong.
+  if (typeof electronPath !== "string") {
+    die("`electron` did not resolve to a binary path.");
+  }
+  if (!existsSync(electronPath)) {
+    die(
+      `the electron binary is missing at ${electronPath}.`,
+      "Its postinstall download may have been skipped or blocked by a proxy.",
+    );
+  }
+  return electronPath;
+}
+
+const child = spawn(resolveElectron(), [resolveShellEntry(), ...process.argv.slice(2)], {
+  stdio: "inherit",
+});
+
+child.on("error", (err) => die(`failed to launch Electron: ${err.message}`));
+child.on("exit", (code, signal) => {
+  if (signal) process.kill(process.pid, signal);
+  else process.exit(code ?? 0);
+});

package/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "llmtab-desktop",
+  "version": "2.0.0",
+  "description": "Menu-bar / tray app for LLMTab — adds the Electron shell to the llmtab CLI.",
+  "type": "module",
+  "license": "MIT",
+  "author": "naninanides",
+  "keywords": [
+    "llm",
+    "tokens",
+    "usage",
+    "cost",
+    "tracker",
+    "menubar",
+    "tray",
+    "electron",
+    "llmtab"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/naninanides/llmtab-v2.git",
+    "directory": "packages/desktop"
+  },
+  "homepage": "https://github.com/naninanides/llmtab-v2#readme",
+  "bugs": {
+    "url": "https://github.com/naninanides/llmtab-v2/issues"
+  },
+  "engines": {
+    "node": ">=20"
+  },
+  "bin": {
+    "llmtab-desktop": "./bin.mjs"
+  },
+  "files": [
+    "bin.mjs",
+    "README.md"
+  ],
+  "dependencies": {
+    "electron": "^44.0.0",
+    "llmtab": "^2.0.0"
+  }
+}