[GH-ISSUE #6961] [Docs] Cutter bridge directory setting is undocumented #4251

Closed
opened 2026-10-31 00:48:05 +00:00 by bsakaguchi · 0 comments
Owner

Originally created by @viniciusdsandrade on GitHub (Oct 24, 2026).
Original GitHub issue: https://github.com/morluto/rea/issues/6961

Before submitting

  • I searched the existing issues for a related documentation report.
  • I removed credentials, tokens, private paths, and sensitive target data.

Documentation location

docs/reverse-engineering-tools.md, section "Cutter bridge" (main 1d896e03b).

Problem

Both sides of the Cutter integration resolve the directory that holds the published session descriptors from REA_CUTTER_BRIDGE_DIR: the plugin in bridge/cutter/rea_bridge.py (_bridge_directory, lines 451 to 457) and the client in src/cutter/CutterBridgeClient.ts (resolveBridgeDirectory, lines 1170 to 1184). Unset, both use %LOCALAPPDATA%\REA\CutterBridge on Windows when LOCALAPPDATA is set and ~/.cache/rea/cutter-bridge otherwise, and both expand a leading ~. The documentation never names the variable or the default locations. The Cutter bridge section describes discovery ("Discovery admits at most 256 descriptor candidates") and documents REA_BRIDGE_MAX_REQUEST_BYTES, including the fact that the plugin reads the environment that starts Cutter, but a reader cannot learn where discovery looks or how to point both processes at the same directory. #3183 fixed tilde handling for this setting without documenting it.

Expected content

A short paragraph in the Cutter bridge section stating that discovery reads the descriptors the plugin publishes in the bridge directory, that both the plugin and the client resolve it from REA_CUTTER_BRIDGE_DIR with a leading ~ expanded, the two default locations, and that a value visible to only one process makes discovery look in a different directory from the one the plugin writes to.

Supporting evidence

  • bridge/cutter/rea_bridge.py lines 451 to 457: _bridge_directory reads REA_CUTTER_BRIDGE_DIR, expands the user prefix, and falls back to the two defaults.
  • src/cutter/CutterBridgeClient.ts lines 1170 to 1184: resolveBridgeDirectory reads the same variable with the same defaults and tilde handling.
  • docs/reverse-engineering-tools.md lines 88 to 134: the section names only REA_BRIDGE_MAX_REQUEST_BYTES.
  • rg REA_CUTTER_BRIDGE_DIR docs README.md at 1d896e03b returns nothing.

Additional context

Source-only report; no runtime was executed.

Originally created by @viniciusdsandrade on GitHub (Oct 24, 2026). Original GitHub issue: https://github.com/morluto/rea/issues/6961 ## Before submitting - [x] I searched the existing issues for a related documentation report. - [x] I removed credentials, tokens, private paths, and sensitive target data. ## Documentation location `docs/reverse-engineering-tools.md`, section "Cutter bridge" (main `1d896e03b`). ## Problem Both sides of the Cutter integration resolve the directory that holds the published session descriptors from `REA_CUTTER_BRIDGE_DIR`: the plugin in `bridge/cutter/rea_bridge.py` (`_bridge_directory`, lines 451 to 457) and the client in `src/cutter/CutterBridgeClient.ts` (`resolveBridgeDirectory`, lines 1170 to 1184). Unset, both use `%LOCALAPPDATA%\REA\CutterBridge` on Windows when `LOCALAPPDATA` is set and `~/.cache/rea/cutter-bridge` otherwise, and both expand a leading `~`. The documentation never names the variable or the default locations. The Cutter bridge section describes discovery ("Discovery admits at most 256 descriptor candidates") and documents `REA_BRIDGE_MAX_REQUEST_BYTES`, including the fact that the plugin reads the environment that starts Cutter, but a reader cannot learn where discovery looks or how to point both processes at the same directory. #3183 fixed tilde handling for this setting without documenting it. ## Expected content A short paragraph in the Cutter bridge section stating that discovery reads the descriptors the plugin publishes in the bridge directory, that both the plugin and the client resolve it from `REA_CUTTER_BRIDGE_DIR` with a leading `~` expanded, the two default locations, and that a value visible to only one process makes discovery look in a different directory from the one the plugin writes to. ## Supporting evidence - `bridge/cutter/rea_bridge.py` lines 451 to 457: `_bridge_directory` reads `REA_CUTTER_BRIDGE_DIR`, expands the user prefix, and falls back to the two defaults. - `src/cutter/CutterBridgeClient.ts` lines 1170 to 1184: `resolveBridgeDirectory` reads the same variable with the same defaults and tilde handling. - `docs/reverse-engineering-tools.md` lines 88 to 134: the section names only `REA_BRIDGE_MAX_REQUEST_BYTES`. - `rg REA_CUTTER_BRIDGE_DIR docs README.md` at `1d896e03b` returns nothing. ## Additional context Source-only report; no runtime was executed.
Sign in to join this conversation.
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
morluto/rea#4251
No description provided.