Skip to content

Commit 9bfdb86

Browse files
committed
docs: pin cerebro-link websocket port in README workflow
1 parent ada82bd commit 9bfdb86

2 files changed

Lines changed: 28 additions & 3 deletions

File tree

ANALYSIS.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -189,3 +189,17 @@
189189
- Updated `parseParamsString(...)` in `index.ts` to retain a trailing literal backslash when an escape sequence is unfinished at end-of-input.
190190
- Added regression coverage in `test/parsing.test.ts` (`shorthand parser preserves trailing backslash in params`).
191191
- Practical impact: shorthand `cerebro.exec` calls now preserve terminal backslashes in parameter payloads instead of truncating them.
192+
193+
## 2026-02-21 cron run follow-up (16:1x PT, README command reliability)
194+
- Rationale: in this environment port `8080` is frequently occupied, so README examples hardcoding `ws://127.0.0.1:8080` can fail even though the websocket bridge is healthy; docs should mirror the practical, smallest reliable setup path.
195+
- Change scope:
196+
- Updated `README.md` websocket section to explicitly start `@arken/cerebro-link` with `PORT=8090 rushx dev` and use matching `CEREBRO_SERVICE_URI` examples.
197+
- Added note that when port is not pinned, users should copy the auto-fallback `ws://localhost:<port>` endpoint printed by link dev server.
198+
- Validation runbook/results (Node `20.11.1`, Rush scripts):
199+
- `source ~/.nvm/nvm.sh && nvm use 20 && rushx test` in `cerebro/link`
200+
- `source ~/.nvm/nvm.sh && nvm use 20 && rushx test` in `cli`
201+
- Live bridge from `cerebro/link` (`rushx dev` bound `ws://localhost:49856`):
202+
- `CEREBRO_SERVICE_URI=ws://127.0.0.1:49856 rushx cli cerebro.info`
203+
- `CEREBRO_SERVICE_URI=ws://127.0.0.1:49856 ./bin/arken cerebro.info`
204+
- `rushx cli config.list`
205+
- Practical impact: README commands now provide a deterministic port-pinned path that works reliably in this runtime while still documenting auto-fallback behavior.

README.md

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,13 +28,24 @@ rushx cli config.list
2828

2929
### Cerebro link over tRPC websocket
3030

31-
With `@arken/cerebro-link` running on `ws://127.0.0.1:8080`:
31+
Start `@arken/cerebro-link` first (pin a port if 8080 may be occupied):
3232

3333
```bash
34-
CEREBRO_SERVICE_URI=ws://127.0.0.1:8080 rushx cli cerebro.info
35-
CEREBRO_SERVICE_URI=ws://127.0.0.1:8080 ./bin/arken cerebro.info
34+
# from arken/cerebro/link
35+
source ~/.nvm/nvm.sh
36+
nvm use 20
37+
PORT=8090 rushx dev
3638
```
3739

40+
Then run CLI commands against that websocket URI:
41+
42+
```bash
43+
CEREBRO_SERVICE_URI=ws://127.0.0.1:8090 rushx cli cerebro.info
44+
CEREBRO_SERVICE_URI=ws://127.0.0.1:8090 ./bin/arken cerebro.info
45+
```
46+
47+
If you run `rushx dev` without `PORT`, cerebro-link may auto-select another free port. Use the printed `ws://localhost:<port>` value for `CEREBRO_SERVICE_URI`.
48+
3849
## Usage
3950

4051
### Commands

0 commit comments

Comments
 (0)