Tldr

Latest version: v3.4.0

Safety actively analyzes 722491 Python packages for vulnerabilities to keep your Python projects secure.

Scan your dependencies

Page 1 of 4

3.4.0

Breaking

* Drop support for EOL Python 3.8 version.

Bugfixes

* Fix broken `--render` option (thanks [acuteenvy](https://github.com/acuteenvy))
* Fix duplicate platform information shown in pages like `du`, `cd`, `w` (thanks [sellisd](https://github.com/sellisd))
* Only install `colorama` dependency in Windows (thanks [hukkin](https://github.com/hukkin))

Features

* Add support for displaying pages with long/short option placeholders using `--long-options`/`--short-options` flags or [TLDR_OPTIONS variable](https://github.com/tldr-pages/tldr-python-client#command-options) (thanks [Managor](https://github.com/Managor))
* Add `--clear-cache`/`-k` option to clear tldr's local cache (thanks [patricedenis](https://github.com/patricedenis) and [vitorhcl](https://github.com/vitorhcl))
* Add support to stylize text inside backticks when appearing in example descriptions (thanks [kyluca](https://github.com/kyluca))
* Add support for specifying a certificate bundle with [TLDR_CERT variable](https://github.com/tldr-pages/tldr-python-client#ssl-inspection) (thanks [jtcbrule](https://github.com/jtcbrule), [CleanMachine1](https://github.com/CleanMachine1), and [vitorhcl](https://github.com/vitorhcl))
* Package build for the project has been migrated from using `setup.py` (with `setuptools` backend) to `pyproject.toml` (with Hatch backend) (thanks [kbdharun](https://github.com/kbdharun))
* Update package metadata in `pyproject.toml` (thanks [kbdharun](https://github.com/kbdharun))
* Add trusted publisher support to securely publish `tldr` package to PyPI directly from the repository's confined environment (thanks [kbdharun](https://github.com/kbdharun))
* Add support for [Client Specification v2.3](https://github.com/tldr-pages/tldr/releases/tag/v2.3)

3.3.0

Breaking

* Drop support for EOL versions Python 3.6 and Python 3.7.

Bugfixes

* Return `str` instead of `list` when executing `tldr -l` (thanks [uunnxx](https://github.com/uunnxx))
* Use pathlib instead of os.path (thanks [vitorhcl](https://github.com/vitorhcl))
* Respect language settings when geting a list of commands (thanks [frenzymadness](https://github.com/frenzymadness))
* Fix `--search` option (thanks [CleanMachine1](https://github.com/CleanMachine1))

Features

* Add support for BSD platform directories (thanks [vitorhcl](https://github.com/vitorhcl))
* Add `--update` long option (thanks [owenvoke](https://github.com/owenvoke))
* Add support for fetching individual translation archives for cache (thanks [SaurabhDRao](https://github.com/SaurabhDRao))
* Add support to show message for other versions of the same page in other platforms (thanks [Jaimepas77](https://github.com/Jaimepas77))
* Update `DOWNLOAD_CACHE_LOCATION` to use GitHub Releases (thanks [vitorhcl](https://github.com/vitorhcl))
* Add `macos` alias for `osx` directory and update `--platform` option (thanks [patricedenis](https://github.com/patricedenis))
* Add support for escaping placeholders for special pages (thanks [kbdharun](https://github.com/kbdharun))
* Add support for Python 3.11 and Python 3.12 (thanks [kbdharun](https://github.com/kbdharun))
* Add support for [Client Specification v2.2](https://github.com/tldr-pages/tldr/releases/tag/v2.2)

3.2.0

Bugfixes

* Fix forcing color through termcolor
* Change non-word regex to be POSIX compliant (thanks [stevejbrown](https://github.com/stevejbrown))
* Update pages source to use the main branch
* Add a timeout to the URL requests (thanks [Jaimepas77](https://github.com/Jaimepas77))

3.1.0

Features

* Add `--search` option to find tldr pages based on keywords (thanks [gotlougit](https://github.com/gotlougit))
* Specify support for v1.5 of the [tldr client specification](https://github.com/tldr-pages/tldr/blob/main/CLIENT-SPECIFICATION.md)

Bugfixes

* Command names are lowercased before searching for page
* Fix color printing for tokens that end with curly braces

3.0.0

Breaking

We have moved from [argcomplete](https://github.com/kislyuk/argcomplete) to [shtab](https://github.com/iterative/shtab) for
providing shell completions. This library is more efficient on doing tab completion, avoiding costly time it takes for the python
intrepreter to parse tldr to get options.

See [Readmeautocomplete](https://github.com/tldr-pages/tldr-python-client#autocomplete) for details on setting up shtab. Please
see the [argcomplete README](https://github.com/kislyuk/argcomplete) for details on where to look to remove its provided completions.

Features

* __breaking__ Move to shtab for tab completion support (thanks [casperdcl](https://github.com/casperdcl))
* Change default max cache age from 1 day to 7 days, can get prior behavior by setting the `TLDR_CACHE_MAX_AGE` environment variable
* Install manpage in pypi package
* Add option to print raw markdown (thanks [dadav](https://github.com/dadav))
* Support Python 3.10

2.0.0

Features

* __breaking__ Drop support for Python 3.5 (thanks [nebnola](https://github.com/nebnola))
* Allow overriding system language using `TLDR_LANGUAGE` environment variable (thanks [nebnola](https://github.com/nebnola))

Fixes

* Improve wording of missing page error message (thanks [CleanMachine1](https://github.com/CleanMachine1))

Page 1 of 4

© 2025 Safety CLI Cybersecurity Inc. All Rights Reserved.