@caius_kong/ccusage-dashboard 0.2.9 → 0.2.11

package/README.md

@@ -38,7 +38,8 @@ npx @caius_kong/ccusage-dashboard
 ```
 
 That's it. npx downloads the package (including its own `ccusage` dependency),
-starts a local server on `http://127.0.0.1:8799`, and opens your browser.
+starts a local server on `http://127.0.0.1:8799`, and prints the dashboard URL
+for you to open.
 
 > Requirements: **Node.js** (for the launcher) and **Python 3.8+** (for the server).
 > On macOS: `brew install python3`. No other installs, no build step, no config.
@@ -48,10 +49,12 @@ starts a local server on `http://127.0.0.1:8799`, and opens your browser.
 ```bash
 npx @caius_kong/ccusage-dashboard --port 9000     # change port
 npx @caius_kong/ccusage-dashboard --budget 500    # monthly budget cap (default $300)
-npx @caius_kong/ccusage-dashboard --no-warm       # skip 3s startup warm-up
-CCUSAGE_UI_NO_OPEN=1 npx @caius_kong/ccusage-dashboard   # don't auto-open browser
+npx @caius_kong/ccusage-dashboard --no-warm       # skip background warm-up
 ```
 
+Once started, the launcher prints the dashboard URL — open it in your browser
+(no browser is auto-launched).
+
 ## What it shows
 
 | | |
@@ -80,7 +83,7 @@ ccusage   (bundled dependency — the real cost engine)
 - `lib/server.py` — Python stdlib HTTP server. Resolves a local ccusage
   (bundled dep → PATH → npx cache), warms caches on boot (~3s), then serves instant responses.
 - `lib/index.html` — single-file dashboard. No build step, no CDN.
-- `bin/ccusage-ui.js` — Node launcher (finds python3, starts server, opens browser).
+- `bin/ccusage-ui.js` — Node launcher (finds python3, starts server, prints URL).
 
 ## Local development
 

package/bin/ccusage-ui.js

@@ -5,12 +5,16 @@
  * Locates the bundled server.py (and its index.html sibling) and runs it with
  * the local python3, forwarding any CLI args. The server itself shells out to
  * ccusage for all numbers, so the dashboard always matches ccusage.
+ *
+ * Startup UX: once the server is up, a clear URL banner is printed so the
+ * user can click/copy it to open the dashboard. No background magic.
  */
 'use strict';
 
 const { spawn, spawnSync } = require('node:child_process');
 const path = require('node:path');
 const fs = require('node:fs');
+const http = require('node:http');
 
 // Data files live in package/lib (installed layout) or the repo root (dev layout).
 function resolveLibFile(name) {
@@ -41,13 +45,47 @@ if (!py) {
   process.exit(1);
 }
 
-const args = process.argv.slice(2);
-if (!args.includes('--open') && !process.env.CCUSAGE_UI_NO_OPEN) {
-  args.push('--open'); // default: open browser after start
+// Parse the user's --port / --host so the banner points at the real URL.
+const rawArgs = process.argv.slice(2);
+function argValue(name, fallback) {
+  const i = rawArgs.indexOf(name);
+  return i >= 0 && rawArgs[i + 1] ? rawArgs[i + 1] : fallback;
 }
+const host = argValue('--host', '127.0.0.1');
+const port = parseInt(argValue('--port', '8799'), 10);
+const url = `http://${host}:${port}`;
+
+const args = rawArgs.slice();
 
 const child = spawn(py, [serverPy, ...args], { stdio: 'inherit', env: { ...process.env } });
 
+// Once the server answers /, print a clear URL banner for manual opening.
+let bannerPrinted = false;
+function printBanner() {
+  if (bannerPrinted) return;
+  bannerPrinted = true;
+  const line = '─'.repeat(Math.max(20, url.length + 6));
+  console.log('');
+  console.log(line);
+  console.log(`  Dashboard is running →  ${url}`);
+  console.log(`  Open it manually:      ${url}`);
+  console.log(line);
+  console.log('');
+}
+
+let checked = false;
+function pingAndBanner() {
+  if (checked) return;
+  checked = true;
+  const req = http.get(url + '/api/health', { timeout: 1500 }, (res) => {
+    if (res.statusCode === 200) printBanner();
+    else setTimeout(pingAndBanner, 500);
+  });
+  req.on('error', () => setTimeout(pingAndBanner, 500));
+}
+
+setTimeout(pingAndBanner, 800); // give the python server a beat to bind
+
 for (const sig of ['SIGINT', 'SIGTERM']) {
   process.on(sig, () => { if (!child.killed) child.kill(sig); });
 }

package/lib/server.py

@@ -12,7 +12,7 @@ Because all numbers come from ccusage itself, the figures always match what
 to maintain, no third-party packages — only the Python standard library.
 
 Usage:
-    python3 server.py [--port 8799] [--budget 300] [--open]
+    python3 server.py [--port 8799] [--budget 300]
 """
 from __future__ import annotations
 
@@ -543,7 +543,6 @@ def main() -> None:
     parser.add_argument("--budget", type=float, default=None, help="monthly budget cap in USD (default 300)")
     parser.add_argument("--ccusage-path", default=None, help="explicit path to a ccusage binary or src/cli.js")
     parser.add_argument("--no-warm", action="store_true", help="skip background warm-up (first requests may be slow)")
-    parser.add_argument("--open", action="store_true", help="open browser after start")
     args = parser.parse_args()
 
     BUDGET = args.budget if args.budget is not None else float(os_env_budget() or 300.0)
@@ -575,8 +574,6 @@ def main() -> None:
     httpd = ThreadingHTTPServer((args.host, args.port), Handler)
     url = f"http://{args.host}:{args.port}"
     print(f"ccusage-ui → {url}  (monthly budget ${BUDGET:g}, Ctrl+C to stop)", flush=True)
-    if args.open:
-        _open_browser(url)
 
     try:
         httpd.serve_forever()
@@ -584,31 +581,6 @@ def main() -> None:
         print("\nbye", flush=True)
 
 
-def _open_browser(url: str) -> None:
-    """Open the dashboard in the default browser. Prefers the OS-native opener
-    (open / xdg-open / start) and logs success/failure so it is verifiable.
-    """
-    import subprocess
-    import sys
-
-    if sys.platform == "darwin":
-        cmd = ["open", url]
-    elif sys.platform.startswith("win"):
-        cmd = ["cmd", "/c", "start", "", url]
-    else:
-        cmd = ["xdg-open", url]
-    try:
-        r = subprocess.run(cmd, timeout=5, capture_output=True, text=True)
-        if r.returncode == 0:
-            print(f"browser opened → {url}", flush=True)
-        else:
-            print(f"browser open failed (rc={r.returncode}): {r.stderr.strip()[:200]}", flush=True)
-    except FileNotFoundError:
-        print(f"no system opener found; open {url} manually", flush=True)
-    except Exception as e:  # noqa: BLE001
-        print(f"browser open error: {e}", flush=True)
-
-
 def os_env_budget() -> str:
     import os
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@caius_kong/ccusage-dashboard",
-  "version": "0.2.9",
+  "version": "0.2.11",
   "description": "One-command local dashboard for ccusage: today/week/month/custom cost by model, 30-day trend, monthly budget alert. Numbers straight from ccusage.",
   "license": "MIT",
   "type": "commonjs",