mirrors/DiscordChatExporter
1
0
Fork 0
mirror of https://github.com/Tyrrrz/DiscordChatExporter.git synced 2025-06-07 01:51:18 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update docs with more information on message filter caveats in CLI

Browse source 
Closes #1045
This commit is contained in:
Tyrrrz 2023-06-08 16:48:32 +03:00
parent 3d2d197904
commit 18d9c189b7
1 changed files with 16 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

18
.docs/Message-filters.md
View file

@ -2,7 +2,7 @@
You can use a special notation to filter messages that you want to have included in an export. The notation syntax is designed to mimic Discord's search query syntax, but with additional capabilities. You can use a special notation to filter messages that you want to have included in an export. The notation syntax is designed to mimic Discord's search query syntax, but with additional capabilities.
To configure a filter, specify it in advanced export parameters when using the GUI or by passing the `--filter` option when using the CLI. To configure a filter, specify it in advanced export parameters when using the GUI or by passing the `--filter` option when using the CLI. For the CLI version, see also [caveats](#cli-caveats).
## Examples ## Examples
@ -84,9 +84,21 @@ from:Tyrrrz | from:"96-LB"
from:96\-LB from:96\-LB
``` ```
## CLI Caveat ## CLI Caveats
Negated filters (those that start with `-`) may cause parsing issues when using the CLI version of DiscordChatExporter. To avoid this, use the tilde (`~`) character instead of the dash (`-`): In most cases, you will need to enclose your filter in quotes (`"`) to escape characters that may have special meaning in your shell:
```
DiscordChatExporter.Cli export [...] --filter "from:Tyrrrz has:image"
```
If you need to include quotes inside the filter itself as well, use single quotes (`'`) for those instead:
```
DiscordChatExporter.Cli export [...] --filter "from:Tyrrrz 'hello world'"
```
Additionally, negated filters (those that start with `-`) may cause parsing issues even when enclosed in quotes. To avoid this, use the tilde (`~`) character instead of the dash (`-`):
``` ```
DiscordChatExporter.Cli export [...] --filter ~from:Tyrrrz DiscordChatExporter.Cli export [...] --filter ~from:Tyrrrz