Skip to content

Commit 94b1806

Browse files
committed
docs(README): v0.10.0
1 parent b5ce635 commit 94b1806

2 files changed

Lines changed: 48 additions & 0 deletions

File tree

README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,7 @@ English | [简体中文](README_zh.md)
3939
- Faster than official clients
4040
- Download files from (protected) chats
4141
- Upload files to Telegram
42+
- Export messages/members/subscribers to JSON
4243

4344
## Preview
4445

@@ -402,6 +403,12 @@ tdl up -p /path/to/file -t 8 -s 524288 -l 4
402403
tdl up -p /path/to/file --rm
403404
```
404405

406+
- Upload images as photos:
407+
408+
```shell
409+
tdl up -p /path/to/file --photo
410+
```
411+
405412
- Upload to custom chat:
406413

407414
```shell
@@ -461,6 +468,22 @@ tdl chat ls -f "Type contains 'channel' && VisibleName contains 'Telegram'"
461468
tdl chat ls -f "len(Topics)>0"
462469
```
463470

471+
- Export chat members/subscribers, admins, bots, etc:
472+
473+
> **Note**
474+
> Chat admin required
475+
476+
```shell
477+
# chat input examples: `@iyear`, `iyear`, `123456789`(chat id), `https://t.me/iyear`, `+1 123456789`
478+
479+
# export all users to tdl-users.json
480+
tdl chat users -c CHAT_INPUT
481+
# export with specified path
482+
tdl chat users -c CHAT_INPUT -o /path/to/export.json
483+
# export Telegram MTProto raw user structure, useful for debugging
484+
tdl chat users -c CHAT_INPUT --raw
485+
```
486+
464487
- Export JSON for `tdl` download:
465488

466489
```shell
@@ -525,6 +548,7 @@ What flags mean: [flags](docs/command/tdl.md#options)
525548
| TDL_SIZE | `-s/--size` |
526549
| TDL_THREADS | `-t/--threads` |
527550
| TDL_LIMIT | `-l/--limit` |
551+
| TDL_POOL | `--pool` |
528552
| TDL_NTP | `--ntp` |
529553
| TDL_RECONNECT_TIMEOUT | `--reconnect-timeout` |
530554
| TDL_TEMPLATE | dl `--template` |

README_zh.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,7 @@
4343
- 比官方客户端更快
4444
- 支持从受保护的会话中下载文件
4545
- 支持上传文件至 Telegram
46+
- 导出历史消息/成员/订阅者数据至 JSON 文件
4647

4748
## 预览
4849

@@ -409,6 +410,12 @@ tdl up -p /path/to/file -t 8 -s 524288 -l 4
409410
tdl up -p /path/to/file --rm
410411
```
411412

413+
- 上传图像为图片而非文件:
414+
415+
```shell
416+
tdl up -p /path/to/image --photo
417+
```
418+
412419
- 上传文件到自定义会话:
413420

414421
```shell
@@ -469,6 +476,22 @@ tdl chat ls -f "Type contains 'channel' && VisibleName contains 'Telegram'"
469476
tdl chat ls -f "len(Topics)>0"
470477
```
471478

479+
- 导出会话成员/订阅者、管理员、机器人等:
480+
481+
> **Note**
482+
> 你必须为该会话的管理员
483+
484+
```shell
485+
# CHAT_INPUT 可接受例子: `@iyear`, `iyear`, `123456789`(会话 ID), `https://t.me/iyear`, `+1 123456789`
486+
487+
# 导出所有用户到 tdl-users.json
488+
tdl chat users -c CHAT_INPUT
489+
# 导出至指定路径
490+
tdl chat users -c CHAT_INPUT -o /path/to/export.json
491+
# # 导出 Telegram MTProto 原生用户结构,可用于调试
492+
tdl chat users -c CHAT_INPUT --raw
493+
```
494+
472495
- 导出 JSON 文件,可用于 `tdl` 下载
473496

474497
```shell
@@ -534,6 +557,7 @@ tdl chat export -c CHAT_INPUT --with-content
534557
| TDL_SIZE | `-s/--size` |
535558
| TDL_THREADS | `-t/--threads` |
536559
| TDL_LIMIT | `-l/--limit` |
560+
| TDL_POOL | `--pool` |
537561
| TDL_NTP | `--ntp` |
538562
| TDL_RECONNECT_TIMEOUT | `--reconnect-timeout` |
539563
| TDL_TEMPLATE | dl `--template` |

0 commit comments

Comments
 (0)