slackdump

README

Slack Dumper

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

Quick links:

• Installation And Quickstart

• Join the discussion in Telegram.

• Buy me a cup of tea, or use GitHub Sponsors button on the top of the page.

• 

• How to's:

  • Mattermost migration steps
  • SlackLogViewerとSlackdumpを一緒に使用する
  • v1 Overview on Medium.com (outdated)

[!WARNING]

Enterprise Workspaces Security Alerts

Depending on your Slack plan and security settings, using Slackdump may trigger Slack security alerts and/or notify workspace administrators of unusual or automated access/scraping attempts.

You are responsible for ensuring your use complies with your organisation’s policies and Slack’s terms of service.

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 quickstart 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.

Running Slackdump from a Repo Checkout

If you've cloned the repository and want to run slackdump directly without downloading a release, you can do one of the following:

1. Build and run (creates an executable):

   go build -o slackdump ./cmd/slackdump
   ./slackdump wiz
   

2. Run directly:

   go run ./cmd/slackdump wiz
   

Note: You need Go installed on your system (see go.mod for the version)

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. Supports displaying files if saved in the "Standard" file mode.

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.

What's the difference between "archive", "export" and "dump"?

"Archive" is the new format introduced in v3, it minimises the memory use while scraping the data and also has a universal structure that can be converted into export and dump formats at will by using the "convert" command.

"Export" format aims to replicate the files generated when exporting a Slack workspace for compatibility.

"Dump" format has one channel per file, there's no workspace information nor any users stored. Should it be required, one must get users and channels by running slackdump list command.

Behind the scenes slackdump always uses the "archive" file format for all operations except "emoji" and "list", and converts to other formats on the fly, removing the temporary archive files afterwards.

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 problem or feature and tested the proposed solution.

See CONTRIBUTORS.md for the full list of contributors.

Also, I'd like to thank current sponsors:

• @malsatin
• @angellk

And everyone who made a donation to support the project in the past and keep supporting the project:

• Davanum S.
• 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.

Documentation

Index

• Variables
• type GetChannelsParameters
• type Option
  • func WithFilesystem(fs fsadapter.FS) Option
  • func WithForceEnterprise(b bool) Option
  • func WithLimits(l network.Limits) Option
  • func WithLogger(l *slog.Logger) Option
  • func WithSlackClient(cl client.SlackClienter) Option
  • func WithUserCacheRetention(d time.Duration) Option
• type ProcessFunc
• type ProcessResult
  • func (pr ProcessResult) String() string
• type ProcessResults
  • func (prs ProcessResults) String() string
• type Session
  • func New(ctx context.Context, prov auth.Provider, opts ...Option) (*Session, error)
  • func NewNoValidate(ctx context.Context, prov auth.Provider, opts ...Option) (*Session, error)
  • func (s *Session) Client() (*slack.Client, error)
  • func (s *Session) CurrentUserID() string
  • func (s *Session) Dump(ctx context.Context, link string, oldest, latest time.Time, ...) (*types.Conversation, error)
  • func (s *Session) DumpAll(ctx context.Context, link string) (*types.Conversation, error)
  • func (s *Session) DumpEmojis(ctx context.Context) (map[string]string, error)
  • func (s *Session) DumpRaw(ctx context.Context, link string, oldest, latest time.Time, ...) (*types.Conversation, error)
  • func (sd *Session) GetChannelMembers(ctx context.Context, channelID string) ([]string, error)
  • func (s *Session) GetChannels(ctx context.Context, chanTypes ...string) (types.Channels, error)
  • func (s *Session) GetChannelsEx(ctx context.Context, p GetChannelsParameters) (types.Channels, error)
  • func (s *Session) GetUsers(ctx context.Context) (types.Users, error)
  • func (s *Session) Info() *WorkspaceInfo
  • func (s *Session) Stream(opts ...stream.Option) *stream.Stream
  • func (s *Session) StreamChannels(ctx context.Context, chanTypes []string, cb func(ch slack.Channel) error) error
  • func (s *Session) StreamChannelsEx(ctx context.Context, p GetChannelsParameters) iter.Seq2[[]slack.Channel, error]
• type WorkspaceInfo

Examples

• New (BrowserAuth)
• New (CookieFile)
• New (TokenAndCookie)

