calvin.erfmann/DiscordChatExporter
1
0
Fork 0
mirror of https://github.com/Tyrrrz/DiscordChatExporter.git synced 2026-05-10 14:23:51 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: use -short|--long convention for option names in prose text

Browse Source 
Agent-Logs-Url: https://github.com/Tyrrrz/DiscordChatExporter/sessions/aa0b1344-6eb9-4853-9b48-afd06e94c970

Co-authored-by: Tyrrrz <1935960+Tyrrrz@users.noreply.github.com>
This commit is contained in:
copilot-swe-agent[bot]
2026-04-04 11:14:19 +00:00
committed by GitHub
parent b0ee4ba646
commit 948ceba8cc
1 changed files with 6 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
.docs/Using-the-CLI.md
View File

@@ -43,7 +43,7 @@ Type the following command in your terminal of choice, then press ENTER to run i
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 `./dce guide`.
To pass the token, use the `-t` option:
To pass the token, use the `-t|--token` option:
```console
./dce export 53555 -t "mfa.Ifrn"
@@ -79,7 +79,7 @@ For example, to figure out how to use the `export` command, run:
## Export a specific channel
You can quickly export with DCE's default settings by providing the channel ID as a positional argument and `-t token`.
You can quickly export with DCE's default settings by providing the channel ID as a positional argument and `-t|--token`.
```console
./dce export 53555 -t "mfa.Ifrn"
@@ -87,7 +87,7 @@ You can quickly export with DCE's default settings by providing the channel ID a
#### Changing the format
You can change the export format to `HtmlDark`, `HtmlLight`, `PlainText` `Json` or `Csv` with `-f format`. The default
You can change the export format to `HtmlDark`, `HtmlLight`, `PlainText` `Json` or `Csv` with `-f|--format`. The default
format is `HtmlDark`.
```console
@@ -96,7 +96,7 @@ format is `HtmlDark`.
#### Changing the output filename
You can change the filename by using `-o name.ext`. e.g. for the `HTML` format:
You can change the filename by using `-o|--output`. e.g. for the `HTML` format:
```console
./dce export 53555 -t "mfa.Ifrn" -o myserver.html
@@ -104,7 +104,7 @@ You can change the filename by using `-o name.ext`. e.g. for the `HTML` format:
#### 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
You can change the export directory by using `-o|--output` 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 (").
@@ -114,7 +114,7 @@ If any of the folders in the path have a space in its name, escape them with quo
#### Changing the filename and output directory
You can change both the filename and export directory by using `-o directory\name.ext`.
You can change both the filename and export directory by using `-o|--output`.
Note that the filename must have an extension, otherwise it will be considered a directory name.
If any of the folders in the path have a space in its name, escape them with quotes (").