@grafema/rfdb 0.2.12-dev1 → 0.3.0-beta

package/README.md

@@ -37,12 +37,56 @@ npx @grafema/rfdb ./my-graph.rfdb --socket /tmp/rfdb.sock
 rfdb-server ./my-graph.rfdb
 ```
 
+### Web / Remote Setup (WebSocket Transport)
+
+For browser-based environments (VS Code web, code-server, Gitpod) or remote access scenarios, use WebSocket transport instead of Unix sockets.
+
+**Start Server with WebSocket:**
+
+```bash
+rfdb-server ./path/to/graph.rfdb --socket /tmp/rfdb.sock --ws-port 7474
+```
+
+This starts BOTH transports simultaneously:
+- Unix socket at `/tmp/rfdb.sock` (for local CLI/MCP)
+- WebSocket at `ws://127.0.0.1:7474` (for web/remote clients)
+
+**Configure VS Code Extension:**
+
+In VS Code settings (Cmd+, or Ctrl+,):
+
+```json
+{
+  "grafema.rfdbTransport": "websocket",
+  "grafema.rfdbWebSocketUrl": "ws://localhost:7474"
+}
+```
+
+Or via UI: Search for "Grafema" → Set "RFDB Transport" to "websocket".
+
+**When to Use WebSocket:**
+
+- **VS Code web (vscode.dev)** - Unix sockets unavailable in browser
+- **code-server / Gitpod** - Remote development environments
+- **Browser clients** - When building web-based graph explorers
+- **Remote access** - Connect to graph database on different machine (via SSH tunnel)
+
+**Security Note:**
+
+WebSocket binds to `127.0.0.1` only (localhost). For remote access, use SSH tunnel:
+
+```bash
+ssh -L 7474:127.0.0.1:7474 user@remote-server
+```
+
+Then connect to `ws://localhost:7474` locally.
+
 ### Programmatic usage
 
-Server lifecycle is managed through `@grafema/core`:
+Server lifecycle is managed through `@grafema/util`:
 
 ```javascript
-const { startRfdbServer, RFDBServerBackend } = require('@grafema/core');
+const { startRfdbServer, RFDBServerBackend } = require('@grafema/util');
 
 // Start server (handles binary discovery, socket polling, PID file)
 const server = await startRfdbServer({
@@ -72,12 +116,10 @@ if (!isAvailable()) {
 RFDB is the default storage backend for Grafema. The MCP server and CLI auto-start RFDB when needed.
 
 ```javascript
-const { Orchestrator, RFDBServerBackend } = require('@grafema/core');
+const { RFDBServerBackend } = require('@grafema/util');
 
-const orchestrator = new Orchestrator({
-  rootDir: './src',
-  backend: new RFDBServerBackend({ socketPath: '.grafema/rfdb.sock' }),
-});
+const backend = new RFDBServerBackend({ socketPath: '.grafema/rfdb.sock' });
+await backend.connect();
 ```
 
 ## Features

package/index.d.ts

@@ -1,7 +1,7 @@
 /**
  * Get the path to the rfdb-server binary for the current platform.
- * Only checks prebuilt directory. For full search, use findRfdbBinary() from @grafema/core.
- * @deprecated Use findRfdbBinary() from @grafema/core for full binary search.
+ * Only checks prebuilt directory. For full search, use findRfdbBinary() from @grafema/util.
+ * @deprecated Use findRfdbBinary() from @grafema/util for full binary search.
  * @returns Path to binary, or null if not available
  */
 export function getBinaryPath(): string | null;

package/index.js

@@ -11,8 +11,8 @@ const net = require('net');
 /**
  * Get the path to the rfdb-server binary for the current platform.
  * Only checks prebuilt directory. For full search (monorepo, PATH, env var, ~/.local/bin),
- * use findRfdbBinary() from @grafema/core instead.
- * @deprecated Use findRfdbBinary() from @grafema/core for full binary search.
+ * use findRfdbBinary() from @grafema/util instead.
+ * @deprecated Use findRfdbBinary() from @grafema/util for full binary search.
  * @returns {string|null} Path to binary, or null if not available
  */
 function getBinaryPath() {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grafema/rfdb",
-  "version": "0.2.12-dev1",
+  "version": "0.3.0-beta",
   "description": "RFDB (Rega Flow Database) — high-performance disk-backed graph database server for Grafema",
   "main": "index.js",
   "types": "index.d.ts",