@solidrt/cli 0.0.10 → 0.0.11

package/AGENTS.md

@@ -0,0 +1,46 @@
+# @solidrt/cli - agent notes
+
+Dense, self-contained facts for running and verifying a SolidRT app. Full docs
+live in docs/ (and the website). For the authoring model (elements, props,
+reactivity), see @solidrt/core (its AGENTS.md).
+
+`srt` is the dev tool. Bun is a dev prerequisite only; SolidRT apps run on the
+bundled `flux` runtime, not on Bun. Invoke via `bunx srt <command>`.
+
+## Commands
+
+- `bunx srt run src/index.tsx` - dev server + a local client window, watches and
+  hot-reloads. NEEDS A DISPLAY (opens a GUI window). Not usable headless.
+- `bunx srt bundle src/index.tsx` - transpile to `<file>.srt.js`. With
+  `--compile`, emits `.srt.bin` bytecode. `--minify`, `--dev`, `--stdout`,
+  `--output` also available.
+- `bunx srt record src/index.tsx [flags]` - render OFFSCREEN to PNG frames.
+- `bunx srt server [file]` / `bunx srt client` - the two halves of `run`
+  separately (server distributes code; clients on other devices connect to it).
+
+## Verifying without a display (headless / CI / agent box)
+
+Two reliable checks that need no GUI:
+
+1. `bunx srt bundle src/index.tsx` - exit 0 means the app compiles. Fast.
+2. `bunx srt record src/index.tsx --size 480x640 --duration 1 --fps 2` -
+   renders offscreen via EGL/wgpu and writes `frame-NNNNNN.png`. This actually
+   proves the app renders. Combine with `--fps`/`--duration` (defaults
+   1280x720, 60fps, 1s).
+
+`record` gotchas:
+- Frames are written to the RUNTIME's working dir (`~/.local/share/SolidRT/go/`),
+  NOT the directory you ran the command from. Look there for the PNGs.
+- The recording includes a debug overlay (FPS/REQ/MiB/CPU) in a corner.
+- Run from the project directory. There is no `bunx --cwd` flag.
+
+## Dev server proxies (when clients on other devices need your machine's data)
+
+- `--proxy-http` - route `fetch` through the dev server; responses cached in
+  `.srt-cache.db` (delete the file to clear).
+- `--proxy-files` - route flux:fs (`file`/`dir`/`write`) through the dev server.
+  Exposes your dev machine's files to all clients; use with care.
+
+## REPL (opened by `run`/`server`)
+
+`load <file>`, `reload [n]`, `stop [n]`, `list`, `!<cmd>`, `quit`/`exit`.

package/README.md

@@ -2,6 +2,8 @@
 
 Developer tooling for SolidRT. Provides a development environment for `@solidrt/core` applications.
 
+> LLM agents: see [AGENTS.md](./AGENTS.md) for a dense, self-contained quickstart.
+
 ## Commands
 
 ```sh

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@solidrt/cli",
-  "version": "0.0.10",
+  "version": "0.0.11",
   "license": "MIT",
   "author": "Antoine van Wel",
   "type": "module",
@@ -10,7 +10,7 @@
   "files": [
     "bin/",
     "src/",
-    "LICENSE"
+    "AGENTS.md"
   ],
   "dependencies": {
     "@babel/core": "^7.28.5",
@@ -20,12 +20,12 @@
     "qrcode-generator": "^2.0.4"
   },
   "optionalDependencies": {
-    "@solidrt/darwin-arm64": "0.0.10",
-    "@solidrt/linux-x64-gnu": "0.0.10",
-    "@solidrt/win32-x64-msvc": "0.0.10"
+    "@solidrt/darwin-arm64": "0.0.11",
+    "@solidrt/linux-x64-gnu": "0.0.11",
+    "@solidrt/win32-x64-msvc": "0.0.11"
   },
   "peerDependencies": {
-    "@solidrt/core": "0.0.10",
+    "@solidrt/core": "0.0.11",
     "typescript": "^5"
   },
   "devDependencies": {

package/src/args.ts

@@ -13,6 +13,7 @@ export let { values, positionals } = parseArgs({
     fps: { type: "string" },
     duration: { type: "string" },
     size: { type: "string" },
+    stats: { type: "boolean", default: false },
     android: { type: "boolean", default: false },
     device: { type: "string" },
   },
@@ -77,6 +78,7 @@ run/server options:
 
 run/client options:
       --size <WxH>       Window size (default: 1280x720)
+      --stats            Show the debug stats overlay (FPS, memory, frame timings)
 
 client options:
       --android          Install and launch the client on a connected Android device

package/src/cache.ts

@@ -48,7 +48,8 @@ export function isEnabled(): boolean {
 
 // Strings returned by bun:sqlite carry an internal representation that
 // Headers.set() rejects, even when value-identical to an acceptable string
-// (Bun bug, present through 1.3.14). Rebuilding each char yields a clean string.
+// (Bun bug oven-sh/bun#28266, present through 1.3.14). Rebuilding each char
+// yields a clean string.
 function reflatten(s: string): string {
   return Array.from(s, (c) => String.fromCharCode(c.charCodeAt(0))).join("")
 }

package/src/dev-server.ts

@@ -157,7 +157,7 @@ export function startServer() {
         print(`[cli] Client connected ${ws.remoteAddress}`)
         // Advertise our real LAN address so clients dialed over the adb loopback
         // can show/remember the directly reachable address (see connection.rs).
-        ws.send(JSON.stringify({ type: "welcome", address: state.serverUrl }))
+        ws.send(JSON.stringify({ type: "welcome", address: state.serverUrl, stats: values.stats }))
         if (state.currentCode) {
           ws.send(buildReload({ code: state.currentCode }))
         }