@hyperlogue/r3 2.3.0 → 2.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +36 -45
- package/package.json +5 -5
package/README.md
CHANGED
|
@@ -14,6 +14,7 @@
|
|
|
14
14
|
</p>
|
|
15
15
|
|
|
16
16
|
r3 is a tool for reading, using, and discussing agent output.
|
|
17
|
+
|
|
17
18
|
Open an interactive page, read a document, or inspect code changes. Select an
|
|
18
19
|
element or passage to leave comments and continue the conversation with your agent.
|
|
19
20
|
|
|
@@ -30,15 +31,17 @@ can run the CLI.
|
|
|
30
31
|
Markdown, and code discussion with a scripted agent. It uses bundled examples;
|
|
31
32
|
production preview protection is not simulated.
|
|
32
33
|
|
|
34
|
+
r3 serves you, a single user, and your agents. Supporting multiple human users is a nongoal.
|
|
35
|
+
|
|
33
36
|
[](https://github.com/user-attachments/assets/26506cba-3d1a-493c-9c7a-e6ae2227718c)
|
|
34
37
|
|
|
35
38
|
## Screenshots
|
|
36
39
|
|
|
37
|
-
| Screenshot
|
|
38
|
-
|
|
|
39
|
-
| [](https://github.com/user-attachments/assets/2dec1368-6679-47cb-aa19-bfeb6228a7d6)
|
|
40
|
-
| [](https://github.com/user-attachments/assets/396df7ca-661e-414d-952b-0a6325638c62) | Learn how a library works internally through an interactive demo.
|
|
41
|
-
| [](https://github.com/user-attachments/assets/8e85f3d9-d03b-45ec-b478-fe7fe109ef19)
|
|
40
|
+
| Screenshot | What it shows |
|
|
41
|
+
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
|
|
42
|
+
| [](https://github.com/user-attachments/assets/2dec1368-6679-47cb-aa19-bfeb6228a7d6) | Review a UI improvement proposal and leave comments directly on HTML elements. |
|
|
43
|
+
| [](https://github.com/user-attachments/assets/396df7ca-661e-414d-952b-0a6325638c62) | Learn how a library works internally through an interactive demo. |
|
|
44
|
+
| [](https://github.com/user-attachments/assets/8e85f3d9-d03b-45ec-b478-fe7fe109ef19) | Codex receives a direct message from r3 when you ping the agent from the web page. |
|
|
42
45
|
|
|
43
46
|
Search your library by project, content, or conversation. Results open the matching
|
|
44
47
|
publication or message, and **Include history** searches older versions. Agents can
|
|
@@ -71,11 +74,11 @@ npx --yes @hyperlogue/r3@latest guide
|
|
|
71
74
|
|
|
72
75
|
r3 supports three kinds of artifacts:
|
|
73
76
|
|
|
74
|
-
| Artifact
|
|
75
|
-
|
|
|
76
|
-
| HTML pages
|
|
77
|
+
| Artifact | What you can do | Examples |
|
|
78
|
+
| ------------------- | ------------------------------------------------------------------------------------ | ----------------------------------------------------------- |
|
|
79
|
+
| HTML pages | Interact with a page and leave comments on specific elements or text | Prototypes, dashboards, interactive tutorials |
|
|
77
80
|
| Documents and files | Read rendered Markdown, browse related files, and discuss specific passages or lines | Design proposals, research reports, generated project files |
|
|
78
|
-
| Code changes
|
|
81
|
+
| Code changes | See what changed and discuss it beside the affected lines | Bug fixes, refactors, feature reviews |
|
|
79
82
|
|
|
80
83
|
HTML artifacts open as pages; files artifacts have a file browser; diff artifacts
|
|
81
84
|
show captured code changes.
|
|
@@ -102,27 +105,24 @@ on the home page to archive or permanently delete them together.
|
|
|
102
105
|
|
|
103
106
|
## Local and remote access
|
|
104
107
|
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
108
|
+
### Local access
|
|
109
|
+
|
|
110
|
+
r3 starts automatically on localhost with no login required. To require local
|
|
111
|
+
authentication:
|
|
112
|
+
|
|
113
|
+
```sh
|
|
114
|
+
r3 config set requireLogin true
|
|
115
|
+
r3 server restart
|
|
116
|
+
r3 auth create-token --label browser
|
|
117
|
+
```
|
|
110
118
|
|
|
111
|
-
|
|
112
|
-
`trustedProxies`, enables login by default, even when the proxy connects through
|
|
113
|
-
localhost. The default local-only mode refuses forwarded requests. Use
|
|
114
|
-
`r3 config set requireLogin true` to require login explicitly, or
|
|
115
|
-
`r3 config set requireLogin false` to disable browser and API authentication for
|
|
116
|
-
all allowed hosts. `r3 config unset requireLogin` restores the automatic default.
|
|
117
|
-
Run `r3 server restart` on the server's machine after changing these settings.
|
|
118
|
-
Host/origin checks and preview isolation apply in both modes.
|
|
119
|
+
Sign in with the printed token. Run `r3 config unset requireLogin` to revert.
|
|
119
120
|
|
|
120
|
-
###
|
|
121
|
+
### Exposing a server
|
|
121
122
|
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
the **server**, replacing `https://reviews.example` with its Tailscale HTTPS address:
|
|
123
|
+
Remote access always requires authentication and should use HTTPS. To expose via
|
|
124
|
+
[Tailscale Serve](https://tailscale.com/docs/reference/tailscale-cli/serve), run
|
|
125
|
+
on the server:
|
|
126
126
|
|
|
127
127
|
```sh
|
|
128
128
|
r3 config set publicUrl https://reviews.example
|
|
@@ -132,30 +132,21 @@ tailscale serve --bg http://127.0.0.1:8791
|
|
|
132
132
|
r3 auth create-token --label browser
|
|
133
133
|
```
|
|
134
134
|
|
|
135
|
-
Open the
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
and set `X-Forwarded-Proto: https`. Set `trustedProxies` to its connection IP only
|
|
139
|
-
if it overwrites `X-Forwarded-For`.
|
|
135
|
+
Open the URL in your browser and sign in with the token. For other reverse
|
|
136
|
+
proxies, forward traffic to `http://127.0.0.1:8791/` with
|
|
137
|
+
`X-Forwarded-Proto: https`.
|
|
140
138
|
|
|
141
|
-
###
|
|
139
|
+
### Connecting a remote CLI
|
|
142
140
|
|
|
143
|
-
|
|
141
|
+
To publish to a remote r3 server from your local machine:
|
|
144
142
|
|
|
145
143
|
```sh
|
|
146
144
|
r3 config set backendUrl https://reviews.example
|
|
147
145
|
r3 login
|
|
148
|
-
```
|
|
149
|
-
|
|
150
|
-
Open the printed address, sign in to r3 if needed, confirm that the code matches
|
|
151
|
-
your terminal, and approve CLI access. Then check the connection:
|
|
152
|
-
|
|
153
|
-
```sh
|
|
154
146
|
r3 list
|
|
155
147
|
```
|
|
156
148
|
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
[remote backend reference](docs/artifacts/remote-protocol.md) for more options.
|
|
149
|
+
Approve browser access when prompted. Then ask your agent to run `r3 guide` and
|
|
150
|
+
publish as usual. See the
|
|
151
|
+
[remote backend reference](docs/artifacts/remote-protocol.md) for advanced setup
|
|
152
|
+
and options.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@hyperlogue/r3",
|
|
3
|
-
"version": "2.
|
|
3
|
+
"version": "2.4.0",
|
|
4
4
|
"description": "Render. Review. Refine. — publish artifacts and discuss them with any coding agent. Runs the matching prebuilt native r3 binary (shipped as a per-platform optional dependency); works with `bunx @hyperlogue/r3` and `npx @hyperlogue/r3`.",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"type": "module",
|
|
@@ -17,10 +17,10 @@
|
|
|
17
17
|
"launch.mjs"
|
|
18
18
|
],
|
|
19
19
|
"optionalDependencies": {
|
|
20
|
-
"@hyperlogue/r3-darwin-arm64": "2.
|
|
21
|
-
"@hyperlogue/r3-darwin-x64": "2.
|
|
22
|
-
"@hyperlogue/r3-linux-x64": "2.
|
|
23
|
-
"@hyperlogue/r3-linux-arm64": "2.
|
|
20
|
+
"@hyperlogue/r3-darwin-arm64": "2.4.0",
|
|
21
|
+
"@hyperlogue/r3-darwin-x64": "2.4.0",
|
|
22
|
+
"@hyperlogue/r3-linux-x64": "2.4.0",
|
|
23
|
+
"@hyperlogue/r3-linux-arm64": "2.4.0"
|
|
24
24
|
},
|
|
25
25
|
"engines": {
|
|
26
26
|
"node": ">=18"
|