Etherpad CLI Client

Common errors

Warnings

Install

Imports

• Client
  wrong

  import Client from 'etherpad-cli-client';

  correct

  const Client = require('etherpad-cli-client');

  The package's default export is the `Client` class. Use CommonJS `require` for direct import. While Node.js ESM interop might allow `import Client from 'etherpad-cli-client'` in a module context, `require` is the explicit and most reliable method as it's a CJS module.

• connect
  wrong

  const { connect } = require('etherpad-cli-client');

  correct

  const Client = require('etherpad-cli-client');
  const pad = Client.connect('https://beta.etherpad.org/p/clitest');

  `connect` is a static method of the `Client` class, not a direct named export. You must access it via the imported `Client` object after importing the class itself.

• pad instance methods
  wrong

  const pad = require('etherpad-cli-client').connect();

  correct

  const Client = require('etherpad-cli-client');
  const pad = Client.connect();
  pad.on('connected', () => { /* ... */ });
  pad.append('new content');

  While technically possible for the `connect` method, directly chaining `require().connect()` can obscure the fact that `Client` is a class and methods like `on`, `append`, etc., are instance methods of the object returned by `Client.connect()`.

Quickstart

Demonstrates connecting to an Etherpad instance, listening for connection status, real-time messages, and updates to the pad's content, while also programmatically appending text. Requires the Etherpad server to be in `loadTest` mode for full functionality.

const Client = require("etherpad-cli-client");

// IMPORTANT: Ensure your Etherpad instance is in loadTest mode (settings.json -> loadTest: true).
// This example connects to a public beta instance that may or may not be in loadTest mode.
const pad = Client.connect("https://beta.etherpad.org/p/clitest");

pad.on("connected", function(padState){
  console.log(`Connected to Etherpad at ${padState.host} with pad ID ${padState.padId}`);
  // Start appending content once connected
  let counter = 0;
  const intervalId = setInterval(() => {
    const textToAppend = `Hello from CLI Client! [${Date.now()}]\n`;
    console.log(`Appending: "${textToAppend.trim()}"`);
    pad.append(textToAppend);
    counter++;
    if (counter >= 3) { // Append a few times then stop
      clearInterval(intervalId);
    }
  }, 2000);
});

pad.on("message", function(message){
  console.log("New message from Etherpad Server:", message.type);
  // You can inspect message.data for specific Etherpad protocol details
});

pad.on("newContents", function(atext){
  console.log("\n--- Pad Contents Updated ---");
  console.log(atext.text);
  console.log("----------------------------\n");
});

pad.on("disconnect", function(e){
  console.log("Disconnected from pad:", e ? e.message : "gracefully");
  process.exit(0);
});

// Keep the process alive for a reasonable duration to observe real-time events
setTimeout(() => {
  console.log("Exiting after 30 seconds to prevent indefinite running.");
  process.exit(0);
}, 30000);