From c118a0bb9402cc74355d7c7ad3cf02ba0e33f500 Mon Sep 17 00:00:00 2001 From: Tyrrrz <1935960+Tyrrrz@users.noreply.github.com> Date: Sat, 11 Nov 2023 17:47:48 +0200 Subject: [PATCH] Fix broken links in docs --- .docs/Docker.md | 2 +- .docs/Getting-started.md | 11 +- .docs/Linux.md | 6 +- .docs/MacOS.md | 6 +- .docs/Readme.md | 32 ++--- .docs/Scheduling-Linux.md | 10 +- .docs/Scheduling-MacOS.md | 8 +- .docs/Scheduling-Windows.md | 8 +- .docs/Token-and-IDs.md | 4 +- .docs/Troubleshooting.md | 37 +++--- .docs/Using-the-CLI.md | 242 +++++++++++++++++++----------------- .docs/Using-the-GUI.md | 2 +- 12 files changed, 192 insertions(+), 176 deletions(-) diff --git a/.docs/Docker.md b/.docs/Docker.md index 8c8c658..b07f071 100644 --- a/.docs/Docker.md +++ b/.docs/Docker.md @@ -59,7 +59,7 @@ You can also use the current working directory as the output directory by specif For more information, please refer to the [Dockerfile](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/DiscordChatExporter.Cli.dockerfile) and [Docker documentation](https://docs.docker.com/engine/reference/run). -To get your Token and Channel IDs, please refer to [this page](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Token-and-IDs.md). +To get your Token and Channel IDs, please refer to [this page](Token-and-IDs.md). ## Environment variables diff --git a/.docs/Getting-started.md b/.docs/Getting-started.md index 7fd7e93..a107ada 100644 --- a/.docs/Getting-started.md +++ b/.docs/Getting-started.md @@ -2,15 +2,16 @@ Welcome to the getting started page! Here you'll learn how to use every **DiscordChatExporter** (DCE for short) feature. -For other things you can do with DCE, check out the [Guides](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Readme.md#Guides) section. +For other things you can do with DCE, check out the [Guides](Readme.md#guides) section. -If you still have unanswered questions after reading this page or if you have encountered a problem, please visit our [FAQ & Troubleshooting](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Troubleshooting.md) section. +If you still have unanswered questions after reading this page or if you have encountered a problem, please visit our [FAQ & Troubleshooting](Troubleshooting.md) section. The information presented on this page is valid for **all** platforms. ## GUI or CLI? ![GUI vs CLI](https://i.imgur.com/j9OTxRB.png) + **DCE** has two different versions: - **Graphical User Interface** (**GUI**) - it's the preferred version for newcomers as it is easy to use. @@ -19,12 +20,12 @@ The information presented on this page is valid for **all** platforms. You can get it by [downloading](https://github.com/Tyrrrz/DiscordChatExporter/releases/latest) the `DiscordChatExporter.CLI.zip` file. If you're not comfortable with **Windows'** Command-line (cmd), please choose the GUI. -[**macOS**](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/MacOS.md), [**Linux**](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Linux.md) and [**Docker**](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Docker.md) users can only use the CLI version. +[**macOS**](MacOS.md), [**Linux**](Linux.md) and [**Docker**](Docker.md) users can only use the CLI version. There are dedicated guides for each version: -- [Using the GUI](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Using-the-GUI.md) -- [Using the CLI](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Using-the-CLI.md) +- [Using the GUI](Using-the-GUI.md) +- [Using the CLI](Using-the-CLI.md) ## File formats diff --git a/.docs/Linux.md b/.docs/Linux.md index 29b0c40..7a37ff7 100644 --- a/.docs/Linux.md +++ b/.docs/Linux.md @@ -2,7 +2,7 @@ ## Installing .NET Runtime -Please follow the [instructions provided here](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Dotnet.md). +Please follow the [instructions provided here](Dotnet.md). ## Downloading and using DiscordChatExporter.Cli @@ -21,6 +21,6 @@ If the above command throws a "Permission denied" error, execute this command to chmod 644 *.dll DiscordChatExporter.* ``` -> [How to get Token and Channel IDs](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Token-and-IDs.md). +> [How to get Token and Channel IDs](Token-and-IDs.md). -There's much more you can do with DCE.CLI! Read the [CLI explained](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Getting-started.md#dcecli-commands-) page to get started. +There's much more you can do with DCE.CLI! Read the [CLI explained](Using-the-CLI.md) page to get started. diff --git a/.docs/MacOS.md b/.docs/MacOS.md index b545f17..8b949e4 100644 --- a/.docs/MacOS.md +++ b/.docs/MacOS.md @@ -4,7 +4,7 @@ ## Installing .NET Runtime -Please follow the [instructions provided here](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Dotnet.md). +Please follow the [instructions provided here](Dotnet.md). ## Downloading and using DiscordChatExporter.Cli @@ -17,6 +17,6 @@ Please follow the [instructions provided here](https://github.com/Tyrrrz/Discord dotnet DiscordChatExporter.Cli.dll export -t TOKEN -c CHANNEL ``` -> [How to get Token and Channel IDs](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Token-and-IDs.md). +> [How to get Token and Channel IDs](Token-and-IDs.md). -There's much more you can do with DCE.CLI! Read the [CLI explained](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Getting-started.md#dcecli-commands-) page to get started. +There's much more you can do with DCE.CLI! Read the [CLI explained](Using-the-CLI.md) page to get started. diff --git a/.docs/Readme.md b/.docs/Readme.md index def58f8..0be5ce3 100644 --- a/.docs/Readme.md +++ b/.docs/Readme.md @@ -2,21 +2,21 @@ ## Installation & Usage -- [Get .NET Core Runtime](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Dotnet.md) (Required for CLI; Installed automatically for GUI; Not required in Docker) -- [Windows](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Getting-started.md#gui-or-cli) | [macOS](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/MacOS.md) | [Linux](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Linux.md) | [Docker](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Docker.md) +- [Get .NET Core Runtime](Dotnet.md) (Required for CLI; Installed automatically for GUI; Not required in Docker) +- [Windows](Getting-started.md#gui-or-cli) | [macOS](MacOS.md) | [Linux](Linux.md) | [Docker](Docker.md) - Getting started: - - [Using the GUI](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Getting-started.md#using-the-gui) - - [Using the CLI](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Getting-started.md#using-the-cli) - - [File formats](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Getting-started.md#file-formats) + - [Using the GUI](Using-the-CLI.md) + - [Using the CLI](Using-the-CLI.md) + - [File formats](Getting-started.md#file-formats) ## Guides -- [How to get Token and Channel IDs](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Token-and-IDs.md) -- [How to use message filters](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Message-filters.md) +- [How to get Token and Channel IDs](Token-and-IDs.md) +- [How to use message filters](Message-filters.md) - Export scheduling with CLI: - - [Windows](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Scheduling-Windows.md) - - [macOS](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Scheduling-MacOS.md) - - [Linux](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Scheduling-Linux.md) + - [Windows](Scheduling-Windows.md) + - [macOS](Scheduling-MacOS.md) + - [Linux](Scheduling-Linux.md) ## Video tutorial @@ -26,9 +26,9 @@ ## FAQ & Troubleshooting -- [General questions](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Troubleshooting.md#general) -- [First steps help](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Troubleshooting.md#first-steps) -- [It's crashing/failing](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Troubleshooting.md#DCE-is-crashingfailing) -- [.NET Core Runtime is required](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Troubleshooting.md#net-core-runtime-is-required) -- [Errors](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Troubleshooting.md#errors) -- [**More help**](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Troubleshooting.md) +- [General questions](Troubleshooting.md#general) +- [First steps help](Troubleshooting.md#first-steps) +- [It's crashing/failing](Troubleshooting.md#DCE-is-crashingfailing) +- [.NET Core Runtime is required](Troubleshooting.md#net-core-runtime-is-required) +- [Errors](Troubleshooting.md#errors) +- [**More help**](Troubleshooting.md) diff --git a/.docs/Scheduling-Linux.md b/.docs/Scheduling-Linux.md index 6e9c650..63a5bfc 100644 --- a/.docs/Scheduling-Linux.md +++ b/.docs/Scheduling-Linux.md @@ -1,10 +1,8 @@ # Scheduling exports with Cron -Make sure you already have **DiscordChatExporter.CLI** and **.NET Core** properly installed ([instructions here](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Linux.md)). +Make sure you already have **DiscordChatExporter.CLI** and **.NET Core** properly installed ([instructions here](Linux.md)). -You can use Cron on macOS, but [this method](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/scheduling-MacOS.md) is preferred. - ---- +## Creating the script 1. Open Terminal and create a new text file with `nano /path/to/DiscordChatExporter/cron.sh` @@ -66,8 +64,8 @@ exit 0 3. Replace: -- `tokenhere` with your [Token](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Token-and-IDs.md). -- `channelhere` with a [Channel ID](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Token-and-IDs.md). +- `tokenhere` with your [Token](Token-and-IDs.md). +- `channelhere` with a [Channel ID](Token-and-IDs.md). - `dceFOLDERpathhere` with DCE's **directory path** (e.g. `/path/to/folder`, NOT `/path/to/folder/DiscordChatExporter.dll`). - `filenamehere` with the exported channel's filename, without spaces. - `dirhere` with the export directory (e.g. /home/user/Documents/Discord\ Exports). diff --git a/.docs/Scheduling-MacOS.md b/.docs/Scheduling-MacOS.md index 8083f76..f2a9a36 100644 --- a/.docs/Scheduling-MacOS.md +++ b/.docs/Scheduling-MacOS.md @@ -2,7 +2,7 @@ Scheduling on macOS is a bit tricky, but it should work if you follow the instructions accordingly. -Make sure you already have **DiscordChatExporter.CLI** and **.NET Core** properly installed ([instructions here](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/macOS-usage-instructions.md)). +Make sure you already have **DiscordChatExporter.CLI** and **.NET Core** properly installed ([instructions here](MacOS.md)). ## Creating the script @@ -70,8 +70,8 @@ exit 0 4. Replace: -- `tokenhere` with your [Token](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Token-and-IDs.md) -- `channelhere` with a [Channel ID](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Token-and-IDs.md) +- `tokenhere` with your [Token](Token-and-IDs.md) +- `channelhere` with a [Channel ID](Token-and-IDs.md) - `dceFOLDERpathhere` with DCE's **directory's path** (e.g. `/Users/user/Desktop/DiscordChatExporterFolder`, NOT `/Users/user/Desktop/DiscordChatExporterFolder/DiscordChatExporter.DLL`) - `filenamehere` with the exported channel's filename, without spaces - `dirhere` with the directory you want the files to be saved at (e.g. `/Users/user/Documents/Discord\ Exports`) @@ -168,7 +168,7 @@ Omitted keys are interpreted as wildcards, for example, if you delete the Minute Be aware that if you set the day to '31', the script will only run on months that have the 31st day. -**Check the examples below ([or skip to step 3 (loading the file)](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/scheduling-MacOS.md#3-loading-the-plist-into-launchctl)):** +**Check the examples below ([or skip to step 3 (loading the file)](#3-loading-the-plist-into-launchctl)):** Export everyday at 5:15 PM: diff --git a/.docs/Scheduling-Windows.md b/.docs/Scheduling-Windows.md index 3822198..9cfed26 100644 --- a/.docs/Scheduling-Windows.md +++ b/.docs/Scheduling-Windows.md @@ -2,10 +2,12 @@ We'll be using [DiscordChatExporter CLI](https://github.com/Tyrrrz/DiscordChatExporter/releases/latest), PowerShell, and Task Scheduler. +## Creating the script + 1. Open a text editor such as Notepad and paste: ```console -# Info: https://github.com/Tyrrrz/DiscordChatExporter/wiki +# Info: https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs $TOKEN = "tokenhere" $CHANNEL = "channelhere" @@ -31,8 +33,8 @@ exit 2. Replace: -- `tokenhere` with your [Token](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Token-and-IDs.md) -- `channelhere` with a [Channel ID](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Token-and-IDs.md) +- `tokenhere` with your [Token](Token-and-IDs.md) +- `channelhere` with a [Channel ID](Token-and-IDs.md) - `exefolderhere` with the .exe **directory's path** (e.g. C:\Users\User\Desktop\DiscordChatExporter) - `filenamehere` with a filename without spaces - `dirhere` with the export directory (e.g. C:\Users\User\Documents\Exports) diff --git a/.docs/Token-and-IDs.md b/.docs/Token-and-IDs.md index 596889c..4ef1d25 100644 --- a/.docs/Token-and-IDs.md +++ b/.docs/Token-and-IDs.md @@ -232,7 +232,7 @@ Prerequisite step: Navigate to [discord.com](https://discord.com) and login. 4. Launch Discord. -5. To find your user token, continue [here](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Token-and-IDs.md#in-chrome). +5. To find your user token, continue [here](#in-chrome). #### Via settings menu (BetterDiscord only) @@ -252,7 +252,7 @@ Prerequisite step: Navigate to [discord.com](https://discord.com) and login.
4. Press Esc. The settings page will close. -5. To find your user token, continue [here](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Token-and-IDs.md#in-chrome). +5. To find your user token, continue [here](#in-chrome). ## How to get a Bot Token diff --git a/.docs/Troubleshooting.md b/.docs/Troubleshooting.md index 305c695..7ff700b 100644 --- a/.docs/Troubleshooting.md +++ b/.docs/Troubleshooting.md @@ -20,7 +20,7 @@ A token can be used to log into your account, so treat it like a password and ne ### How can I reset my token? -Follow the [instructions here](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Token-and-IDs.md). +Follow the [instructions here](Token-and-IDs.md). ### Will I get banned if I use this? @@ -66,31 +66,26 @@ No. ### How can I find my token? -Check the following page: [Obtaining token](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Token-and-IDs.md) +Check the following page: [Obtaining token](Token-and-IDs.md) ### When I open DCE a black window pops up quickly or nothing shows up -If you have [.NET Core Runtime correctly installed](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Dotnet.md), you might have downloaded the CLi flavor, try [downloading the GUI](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Getting-started.md#gui-or-cli) instead. - -### I can't open DCE, it sends me to a Visual Studio webpage - -Check the following page: -[Installation and usage](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Readme.md#installation--usage) +If you have [.NET Core Runtime correctly installed](Dotnet.md), you might have downloaded the CLi flavor, try [downloading the GUI](Getting-started.md#gui-or-cli) instead. ### How do I run DCE on macOS or Linux? Check the following pages: -- [macOS usage instructions](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/MacOS.md) -- [Linux usage instructions](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Linux.md) +- [macOS usage instructions](MacOS.md) +- [Linux usage instructions](Linux.md) ### How can I set DCE to export automatically at certain times? Check the following pages to learn how to schedule **DiscordChatExporter.CLI** runs (advanced): -- [Windows scheduling](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/scheduling-windows.md) -- [macOS scheduling](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/scheduling-MacOS.md) -- [Linux scheduling](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/scheduling-Linux.md) +- [Windows scheduling](Scheduling-Windows.md) +- [macOS scheduling](Scheduling-MacOS.md) +- [Linux scheduling](Scheduling-Linux.md) ### The exported file is too large, I can't open it @@ -98,13 +93,13 @@ Try opening it with a different program, try partitioning or use a different fil ### DCE is crashing/failing -Check the following page: [Installing .NET Core Runtime](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Dotnet.md) +Check the following page: [Installing .NET Core Runtime](Dotnet.md) If you already have .NET Core installed, please check if your problem is a [known issue](https://github.com/Tyrrrz/DiscordChatExporter/issues?q=is%3Aissue) before [opening a bug report](https://github.com/Tyrrrz/DiscordChatExporter/issues/new). ### .NET Core Runtime is required -Check the following page: [Installing .NET Core Runtime](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Dotnet.md) +Check the following page: [Installing .NET Core Runtime](Dotnet.md) ### I see messages in the export, but they have no content @@ -116,25 +111,25 @@ Your bot is missing the 'Message Content Intent'. Go to the [Discord Developer P Check the following page: -- [Using the CLI](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Getting-started.md#using-the-cli) +- [Using the CLI](Using-the-CLI.md) -If you're using **Docker**, please refer to the [Docker Usage Instructions](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Docker.md) instead. +If you're using **Docker**, please refer to the [Docker Usage Instructions](Docker.md) instead. ### Where can I find the 'Channel IDs'? Check the following page: -- [Obtaining Channel IDs](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Token-and-IDs.md) +- [Obtaining Channel IDs](Token-and-IDs.md) ### I can't find Docker exported chats Check the following page: -- [Docker usage instructions](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/docker) +- [Docker usage instructions](Docker.md) ### I can't export Direct Messages -Make sure you're [copying the DM Channel ID](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Token-and-IDs.md#how-to-get-a-direct-message-channel-id), not the person's user ID. +Make sure you're [copying the DM Channel ID](Token-and-IDs.md#how-to-get-a-direct-message-channel-id), not the person's user ID. ## Errors @@ -149,7 +144,7 @@ DiscordChatExporter.Domain.Exceptions.DiscordChatExporterException: Authenticati DiscordChatExporter.Domain.Exceptions.DiscordChatExporterException: Requested resource does not exist. ``` -↳ Check your channel ID, it might be invalid. [Read this if you need help](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Token-and-IDs.md). +↳ Check your channel ID, it might be invalid. [Read this if you need help](Token-and-IDs.md). ```console DiscordChatExporter.Domain.Exceptions.DiscordChatExporterException: Access is forbidden. diff --git a/.docs/Using-the-CLI.md b/.docs/Using-the-CLI.md index 5bb8bc1..526f6f4 100644 --- a/.docs/Using-the-CLI.md +++ b/.docs/Using-the-CLI.md @@ -3,8 +3,8 @@ ## Guide > **Note**: -> Make sure you have [.NET Core installed](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Dotnet.md) before attempting to run the commands below. -> **Docker** users, please refer to the [Docker usage instructions](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Docker.md). +> Make sure you have [.NET Core installed](Dotnet.md) before attempting to run the commands below. +> **Docker** users, please refer to the [Docker usage instructions](Docker.md). ## Step 1 @@ -25,7 +25,8 @@ You can also drag and drop the folder on **every platform**. ## Step 3 -Now we're ready to run the commands. The examples on this page follow the Windows file path format, change the file paths according to your system. +Now we're ready to run the commands. The examples on this page follow the Windows file path format, change the file +paths according to your system. Type the following in Command Prompt (Terminal), then press ENTER to run it. This will list DCE's options. @@ -33,22 +34,23 @@ Type the following in Command Prompt (Terminal), then press ENTER to run it. Thi dotnet DiscordChatExporter.Cli.dll ``` -> **Docker** users, please refer to the [Docker usage instructions](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Docker.md). +> **Docker** users, please refer to the [Docker usage instructions](Docker.md). ## CLI commands -| Command | Description | -| ------------------------------------------------------------------------------------------------------------- | --------------------------------------------------- | -| [export](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Getting-started.md#export) | Exports a channel | -| [exportdm](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Getting-started.md#exportdm) | Exports all direct message channels | -| [exportguild](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Getting-started.md#exportguild) | Exports all channels within the specified server | -| [exportall](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Getting-started.md#exportall) | Exports all accessible channels | -| [channels](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Getting-started.md#channels) | Outputs the list of channels in the given server | -| [dm](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Getting-started.md#dm) | Outputs the list of direct message channels | -| [guilds](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Getting-started.md#guilds) | Outputs the list of accessible servers | -| [guide](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Getting-started.md#guide) | Explains how to obtain token, guild, and channel ID | - -To use the commands, you'll need a token. For the instructions on how to get a token, please refer to [this page](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Token-and-IDs.md), or run `dotnet DiscordChatExporter.Cli.dll guide`. +| Command | Description | +|-----------------------------|-----------------------------------------------------| +| [export](#export) | Exports a channel | +| [exportdm](#exportdm) | Exports all direct message channels | +| [exportguild](#exportguild) | Exports all channels within the specified server | +| [exportall](#exportall) | Exports all accessible channels | +| [channels](#channels) | Outputs the list of channels in the given server | +| [dm](#dm) | Outputs the list of direct message channels | +| [guilds](#guilds) | Outputs the list of accessible servers | +| [guide](#guide) | Explains how to obtain token, guild, and channel ID | + +To use the commands, you'll need a token. For the instructions on how to get a token, please refer +to [this page](Token-and-IDs.md), or run `dotnet DiscordChatExporter.Cli.dll guide`. To get help with a specific command, please run: ```console @@ -59,21 +61,21 @@ dotnet DiscordChatExporter.Cli.dll command -h With this command, you can export **server channels** and **direct messages**. -| | Option | Description | -| ------ | --------------------------------------------------------------------------------------------------------------------- | ----------- | -| **\*** | [-c](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Getting-started.md#basic-usage) | [Channel ID(s)](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Token-and-IDs.md#how-to-get-guild-id-or-guild-channel-id) | -| **\*** | [-t](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Getting-started.md#basic-usage) | [Authorization token](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Token-and-IDs.md#how-to-get-user-token). Environment variable: `DISCORD_TOKEN` | -| | [-o](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Getting-started.md#changing-the-output-filename) | Output file or directory path | -| | [-f](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Getting-started.md#changing-the-format) | [Output file format](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Getting-started.md#file-formats). Default: HtmlDark | -| | [--after](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Using-the-CLI.md#date-ranges) | Only include messages sent after this date | -| | [--before](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Using-the-CLI.md#date-ranges) | Only include messages sent before this date | -| | [-p](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Using-the-CLI.md#partitioning) | Split output into partitions, each limited to this number of messages (e.g. 100) or file size (e.g. 10mb) | -| | [--filter](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Message-filters.md) | Special notation for filtering the messages that get included in the export | -| | [--media](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Using-the-CLI.md#downloading-assets) | Download assets referenced by the export (user avatars, attached files, embedded images, etc.). Default: false | -| | [--reuse-media](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Using-the-CLI.md#reuse-assets) | Reuse previously downloaded assets to avoid redundant requests. Default: false | -| | [--media-dir](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Using-the-CLI.md#downloading-assets) | Directory to store assets from all exported channels in the same place | -| | [--locale](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Using-the-CLI.md#changing-the-date-format) | Format used when writing dates. Default: en-US | -| | -h | Shows help text | +| | Option | Description | +|--------|---------------------------------------|----------------------------------------------------------------------------------------------------------------| +| **\*** | [-c](#basic-usage) | [Channel ID(s)](Token-and-IDs.md#how-to-get-guild-id-or-guild-channel-id) | +| **\*** | [-t](#basic-usage) | [Authorization token](Token-and-IDs.md#how-to-get-user-token). Environment variable: `DISCORD_TOKEN` | +| | [-o](#changing-the-output-filename) | Output file or directory path | +| | [-f](#changing-the-format) | [Output file format](Getting-started.md#file-formats). Default: HtmlDark | +| | [--after](#date-ranges) | Only include messages sent after this date | +| | [--before](#date-ranges) | Only include messages sent before this date | +| | [-p](#partitioning) | Split output into partitions, each limited to this number of messages (e.g. 100) or file size (e.g. 10mb) | +| | [--filter](Message-filters.md) | Special notation for filtering the messages that get included in the export | +| | [--media](#downloading-assets) | Download assets referenced by the export (user avatars, attached files, embedded images, etc.). Default: false | +| | [--reuse-media](#reuse-assets) | Reuse previously downloaded assets to avoid redundant requests. Default: false | +| | [--media-dir](#downloading-assets) | Directory to store assets from all exported channels in the same place | +| | [--locale](#changing-the-date-format) | Format used when writing dates. Default: en-US | +| | -h | Shows help text | > **Note**: > Options with an asterisk (**\***) are required. The order of the options doesn't matter. @@ -88,7 +90,8 @@ dotnet DiscordChatExporter.Cli.dll export -t "mfa.Ifrn" -c 53555 #### Changing the format -You can change the export format to `HtmlDark`, `HtmlLight`, `PlainText` `Json` or `Csv` with `-f format`. The default format is `HtmlDark`. +You can change the export format to `HtmlDark`, `HtmlLight`, `PlainText` `Json` or `Csv` with `-f format`. The default +format is `HtmlDark`. ```console dotnet DiscordChatExporter.Cli.dll export -t "mfa.Ifrn" -c 53555 -f Json @@ -104,7 +107,8 @@ dotnet DiscordChatExporter.Cli.dll export -t "mfa.Ifrn" -c 53555 -o myserver.htm #### Changing the output directory -You can change the export directory by using `-o` and providing a path that ends with a slash or does not have a file extension. +You can change the export directory by using `-o` and providing a path that ends with a slash or does not have a file +extension. If any of the folders in the path have a space in its name, escape them with quotes ("). ```console @@ -129,7 +133,9 @@ You can use template tokens to generate the output file path based on the guild dotnet DiscordChatExporter.Cli.dll export -t "mfa.Ifrn" -c 53555 -o "C:\Discord Exports\%G\%T\%C.html" ``` -Assuming you are exporting a channel named `"my-channel"` in the `"Text channels"` category from a server called `"My server"`, you will get the following output file path: `C:\Discord Exports\My server\Text channels\my-channel.html` +Assuming you are exporting a channel named `"my-channel"` in the `"Text channels"` category from a server +called `"My server"`, you will get the following output file +path: `C:\Discord Exports\My server\Text channels\my-channel.html` Here is the full list of supported template tokens: @@ -163,7 +169,8 @@ dotnet DiscordChatExporter.Cli.dll export -t "mfa.Ifrn" -c 53555 -p 20mb #### Downloading assets If this option is set, the export will include additional files such as user avatars, attached files, images, etc. -Only files that are referenced by the export are downloaded, which means that, for example, user avatars will not be downloaded when using the plain text (TXT) export format. +Only files that are referenced by the export are downloaded, which means that, for example, user avatars will not be +downloaded when using the plain text (TXT) export format. A folder containing the assets will be created along with the exported chat. They must be kept together. ```console @@ -172,7 +179,8 @@ dotnet DiscordChatExporter.Cli.dll export -t "mfa.Ifrn" -c 53555 --media #### Reusing assets -Previously downloaded assets can be reused to skip redundant downloads as long as the chat is always exported to the same folder. Using this option can speed up future exports. This option requires the `--media` option. +Previously downloaded assets can be reused to skip redundant downloads as long as the chat is always exported to the +same folder. Using this option can speed up future exports. This option requires the `--media` option. ```console dotnet DiscordChatExporter.Cli.dll export -t "mfa.Ifrn" -c 53555 --media --reuse-media @@ -180,7 +188,8 @@ dotnet DiscordChatExporter.Cli.dll export -t "mfa.Ifrn" -c 53555 --media --reuse #### Changing the media directory -By default, the media directory is created alongside the exported chat. You can change this by using `--media-dir` and providing a path that ends with a slash. All of the exported media will be stored in this directory. +By default, the media directory is created alongside the exported chat. You can change this by using `--media-dir` and +providing a path that ends with a slash. All of the exported media will be stored in this directory. ```console dotnet DiscordChatExporter.Cli.dll export -t "mfa.Ifrn" -c 53555 --media --media-dir "C:\Discord Media" @@ -188,7 +197,8 @@ dotnet DiscordChatExporter.Cli.dll export -t "mfa.Ifrn" -c 53555 --media --media #### Changing the date format -You can customize how dates are formatted in the exported files by using `--locale` and inserting one of Discord's locales. The default locale is `en-US`. +You can customize how dates are formatted in the exported files by using `--locale` and inserting one of Discord's +locales. The default locale is `en-US`. ```console dotnet DiscordChatExporter.Cli.dll export -t "mfa.Ifrn" -c 53555 --locale "de-DE" @@ -211,35 +221,38 @@ dotnet DiscordChatExporter.Cli.dll export -t "mfa.Ifrn" -c 53555 --after "2019-0 ``` **Messages sent in a date range** -Use `--before` and `--after` to export messages sent during the provided date range. E.g. messages sent between September 17th, 2019 11:34 PM and September 18th: +Use `--before` and `--after` to export messages sent during the provided date range. E.g. messages sent between +September 17th, 2019 11:34 PM and September 18th: ```console dotnet DiscordChatExporter.Cli.dll export -t "mfa.Ifrn" -c 53555 --after "2019-09-17 23:34" --before "2019-09-18" ``` -You can try different formats like `17-SEP-2019 11:34 PM` or even refine your ranges down to milliseconds `17-SEP-2019 23:45:30.6170`! +You can try different formats like `17-SEP-2019 11:34 PM` or even refine your ranges down to +milliseconds `17-SEP-2019 23:45:30.6170`! Don't forget to quote (") the date if it has spaces! -More info about .NET date formats [here](https://docs.microsoft.com/en-us/dotnet/standard/base-types/custom-date-and-time-format-strings). +More info about .NET date +formats [here](https://docs.microsoft.com/en-us/dotnet/standard/base-types/custom-date-and-time-format-strings). ### `exportdm` This command exports all your **direct messages**. -| | Option | Description | -| ------ | --------------------------------------------------------------------------------------------------------------------- | ----------- | -| **\*** | [-c](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Getting-started.md#basic-usage) | [Channel ID(s)](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Token-and-IDs.md#how-to-get-guild-id-or-guild-channel-id) | -| **\*** | [-t](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Getting-started.md#basic-usage) | [Authorization token](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Token-and-IDs.md#how-to-get-user-token). Environment variable: `DISCORD_TOKEN` | -| | [-o](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Getting-started.md#changing-the-output-filename) | Output file or directory path | -| | [-f](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Getting-started.md#changing-the-format) | [Output file format](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Getting-started.md#file-formats). Default: HtmlDark | -| | [--after](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Using-the-CLI.md#date-ranges) | Only include messages sent after this date | -| | [--before](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Using-the-CLI.md#date-ranges) | Only include messages sent before this date | -| | [-p](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Using-the-CLI.md#partitioning) | Split output into partitions, each limited to this number of messages (e.g. 100) or file size (e.g. 10mb) | -| | [--filter](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Message-filters.md) | Special notation for filtering the messages that get included in the export | -| | [--media](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Using-the-CLI.md#downloading-assets) | Download assets referenced by the export (user avatars, attached files, embedded images, etc.). Default: false | -| | [--reuse-media](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Using-the-CLI.md#reuse-assets) | Reuse previously downloaded assets to avoid redundant requests. Default: false | -| | [--media-dir](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Using-the-CLI.md#downloading-assets) | Directory to store assets from all exported channels in the same place | -| | [--locale](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Using-the-CLI.md#changing-the-date-format) | Format used when writing dates. Default: en-US | -| | -h | Shows help text | +| | Option | Description | +|--------|---------------------------------------|----------------------------------------------------------------------------------------------------------------| +| **\*** | [-c](#basic-usage) | [Channel ID(s)](Token-and-IDs.md#how-to-get-guild-id-or-guild-channel-id) | +| **\*** | [-t](#basic-usage) | [Authorization token](Token-and-IDs.md#how-to-get-user-token). Environment variable: `DISCORD_TOKEN` | +| | [-o](#changing-the-output-filename) | Output file or directory path | +| | [-f](#changing-the-format) | [Output file format](Getting-started.md#file-formats). Default: HtmlDark | +| | [--after](#date-ranges) | Only include messages sent after this date | +| | [--before](#date-ranges) | Only include messages sent before this date | +| | [-p](#partitioning) | Split output into partitions, each limited to this number of messages (e.g. 100) or file size (e.g. 10mb) | +| | [--filter](Message-filters.md) | Special notation for filtering the messages that get included in the export | +| | [--media](#downloading-assets) | Download assets referenced by the export (user avatars, attached files, embedded images, etc.). Default: false | +| | [--reuse-media](#reuse-assets) | Reuse previously downloaded assets to avoid redundant requests. Default: false | +| | [--media-dir](#downloading-assets) | Directory to store assets from all exported channels in the same place | +| | [--locale](#changing-the-date-format) | Format used when writing dates. Default: en-US | +| | -h | Shows help text | > **Note**: > Options with an asterisk (**\***) are required. The order of the options doesn't matter. @@ -248,30 +261,32 @@ This command exports all your **direct messages**. This command exports all channels of a **server**. -| | Option | Description | -| ------ | ------------------------------------------------------------------------------------------------------------------------- | ----------- | -| **\*** | -g | [Server ID](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Token-and-IDs.md#how-to-get-guild-id-or-guild-channel-id) | -| **\*** | [-t](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Getting-started.md#basic-usage) | [Authorization token](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Token-and-IDs.md#how-to-get-user-token). Environment variable: `DISCORD_TOKEN` | -| | [-o](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Getting-started.md#changing-the-output-filename) | Output file or directory path | -| | [-f](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Getting-started.md#changing-the-format) | [Output file format](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Getting-started.md#file-formats). Default: HtmlDark | -| | [--after](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Using-the-CLI.md#date-ranges) | Only include messages sent after this date | -| | [--before](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Using-the-CLI.md#date-ranges) | Only include messages sent before this date | -| | [-p](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Using-the-CLI.md#partitioning) | Split output into partitions, each limited to this number of messages (e.g. 100) or file size (e.g. 10mb) | -| | [--filter](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Message-filters.md) | Special notation for filtering the messages that get included in the export | -| | [--media](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Using-the-CLI.md#downloading-assets) | Download assets referenced by the export (user avatars, attached files, embedded images, etc.). Default: false | -| | [--reuse-media](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Using-the-CLI.md#reuse-assets) | Reuse previously downloaded assets to avoid redundant requests. Default: false | -| | [--media-dir](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Using-the-CLI.md#downloading-assets) | Directory to store assets from all exported channels in the same place | -| | [--locale](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Using-the-CLI.md#changing-the-date-format) | Format used when writing dates. Default: en-US | -| | [--include-threads](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Using-the-CLI.md#including-threads) | Specify whether to include threads (and which type) in the export. By default, threads are not included. It has possible values of `none`, `active`, or `all`, indicating which threads should be included. To include both active and archived threads, use `--include-threads all`. | -| | [--include-vc](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Using-the-CLI.md#including-voice-channels) | Include voice channels in the export. Default: true | -| | -h | Shows help text | +| | Option | Description | +|--------|-------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **\*** | -g | [Server ID](Token-and-IDs.md#how-to-get-guild-id-or-guild-channel-id) | +| **\*** | [-t](#basic-usage) | [Authorization token](Token-and-IDs.md#how-to-get-user-token). Environment variable: `DISCORD_TOKEN` | +| | [-o](#changing-the-output-filename) | Output file or directory path | +| | [-f](#changing-the-format) | [Output file format](Getting-started.md#file-formats). Default: HtmlDark | +| | [--after](#date-ranges) | Only include messages sent after this date | +| | [--before](#date-ranges) | Only include messages sent before this date | +| | [-p](#partitioning) | Split output into partitions, each limited to this number of messages (e.g. 100) or file size (e.g. 10mb) | +| | [--filter](Message-filters.md) | Special notation for filtering the messages that get included in the export | +| | [--media](#downloading-assets) | Download assets referenced by the export (user avatars, attached files, embedded images, etc.). Default: false | +| | [--reuse-media](#reuse-assets) | Reuse previously downloaded assets to avoid redundant requests. Default: false | +| | [--media-dir](#downloading-assets) | Directory to store assets from all exported channels in the same place | +| | [--locale](#changing-the-date-format) | Format used when writing dates. Default: en-US | +| | [--include-threads](#including-threads) | Specify whether to include threads (and which type) in the export. By default, threads are not included. It has possible values of `none`, `active`, or `all`, indicating which threads should be included. To include both active and archived threads, use `--include-threads all`. | +| | [--include-vc](#including-voice-channels) | Include voice channels in the export. Default: true | +| | -h | Shows help text | > **Note**: > Options with an asterisk (**\***) are required. The order of the options doesn't matter. #### Including threads -By default, threads are not included in the export. You can change this behavior by using `--include-threads` and specifying which threads should be included. It has possible values of `none`, `active`, or `all`, indicating which threads should be included. To include both active and archived threads, use `--include-threads all`. +By default, threads are not included in the export. You can change this behavior by using `--include-threads` and +specifying which threads should be included. It has possible values of `none`, `active`, or `all`, indicating which +threads should be included. To include both active and archived threads, use `--include-threads all`. ```console dotnet DiscordChatExporter.Cli.dll exportguild -t "mfa.Ifrn" -g 21814 --include-threads all @@ -279,7 +294,9 @@ dotnet DiscordChatExporter.Cli.dll exportguild -t "mfa.Ifrn" -g 21814 --include- #### Including voice channels -By default, voice channels are included in the export. You can change this behavior by using `--include-vc` and specifying whether to include voice channels in the export. It has possible values of `true` or `false`, to exclude voice channels, use `--include-vc false`. +By default, voice channels are included in the export. You can change this behavior by using `--include-vc` and +specifying whether to include voice channels in the export. It has possible values of `true` or `false`, to exclude +voice channels, use `--include-vc false`. ```console dotnet DiscordChatExporter.Cli.dll exportguild -t "mfa.Ifrn" -g 21814 --include-vc false @@ -289,23 +306,23 @@ dotnet DiscordChatExporter.Cli.dll exportguild -t "mfa.Ifrn" -g 21814 --include- This command exports **all accessible channels**, including server channels and DMs. -| | Option | Description | -| ------ | ------------------------------------------------------------------------------------------------------------------------- | ----------- | -| **\*** | [-t](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Getting-started.md#basic-usage) | [Authorization token](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Token-and-IDs.md#how-to-get-user-token). Environment variable: `DISCORD_TOKEN` | -| | [-o](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Getting-started.md#changing-the-output-filename) | Output file or directory path | -| | [-f](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Getting-started.md#changing-the-format) | [Output file format](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Getting-started.md#file-formats). Default: HtmlDark | -| | [--after](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Using-the-CLI.md#date-ranges) | Only include messages sent after this date | -| | [--before](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Using-the-CLI.md#date-ranges) | Only include messages sent before this date | -| | [-p](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Using-the-CLI.md#partitioning) | Split output into partitions, each limited to this number of messages (e.g. 100) or file size (e.g. 10mb) | -| | [--filter](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Message-filters.md) | Special notation for filtering the messages that get included in the export | -| | [--media](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Using-the-CLI.md#downloading-assets) | Download assets referenced by the export (user avatars, attached files, embedded images, etc.). Default: false | -| | [--reuse-media](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Using-the-CLI.md#reuse-assets) | Reuse previously downloaded assets to avoid redundant requests. Default: false | -| | [--media-dir](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Using-the-CLI.md#downloading-assets) | Directory to store assets from all exported channels in the same place | -| | [--locale](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Using-the-CLI.md#changing-the-date-format) | Format used when writing dates. Default: en-US | -| | [--include-threads](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Using-the-CLI.md#including-threads) | Specify whether to include threads (and which type) in the export. By default, threads are not included. It has possible values of `none`, `active`, or `all`, indicating which threads should be included. To include both active and archived threads, use `--include-threads all`. | -| | [--include-vc](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Using-the-CLI.md#including-voice-channels) | Include voice channels in the export. Default: true | -| | [--include-dm](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Using-the-CLI.md#excluding-dms) | Include direct messages in the export. Default: true | -| | -h | Shows help text | +| | Option | Description | +|--------|-------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **\*** | [-t](#basic-usage) | [Authorization token](Token-and-IDs.md#how-to-get-user-token). Environment variable: `DISCORD_TOKEN` | +| | [-o](#changing-the-output-filename) | Output file or directory path | +| | [-f](#changing-the-format) | [Output file format](Getting-started.md#file-formats). Default: HtmlDark | +| | [--after](#date-ranges) | Only include messages sent after this date | +| | [--before](#date-ranges) | Only include messages sent before this date | +| | [-p](#partitioning) | Split output into partitions, each limited to this number of messages (e.g. 100) or file size (e.g. 10mb) | +| | [--filter](Message-filters.md) | Special notation for filtering the messages that get included in the export | +| | [--media](#downloading-assets) | Download assets referenced by the export (user avatars, attached files, embedded images, etc.). Default: false | +| | [--reuse-media](#reuse-assets) | Reuse previously downloaded assets to avoid redundant requests. Default: false | +| | [--media-dir](#downloading-assets) | Directory to store assets from all exported channels in the same place | +| | [--locale](#changing-the-date-format) | Format used when writing dates. Default: en-US | +| | [--include-threads](#including-threads) | Specify whether to include threads (and which type) in the export. By default, threads are not included. It has possible values of `none`, `active`, or `all`, indicating which threads should be included. To include both active and archived threads, use `--include-threads all`. | +| | [--include-vc](#including-voice-channels) | Include voice channels in the export. Default: true | +| | [--include-dm](#excluding-dms) | Include direct messages in the export. Default: true | +| | -h | Shows help text | > **Note**: > Options with an asterisk (**\***) are required. The order of the options doesn't matter. @@ -324,18 +341,19 @@ This command outputs a **server's channels** in the following format: `Channel ID | Channel Name` To save the output to a file, run the command below. If the file already exists, it will be overwritten. -| | Option | Description | -| ------ | ---------------------------------------------------------------------------------------------------- | ----------- | -| **\*** | -g | [Server ID](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Token-and-IDs.md#how-to-get-guild-id-or-guild-channel-id) | -| **\*** | [-t](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Getting-started.md#basic-usage) | [Authorization token](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Token-and-IDs.md#how-to-get-user-token). Environment variable: `DISCORD_TOKEN` | -| | [--include-threads](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Using-the-CLI.md#including-threads) | Specify whether to include threads (and which type) in the output. By default, threads are not included. It has possible values of `none`, `active`, or `all`, indicating which threads should be included. To include both active and archived threads, use `--include-threads all`. | -| | [--include-vc](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Using-the-CLI.md#including-voice-channels) | Include voice channels in the output. Default: true | -| | -h | Shows help text | +| | Option | Description | +|--------|-------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **\*** | -g | [Server ID](Token-and-IDs.md#how-to-get-guild-id-or-guild-channel-id) | +| **\*** | [-t](#basic-usage) | [Authorization token](Token-and-IDs.md#how-to-get-user-token). Environment variable: `DISCORD_TOKEN` | +| | [--include-threads](#including-threads) | Specify whether to include threads (and which type) in the output. By default, threads are not included. It has possible values of `none`, `active`, or `all`, indicating which threads should be included. To include both active and archived threads, use `--include-threads all`. | +| | [--include-vc](#including-voice-channels) | Include voice channels in the output. Default: true | +| | -h | Shows help text | > **Note**: > Options with an asterisk (**\***) are required. The order of the options doesn't matter. -To save the output to a file, run the command with `> C:\path\…` like the example below. If the file already exists, it will be overwritten. +To save the output to a file, run the command with `> C:\path\…` like the example below. If the file already exists, it +will be overwritten. ```console dotnet DiscordChatExporter.Cli.dll channels -t "mfa.Ifrn" -g 21814 > C:\path\to\output.txt @@ -345,15 +363,16 @@ dotnet DiscordChatExporter.Cli.dll channels -t "mfa.Ifrn" -g 21814 > C:\path\to\ This command outputs a list of your **direct messages**. -| | Option | Description | -| ------ | ---------------------------------------------------------------------------------------------------- | ----------- | -| **\*** | [-t](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Getting-started.md#basic-usage) | [Authorization token](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Token-and-IDs.md#how-to-get-user-token). Environment variable: `DISCORD_TOKEN` | -| | -h | Shows help text | +| | Option | Description | +|--------|--------------------|------------------------------------------------------------------------------------------------------| +| **\*** | [-t](#basic-usage) | [Authorization token](Token-and-IDs.md#how-to-get-user-token). Environment variable: `DISCORD_TOKEN` | +| | -h | Shows help text | > **Note**: > Options with an asterisk (**\***) are required. The order of the options doesn't matter. -To save the output to a file, run the command with `> C:\path\…` like the example below. If the file already exists, it will be overwritten. +To save the output to a file, run the command with `> C:\path\…` like the example below. If the file already exists, it +will be overwritten. ```console dotnet DiscordChatExporter.Cli.dll dm -t "mfa.Ifrn" > C:\path\to\output.txt @@ -363,15 +382,16 @@ dotnet DiscordChatExporter.Cli.dll dm -t "mfa.Ifrn" > C:\path\to\output.txt This command outputs a list of your **servers**. -| | Option | Description | -| ------ | ---------------------------------------------------------------------------------------------------- | ----------- | -| **\*** | [-t](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Getting-started.md#basic-usage) | [Authorization token](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Token-and-IDs.md#how-to-get-user-token). Environment variable: `DISCORD_TOKEN` | -| | -h | Shows help text | +| | Option | Description | +|--------|--------------------|------------------------------------------------------------------------------------------------------| +| **\*** | [-t](#basic-usage) | [Authorization token](Token-and-IDs.md#how-to-get-user-token). Environment variable: `DISCORD_TOKEN` | +| | -h | Shows help text | > **Note**: > Options with an asterisk (**\***) are required. The order of the options doesn't matter. -To save the output to a file, run the command with `> C:\path\…` like the example below. If the file already exists, it will be overwritten. +To save the output to a file, run the command with `> C:\path\…` like the example below. If the file already exists, it +will be overwritten. ```console dotnet DiscordChatExporter.Cli.dll guilds -t "mfa.Ifrn" > C:\path\to\output.txt @@ -379,4 +399,4 @@ dotnet DiscordChatExporter.Cli.dll guilds -t "mfa.Ifrn" > C:\path\to\output.txt ### `guide` -This command explains [how to get your token, guild, and channel IDs](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Token-and-IDs.md). +This command explains [how to get your token, guild, and channel IDs](Token-and-IDs.md). diff --git a/.docs/Using-the-GUI.md b/.docs/Using-the-GUI.md index 382f796..07e073f 100644 --- a/.docs/Using-the-GUI.md +++ b/.docs/Using-the-GUI.md @@ -46,7 +46,7 @@ In this screen you can customize the following: - **Partition limit** (Optional) - Split output into partitions, each limited to this number of messages (e.g. 100) or file size (e.g. 10mb). For example, a channel with 36 messages set to be partitioned every 10 messages will output 4 files. -- **Message Filter** (Optional) - Special notation for filtering the messages that get included in the export. See [Message filters](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Message-filters.md) for more info. +- **Message Filter** (Optional) - Special notation for filtering the messages that get included in the export. See [Message filters](Message-filters.md) for more info. - **Format markdown** (Optional) - Disable markdown processing when exporting. You can use this to produce JSON or plain text exports without unwrapping mentions, custom emoji, and certain other special tokens.