Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/tldr-pages/tldr/llms.txt

Use this file to discover all available pages before exploring further.

Caching allows tldr clients to work offline by storing a local copy of pages. Clients that implement caching must download official archives from GitHub releases — they MUST NOT use unofficial mirrors or construct their own archive URLs.

​
Archive URLs

The following official archive URLs are available from the tldr-pages GitHub releases:
ArchiveURLDescription
Full (all languages)https://github.com/tldr-pages/tldr/releases/latest/download/tldr.zipAll pages in every available language — the largest download
English onlyhttps://github.com/tldr-pages/tldr/releases/latest/download/tldr-pages.zipEnglish pages only
Language-specifichttps://github.com/tldr-pages/tldr/releases/latest/download/tldr-pages.[language-code].zipPages for a single language (e.g. tldr-pages.fr.zip)
The language-specific archive URL pattern and some examples: 
# URL pattern
https://github.com/tldr-pages/tldr/releases/latest/download/tldr-pages.{{language-code}}.zip

# Examples
https://github.com/tldr-pages/tldr/releases/latest/download/tldr-pages.fr.zip      — French
https://github.com/tldr-pages/tldr/releases/latest/download/tldr-pages.zh.zip      — Chinese
https://github.com/tldr-pages/tldr/releases/latest/download/tldr-pages.pt_BR.zip   — Portuguese (Brazil)
https://github.com/tldr-pages/tldr/releases/latest/download/tldr-pages.it.zip      — Italian
The old asset URL at https://tldr.sh/assets was deprecated and has been permanently removed on January 20, 2026. Clients that still use the old URL can no longer download pages. All clients must be updated to use the GitHub releases URLs listed above.

​
Implementation requirements

The specification distinguishes between what is strictly required and what is recommended when implementing caching:

REQUIRED

  • If caching is implemented, clients MUST download archives from the official GitHub releases URLs above — no other source is permitted.
  • Clients that support caching MUST implement the -u / --update flag to allow users to manually refresh the local cache.

RECOMMENDED

  • Cache only the languages the user needs, rather than downloading all 40+ language archives unnecessarily.
  • Automatically update the cache on a regular schedule so pages stay current without requiring manual intervention.

​
Selecting language-specific archives

Clients face a tradeoff when choosing which archive(s) to download:
  • tldr.zip — the full archive includes every page in every available language. It is the simplest option (one download) but is the largest in size.
  • Language-specific archives (e.g., tldr-pages.fr.zip) — much smaller downloads, containing only pages for a single language. Ideal when the client knows the user’s preferred language(s).
It is RECOMMENDED that clients cache only the languages the user actually needs, both to conserve disk space and to reduce download time.

​
Updating the cache

Clients that implement caching MUST support the -u / --update flag: 
# Update cached pages
tldr --update
# or
tldr -u
Clients MAY also automatically update the cache on a regular schedule so that pages remain up to date without requiring the user to run --update manually.

​
PDF version

A PDF of all tldr pages is available for offline reading: 
https://github.com/tldr-pages/tldr/releases/latest/download/tldr-book.pdf
This is a static document intended for human reading, not for use as a cache source by clients.
Caching is RECOMMENDED but not strictly required by the specification. Clients that always fetch pages live from the network (rather than from a local cache) do not need to implement caching at all.

Build docs developers (and LLMs) love

Get started for freeTalk to us