telegram-history-dump

该工具是 telegram-json-backup 的继任者，从头开始用 Ruby 编写。它通过 telegram-cli 的远程控制功能，可以创建你的 Telegram 用户和（超级）群组对话的备份。

与旧项目相比，telegram-history-dump：

• 对媒体下载有更好的支持
• 支持除 JSON 以外的输出格式，并且可通过自定义格式进行扩展
• 支持增量备份（仅下载新消息）
• 不依赖于 telegram-cli 内不稳定的 Python/Lua 绑定
• 拥有独立的 YAML 格式配置文件

默认配置将备份所有对话到名为 output 的目录，格式为 JSON，不下载任何媒体。

使用方法

首次设置

1. 编译 telegram-cli，启动一次以关联你的 Telegram 账户
2. 确保系统中安装了 Ruby 2+：ruby --version
3. 可选：通过编辑 config.yaml 配置备份例程

执行备份

1. 至少使用以下选项启动 telegram-cli： telegram-cli --json -P 9009
2. 在 telegram-cli 运行时，执行脚本： ruby telegram-history-dump.rb

格式化器

历史记录将始终以 JSON Lines 兼容文件存储。不过，可以通过取消配置文件中几行的注释来生成其他输出格式。

你可以启用以下一个或多个格式化模块：

html 创建可通过浏览器查看的、带样式的分页聊天记录。

plaintext 创建人类可读的文本文件，按每天一个文件组织。

bare 仅输出实际消息文本，不带任何上下文。适用于语言学/统计分析。

pisg 创建与 EnergyMech IRC 日志格式兼容的每日日志，作为 PISG 聊天统计生成器的输入。另见 telegram-pisg。

你还可以实现自定义格式化器；详情请参阅 formatters/lib/formatter_base.rb。

命令行选项

大部分备份配置通过配置文件完成，但少数特定选项可作为 CLI 选项提供。它们都不是必需的。

Usage: telegram-history-dump.rb [options]
    -c, --config=cfg.yaml            Path to YAML configuration file
    -k, --kill-tg                    Kill telegram-cli after backup
    -h, --help                       Show help
    -d, --dir=DIR                    Subdirectory for output files
                                     (relative to backup_dir in YAML config)
    -l, --limit=LIMIT                Maximum number of messages to backup
                                     for each target (overrides YAML config)

说明

使用说明：

• 可以在不同机器上运行 telegram-cli，例如作为服务器上的守护进程。在这种情况下，必须向 telegram-cli 传递 --accept-any-tcp，并适当防火墙该端口以防止不必要的暴露。请记住，某些与媒体文件相关的选项在远程设置中将无法使用。
• 降低 chunk_delay 或增加 chunk_size 时要小心。Telegram 似乎会对历史请求进行速率限制。速度过快可能导致操作超时，并迫使脚本跳过部分转储。

已知影响 telegram-history-dump 的 telegram-cli 问题：

• vysheng/tg#947 可能导致在转储包含超过 100 条消息的频道时崩溃。
• vysheng/tg#904 可能在对话包含某些媒体文件时导致崩溃。如果遇到此问题，请使用建议的解决方法重新编译 telegram-cli。