Variables

var AllChanTypes = []string{st.CMPIM, st.CIM, st.CPublic, st.CPrivate}

AllChanTypes enumerates all API-supported channel types as of 12/2025.

var ErrNoUserCache = errors.New("user cache unavailable")

ErrNoUserCache is returned when the user cache is not initialised.

var ErrNotAClient = errors.New("programming error: underlying client is not a slack.Client")

ErrNotAClient is returned by Client() when the underlying client is not a slack.Client.

var ErrStop = errors.New("stop")

ErrStop instructs early stop to streaming function, when returned from a callback function.

Types

type GetChannelsParameters

type GetChannelsParameters struct {
	// ChannelTypes allows to specify the channel types to fetch.  If the slice
	// is empty, all channel types will be fetched.
	ChannelTypes []string
	// OnlyMyChannels restricts the channels only to the channels that the user
	// is a member of.
	OnlyMyChannels bool
}

GetChannelsParameters holds the parameters for [GetChannelsEx] and [StreamChannelsEx] functions.

type Option

type Option func(*Session)

Option is the signature of the option-setting function.

func WithFilesystem

func WithFilesystem(fs fsadapter.FS) Option

WithFilesystem sets the filesystem adapter to use for the session. If this option is not given, the default filesystem adapter is initialised with the base location specified in the Config.

func WithForceEnterprise

func WithForceEnterprise(b bool) Option

func WithLimits

func WithLimits(l network.Limits) Option

WithLimits sets the API limits to use for the session. If this option is not given, the default limits are initialised with the values specified in DefLimits.

func WithLogger

func WithLogger(l *slog.Logger) Option

WithLogger sets the logger to use for the session. If this option is not given, the default logger is initialised with the filename specified in Config.Logfile. If the Config.Logfile is empty, the default logger writes to STDERR.

func WithSlackClient

func WithSlackClient(cl client.SlackClienter) Option

WithSlackClient sets the Slack client to use for the session. If this

func WithUserCacheRetention

func WithUserCacheRetention(d time.Duration) Option

WithUserCacheRetention sets the retention period for the user cache. If this option is not given, the default value is 60 minutes.

type ProcessFunc

type ProcessFunc func(msg []types.Message, channelID string) (ProcessResult, error)

ProcessFunc is the signature of the processor function that Dump* family functions accept and call for each API call result. It can be used to modify in-place the slice of messages, returned from API, before they are appended to the slice that will be returned by Dump*. Messages passed to this function are unsorted.

type ProcessResult

type ProcessResult struct {
	// Entity is the type of entity that this result is related to.
	Entity string
	// Count is the number of items processed during processing.
	Count int
}

ProcessResult contains the result of processing.

func (ProcessResult) String

func (pr ProcessResult) String() string

type ProcessResults

type ProcessResults []ProcessResult

ProcessResults is the slice of ProcessResult

func (ProcessResults) String

func (prs ProcessResults) String() string

type Session

type Session struct {
	// contains filtered or unexported fields
}

Session stores basic session parameters. Zero value is not usable, must be initialised with New.

func New

func New(ctx context.Context, prov auth.Provider, opts ...Option) (*Session, error)

New creates new Slackdump session with provided options, and populates the internal cache of users and channels for lookups. If it fails to authenticate, AuthError is returned.

Example (BrowserAuth)

provider, err := auth.NewPlaywrightAuth(context.Background())
if err != nil {
	log.Print(err)
	return
}
fsa := openTempFS()
defer fsa.Close()
sd, err := New(context.Background(), provider)
if err != nil {
	log.Print(err)
	return
}
_ = sd

Example (CookieFile)

provider, err := auth.NewCookieFileAuth("xoxc-...", "cookies.txt")
if err != nil {
	log.Print(err)
	return
}
fsa := openTempFS()
defer fsa.Close()

sd, err := New(context.Background(), provider)
if err != nil {
	log.Print(err)
	return
}
_ = sd

Example (TokenAndCookie)

provider, err := auth.NewValueAuth("xoxc-...", "xoxd-...")
if err != nil {
	log.Print(err)
	return
}
fsa := openTempFS()
defer fsa.Close()

sd, err := New(context.Background(), provider)
if err != nil {
	log.Print(err)
	return
}
_ = sd

