{"id":15068913,"url":"https://github.com/patrickfav/rocketchat-exporter","last_synced_at":"2025-04-10T17:11:14.757Z","repository":{"id":38388623,"uuid":"210578179","full_name":"patrickfav/rocketchat-exporter","owner":"patrickfav","description":"A simple script exporting chats from a rocket chat instance using the public REST API. Useful if no administrative access is possible.","archived":false,"fork":false,"pushed_at":"2023-10-23T13:12:01.000Z","size":269,"stargazers_count":25,"open_issues_count":8,"forks_count":10,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-03-24T14:51:23.364Z","etag":null,"topics":["cli","csv","export","java11","rocket-chat","slack","tool"],"latest_commit_sha":null,"homepage":"https://favr.dev/opensource/rocketchat-exporter","language":"Java","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/patrickfav.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG","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}},"created_at":"2019-09-24T10:43:30.000Z","updated_at":"2025-01-02T16:24:21.000Z","dependencies_parsed_at":"2025-02-17T16:46:42.356Z","dependency_job_id":null,"html_url":"https://github.com/patrickfav/rocketchat-exporter","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/patrickfav%2Frocketchat-exporter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/patrickfav%2Frocketchat-exporter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/patrickfav%2Frocketchat-exporter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/patrickfav%2Frocketchat-exporter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/patrickfav","download_url":"https://codeload.github.com/patrickfav/rocketchat-exporter/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248261478,"owners_count":21074223,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["cli","csv","export","java11","rocket-chat","slack","tool"],"created_at":"2024-09-25T01:39:42.935Z","updated_at":"2025-04-10T17:11:14.737Z","avatar_url":"https://github.com/patrickfav.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Rocket Chat Exporter CLI\n\nA simple Java CLI tool to export the messages from a [Rocket Chat](https://rocket.chat/) server. It currently supports _groups_, _channels_ and _direct message_ export. You can either choose a single conversation or export all in a batch. As export format this tool only supports the **[Slack CSV](https://slack.com/intl/en-au/help/articles/201748703#) output format** as of now, but adding new output format is quite easy (check out the `ExportFormat` interface).\n\nThis tool uses the [RocketChat API](https://developer.rocket.chat/reference/api/rest-api/endpoints/core-endpoints/groups-endpoints) and is useful for situations where the user does not have administrative access to the server.\n\n[![GitHub release](https://img.shields.io/github/release/patrickfav/rocketchat-exporter.svg)](https://github.com/patrickfav/rocketchat-exporter/releases/latest)\n[![Github Actions](https://github.com/patrickfav/rocketchat-exporter/actions/workflows/build.yml/badge.svg)](https://github.com/patrickfav/rocketchat-exporter/actions)\n[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=patrickfav_rocketchat-exporter\u0026metric=coverage)](https://sonarcloud.io/summary/new_code?id=patrickfav_rocketchat-exporter)\n\n## Quickstart\n\nProvide the tool with your host URL, output file and username.\n\n    java -jar .\\rocketchat-exporter.jar --host \"http://my-rocket-chat.com\" -o \"./out\" -u \"fname.lastname@mail.com\"\n\nAfter that the password will be prompted. The tool will print all available channels. \nChoose one and the resulting export will be written to the provided file. Example output:\n\n```\nPlease enter your RocketChat password: ************\nAuthentication successful (fname.lastname).\n\nWhat type do you want to export:\n\t(1) group\n\t(2) channel\n\t(3) direct message\nSelect option (1-3):\n2\n\nPlease choose the channel you want to export:\n\t(1) [ALL]\n\t(2) channel a\n\t(3) channel b\n\t(4) channel c\nSelect option (1-4):\n3\nSuccessfully exported 122 channel messages to 'out\\channel_channel-b_20190927013945.csv'\n```\n\n### Manpage\n\n    Usage: export [-hV] [--debug] [-m=\u003cmaxMessages\u003e] [-o=\u003cfile\u003e] -t=\u003chost\u003e\n                  -u=\u003cusername\u003e\n    Exports rocket chat messages from a specific group/channel.\n          --debug             Add debug log output to STDOUT.\n      -h, --help              Show this help message and exit.\n      -m, --maxMsg=\u003cmaxMessages\u003e\n                              How many messages should be exported.\n      -o, --outFile=\u003cfile\u003e    The file or directory to write the export data to.\n                                Will write to current directory with auto generated\n                                filename if this arg is omitted. If you want to\n                                export multiple conversations you must pass a\n                                directory not a file.\n      -t, --host=\u003chost\u003e       The rocket chat server. E.g. 'https://myserver.com'\n      -u, --user=\u003cusername\u003e   RocketChat username for authentication.\n      -V, --version           Print version information and exit.\n\n### Requirements\n\n* [Java Runtime Environment (JRE) 11](https://adoptopenjdk.net/)\n\n## Download\n\n**[Grab jar from the latest Release](https://github.com/patrickfav/rocketchat-exporter/releases/latest)**\n\n## Development\n\n### Build with Maven\n\nUse the Maven wrapper to create a jar including all dependencies\n\n    mvnw clean install\n\n### Checkstyle Config File\n\nThis project uses my [`common-parent`](https://github.com/patrickfav/mvn-common-parent) which centralized a lot of\nthe plugin versions as well as providing the checkstyle config rules. Specifically they are maintained\nin [`checkstyle-config`](https://github.com/patrickfav/checkstyle-config). Locally the files will be copied after\nyou `mvnw install` into your `target` folder and is called\n`target/checkstyle-checker.xml`. So if you use a plugin for your IDE, use this file as your local configuration.\n\n# License\n\nCopyright 2019 Patrick Favre-Bulle\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n    http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpatrickfav%2Frocketchat-exporter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpatrickfav%2Frocketchat-exporter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpatrickfav%2Frocketchat-exporter/lists"}