frdmn / rocketchat-export-channel-messages

Simple Node CLI tool to export all messages of a given Rocket.Chat channel or private group.
MIT License
16 stars 4 forks source link

rocketchat-export-channel-messages

Simple Node CLI tool to export all messages of a given Rocket.Chat channel or private group.

Installation

  1. Make sure you've installed all requirements

  2. Clone this repository and enter it:

    git clone https://github.com/frdmn/rocketchat-export-channel-messages
    cd rocketchat-export-channel-messages
  3. Copy and adjust configuration file from sample (On Windows you can open the config.json file with e.g. notepad and edit it manually, if you don't have bash or vi installed.):

    cp config.sample.json config.json
    vi config.json

Make sure it contains proper user (with administration access) credentials

  1. Install the project dependencies:

    npm install

Usage

Here's a short explanation how to use rocketchat-export-channel-messages:

To export as CSV (default), run:

node index.js --room <roomName>

If you rather have a JSON export, pass the --json argument:

node index.js --room <roomName> --json

Contributing

  1. Fork it

  2. Create your feature branch:

    git checkout -b feature/my-new-feature
  3. Commit your changes:

    git commit -am 'Add some feature'
  4. Push to the branch:

    git push origin feature/my-new-feature
  5. Submit a pull request

Requirements / Dependencies

Version

1.0.0

License

MIT