diff --git a/README.md b/README.md index f3591e9fd3..1801221d4a 100644 --- a/README.md +++ b/README.md @@ -396,6 +396,12 @@ tdl up -p /path/to/file -p /path/to/dir -e .so -e .tmp tdl up -p /path/to/file -t 8 -s 524288 -l 4 ``` +- Delete the uploaded file after successful upload: + +```shell +tdl up -p /path/to/file --rm +``` + - Upload to custom chat: ```shell @@ -439,37 +445,62 @@ tdl recover -f /path/to/backup.zip ```shell tdl chat ls + +# output with JSON format +tdl chat ls -o json + +# specify filter that powered by expression engine, default is `true`(match all) +# feel free to file an issue if you have any questions about the expression engine. +# expression engine docs: https://expr.medv.io/docs/Language-Definition + +# list all available filter fields +tdl chat ls -f - +# list channels that VisibleName contains "Telegram" +tdl chat ls -f "Type contains 'channel' && VisibleName contains 'Telegram'" +# list groups that have topics +tdl chat ls -f "len(Topics)>0" ``` -- Export minimal JSON for `tdl` download (NOT for backup): +- Export JSON for `tdl` download: ```shell # will export all media files in the chat. # chat input examples: `@iyear`, `iyear`, `123456789`(chat id), `https://t.me/iyear`, `+1 123456789` -# export all messages +# export all media messages tdl chat export -c CHAT_INPUT +# export all messages including non-media messages +tdl chat export -c CHAT_INPUT --all + +# export Telegram MTProto raw message structure, useful for debugging +tdl chat export -c CHAT_INPUT --raw + +# export from specific topic +# You can get topic id from: +# 1. message link: https://t.me/c/1492447836/251011/269724(251011 is topic id) +# 2. `tdl chat ls` command +tdl chat export -c CHAT_INPUT --topic TOPIC_ID +# export from specific channel post replies +tdl chat export -c CHAT_INPUT --reply MSG_ID + # export with specific timestamp range, default is start from 1970-01-01, end to now tdl chat export -c CHAT_INPUT -i 1665700000,1665761624 # or (time is default type) tdl chat export -c CHAT_INPUT -T time -i 1665700000,1665761624 - # export with specific message id range, default to start from 0, end to latest message tdl chat export -c CHAT_INPUT -T id -i 100,500 - # export last N media files tdl chat export -c CHAT_INPUT -T last -i 100 -# specify files filter that powered by regexp, default matches all files -# regexp syntax: https://github.com/google/re2/wiki/Syntax -# supported fields: `file`, `content` -tdl chat export -c CHAT_INPUT -f file=.*\.jpg # match file name ends with `.jpg` -tdl chat export -c CHAT_INPUT -f content=.*Book.* # match message content contains `Book` -tdl chat export -c CHAT_INPUT -f file=.*\.jpg,content=.*Book.* # match both +# specify filter that powered by expression engine, default is `true`(match all) +# feel free to file an issue if you have any questions about the expression engine. +# expression engine docs: https://expr.medv.io/docs/Language-Definition -# practice: export a specific message from protected chat -tdl chat export -c CHAT_INPUT -i 1 -T last -f file=FILE_NAME_REGEXP,content=MESSAGE_CONTENT_REGEXP +# list all available filter fields +tdl chat export -c CHAT_INPUT -f - +# match last 10 zip files that size > 5MiB and views > 200 +tdl chat export -c CHAT_INPUT -T last -i 10 -f "Views>200 && Media.Name endsWith '.zip' && Media.Size > 5*1024*1024" # specify the output file path, default is `tdl-export.json` tdl chat export -c CHAT_INPUT -o /path/to/output.json diff --git a/README_zh.md b/README_zh.md index 10396d1247..793921d514 100644 --- a/README_zh.md +++ b/README_zh.md @@ -402,6 +402,12 @@ tdl up -p /path/to/file -p /path/to/dir -e .so -e .tmp tdl up -p /path/to/file -t 8 -s 524288 -l 4 ``` +- 删除本地已上传成功的文件： + +```shell +tdl up -p /path/to/file --rm +``` + - 上传文件到自定义会话： ```shell @@ -446,37 +452,63 @@ tdl recover -f /path/to/backup.zip ```shell tdl chat ls + +# 输出为 JSON 格式 +tdl chat ls -o json + +# 指定使用表达式引擎的过滤器，默认值为 `true`(匹配所有) +# 如果你对表达式引擎有任何问题，请发起新的 ISSUE +# 表达式引擎文档: https://expr.medv.io/docs/Language-Definition + +# 列出所有可用的过滤器字段 +tdl chat ls -f - +# 列出所有名称包含 "Telegram" 的频道 +tdl chat ls -f "Type contains 'channel' && VisibleName contains 'Telegram'" +# 列出所有设置了话题功能的群组 +tdl chat ls -f "len(Topics)>0" ``` -- 导出最小化的 JSON 文件，用于 `tdl` 下载（非备份作用） +- 导出 JSON 文件，可用于 `tdl` 下载 ```shell # 将导出会话中的所有媒体文件 # CHAT_INPUT 可接受例子: `@iyear`, `iyear`, `123456789`(会话 ID), `https://t.me/iyear`, `+1 123456789` -# 导出所有消息 +# 导出所有含媒体文件的消息 tdl chat export -c CHAT_INPUT +# 导出包含非媒体文件的所有消息 +tdl chat export -c CHAT_INPUT --all + +# 导出 Telegram MTProto 原生消息结构，可用于调试 +tdl chat export -c CHAT_INPUT --raw + +# 从指定 Topic 导出 +# 你可以从以下方式获取 topic id: +# 1. 消息链接: https://t.me/c/1492447836/251011/269724(251011 为 topic id) +# 2. `tdl chat ls` 命令 +tdl chat export -c CHAT_INPUT --topic TOPIC_ID + +# 从指定频道文章的讨论区导出 +tdl chat export -c CHAT_INPUT --reply MSG_ID + # 导出指定时间范围内的消息 tdl chat export -c CHAT_INPUT -i 1665700000,1665761624 # 或 tdl chat export -c CHAT_INPUT -T time -i 1665700000,1665761624 - # 导出指定消息 ID 范围内的消息 tdl chat export -c CHAT_INPUT -T id -i 100,500 - # 导出最近 N 条消息(计数受过滤器影响) tdl chat export -c CHAT_INPUT -T last -i 100 -# 指定文件过滤器，使用正则表达式，默认为匹配所有文件 -# 正则表达式语法: https://github.com/google/re2/wiki/Syntax -# 支持过滤字段: `file`, `content` -tdl chat export -c CHAT_INPUT -f file=.*\.jpg # 匹配文件扩展名为 `.jpg` 的消息 -tdl chat export -c CHAT_INPUT -f content=.*Book.* # 匹配消息内容中包含 `Book` 的消息 -tdl chat export -c CHAT_INPUT -f file=.*\.jpg,content=.*Book.* # 同时使用多个过滤器 +# 使用由表达式引擎提供的过滤器，默认为 `true`（即匹配所有） +# 如果你对表达式引擎有任何问题，请发起新的 ISSUE +# 表达式引擎文档: https://expr.medv.io/docs/Language-Definition -# 例子：从会话中导出指定的某条消息 -tdl chat export -c CHAT_INPUT -i 1 -T last -f file=FILE_NAME_REGEXP,content=MESSAGE_CONTENT_REGEXP +# 列出所有可用的过滤器字段 +tdl chat export -c CHAT_INPUT -f - +# 匹配所有 zip 文件，大小 > 5MiB，且消息浏览量 > 200 的最近 10 条消息 +tdl chat export -c CHAT_INPUT -T last -i 10 -f "Views>200 && Media.Name endsWith '.zip' && Media.Size > 5*1024*1024" # 指定输出文件路径，默认为 `tdl-export.json` tdl chat export -c CHAT_INPUT -o /path/to/output.json