Skip to main content

telegram-export-md

Turn Telegram's unreadable result.json export into clean, searchable Markdown files.

License: MIT Python PyPI CI

🌐 Languages: English · فارسی

Telegram Desktop's built-in Export chat history gives you a giant result.json (plus folders full of media) — technically complete, practically unreadable. telegram-export-md converts it into one tidy Markdown file per chat, with formatting, replies, forwards, polls, and media all preserved.

Zero dependencies. Pure Python standard library.

terminal demo

Before → After

Before — raw export JSON:

{"id": 183, "type": "message", "date": "2021-01-01T10:00:00",
 "from": "Arian", "text": [{"type": "plain", "text": "hello "},
 {"type": "bold", "text": "everyone"}, {"type": "plain", "text": "?"}]}

After — rendered Markdown:

**2021-01-01 10:00 — Arian**

hello **everyone**?

---

**2021-01-02 18:30 — Arian**

![](media/Gaming Crew/photo_1.jpg)

*1920×1080*

Features

  • 📄 One Markdown file per chat, plus an index.md table of contents
  • 📡 fetch mode (optional extra) — pull chats straight from Telegram's servers, no desktop app needed
  • 🎨 Telegram formatting preserved — bold, italic, code, pre, strikethrough, underline, links
  • 💬 Replies resolved — quoted with sender and a snippet of the original message
  • ↩️ Forwards, edits, and polls rendered faithfully
  • 🖼 Media support — photos embed, everything else links; --copy-media makes the backup self-contained
  • 🔍 Filters — pick chats by name or id, slice by date range
  • 🧹 Service messages (joins, pins, calls) can be excluded
  • 🐍 No dependencies — works on Python 3.10+, Windows/macOS/Linux

Install

# from PyPI
pipx install telegram-export-md

# optional: fetch mode (pull chats from Telegram's servers via their API)
pipx install 'telegram-export-md[fetch]'

# or directly from this repo
uv tool install git+https://github.com/Retro-Zero/telegram-export-md.git
# or
pip install git+https://github.com/Retro-Zero/telegram-export-md.git

Usage

1. Export your data

In Telegram Desktop: Settings → Advanced → Export chat history. Tick JSON as the format and check Include photos and videos if you want media. This creates a folder containing result.json and media subfolders.

2. Convert

tg-export-md ~/Downloads/Telegram-Export -o ~/telegram-backup

Result:

telegram-backup/
├── index.md
├── Gaming Crew.md
├── Saved Messages.md
└── media/
    └── Gaming Crew/
        ├── photo_1.jpg
        └── video_1.mp4

Options

Option Description
export Path to the export folder (containing result.json) or to result.json itself
-o, --output Output directory (default: ./markdown)
--chat TEXT Only export chats whose name or id contains TEXT
--since YYYY-MM-DD Only messages on or after this date
--until YYYY-MM-DD Only messages on or before this date
--copy-media Copy media into the output folder (self-contained backup)
--no-media Omit media references entirely
--no-service Skip service messages (joins, pins, calls, …)
--quiet Only print errors

Examples

# One chat, as a searchable text archive
tg-export-md export/ -o backup --chat "Gaming Crew" --copy-media

# Everything from 2022, text only
tg-export-md export/ -o backup --since 2022-01-01 --no-media

# Point straight at the JSON file
tg-export-md export/result.json -o backup

Automatic backup with fetch

No desktop app? No problem. tg-export-md fetch pulls chats straight from Telegram's servers into the same result.json + media format the desktop export produces — so the converter above works unchanged, and you get backups you can schedule.

Setup (once)

  1. Get free API keys at my.telegram.orgAPI development tools

  2. Make the keys available — either:

    export TG_API_ID=123456
    export TG_API_HASH=yourhash
    

    or save them in ~/.config/telegram-export-md/config.ini:

    [telegram]
    api_id = 123456
    api_hash = yourhash
    
  3. Install with the extra: pipx install 'telegram-export-md[fetch]'