func NewNoValidate

func NewNoValidate(ctx context.Context, prov auth.Provider, opts ...Option) (*Session, error)

NewNoValidate creates new Slackdump session with provided options, and populates the internal cache of users and channels for lookups. This function does not validate the auth.Provider.

func (*Session) Client

func (s *Session) Client() (*slack.Client, error)

Client returns the underlying slack.Client. If the underlying client is not a slack.Client, ErrNotAClient is returned.

func (*Session) CurrentUserID

func (s *Session) CurrentUserID() string

CurrentUserID returns the user ID of the authenticated user.

func (*Session) Dump

func (s *Session) Dump(ctx context.Context, link string, oldest, latest time.Time, processFn ...ProcessFunc) (*types.Conversation, error)

Dump dumps messages or threads specified by link. link can be one of the following:

• Channel URL - i.e. https://ora600.slack.com/archives/CHM82GF99
• Thread URL - i.e. https://ora600.slack.com/archives/CHM82GF99/p1577694990000400
• ChannelID - i.e. CHM82GF99
• ChannelID:ThreadTS - i.e. CHM82GF99:1577694990.000400

oldest and latest timestamps set a timeframe within which the messages should be retrieved, also one can provide process functions.

func (*Session) DumpAll

func (s *Session) DumpAll(ctx context.Context, link string) (*types.Conversation, error)

DumpAll dumps all messages. See description of Dump for what can be provided in link.

func (*Session) DumpEmojis

func (s *Session) DumpEmojis(ctx context.Context) (map[string]string, error)

func (*Session) DumpRaw

func (s *Session) DumpRaw(ctx context.Context, link string, oldest, latest time.Time, processFn ...ProcessFunc) (*types.Conversation, error)

DumpRaw dumps all messages, but does not account for any options defined, such as DumpFiles, instead, the caller must hassle about any processFns they want to apply.

func (*Session) GetChannelMembers

func (sd *Session) GetChannelMembers(ctx context.Context, channelID string) ([]string, error)

GetChannelMembers returns a list of all members in a channel.

func (*Session) GetChannels

func (s *Session) GetChannels(ctx context.Context, chanTypes ...string) (types.Channels, error)

GetChannels list all conversations for a user. `chanTypes` specifies the type of channels to fetch. See github.com/rusq/slack docs for possible values. If large number of channels is to be returned, consider using [StreamChannelsEx]. It is a wrapper for [GetChannelsEx].

Deprecated; Use [GetChannelsEx]. This function Will be removed in v5.

func (*Session) GetChannelsEx

func (s *Session) GetChannelsEx(ctx context.Context, p GetChannelsParameters) (types.Channels, error)

GetChannelsEx list all conversations for a user. GetChannelParameters should contain the fetch criteria. If large number of channels is to be returned, consider using [StreamChannelsEx].

func (*Session) GetUsers

func (s *Session) GetUsers(ctx context.Context) (types.Users, error)

GetUsers retrieves all users either from cache or from the API. If Session.usercache is not empty, it will return the cached users. Otherwise, it will try fetching them from the API and cache them.

func (*Session) Info

func (s *Session) Info() *WorkspaceInfo

Info returns a workspace information. Slackdump retrieves workspace information during the initialisation when performing authentication test, so no API call is involved at this point.

func (*Session) Stream

func (s *Session) Stream(opts ...stream.Option) *stream.Stream

Stream returns the new data streamer with the current session parameters.

func (*Session) StreamChannels

func (s *Session) StreamChannels(ctx context.Context, chanTypes []string, cb func(ch slack.Channel) error) error

StreamChannels requests the channels from the API and calls the callback function cb for each. It is a wrapper for [StreamChannelsEx].

Deprecated: Use [StreamChannelsEx]. This function Will be removed in v5.

func (*Session) StreamChannelsEx

func (s *Session) StreamChannelsEx(ctx context.Context, p GetChannelsParameters) iter.Seq2[[]slack.Channel, error]

StreamChannelsEx requests the channels from the API and returns an iterator of channel chunks.

type WorkspaceInfo

type WorkspaceInfo = slack.AuthTestResponse

WorkspaceInfo is an type alias for slack.AuthTestResponse.