From 72f02cd9a0ebcce630a3a106cddc808cd87e6d48 Mon Sep 17 00:00:00 2001 From: Tyrrrz <1935960+Tyrrrz@users.noreply.github.com> Date: Mon, 18 Mar 2024 03:20:46 +0200 Subject: [PATCH] Update docs with the easier way to run the CLI --- .docs/Linux.md | 14 ++++++++++---- .docs/MacOS.md | 12 ++++++++++++ .docs/Using-the-CLI.md | 14 +++++++++++++- 3 files changed, 35 insertions(+), 5 deletions(-) diff --git a/.docs/Linux.md b/.docs/Linux.md index 7a37ff7..740b6b1 100644 --- a/.docs/Linux.md +++ b/.docs/Linux.md @@ -8,17 +8,23 @@ Please follow the [instructions provided here](Dotnet.md). 1. Download [DiscordChatExporter.CLI.zip](https://github.com/Tyrrrz/DiscordChatExporter/releases/latest) and extract it to a folder. 2. Open Terminal. -3. `cd` into the extracted folder. You can do this in Terminal by typing `cd`, then press the SPACE key, drag and drop the extracted folder into the Terminal window, and press the ENTER key. +3. Change the working directory into the extracted folder. You can do this in Terminal by typing `cd`, then press the SPACE key, drag and drop the extracted folder into the Terminal window, and press the ENTER key. 4. Replace `TOKEN` and `CHANNEL`, then execute this command to export: ```console -dotnet DiscordChatExporter.Cli.dll export -t TOKEN -c CHANNEL +./DiscordChatExporter.Cli.sh export -t TOKEN -c CHANNEL +``` + +If the above command throws a "Permission denied" error, use `chmod` to fix the permissions: + +```console +chmod +x DiscordChatExporter.Cli.sh ``` -If the above command throws a "Permission denied" error, execute this command to fix the permissions: +Alternatively, if the script doesn't work, you can run the following command to run the application directly: ```console -chmod 644 *.dll DiscordChatExporter.* +dotnet DiscordChatExporter.Cli.dll export -t TOKEN -c CHANNEL ``` > [How to get Token and Channel IDs](Token-and-IDs.md). diff --git a/.docs/MacOS.md b/.docs/MacOS.md index 8b949e4..56bcd52 100644 --- a/.docs/MacOS.md +++ b/.docs/MacOS.md @@ -13,6 +13,18 @@ Please follow the [instructions provided here](Dotnet.md). 3. In the Terminal window, type `cd` , press the SPACE key, then drag and drop the extracted folder into the window, then press the RETURN key. 4. Execute the following command to export, replacing `TOKEN` and `CHANNEL` with your own values: +```console +./DiscordChatExporter.Cli.sh export -t TOKEN -c CHANNEL +``` + +If the above command throws a "Permission denied" error, use `chmod` to fix the permissions: + +```console +chmod +x DiscordChatExporter.Cli.sh +``` + +Alternatively, if the script doesn't work, you can run the following command to run the application directly: + ```console dotnet DiscordChatExporter.Cli.dll export -t TOKEN -c CHANNEL ``` diff --git a/.docs/Using-the-CLI.md b/.docs/Using-the-CLI.md index b52d244..79db0d5 100644 --- a/.docs/Using-the-CLI.md +++ b/.docs/Using-the-CLI.md @@ -28,7 +28,19 @@ You can also drag and drop the folder on **every platform**. 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. +On **Windows**, type the following command in your terminal of choice, then press ENTER to run it. This will list all available subcommands and options. + +```console +DiscordChatExporter.Cli.exe +``` + +On **macOS** and **Linux**, run the following instead: + +```console +./DiscordChatExporter.Cli.sh +``` + +If either of the above approaches don't work for you, you can also run **DiscordChatExporter** directly like this, regardless of the platform: ```console dotnet DiscordChatExporter.Cli.dll