https://6e2a28aa.tdl-docs.pages.dev/ Recent content in Introduction on tdl Hugo -- gohugo.io en https://6e2a28aa.tdl-docs.pages.dev/guide/global-config/ Mon, 01 Jan 0001 00:00:00 +0000 https://6e2a28aa.tdl-docs.pages.dev/guide/global-config/ Global Config # Global config is some CLI flags that can be set in every command. Set Global Config EVERYTIME! Global config does not mean that the configuration will be persisted or only need to be set once in global settings, they will only take effect in the current command. You need to set them in each command. -n/--ns # Each namespace represents a Telegram account. Default: default. If you want to add another account, just add -n YOUR_ACCOUNT_NAME option to every command: https://6e2a28aa.tdl-docs.pages.dev/getting-started/installation/ Mon, 01 Jan 0001 00:00:00 +0000 https://6e2a28aa.tdl-docs.pages.dev/getting-started/installation/ Installation # One-Line Scripts # Windows tdl will be installed to $Env:SystemDrive\tdl(will be added to PATH), and script also can be used to upgrade tdl . Install latest version # iwr -useb https://docs.iyear.me/tdl/install.ps1 | iex Install with ghproxy.com # $Script=iwr -useb https://docs.iyear.me/tdl/install.ps1; $Block=[ScriptBlock]::Create($Script); Invoke-Command -ScriptBlock $Block -ArgumentList "", "$True" Install specific version # $Env:TDLVersion = "VERSION" $Script=iwr -useb https://docs.iyear.me/tdl/install.ps1; $Block=[ScriptBlock]::Create($Script); Invoke-Command -ScriptBlock $Block -ArgumentList "$Env:TDLVersion" macOS & Linux tdl will be installed to /usr/local/bin/tdl, and script also can be used to upgrade tdl. https://6e2a28aa.tdl-docs.pages.dev/guide/tools/list-chats/ Mon, 01 Jan 0001 00:00:00 +0000 https://6e2a28aa.tdl-docs.pages.dev/guide/tools/list-chats/ List Chats # List all chats # tdl chat ls JSON Output # tdl chat ls -o json Filter # Please refer to Filter Guide for basic knowledge about filter. 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" https://6e2a28aa.tdl-docs.pages.dev/more/env/ Mon, 01 Jan 0001 00:00:00 +0000 https://6e2a28aa.tdl-docs.pages.dev/more/env/ Env # The values of all environment variables have a lower priority than flags. Avoid typing the same flag values repeatedly every time by setting environment variables. NAME FLAG TDL_NS -n/--ns TDL_PROXY --proxy TDL_STORAGE --storage TDL_DEBUG --debug TDL_SIZE -s/--size TDL_THREADS -t/--threads TDL_LIMIT -l/--limit TDL_POOL --pool TDL_NTP --ntp TDL_RECONNECT_TIMEOUT --reconnect-timeout TDL_DISABLE_PROGRESS_PS --disable-progress-ps TDL_TEMPLATE dl --template TDL_STORAGE format in env is different from that in flags: {"type": "bolt", "path": "/path/to/data-dir"} (JSON object). https://6e2a28aa.tdl-docs.pages.dev/guide/tools/export-members/ Mon, 01 Jan 0001 00:00:00 +0000 https://6e2a28aa.tdl-docs.pages.dev/guide/tools/export-members/ Export Members # Export chat members/subscribers, admins, bots, etc. Chat administrator permission is required for some types of members(kicked, banned, etc.). CHAT Examples Available Values: # @iyear (Username) iyear (Username without @) 123456789 (ID) https://t.me/iyear (Public Link) +1 123456789 (Phone) How to Get Chat ID on Telegram Desktop: # Settings → Advanced → Experimental settings → Show Peer IDs in Profile All # Export all users to tdl-users.json tdl chat users -c CHAT https://6e2a28aa.tdl-docs.pages.dev/guide/login/ Mon, 01 Jan 0001 00:00:00 +0000 https://6e2a28aa.tdl-docs.pages.dev/guide/login/ Login # https://6e2a28aa.tdl-docs.pages.dev/getting-started/quick-start/ Mon, 01 Jan 0001 00:00:00 +0000 https://6e2a28aa.tdl-docs.pages.dev/getting-started/quick-start/ Quick Start # Login # We don’t specify the namespace here, so it will use the default namespace. You can specify the namespace with -n flag if you want to use another namespace. Login with desktop clients # Please ensure that clients are downloaded from official website (NOT from Microsoft Store or App Store) Automatically find the client path: tdl login Or if you set a local passcode: tdl login -p YOUR_PASSCODE https://6e2a28aa.tdl-docs.pages.dev/more/data/ Mon, 01 Jan 0001 00:00:00 +0000 https://6e2a28aa.tdl-docs.pages.dev/more/data/ Data # Your account information will be stored in the ~/.tdl directory. Log files will be stored in the ~/.tdl/log directory. https://6e2a28aa.tdl-docs.pages.dev/guide/download/ Mon, 01 Jan 0001 00:00:00 +0000 https://6e2a28aa.tdl-docs.pages.dev/guide/download/ Download # From Links: # Get message links from “Copy Link” button in official clients. Message Link Examples https://t.me/telegram/193 https://t.me/c/1697797156/151 https://t.me/iFreeKnow/45662/55005 https://t.me/c/1492447836/251015/251021 https://t.me/opencfdchannel/4434?comment=360409 https://t.me/myhostloc/1485524?thread=1485523 ... (File a new issue if you find a new link format) tdl dl -u https://t.me/tdl/1 -u https://t.me/tdl/2 From JSON: # There are two ways to export the JSON you need: tdl This is especially for protected chats and more powerful than the desktop client. https://6e2a28aa.tdl-docs.pages.dev/guide/tools/export-messages/ Mon, 01 Jan 0001 00:00:00 +0000 https://6e2a28aa.tdl-docs.pages.dev/guide/tools/export-messages/ Export Messages # Export media messages from chats, channels, groups, etc. in JSON format. CHAT Examples Available Values: # @iyear (Username) iyear (Username without @) 123456789 (ID) https://t.me/iyear (Public Link) +1 123456789 (Phone) How to Get Chat ID on Telegram Desktop: # Settings → Advanced → Experimental settings → Show Peer IDs in Profile Empty CHAT means ‘Saved Messages’ All # Export all messages containing media to tdl-export.json tdl chat export -c CHAT https://6e2a28aa.tdl-docs.pages.dev/getting-started/shell-completion/ Mon, 01 Jan 0001 00:00:00 +0000 https://6e2a28aa.tdl-docs.pages.dev/getting-started/shell-completion/ Shell Completion # Run corresponding command to enable shell completion in all sessions: bash echo "source <(tdl completion bash)" >> ~/.bashrc zsh echo "source <(tdl completion zsh)" >> ~/.zshrc fish echo "tdl completion fish | source" >> ~/.config/fish/config.fish PowerShell Add-Content -Path $PROFILE -Value "tdl completion powershell | Out-String | Invoke-Expression" https://6e2a28aa.tdl-docs.pages.dev/guide/forward/ Mon, 01 Jan 0001 00:00:00 +0000 https://6e2a28aa.tdl-docs.pages.dev/guide/forward/ Forward # Forward messages with automatic fallback and message routing One-liner to forward messages from https://t.me/telegram/193 to Saved Messages: tdl forward --from https://t.me/telegram/193 Custom Source # Message Link Examples https://t.me/telegram/193 https://t.me/c/1697797156/151 https://t.me/iFreeKnow/45662/55005 https://t.me/c/1492447836/251015/251021 https://t.me/opencfdchannel/4434?comment=360409 https://t.me/myhostloc/1485524?thread=1485523 ... (File a new issue if you find a new link format) You can forward messages from links and exported JSON files: tdl forward \ --from https://t.me/telegram/193 \ --from https://t.me/telegram/195 \ --from tdl-export.json \ https://6e2a28aa.tdl-docs.pages.dev/more/troubleshooting/ Mon, 01 Jan 0001 00:00:00 +0000 https://6e2a28aa.tdl-docs.pages.dev/more/troubleshooting/ Troubleshooting # Best Practices # How to minimize the risk of blocking? Login with the official client session. Use the default download and upload options as possible. Do not set too large threads and size. Do not use the same account to login on multiple devices at the same time. Don’t download or upload too many files at once. Become a Telegram premium user. 😅 FAQ # Q: Why no response after entering the command? https://6e2a28aa.tdl-docs.pages.dev/guide/upload/ Mon, 01 Jan 0001 00:00:00 +0000 https://6e2a28aa.tdl-docs.pages.dev/guide/upload/ Upload # Upload Files # Upload specified files and directories to Saved Messages: tdl up -p /path/to/file -p /path/to/dir Custom Destination # Upload to custom chat. CHAT Examples Available Values: # @iyear (Username) iyear (Username without @) 123456789 (ID) https://t.me/iyear (Public Link) +1 123456789 (Phone) How to Get Chat ID on Telegram Desktop: # Settings → Advanced → Experimental settings → Show Peer IDs in Profile Specific Chat # Upload to specific one chat: https://6e2a28aa.tdl-docs.pages.dev/guide/migration/ Mon, 01 Jan 0001 00:00:00 +0000 https://6e2a28aa.tdl-docs.pages.dev/guide/migration/ Migration # Backup or recover your data Backup # Backup all namespace data to a file. Default: <date>.backup.tdl. tdl backup Or specify the output file: tdl backup -d /path/to/custom.tdl Recover # Recover your data from a tdl backup file. Existing namespace data will be overwritten. tdl recover -f /path/to/custom.backup.tdl Migrate # Migrate your data to another storage See Storage Flag for storage option details. Migrate current storage to file storage: tdl migrate --to type=file,path=/path/to/data. https://6e2a28aa.tdl-docs.pages.dev/guide/extensions/ Mon, 01 Jan 0001 00:00:00 +0000 https://6e2a28aa.tdl-docs.pages.dev/guide/extensions/ Extensions # Extensions are a new feature in tdl. They are still in the experimental stage, and the CLI may change in future versions. If you encounter any problems or have any suggestions, please open an issue on GitHub. Overview # tdl extensions are add-on tools that integrate seamlessly with tdl. They provide a way to extend the core feature set of tdl, but without requiring every new feature to be added to the core. https://6e2a28aa.tdl-docs.pages.dev/snippets/chat/ Mon, 01 Jan 0001 00:00:00 +0000 https://6e2a28aa.tdl-docs.pages.dev/snippets/chat/ CHAT Examples Available Values: # @iyear (Username) iyear (Username without @) 123456789 (ID) https://t.me/iyear (Public Link) +1 123456789 (Phone) How to Get Chat ID on Telegram Desktop: # Settings → Advanced → Experimental settings → Show Peer IDs in Profile https://6e2a28aa.tdl-docs.pages.dev/snippets/link/ Mon, 01 Jan 0001 00:00:00 +0000 https://6e2a28aa.tdl-docs.pages.dev/snippets/link/ Message Link Examples https://t.me/telegram/193 https://t.me/c/1697797156/151 https://t.me/iFreeKnow/45662/55005 https://t.me/c/1492447836/251015/251021 https://t.me/opencfdchannel/4434?comment=360409 https://t.me/myhostloc/1485524?thread=1485523 ... (File a new issue if you find a new link format) https://6e2a28aa.tdl-docs.pages.dev/reference/expr/ Mon, 01 Jan 0001 00:00:00 +0000 https://6e2a28aa.tdl-docs.pages.dev/reference/expr/ Expr Guide # Expr is powered by expr, which is a simple, lightweight, yet powerful expression engine. Expression engine docs: https://expr.medv.io/docs/Language-Definition It’s powerful but may be a little hard to new users. So feel free to file an issue if you have any questions about the expression engine. https://6e2a28aa.tdl-docs.pages.dev/guide/template/ Mon, 01 Jan 0001 00:00:00 +0000 https://6e2a28aa.tdl-docs.pages.dev/guide/template/ Template Guide # This guide is intended to introduce variables and functions that are available in the tdl template. Template syntax is based on Go’s text/template package. Download # Variables (beta) # Var Desc DialogID Telegram dialog id MessageID Telegram message id MessageDate Telegram message date(timestamp) FileName Telegram file name FileCaption Telegram file caption, aka. text message FileSize Human-readable file size, like 1GB DownloadDate Download date(timestamp) Functions (beta) # Func Desc Usage Example repeat Repeat STRING N times repeat STRING N {{ repeat "test" 3 }} replace Perform replacement on STRING with PAIRS replace STRING PAIRS.