@hyperlogue/r3 0.4.0 → 0.6.0

package/README.md

@@ -8,18 +8,28 @@
   <a href="https://www.npmjs.com/package/@hyperlogue/r3"><img src="https://img.shields.io/npm/v/@hyperlogue/r3?color=cb3837&amp;logo=npm&amp;label=%40hyperlogue%2Fr3" alt="npm version"></a>
   <a href="LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="license: MIT"></a>
   <img src="https://img.shields.io/badge/platform-macOS%20%7C%20Linux-lightgrey" alt="platforms: macOS, Linux">
+  <a href="https://hyperlogue.github.io/r3/demo/"><img src="https://img.shields.io/badge/live-demo-6164ff?logo=googlechrome&amp;logoColor=white" alt="live demo"></a>
+</p>
+
+<p align="center">
+  <img alt="r3_cc" src="https://github.com/user-attachments/assets/ba85f5a2-e244-4a04-b673-22cb88694c2b" width="49.6%">
+  <img alt="r3_web" src="https://github.com/user-attachments/assets/4b99a128-3484-44ce-a727-8d72a3dc532b" width="42.4%">
+</p>
+ 
+<p align="center">
+  <a href="https://hyperlogue.github.io/r3/demo/"><b>▶&nbsp;Try the live demo</b></a> — the full UI, running entirely in your browser.
 </p>
 
 r3 is a review tool for the diffs and docs produced by your coding agents, running
 locally with a web interface. You leave feedback pinned to the exact line or
 quote it's about, and track each comment to resolution.
 
-r3 fills a gap the chat box can't. Say your agent writes a long planning doc and
-you want to fix a handful of things. In a chat you copy-paste each passage to
-quote it, type your feedback, then lose track across turns of what's been handled.
-Instead of working in a linear, unstructured chat stream, r3 works like the code
-review tools you're used to, but just for you and your agents, and it runs fully
-locally.
+r3 fills a gap that chat boxes can’t. Say your agent writes a long planning
+document and you want to fix a handful of issues. In chat, you have to copy and
+paste each passage, explain your feedback, and then keep track of what has or
+hasn’t been addressed across multiple turns. r3 replaces that linear,
+unstructured stream with a workflow modeled on the code review tools you already
+know—built specifically for you and your agents, and running entirely locally.
 
 <div align="center">
   <video src="https://github.com/user-attachments/assets/0c1aefaf-0229-49e7-a4dc-e660dc0214f6" width="760" muted controls></video>
@@ -27,7 +37,7 @@ locally.
 
 ## Workflow
 
-The point of r3 is a tight, copy-paste-free review loop between you and an agent.
+r3 offers a tight, copy-paste-free review loop between you and an agent.
 
 ```mermaid
 sequenceDiagram
@@ -153,17 +163,27 @@ when exposed.) Force it either way with `R3_REQUIRE_LOGIN=1|0`.
 
 ```sh
 # on the host:
-export R3_PUBLIC_URL=https://myhost.tailnet.ts.net      # allows that Host + requires login
-r3 restart
-tailscale serve --bg 8791                                # -> https://myhost.tailnet.ts.net/
-r3 auth create-token --label laptop                      # prints the token once — paste it in the browser
+r3 config set publicUrl https://myhost.tailnet.ts.net    # allows that Host + requires login
+r3 restart                                                # config.json is read below env
+tailscale serve --bg 8791                                 # -> https://myhost.tailnet.ts.net/
+r3 auth create-token --label laptop                       # prints the token once — paste it in the browser
 ```
 
-`r3 auth list-tokens` / `r3 auth revoke-token <id> | --all` manage them (revoking
+`r3 config set` **persists** these settings to `$XDG_CONFIG_HOME/r3/config.json`, so
+a restart — or a daemon lazily re-spawned by any CLI call from a shell that never
+exported the env vars — keeps serving remotely instead of silently dropping to
+loopback-only. (`export R3_PUBLIC_URL=…` still works for a one-off run; it just
+isn't remembered.) The store is a flat map — names `bind`, `port`, `publicUrl`,
+`allowedHosts` (comma list), `requireLogin`: `r3 config show` dumps the JSON,
+`r3 config get <name>` prints one value, `r3 config unset <name>` reverts one.
+
+`r3 auth list-tokens` / `r3 auth revoke-token <id> | --all` manage tokens (revoking
 kills its sessions immediately).
 
-Env: `R3_PORT` (default 8791), `R3_BIND` (default `127.0.0.1`), `R3_ALLOWED_HOSTS`
+Settings: `R3_PORT` (default 8791), `R3_BIND` (default `127.0.0.1`), `R3_ALLOWED_HOSTS`
 (comma-separated exact Host names, never `*`; a non-loopback name here also marks r3
 exposed), `R3_PUBLIC_URL` (a non-loopback host is auto-allowed **and** marks r3
 exposed, so this alone covers the common single-name `tailscale serve` case), `R3_REQUIRE_LOGIN`
-(`1`/`0` to force the login requirement on or off explicitly).
+(`1`/`0` to force the login requirement on or off explicitly). Each resolves
+**env → `config.json` (via `r3 config set`) → default**, so env overrides the
+persisted file for a single run.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hyperlogue/r3",
-  "version": "0.4.0",
+  "version": "0.6.0",
   "description": "Review. Revise. Resolve. — a local-first review tool for AI-generated code and docs. Runs the matching prebuilt native r3 binary (shipped as a per-platform optional dependency); works with `bunx @hyperlogue/r3` and `npx @hyperlogue/r3`.",
   "license": "MIT",
   "type": "module",
@@ -17,10 +17,10 @@
     "launch.mjs"
   ],
   "optionalDependencies": {
-    "@hyperlogue/r3-darwin-arm64": "0.4.0",
-    "@hyperlogue/r3-darwin-x64": "0.4.0",
-    "@hyperlogue/r3-linux-x64": "0.4.0",
-    "@hyperlogue/r3-linux-arm64": "0.4.0"
+    "@hyperlogue/r3-darwin-arm64": "0.6.0",
+    "@hyperlogue/r3-darwin-x64": "0.6.0",
+    "@hyperlogue/r3-linux-x64": "0.6.0",
+    "@hyperlogue/r3-linux-arm64": "0.6.0"
   },
   "engines": {
     "node": ">=18"