3.3.0

Changelog

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)
• Use pathlib instead of os.path (thanks @vitorhcl)
• Respect language settings when geting a list of commands (thanks @frenzymadness)
• Fix --search option (thanks @CleanMachine1)

Features

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

Chronological Changelog

• Fix typo in CHANGELOG.md by @waldyrious in #214
• Add support for Snap by @soumyaDghosh in #215
• CI: add Snap build to test.yml by @kbdharun in #216
• chore/ci: update runner to ubuntu-latest, minor fixes in comments by @kbdharun in #223
• fix: return str instead of list when executing tldr -l by @uunnxx in #222
• chore: bump actions, set dependabot config and default eol by @kbdharun in #225
• Bump actions/checkout from 3 to 4 by @dependabot in #226
• docs: add Repology badge to README by @vitorhcl in #227
• feat: add BSD platforms to OS_DIRECTORIES by @vitorhcl in #228
• feat: add --update to match client spec by @owenvoke in #232
• Fetch individual translation archives for cache (#217) by @SaurabhDRao in #218
• refactor: use pathlib instead of os.path by @vitorhcl in #224
• Respect language settings when geting a list of commands by @frenzymadness in #239
• tldr.py: fix search by @CleanMachine1 in #244
• Notice other versions of the same page by @Jaimepas77 in #208
• fix: update assets URL and create directories recursively by @vitorhcl in #245
• feat : update platforms list and the --platform option by @patricedenis in #246
• feat: add support for placeholder escaping, prep for release, misc by @kbdharun in #247

New Contributors

• @soumyaDghosh made their first contribution in #215
• @uunnxx made their first contribution in #222
• @dependabot made their first contribution in #226
• @vitorhcl made their first contribution in #227
• @SaurabhDRao made their first contribution in #218

Full Changelog: 3.2.0...3.3.0

3.2.0

Bugfixes

• Fix forcing color through termcolor
• Change non-word regex to be POSIX compliant (thanks @stevejbrown)
• Update pages source to use the main branch
• Add a timeout to the URL requests (thanks @Jaimepas77)

3.1.0

Features

• Add --search option to find tldr pages based on keywords (thanks @gotlougit)
• Specify support for v1.5 of the tldr client specification

Bugfixes

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

3.0.0

We have moved from argcomplete to 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 Readme#autocomplete for details on setting up shtab. Please
see the argcomplete README for details on where to look to remove its provided completions.

Features

• breaking Move to shtab for tab completion support (thanks @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)
• Support Python 3.10

2.0.0

Features

• breaking Drop support for Python 3.5 (thanks @nebnola)
• Allow overriding system language using TLDR_LANGUAGE environment variable (thanks @nebnola)

Fixes

• Improve wording of missing page error message (thanks @CleanMachine1)

1.2.1

Fixes

• Fallback to using linux as platform if no pages folder found for current platform

1.2.0

Features

• Set --help usage line to match node client (#149)
• Get remote resource only after all cache failed (#151) (thanks @ramwin)

1.1.0

• Add autocomplete and --list command (thanks @wcheang)
• Exit with code 1 when command not found (thanks @samuel-w)
• Always fall back to English for LANG / LANGUAGE env vars (thanks @columbarius)
• Check that cache directory exists on platform before using it