tdl/README.md

65 lines
1.5 KiB
Markdown
Raw Normal View History

2022-09-05 20:04:10 +08:00
## Intro
![](https://img.shields.io/github/go-mod/go-version/iyear/tdl?style=flat-square)
![](https://img.shields.io/github/license/iyear/tdl?style=flat-square)
![](https://img.shields.io/github/workflow/status/iyear/tdl/master%20builder?style=flat-square)
![](https://img.shields.io/github/v/release/iyear/tdl?color=red&style=flat-square)
![](https://img.shields.io/github/last-commit/iyear/tdl?style=flat-square)
2022-09-05 22:14:03 +08:00
📥 Telegram Downloader, but more than a downloader 🚀
2022-09-05 20:04:10 +08:00
> ⚠ Note: Command compatibility is not guaranteed in the early stages of development
## Features
- Single file start-up
- Cross-platform support
- Low resource usage
- Faster than official clients
- Downloading files from protected chats
2022-09-05 22:48:52 +08:00
## Preview
It reaches my proxy's speed limit
![](img/preview.gif)
2022-09-12 21:42:39 +08:00
## Install
Go to [GitHub Releases](https://github.com/iyear/tdl/releases) to download the latest version
2022-09-05 20:04:10 +08:00
## Usage
```shell
# check the version
tdl version
# use proxy
tdl --proxy socks5://127.0.0.1:1080
2022-09-10 15:36:01 +08:00
# specify the account namespace
tdl -n my-tdl
2022-09-05 20:04:10 +08:00
# login your account
2022-09-05 23:31:24 +08:00
tdl login -n iyear --proxy socks5://127.0.0.1:1080
2022-09-05 20:04:10 +08:00
# download files in url mode, url is the message link
2022-09-10 15:36:01 +08:00
tdl dl url -n iyear -u https://t.me/tdl/1 -u https://t.me/tdl/2
2022-09-05 20:04:10 +08:00
# full examples in url mode
2022-09-10 15:36:01 +08:00
tdl dl url -n iyear --proxy socks5://127.0.0.1:1080 -u https://t.me/tdl/1 -u https://t.me/tdl/2 -s 262144 -t 16 -l 3
2022-09-05 20:04:10 +08:00
```
## Data
Your account information will be stored in the `~/.tdl` directory.
## Commands
Go to [command documentation](docs/command/tdl.md) for full command docs.
## LICENSE
AGPL-3.0 License