Skip to content

Latest commit

 

History

History
237 lines (167 loc) · 7.66 KB

README.md

File metadata and controls

237 lines (167 loc) · 7.66 KB

Slack Dumper

Purpose: archive your private and public Slack messages, users, channels, files and emojis. Generate Slack Export without admin privileges.

Slackdump screenshot

Quick links:

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
  2. Dumping messages and threads
  3. Creating a Slack Export in Mattermost or Standard modes.
  4. Creating an Archive
  5. Emoji download mode.
  6. Viewing export, dump or archive files or directories (displays images).
  7. Search mode (messages and files).

Run slackdump help to see all available options:

Installation and Quickstart

On macOS, you can install Slackdump with Homebrew::

brew install slackdump

On other Operating Systems, please follow these steps:

  1. Download the latest release for your operating system from the releases page.
  2. Unpack the archive to any directory.
  3. Run the ./slackdump or slackdump.exe executable (see note below).
  4. You know the drill: use arrow keys to select the menu item, and Enter (or Return) to confirm.
  5. Follow these qickstart instructions.

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.
  • Generic command overview: man ./slackdump.1
  • Ez-Login 3000 Guide.
  • V2 to V3 migration notes: slackdump help v2migrate, read online.
  • What's new in V3: slackdump help whatsnew, read online.

Slackord2: Migrating to Discord

If you're migrating to Discord, the recommended way is to use 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:

slackdump view <zip or directory>

The built-in viewer supports all types of dumps:

  1. Slackdump Archive format;
  2. Standard and Mattermost Slack Export;
  3. 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 is a well known viewer for slack export files.

Using as a library

Download:

go get github.com/rusq/slackdump/v3

Example

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.

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 a discarding Handler for slog.

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 <name or url> to reauthenticate.

How to read the export file?

slackdump view <ZIP-archive or directory>

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:

  • @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, ya hear, they don't pay what they owe to their employees.