RemoteDev Server for Redux DevTools

Common errors

• Error: listen EADDRINUSE: address already in use :::8000

  cause Another process is already using the default port 8000, preventing remotedev-server from starting.
  fix Stop the conflicting process or start remotedev-server on a different port using `--port <NEW_PORT>` in CLI or `port: <NEW_PORT>` in programmatic options.

• remotedev: command not found

  cause The `remotedev` executable is not found in the system's PATH, typically because the package was installed locally and not globally, or npm's local `node_modules/.bin` directory is not in the PATH.
  fix If installed locally, run it via an npm script (e.g., `npm run remotedev` if defined in `package.json`). If desired globally (not recommended), install with `npm install -g remotedev-server`.

Warnings

• breaking The project is largely unmaintained since its last update in February 2021. Users should be aware that it may not be compatible with newer Node.js versions, WebSocket libraries, or recent changes in the Redux DevTools ecosystem. Critical bugs or security vulnerabilities are unlikely to be patched.
  Fix: Consider migrating to actively maintained alternatives for Redux DevTools remote monitoring or ensure thorough compatibility testing in your environment.
• gotcha Installing `remotedev-server` globally (`npm install -g remotedev-server`) is explicitly not recommended by the maintainers. While it allows direct command-line execution, it can lead to versioning conflicts and makes project-specific configurations harder to manage.
  Fix: Prefer installing it as a development dependency (`npm install --save-dev remotedev-server`) and running it via `npm scripts` (e.g., `npm run remotedev`) or integrating it directly into your application's development server startup script.
• gotcha When running multiple instances of remotedev-server or integrating with other services, port conflicts are common. The default port is 8000.
  Fix: Always specify a unique port using the `--port` argument in the CLI (`remotedev --port=8001`) or the `port` option in the programmatic API (`remotedev({ port: 8001 })`).

Install

• npm install remotedev-server npm
• yarn add remotedev-server yarn
• pnpm add remotedev-server pnpm

Imports

• remotedev
  wrong:

  const remotedev = require('remotedev-server').default;

  correct:

  import remotedev from 'remotedev-server';

  While the README uses `require()`, the primary export is a default function. For ES Modules, it's `import remotedev from 'remotedev-server';`. For CJS, `const remotedev = require('remotedev-server');` is correct and returns the function directly.
• startServer
  wrong:

  import { startServer } from 'remotedev-server';

  correct:

  import remotedev from 'remotedev-server'; remotedev({ port: 8000 });

  The package exports a single default function that directly starts the server. There are no named exports like `startServer`.

Quickstart

This quickstart demonstrates how to programmatically start the remotedev-server with configurable host, port, and protocol, reading options from environment variables. It illustrates the core usage of the default export function.

import remotedev from 'remotedev-server';
import http from 'http';

const PORT = process.env.REMOTEDEV_PORT ? parseInt(process.env.REMOTEDEV_PORT, 10) : 8000;
const HOSTNAME = process.env.REMOTEDEV_HOSTNAME || 'localhost';
const PROTOCOL = process.env.REMOTEDEV_PROTOCOL || 'http';

const serverOptions = {
  hostname: HOSTNAME,
  port: PORT,
  protocol: PROTOCOL
};

// To enable HTTPS, provide key, cert, and passphrase
// if (PROTOCOL === 'https') {
//   serverOptions.key = process.env.REMOTEDEV_KEY_PATH ?? '';
//   serverOptions.cert = process.env.REMOTEDEV_CERT_PATH ?? '';
//   serverOptions.passphrase = process.env.REMOTEDEV_PASSPHRASE ?? '';
// }

remotedev(serverOptions);

console.log(`RemoteDev server running on ${PROTOCOL}://${HOSTNAME}:${PORT}`);
console.log('Connect your Redux DevTools extension to this address.');