@comfanion/vgdb

A thin Node.js wrapper for the vgdbd daemon (JSON‑RPC over stdio).

Install

npm install @comfanion/vgdb

Usage

const { start } = require("@comfanion/vgdb");

const child = start({
  // Optional: override binary path
  // binPath: "/path/to/vgdbd"
});

child.stdin.write(JSON.stringify({
  jsonrpc: "2.0",
  id: 1,
  method: "open",
  params: { path: "./data" }
}) + "\n");

child.stdout.on("data", (buf) => {
  console.log(buf.toString());
});

// Graceful shutdown
// const { requestShutdown } = require("@comfanion/vgdb");
// await requestShutdown(child);

Binary resolution

Order of resolution:

1. binPath option
2. VGDBD_BIN environment variable
3. Packaged binary in bin/<platform>-<arch>/
4. vgdbd in PATH

The binary is bundled inside the npm package under bin/<platform>-<arch>/. If it is missing, the install will attempt to download it automatically from the GitLab release for the current package version.

You can override the download base URL with VGDBD_DOWNLOAD_BASE_URL.