{"id":28746159,"url":"https://github.com/ether/etherpad-cli-client","last_synced_at":"2026-02-27T09:11:26.060Z","repository":{"id":27469049,"uuid":"30948271","full_name":"ether/etherpad-cli-client","owner":"ether","description":"Etherpad Node CLI for interacting with Pads in real time.","archived":false,"fork":false,"pushed_at":"2025-08-24T19:59:40.000Z","size":709,"stargazers_count":16,"open_issues_count":4,"forks_count":8,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-08-24T23:21:46.072Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ether.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2015-02-18T02:06:43.000Z","updated_at":"2025-08-24T19:59:44.000Z","dependencies_parsed_at":"2023-02-16T12:25:22.781Z","dependency_job_id":"6169cd7e-2b9c-42b4-be67-7beb9d0693be","html_url":"https://github.com/ether/etherpad-cli-client","commit_stats":{"total_commits":83,"total_committers":6,"mean_commits":"13.833333333333334","dds":0.3493975903614458,"last_synced_commit":"8b8f90f8de4435b4e86a69e78e743faa2527e493"},"previous_names":["johnmclear/etherpad-cli-client"],"tags_count":21,"template":false,"template_full_name":null,"purl":"pkg:github/ether/etherpad-cli-client","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ether%2Fetherpad-cli-client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ether%2Fetherpad-cli-client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ether%2Fetherpad-cli-client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ether%2Fetherpad-cli-client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ether","download_url":"https://codeload.github.com/ether/etherpad-cli-client/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ether%2Fetherpad-cli-client/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29889054,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-27T08:34:21.514Z","status":"ssl_error","status_checked_at":"2026-02-27T08:32:38.035Z","response_time":57,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-06-16T14:30:35.680Z","updated_at":"2026-02-27T09:11:26.036Z","avatar_url":"https://github.com/ether.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"![Publish Status](https://github.com/ether/etherpad-cli-client/workflows/Node.js%20Package/badge.svg) ![Backend Tests Status](https://github.com/ether/etherpad-cli-client/workflows/Backend%20tests/badge.svg)\n\n# Etherpad CLI Client\nInteract with Etherpad contents in real time from within Node and from your CLI.  \n\n# IMPORTANT: Your Etherpad installation must be in loadTest mode for this client to work.  \nTLDR; Set ``loadTest`` to ``true`` in your Etherpad settings.json\n\nWe hope in the future to support full editor functionality but for how functionality is limited.  Read the Etherpad Guide for how to enable load testing.  https://github.com/ether/etherpad-lite/wiki/Load-Testing-Etherpad\nWant to fund some dev so this isn't required?  Get at me.\n\n## 5 seconds getting started...\n```\nsudo npm install -g etherpad-cli-client\netherpad-cli https://beta.etherpad.org/p/clitest\n```\nVisit etherpad https://beta.etherpad.org/p/clitest in your browser and start typing...\n\n## Installation\n``sudo npm install -g etherpad-cli-client``\n\n# CLI\n## Get help\n```\netherpad-cli\n```\n\n## Stream Pad to CLI\n```\netherpad-cli http://127.0.0.1:9001/p/test\n```\n\n## Append contents to pad\n```\netherpad-cli http://127.0.0.1:9001/p/test -a \"hello world\"\n```\n\n# NODE\n## Basic Example\n\n```\nvar etherpad = require(\"etherpad-cli-client\");\nvar pad = etherpad.connect(); // Note no host or padId, will connect to random pad Id on localhost\n\npad.on(\"connected\", function(padState){\n  console.log(\"Connected to \", padState.host);\n});\n\npad.on(\"message\", function(message){\n  console.log(\"New message from Etherpad Server\", message);\n});\n\npad.on(\"disconnect\", function(e){\n  console.log(\"disconnected from pad\", e);\n  process.exit(code=0)\n});\n```\n\n## Stream Pad Text contents to CLI\n```\nvar etherpad = require(\"etherpad-cli-client\");\nvar pad = etherpad.connect(\"http://127.0.0.1:9001/p/test\");\npad.on(\"newContents\", function(atext){\n  console.log(\"\\u001b[2J\\u001b[0;0H\");\n  console.log(\"Test Pad Contents\", \"\\n\"+atext.text);\n});\n```\n\n## Append contents to Pad\n```\nvar etherpad = require(\"etherpad-cli-client\");\nvar pad = etherpad.connect(\"http://127.0.0.1:9001/p/test\");\npad.on(\"connected\", function(){\n  setInterval(function(){\n    pad.append(\"hello world spam\"); // Appends Hello to the Pad contents\n  }, 200);\n});\n```\n\n## Prefix contents to Pad\nTODO\n\n## Write contents to specific location in Pad\nTODO\n\n## Todo\nPrefix Pad content\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fether%2Fetherpad-cli-client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fether%2Fetherpad-cli-client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fether%2Fetherpad-cli-client/lists"}