@n-dream/builders-cli 0.0.0-stage → 0.1.1

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 CHANGED
@@ -1,3 +1,44 @@
1
- # Temporary Holding Version
1
+ # @n-dream/builders-cli
2
2
 
3
- This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
3
+ The command line helper of Builders for coding agent sessions.
4
+
5
+ ## Dev preview tunnel
6
+
7
+ The tunnel makes the dev server of a coding session visible at the app's
8
+ dev preview address (`https://d--<app>.<company>.builders.n-dream.com`).
9
+ Only the person who opened the app sees it.
10
+
11
+ ```
12
+ BUILDERS_TUNNEL_TOKEN_FILE=<file> BUILDERS_TUNNEL_URL=<url> npx -y @n-dream/builders-cli tunnel --port 3000
13
+ ```
14
+
15
+ The Builders MCP tool `open_app` writes the token file and gives the URL
16
+ and the full command. The token is short-lived and is for one app and one
17
+ person. Do not share it. The command reads the file again before each
18
+ connection, so a new token from `open_app` takes effect without a restart.
19
+ `BUILDERS_TUNNEL_TOKEN` (the token itself) also works, but never put the
20
+ token in an argument: other processes can read arguments.
21
+
22
+ Options:
23
+
24
+ - `--port <port>`: the port of the local dev server (required).
25
+ - `--url <url>`: the tunnel URL, if `BUILDERS_TUNNEL_URL` is not set.
26
+ - `--token-file <file>`: the token file, if `BUILDERS_TUNNEL_TOKEN_FILE` is
27
+ not set.
28
+ - `--transport auto|ws|poll`: `auto` (default) uses a WebSocket and falls
29
+ back to HTTPS polling when a proxy does not let WebSockets through.
30
+
31
+ The command writes one line per change of state, for example:
32
+
33
+ ```
34
+ builders-cli: connected: dev preview at https://d--todo.internal.builders.n-dream.com (local port 3000)
35
+ ```
36
+
37
+ When `HTTPS_PROXY` (or `https_proxy`) is set, as in claude.ai/code
38
+ sessions, the command connects through that proxy. `NO_PROXY` hosts go
39
+ direct. The connection to the local dev server never uses the proxy.
40
+
41
+ It connects again by itself when the connection breaks. It stops when the
42
+ token is not valid, or when a newer tunnel for the same work takes over.
43
+
44
+ Node.js 20.18.1 or later. No runtime dependencies (all are bundled).