Skip to content

Commit

Permalink
docs(prj): v0.7.3
Browse files Browse the repository at this point in the history
  • Loading branch information
iyear committed Mar 22, 2023
1 parent 994b75d commit 88f4592
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 17 deletions.
31 changes: 19 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,11 +66,13 @@ scoop install telegram-downloader

```shell
# login with existing official desktop clients (recommended)
tdl login -n quickstart -d /path/to/Desktop-Telegram-Client
tdl login -n quickstart
# if you set a local passcode
tdl login -n quickstart -d /path/to/Desktop-Telegram-Client -p YOUR_PASSCODE
tdl login -n quickstart -p YOUR_PASSCODE
# specify custom path
tdl login -n quickstart -d /path/to/TelegramDesktop
# or login with phone & code
tdl login -n quickstart
tdl login -n quickstart --code

tdl dl -n quickstart -u https://t.me/telegram/193
```
Expand Down Expand Up @@ -128,15 +130,17 @@ export TDL_NTP=pool.ntp.org # recommended
This may reduce the risk of blocking, but is unproven:

```shell
tdl login -d /path/to/Telegram
tdl login
# if you set a local passcode
tdl login -d /path/to/Telegram -p YOUR_PASSCODE
tdl login -p YOUR_PASSCODE
# specify custom path
tdl login -d /path/to/TelegramDesktop
```

- Login to Telegram with phone & code:

```shell
tdl login
tdl login --code
```

### Download
Expand Down Expand Up @@ -320,13 +324,16 @@ tdl chat ls
# export all messages
tdl chat export -c CHAT_INPUT

# specify the time period with timestamp format, default is start from 1970-01-01, end to now
tdl chat export -c CHAT_INPUT --from 1665700000 --to 1665761624
# or (timestamp is default format)
tdl chat export -c CHAT_INPUT --from 1665700000 --to 1665761624 --time
# 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 -i 1665700000,1665761624 -T time

# export with specific message id range, default is start from 0, end to latest message
tdl chat export -c CHAT_INPUT -i 100,500 -T id

# specify with message id format, default is start from 0, end to latest message
tdl chat export -c CHAT_INPUT --from 100 --to 500 --msg
# export last N media files
tdl chat export -c CHAT_INPUT -i 100 -T last

# specify the output file path, default is `tdl-export.json`
tdl chat export -c CHAT_INPUT -o /path/to/output.json
Expand Down
6 changes: 2 additions & 4 deletions docs/command/tdl_chat_export.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,10 @@ tdl chat export [flags]

```
-c, --chat string chat id or domain
--from int starting message
-h, --help help for export
--msg the format for from&to is message id
-i, --input ints input data, depends on export type
-o, --output string output JSON file path (default "tdl-export.json")
--time the format for from&to is timestamp
--to int ending message, default value is NOW/LATEST
-T, --type string export type. time: timestamp range, id: message id range, last: last N messages: {time|id|last} (default "time")
```

### Options inherited from parent commands
Expand Down
3 changes: 2 additions & 1 deletion docs/command/tdl_login.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,8 @@ tdl login [flags]
### Options

```
-d, --desktop string official desktop client path, import session from it
--code login with code, instead of importing session from desktop client
-d, --desktop string official desktop client path, and automatically find possible paths if empty
-h, --help help for login
-p, --passcode string passcode for desktop client, keep empty if no passcode
```
Expand Down

0 comments on commit 88f4592

Please sign in to comment.