Skip to content

Commit

Permalink
Update docs with the easier way to run the CLI
Browse files Browse the repository at this point in the history
  • Loading branch information
Tyrrrz committed Mar 18, 2024
1 parent 47d5602 commit 72f02cd
Show file tree
Hide file tree
Showing 3 changed files with 35 additions and 5 deletions.
14 changes: 10 additions & 4 deletions .docs/Linux.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down
12 changes: 12 additions & 0 deletions .docs/MacOS.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```
Expand Down
14 changes: 13 additions & 1 deletion .docs/Using-the-CLI.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 72f02cd

Please sign in to comment.