Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rusq/slackdump
Save or export your private and public Slack messages, threads, files, and users locally without admin privileges.
https://github.com/rusq/slackdump
archive backup channels dump dumper mattermost migration-tool slack slack-exports slackdump
Last synced: 6 days ago
JSON representation
Save or export your private and public Slack messages, threads, files, and users locally without admin privileges.
- Host: GitHub
- URL: https://github.com/rusq/slackdump
- Owner: rusq
- License: gpl-3.0
- Created: 2021-10-31T06:51:23.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2025-01-09T03:45:53.000Z (14 days ago)
- Last Synced: 2025-01-09T06:03:27.402Z (13 days ago)
- Topics: archive, backup, channels, dump, dumper, mattermost, migration-tool, slack, slack-exports, slackdump
- Language: Go
- Homepage:
- Size: 5.93 MB
- Stars: 1,683
- Watchers: 9
- Forks: 74
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Slack Dumper
Purpose: archive your private and public Slack messages, users, channels,
files and emojis. Generate Slack Export without admin privileges.
[](https://github.com/rusq/slackdump/releases/)
**Quick links**:
- [Installation And Quickstart](#installation-and-quickstart)
- [Join the discussion in Telegram](https://t.me/slackdump).
- [Buy me a cup of tea](https://ko-fi.com/rusq_), or use **Github Sponsors**
button on the top of the page.
- [][godoc]
- How to's:
- [Mattermost migration][mmost] steps
- [SlackLogViewerとSlackdumpを一緒に使用する](https://kenkyu-note.hatenablog.com/entry/2022/09/02/090949)
- [v1 Overview on Medium.com](https://medium.com/@gilyazov/downloading-your-private-slack-conversations-52e50428b3c2) (outdated)
[godoc]: https://pkg.go.dev/github.com/rusq/slackdump/v3/
[mmost]: doc/usage-export.rst
## Description
Typical use scenarios:
* archive your private conversations from Slack when the administrator
does not allow you to install applications OR you don't want to use
potentially privacy-violating third-party tools,
* archive channels from Slack when you're on a free "no archive" subscription,
so you don't lose valuable knowledge in those channels,
* create a Slack Export archive without admin access, or
* save your favourite emojis.
There are several modes of operation
1. List users/channels
1. Dumping messages and threads
1. Creating a Slack Export in Mattermost or Standard modes.
1. Creating an Archive
1. Emoji download mode.
1. Viewing export, dump or archive files or directories (displays images).
1. Search mode (messages and files).
Run `slackdump help` to see all available options:
## Installation and Quickstart
On macOS, you can install Slackdump with Homebrew::
```shell
brew install slackdump
```
On other Operating Systems, please follow these steps:
1. Download the latest release for your operating system from the [releases] page.
1. Unpack the archive to any directory.
1. Run the `./slackdump` or `slackdump.exe` executable (see note below).
1. You know the drill: use arrow keys to select the menu item, and Enter (or
Return) to confirm.
1. Follow these [qickstart instructions][man-quickstart].
[releases]: https://github.com/rusq/slackdump/releases/
> [!NOTE]
> On Windows and macOS you may be presented with "Unknown developer" window,
> this is fine. Reason for this is that the executable hasn't been signed by
> the developer certificate.
To work around this:
- **on Windows**: click "more information", and press "Run
Anyway" button.
- **on macOS** 14 Sonoma and prior: open the folder in Finder, hold Option
and double click the executable, choose Run.
- **on macOS** 15 Sequoia and later: start the slackdump, OS will show the
"Unknown developer" window, then go to System Preferences -> Security and
Privacy -> General, and press "Open Anyway" button.
### Getting Help
- Quickstart guide: `slackdump help quickstart`, read [online][man-quickstart].
- Generic command overview: `man ./slackdump.1`
- [Ez-Login 3000](https://github.com/rusq/slackdump/wiki/EZ-Login-3000) Guide.
- V2 to V3 migration notes: `slackdump help v2migrate`, read [online][man-v2migrate].
- What's new in V3: `slackdump help whatsnew`, read [online][man-changelog].
[man-quickstart]: https://github.com/rusq/slackdump/blob/master/cmd/slackdump/internal/man/assets/quickstart.md
[man-v2migrate]: https://github.com/rusq/slackdump/blob/master/cmd/slackdump/internal/man/assets/v2migr.md
[man-changelog]: https://github.com/rusq/slackdump/blob/master/cmd/slackdump/internal/man/assets/changelog.md
## Slackord2: Migrating to Discord
If you're migrating to Discord, the recommended way is to use
[Slackord2](https://github.com/thomasloupe/Slackord2) — a great tool with a
nice GUI, that is compatible with the export files generated by Slackdump.
## User Guide
For more advanced features and instructions, please see the [User Guide][ug],
and read `slackdump help` pages.
# Previewing Results
Once the workspace data is dumped, you can run built-in viewer:
```shell
slackdump view
```
The built-in viewer supports all types of dumps:
1. Slackdump Archive format;
1. Standard and Mattermost Slack Export;
1. Dump mode files
The built-in viewer is experimental, any contributions to make it better looking are welcome.
Alternatively, you can use one of the following tools to preview the
export results:
- [SlackLogViewer] - a fast and powerful Slack Export viewer written in C++, works on Export files (images won't be displayed, unless you used an export token flag).
- [Slackdump2Html] - a great Python application that converts Slack Dump to a
static browsable HTML. It works on Dump mode files.
- [slack export viewer][slack-export-viewer] - Slack Export Viewer is a well known viewer for
slack export files.
[SlackLogViewer]: https://github.com/thayakawa-gh/SlackLogViewer/releases
[Slackdump2Html]: https://github.com/kununu/slackdump2html
[slack-export-viewer]: https://github.com/hfaran/slack-export-viewer
## Using as a library
Download:
```shell
go get github.com/rusq/slackdump/v3
```
### Example
```go
package main
import (
"context"
"log"
"github.com/rusq/slackdump/v2"
"github.com/rusq/slackdump/v2/auth"
)
func main() {
provider, err := auth.NewValueAuth("xoxc-...", "xoxd-...")
if err != nil {
log.Print(err)
return
}
sd, err := slackdump.New(context.Background(), provider)
if err != nil {
log.Print(err)
return
}
_ = sd
}
```
See [Package Documentation][godoc].
### Using Custom Logger
Slackdump uses a "log/slog" package, it defaults to "slog.Default()". Set the
default slog logger to the one you want to use.
If you were using `logger.Silent` before, you would need to
[implement][slog-handler-guide] a discarding [Handler][godoc-slog-handler] for slog.
[slog-handler-guide]: https://github.com/golang/example/blob/master/slog-handler-guide/README.md
[godoc-slog-handler]: https://pkg.go.dev/log/slog#Handler
## FAQ
#### Do I need to create a Slack application?
No, you don't. Just run the application and EZ-Login 3000 will take
care of the authentication or, alternatively, grab that token and
cookie from the browser Slack session. See [User's Guide][ug].
#### I'm getting "invalid_auth" error
Run `slackdump workspace new ` to reauthenticate.
#### How to read the export file?
```shell
slackdump view
```
#### My Slack Workspace is on the Free plan. Can I get data older than 90-days?
No, unfortunately you can't. Slack doesn't allow to export data older than 90
days for free workspaces, the API does not return any data before 90 days for
workspaces on the Free plan.
## Thank you
Big thanks to all contributors, who submitted a pull request, reported a bug,
suggested a feature, helped to reproduce, or spent time chatting with me on
the Telegram or Slack to help to understand the issue and tested the proposed
solution.
Also, I'd like to thank current sponsors:
- [
](https://github.com/malsatin) @malsatin
And everyone who made a donation to support the project in the past and keep
supporting the project:
- Vivek R.
- Fabian I.
- Ori P.
- Shir B. L.
- Emin G.
- Robert Z.
- Sudhanshu J.
# Bulletin Board
Messages that were conveyed with the donations:
- 25/01/2022: Stay away from [TheSignChef.com][glassdoor], ya hear, they don't
pay what they owe to their employees.
[glassdoor]: https://www.glassdoor.com/Reviews/The-Sign-Chef-Reviews-E1026706.htm