opencode-dashboard-client 0.2.0 → 0.3.0

package/README.md

@@ -4,43 +4,41 @@ Front end for [opencode-dashboard](https://github.com/GCS-ZHN/opencode-dashboard
 view of opencode token usage (server → project → session → model), with input / output / reasoning /
 cache tokens and cost at every level.
 
-The npm package ships the **built SPA** plus the **front-end server**, which is the single entry point
-for browsers: it serves the SPA and proxies `/api/s/{i}/*` to the configured aggregation backends.
-Real backends stay hidden from the client's network.
+Installs as a CLI (`opencode-dashboard`): its `serve` command runs the **front-end server**, the single
+entry point for browsers — it serves the built SPA and proxies `/api/s/{i}/*` to the configured
+aggregation backends. Real backends stay hidden from the client's network.
 
 ## Install (npm)
 
 ```bash
-npm install opencode-dashboard-client
+npm install -g opencode-dashboard-client
 ```
 
-Requires Node ≥ 22 and [bun](https://bun.sh) (the front-end server runs on bun).
+Requires Node ≥ 22. Works anywhere with `npx opencode-dashboard ...` too.
 
-## Quick start
+## Configure
+
+Write the config interactively to the standard XDG path
+(`$XDG_CONFIG_HOME/opencode-dashboard/config.yaml`, `~/.config/...` by default):
 
 ```bash
-cd node_modules/opencode-dashboard-client   # or wherever npm installed the package
+opencode-dashboard configure
 ```
 
-1. **Point it at your backends** — edit `dashboard.yaml`:
-   ```yaml
-   servers:
-     - name: main
-       url: http://127.0.0.1:8791
-     - name: backup
-       url: http://127.0.0.1:8792
-   ui:
-     sessionPage: 30   # sessions loaded per page when a project is expanded
-   ```
-   `dashboard.yaml` is the single file you edit — the SPA fetches the server list + UI options from
-   `GET /api/config` at startup, so there is nothing to rebuild after a change.
-
-2. **Run the front-end server** (serves the built SPA + proxies `/api/s/{i}/*`):
-   ```bash
-   bun server.ts
-   ```
-   Env overrides: `PORT` (default 5173), `HOST` (default 0.0.0.0), `DASHBOARD_CONFIG` (config file
-   path). Open http://localhost:5173/.
+Add one backend per prompt (`name` + `url`, e.g. `main` / `http://127.0.0.1:8791`), then set the
+front-end port, host, and `ui.sessionPage`. Re-run it any time to preview and extend the existing
+config. You can also hand-edit the file — the SPA fetches the server list + UI options from
+`GET /api/config` at startup, so there is nothing to rebuild after a change.
+
+## Run
+
+```bash
+opencode-dashboard serve [--port N] [--host H]
+```
+
+Serves the SPA on the configured host/port (default `0.0.0.0:5173`) and proxies `/api/s/{i}/*` to the
+configured backends. CLI flags beat env vars (`PORT`, `HOST`), which beat the config file. Open
+http://localhost:5173/.
 
 Each configured backend is one tab (with an **Overall** tab showing all of them in a grid). Sessions
 render as parent/child trees — subagents are collapsed by default and a parent's totals include all
@@ -52,10 +50,14 @@ descendants. Live updates come over SSE, so the page refreshes itself as opencod
 git clone https://github.com/GCS-ZHN/opencode-dashboard
 cd opencode-dashboard/client
 bun install        # install dev deps (typescript, vite, yaml)
-bun run dev        # Vite dev server (same /api/s/{i} proxy + /api/config from dashboard.yaml) → :5173
-bun run build      # typecheck (tsc) + bundle (vite)
+bun run dev        # Vite dev server (reads repo dashboard.yaml) → :5173
+bun run build      # typecheck (tsc) + bundle (vite + CLI)
+bun run serve      # run the built CLI: node dist-cli/cli.mjs serve
 bun mock-server.ts # serve canned API data for frontend-only work (PORT env, default 8791)
 ```
 
+During dev the repo `dashboard.yaml` is used; the published package never ships it — runtime
+configuration lives in the XDG file written by `opencode-dashboard configure`.
+
 Full project docs (architecture, API contract, publishing) live in the repo
 [README](https://github.com/GCS-ZHN/opencode-dashboard).