Run

Run without flags for an interactive picker: after login it lists your chats and lets you choose which ones to export, which media types to download (photo, video, voice, audio, document, sticker, animation), and optional limits — last N messages per chat, a per-file size cap, and a date range.

tg-export-md fetch -o ~/telegram-export

The first run asks for your phone number and a login code Telegram sends you — the session is saved, so later runs are automatic. Everything the picker asks is also available as a flag, so cron jobs stay hands-free:

tg-export-md fetch -o ~/telegram-export --chat "Family" --media-types photo,video --last 500 --max-size 100mb
tg-export-md ~/telegram-export -o ~/telegram-backup
Flag Description
--chat TEXT only fetch chats whose name or id contains TEXT
--since / --until YYYY-MM-DD date range
--last N (alias --limit) only the last N messages per chat (newest)
--media download all media types
--media-types TYPES which media to download: photo,video,voice,audio,document,sticker,animation
--max-size SIZE skip files larger than this (e.g. 50mb, 1gb)

Notes

  • Large exports — the whole result.json is loaded into memory; exports up to a few hundred MB work fine on a modern laptop. Streaming support is on the roadmap.
  • Media paths without --copy-media point back into your original export folder. Use --copy-media for a backup you can move or archive.
  • Restricted chats — in chats where the other side enabled Restrict saving content, the full text history still exports, but their media can't be saved by anyone (by design). fetch keeps the messages with media placeholders and prints a per-file warning, plus a "could not be saved" count in the end summary. Secret chats (end-to-end encrypted) are never visible to the API at all.
  • Media availabilityfetch downloads whatever media is still available at fetch time; files that are already gone are kept as references in the JSON and counted in the end summary.
  • Export JSON is generated by Telegram Desktop (Windows/macOS/Linux). Exports from other clients may differ slightly — open an issue if something doesn't parse.

Roadmap

  • Streaming parse for huge exports
  • Support the HTML export format
  • Per-year splitting (--split)
  • --format obsidian for vault-friendly output

Contributing

Bug reports, feature requests, and PRs are welcome. Please open an issue first for anything beyond a small fix.

License

MIT

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

telegram_export_md-0.3.3.tar.gz (266.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

telegram_export_md-0.3.3-py3-none-any.whl (23.3 kB view details)

Uploaded Python 3

File details

Details for the file telegram_export_md-0.3.3.tar.gz.

File metadata

  • Download URL: telegram_export_md-0.3.3.tar.gz
  • Upload date:
  • Size: 266.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for telegram_export_md-0.3.3.tar.gz
Algorithm Hash digest
SHA256 f974eb277ff52e7ab178d07d39c6ac156b020edb963ec3564fbf3098d8e91640
MD5 d037b2710093419332fe7023453623c9
BLAKE2b-256 51e6b872b1182c66acd45d0d7c0276e4aaa0061497384a04cf4ed49d862c2375

See more details on using hashes here.

Provenance

The following attestation bundles were made for telegram_export_md-0.3.3.tar.gz:

Publisher: release.yml on Retro-Zero/telegram-export-md

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file telegram_export_md-0.3.3-py3-none-any.whl.

File metadata

File hashes

Hashes for telegram_export_md-0.3.3-py3-none-any.whl
Algorithm Hash digest
SHA256 315b90ec86f818c31d3f6a5cc630dc1f8815539c58ca4fa6c5783de87a7a4511
MD5 50da2d67c125f4f9d6ea2b54a5c14a32
BLAKE2b-256 be2b7fd5c453fea5a25d38e165b0d4dae473fa1747124e521ac033c2eea1e03f

See more details on using hashes here.

Provenance

The following attestation bundles were made for telegram_export_md-0.3.3-py3-none-any.whl:

Publisher: release.yml on Retro-Zero/telegram-export-md

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page