docs(prj): add chat export part

2025-01-09 04:17:35 +08:00 · 2023-10-02 16:22:49 +08:00 · 2023-10-02 16:22:49 +08:00 · 31c373777a
commit 31c373777a
parent 9e84409107
1 changed files with 125 additions and 0 deletions
--- a/docs/content/en/docs/guide/tools/export-messages.md
+++ b/docs/content/en/docs/guide/tools/export-messages.md
@ -0,0 +1,125 @@
+---
+title: "Export Messages"
+weight: 30
+---
+
+# Export Messages
+
+Export media messages from chats, channels, groups, etc. in JSON format.
+
+{{< details title="CHAT Examples" open=false >}}
+
+- `@iyear`
+- `iyear`
+- `123456789` (ID)
+- `https://t.me/iyear`
+- `+1 123456789` (Phone)
+  {{< /details >}}
+
+## All
+
+Export all messages containing media to `tdl-export.json`
+
+```
+tdl chat export -c CHAT
+```
+
+## From Topic/Replies
+
+Export media messages from specific topic:
+{{< hint info >}}
+Get Topic ID:
+
+1. Message Link: `https://t.me/c/1492447836/251011/269724` (`251011` is topic id)
+2. `tdl chat ls` command
+   {{< /hint >}}
+
+```
+tdl chat export -c CHAT --topic TOPIC_ID
+```
+
+Export media messages from specific channel post replies:
+
+```
+tdl chat export -c CHAT --reply POST_ID
+```
+
+## Custom Destination
+
+Export with specific output file path. Default: `tdl-export.json`.
+
+```
+tdl chat export -c CHAT -o /path/to/output.json
+```
+
+## Custom Type
+
+### Time Range
+
+Export with specific timestamp range. Default: `1970-01-01` - `NOW`
+
+```
+tdl chat export -c CHAT -T time -i 1665700000,1665761624
+```
+
+`time` is also the default value of `-T` option, so you can omit it
+
+```
+tdl chat export -c CHAT -i 1665700000,1665761624
+```
+
+### ID Range
+
+Export with specific message id range. Default: `0` - `latest`
+
+```
+tdl chat export -c CHAT -T id -i 100,500
+```
+
+### Last
+
+Export last 100 media messages:
+
+```
+tdl chat export -c CHAT -T last -i 100
+```
+
+## Filter
+
+Please refer to [Filter Guide](/docs/guide/tools/filter) for basic knowledge about filter.
+
+List all available filter fields:
+
+```
+tdl chat export -c CHAT -f -
+```
+
+Export last 10 zip files that `size > 5MiB` and `views > 200`:
+
+```
+tdl chat export -c CHAT -T last -i 10 -f "Views>200 && Media.Name endsWith '.zip' && Media.Size > 5*1024*1024"
+```
+
+## With Content
+
+Export with message content:
+
+```
+tdl chat -c CHAT --with-content
+```
+
+## Raw
+
+Export Telegram MTProto raw message structure, which is useful for debugging.
+
+```
+tdl chat export -c CHAT --raw
+```
+
+## Non-Media
+
+Export all messages including non-media messages, which is useful for debugging/backup.
+
+```
+tdl chat export -c CHAT --all
+```