The `etherpad-cli-client` package provides a Node.js and CLI interface for real-time interaction with Etherpad content. It allows developers to connect to an Etherpad instance, stream pad text, listen for real-time messages, and programmatically append or prefix content. The current stable version is 3.0.5. A critical design decision is that this client *requires* the connected Etherpad server to be running in `loadTest` mode, which fundamentally alters Etherpad's behavior and is not suitable for typical production environments. This limits its use to specific testing, automation, or specialized integration scenarios rather than full-fledged editor functionality. The project appears actively maintained, with continuous integration badges indicating ongoing development. Its core differentiator is its programmatic access to real-time Etherpad content, albeit under the `loadTest` mode constraint.
npm install etherpad-cli-clientVerified import paths — ran on the pinned version, not inferred.
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.
Modify your Etherpad server's `settings.json` to include `"loadTest": true` and restart the Etherpad server.
Upgrade your Node.js environment to version 18.0.0 or later. Use a version manager like `nvm` to easily switch Node.js versions (e.g., `nvm install 18 && nvm use 18`).
Understand the scope of this client. If you need full editor capabilities, consider alternative Etherpad API clients or direct browser-based interaction.
Prefer `const Client = require('etherpad-cli-client');` for importing the module in CommonJS environments. If using in an ESM project, use `import Client from 'etherpad-cli-client';` leveraging Node.js's CJS-ESM interop, but be aware of potential quirks.Edit your Etherpad server's `settings.json` file, add or set `"loadTest": true`, and restart the Etherpad server.
Ensure you import the `Client` class correctly using `const Client = require('etherpad-cli-client');` and then call its static method: `Client.connect(url);`.If your project is configured with `"type": "module"` in `package.json`, use `import Client from 'etherpad-cli-client';` for CJS interoperability. Alternatively, switch your project to CommonJS by removing `"type": "module"`.
No dependency data recorded yet.