calvin.erfmann/DiscordChatExporter
1
0
Fork 0
mirror of https://github.com/Tyrrrz/DiscordChatExporter.git synced 2026-03-01 20:53:41 +00:00
Code Issues Packages Projects Releases Wiki Activity

Tweaked CLI instructions and Formats

Yudi
2020-04-26 16:40:21 -03:00
parent b3eefbcdac
commit 4732c6b8b4
1 changed files with 23 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

39
GUI,-CLI-and-Formats-explained.md

@@ -13,8 +13,8 @@ If you still have unanswered questions after reading this page or if you have en
* [GUI or CLI?](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#gui-or-cli-)
* [Using the GUI](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#using-the-gui-)
* [Using the CLI](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#using-the-cli-)
* [Command List](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#dcecli-commands-)
* [Which File Format to use?](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#file-formats-)
* [Command list](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#dcecli-commands-)
* [File formats](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#file-formats-)
* [HTML](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#html-)
* [Plain Text](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#plain-text-)
* [JSON](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#json-)
@@ -72,7 +72,7 @@ You can customize how dates are formatted in the exported files at the settings
* To change it to `17-09-2019 23:34` use `dd-MM-yyyy HH:mm`<br/>
* To change it to `2019-09-17 23:34:05.6534` use `yyyy-MM-dd HH:mm:ss.ffff`<br/>
* To change it to UTC `2019-09-18 04:34:05Z` use `u`<br/>
* To display the time zone, add `K`. E.g. to show `17-Sep-19 11:34 PM (UTC-05:00)` use `dd-MMM-yy hh:mm tt (UTCK)`<br/>
* To display the time zone, add `K`. E.g. to change it to `17-Sep-19 11:34 PM (UTC-05:00)` use `dd-MMM-yy hh:mm tt (UTCK)`<br/>
More info about .NET date formats [here](https://docs.microsoft.com/en-us/dotnet/standard/base-types/custom-date-and-time-format-strings).
@@ -85,7 +85,7 @@ More info about .NET date formats [here](https://docs.microsoft.com/en-us/dotnet
**1.** After extracting the `.zip`, open Command Prompt, aka `cmd` (`Terminal` on **macOS** and **Linux**).
**2.** Change the current directory to DCE's folder with `cd C:\path\to\directory`. Press ENTER to run the commands after writing them.
**2.** Change the current directory to DCE's folder with `cd C:\path\to\directory`, then press ENTER to run the command.
<br/><br/>
**Windows** users can quickly get the directory's path by clicking the address bar while inside the folder.<br/>
![](https://i.imgur.com/XncnhC2.gif)<br/><br/>
@@ -94,19 +94,26 @@ More info about .NET date formats [here](https://docs.microsoft.com/en-us/dotnet
You can also drag and drop the folder on **every platform**.</br>
![](https://i.imgur.com/sOpZQAb.gif)
**3.** Let's start by listing the available commands. Type the following command and press ENTER to run it:
**3.** Now we're ready to run the commands, but please notice that the commands differ depending on your platform. The examples in this page follow the Windows format.<br/>
Non-Windows users will need to change the examples according to what is described below.
Let's run the following to list DCE's options:
**Windows:** Type the following in Command Prompt, then press ENTER to run it:
```powershell
DiscordChatExporter.Cli.exe
```
**macOS and Linux** users <u>must</u> write `dotnet` before every command **and** instead of `.exe`, it's `DiscordChatExporter.Cli.dll`:
**macOS and Linux:** Type the following in Terminal, then press ENTER to run it:
```powershell
dotnet DiscordChatExporter.Cli.dll
```
So, **macOS and Linux** users <u>must</u> write `dotnet` before every command **and** instead of `DiscordChatExporter.Cli.exe`, it's `DiscordChatExporter.Cli.dll`:
**Docker** users, please refer to the [Docker usage instructions](https://github.com/Tyrrrz/DiscordChatExporter/wiki/Docker-usage-instructions).
## DCE.CLI Commands ↴
## DCE.CLI commands ↴
| Command | Description |
| ------- | ----------- |
@@ -193,7 +200,7 @@ This setting changes how dates are formatted in the exported files.<br/>
* To change it to `17-09-2019 23:34` use `dd-MM-yyyy HH:mm`<br/>
* To change it to `2019-09-17 23:34:05.6534` use `yyyy-MM-dd HH:mm:ss.ffff`<br/>
* To change it to UTC `2019-09-18 04:34:05Z` use `u`<br/>
* To display the time zone, add `K`. E.g. to show `17-Sep-19 11:34 PM (UTC-05:00)` use `dd-MMM-yy hh:mm tt (UTCK)`<br/>
* To display the time zone, add `K`. E.g. to change it to `17-Sep-19 11:34 PM (UTC-05:00)` use `dd-MMM-yy hh:mm tt (UTCK)`<br/>
More info about .NET date formats [here](https://docs.microsoft.com/en-us/dotnet/standard/base-types/custom-date-and-time-format-strings).
@@ -267,8 +274,8 @@ This command exports all channels of a Server.
> Options with an asterisk (**\***) are required. The order of the options doesn't matter.<br/>
This command outputs the server channels. Example:<br/>
`Channel ID | Name`<br/><br/>
This command outputs the server channels in the following format:<br/>
`Channel ID | Channel Name`<br/><br/>
To save the output to a file, run the command below. If the file already exists, it will be overwritten.
```powershell
DiscordChatExporter.exe channels -t "mfa.Ifrn" -g 21814 > C:\path\to\output.txt
@@ -283,7 +290,7 @@ DiscordChatExporter.exe channels -t "mfa.Ifrn" -g 21814 > C:\path\to\output.txt
> Options with an asterisk (**\***) are required. The order of the options doesn't matter.<br/>
This command outputs the list of Direct Messages.<br/>
To save the output to a file, run the command 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.
```powershell
DiscordChatExporter.exe dm -t "mfa.Ifrn" > C:\path\to\output.txt
```
@@ -298,7 +305,7 @@ DiscordChatExporter.exe dm -t "mfa.Ifrn" > C:\path\to\output.txt
> Options with an asterisk (**\***) are required. The order of the options doesn't matter.<br/>
This command outputs a list of your Server List.<br/>
To save the output to a file, run the command 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.
```powershell
DiscordChatExporter.exe guilds -t "mfa.Ifrn" > C:\path\to\output.txt
```
@@ -314,8 +321,8 @@ This command explains [how to get your token, guild, and channel IDs](https://gi
The HTML format replicates Discord's interface, making it the most user-friendly option.<br/>
It's the best format for attachment preview and sharing.<br/>
You can open `.html` files with a web browser, such as Google Chrome.<br/>
> Please notice that if the picture is deleted, or if a user changes its avatar, the images won't show up anymore.<br/>
[Save images for offline viewing to avoid this problem](https://github.com/Tyrrrz/DiscordChatExporter/wiki/Storing-HTML-locally)!<br/>
> Please notice that if a picture is deleted, or if a user changes its avatar, the respective images will no longer be displayed.<br/>
[Save the file for offline viewing to avoid this problem](https://github.com/Tyrrrz/DiscordChatExporter/wiki/Storing-HTML-locally)!<br/>
![](https://i.imgur.com/9uAHT3o.png)
## Plain Text ↴
@@ -329,7 +336,7 @@ You can open `.txt` files with text editors, such as Notepad.
<img src="https://i.imgur.com/FAeSA4O.png" height="400" />
The JSON format contains more technical information and it's easily parsable.<br/>
The JSON format contains more technical information and is easily parsable.<br/>
You can open `.json` files with text editors, such as Notepad.
## CSV ↴
@@ -343,5 +350,5 @@ You can open `.csv` files with text editors, such as Notepad, or spreadsheet pro
**([Back to top](https://github.com/Tyrrrz/DiscordChatExporter/wiki/GUI%2C-CLI-and-Formats-explained#getting-started))**
#
Further reading: [Storing images locally for offline viewing](https://github.com/Tyrrrz/DiscordChatExporter/wiki/Storing-HTML-locally), [.NET date formats](https://docs.microsoft.com/en-us/dotnet/standard/base-types/custom-date-and-time-format-strings)<br/>
Further reading: [Storing HTML files locally for offline viewing](https://github.com/Tyrrrz/DiscordChatExporter/wiki/Storing-HTML-locally), [.NET date formats](https://docs.microsoft.com/en-us/dotnet/standard/base-types/custom-date-and-time-format-strings)<br/>
Special thanks to [@RenanYudi](https://github.com/RenanYudi)