A thin console toolkit to maintain an etherpad lite instance

v0.2.0 2019-11-23 13:09 UTC


Continuous Integration Latest Stable Version License Scrutinizer Quality Score

A thin console toolkit to maintain an etherpad lite instance


git clone https://github.com/0x46616c6b/etherpad-lite-console.git

cd etherpad-lite-console

composer install


Sample Output

Etherpad Lite Console version 0.1

  [options] command [arguments]

  --help           -h Display this help message.
  --quiet          -q Do not output any message.
  --verbose        -v|vv|vvv Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
  --version        -V Display this application version.
  --ansi              Force ANSI output.
  --no-ansi           Disable ANSI output.
  --no-interaction -n Do not ask any interactive question.

Available commands:
  help                  Displays help for a command
  list                  Lists commands
  pad:delete            Delete a pad
  pad:purge             Purge pads which older then x days
  redis:import:sqlite   Imports a sqlite database to redis

Current features

  • Delete a pad
  • Purge old pads (avoid massive data retention)
    • White- or blacklist pads by suffixes to their pad IDs
  • Migration
    • From SQLite to Redis

Purging pads by suffixes

Suffixes to pad IDs can be used for variable expiry pad times. E.g. to purge pads with suffix '-1day' after 1 day, with '-1year' after 365 days and all other pads after 60 days, do the following:

./bin/console pad:purge --days=1 --suffix=-1day
./bin/console pad:purge --days=365 --suffix=-1year
./bin/console pad:purge --days=60 --ignore-suffix=-1day --ignore-suffix=-1year



  • More Migration (MySQL -> Redis, ...)
  • Stats, stats, stats