Skip to content

Latest commit

 

History

History
41 lines (36 loc) · 1.92 KB

quickstart.md

File metadata and controls

41 lines (36 loc) · 1.92 KB

Quick Start

There are two ways to use Slackdump:

  1. Wizard Mode;
  2. Command Line Mode.

Wizard Mode

  1. Start Slackdump without parameters, and choose Run wizard. Alternatively, you can start wizard by runnning slackdump wiz).

  2. Add a new workspace:

    1. In the main menu, choose Workspace => New
    2. Select Login In Browser, and type your workspace name or paste a URL.
    3. If your workspace uses Google Authentication, select User Browser and pick the one installed on your system.
    4. In all other cases, choose Interactive mode.
    5. The browser will open, login as usual. Choose "Open this workspace in browser." The new workspace is automatically selected, and ready to use. (You can switch between workspaces using the Workspace menu).
    6. Exit the Workspace menu by choosing Exit to exit to workspace menu and then << Back to return to the main menu.

  3. Select Archive or Export items to save your workspace data. You can configure the following options:

    • specify the list of channel IDs to include or exclude in the "Archive Options" (or "Export Options"). The list supports URLs, that you can copy and paste from the Slack client.
    • define the Time range in the "Global Configuration".

    The difference between Options and Global Configuration is that the Options affect only the current command, while the Global Configuration affects all commands.

  4. The data is saved by default in the directory or ZIP file that starts with slackdump-<timestamp>.

  5. To view your data, you need to use the Command Line Mode, see item 3 below.

Command Line Mode

  1. Add a workspace slackdump workspace new <workspace_name>. The browser will open, login as usual.
  2. Run slackdump archive or slackdump export to save your workspace data.
  3. Run slackdump view <archive name> to view the data.

Fallback to Manual login