Tealdeer Versions Save

A very fast implementation of tldr in Rust.

v1.6.1

1 year ago

Tealdeer version 1.6.1.

For the full changelog, see https://github.com/dbrgn/tealdeer/blob/main/CHANGELOG.md.

Binaries were generated automatically in CI, and are therefore unsigned. For a fully trusted release, please build from source.

v1.6.0

1 year ago

It's been 9 months since the last release already! This is not a huge update feature-wise, but it still contains a few nice new improvements and a few bugfixes, contributed by 11 different people. The most important new feature is probably the option to override the cache directory through the config file. The TEALDEER_CACHE_DIR env variable is now deprecated.

A note to packagers: Shell completions have been moved to the completion/ subdirectory! Packaging scripts might need to be updated.

For the full changelog, see https://github.com/dbrgn/tealdeer/blob/main/CHANGELOG.md.

Binaries were generated automatically in CI, and are therefore unsigned. For a fully trusted release, please build from source.

v1.5.0

2 years ago

This is quite a big release with many new features. In the 15 months since the last release, 59 pull requests from 16 different contributors were merged!

The highlights:

  • Custom pages and patches: You can now create your own local-only tldr pages. But not just that, you can also extend existing upstream pages with your own examples. For more details, see the docs.
  • Change argument parsing from docopt to clap: We replaced docopt.rs as argument parsing library with clap v3, resulting in almost 1 MiB smaller binaries and a 22% speed increase when rendering a tldr page.
  • Multi-language support: You can now override the language with -L/--language.
  • A new --show-paths command: By running tldr --show-paths, you can list the currently used config dir, cache dir, upstream pages dir and custom pages dir.
  • Compliance with the tldr client spec v1.5: We renamed -o/--os to -p/--platform and implemented transparent lowercasing of the page names.
  • Docs: The README based documentation has reached its limits. There are now new mdbook based docs over at dbrgn.github.io/tealdeer/, we hope these make using tealdeer easier. Of course, documentation improvements are welcome! Also, if you're confused about how to use a certain feature, feel free to open an issue, this way we can improve the docs.

Note that the MSRV (Minimal Supported Rust Version) of the project changed:

When publishing a Tealdeer release, the Rust version required to build it should be stable for at least a month.

For the full changelog, see https://github.com/dbrgn/tealdeer/blob/main/CHANGELOG.md.

Binaries were generated automatically in CI, and are therefore unsigned. For a fully trusted release, please build from source.

v1.4.1

3 years ago

This release fixes the zsh completion file. No new functionality since 1.4.0.

For the full changelog, see https://github.com/dbrgn/tealdeer/blob/master/CHANGELOG.md.

The binaries have been statically cross compiled using the musl libc. Currently Linux-only.

Detached GPG signatures are provided for every binary, they are signed with this key: https://keybase.io/dbrgn (alternative download: https://dbrgn.ch/3578F667F2F3A5FA.txt)

This release requires at least Rust 1.39 to build.

v1.4.0

3 years ago

Main new features: Configurable automatic cache updates, improved color detection.

For the full changelog, see https://github.com/dbrgn/tealdeer/blob/master/CHANGELOG.md.

The binaries have been statically cross compiled using the musl libc. Currently Linux-only.

Detached GPG signatures are provided for every binary, they are signed with this key: https://keybase.io/dbrgn (alternative download: https://dbrgn.ch/3578F667F2F3A5FA.txt)

This release requires at least Rust 1.39 to build.

v1.3.0

4 years ago

Main new features: Compact output mode, raw rendering mode, Zsh autocompletion.

For the full changelog, see https://github.com/dbrgn/tealdeer/blob/master/CHANGELOG.md.

The binaries have been statically cross compiled using the musl libc. Currently Linux-only.

Detached GPG signatures are provided for every binary, they are signed with this key: https://keybase.io/dbrgn (alternative download: https://dbrgn.ch/3578F667F2F3A5FA.txt)

This release requires at least Rust 1.39 to build.

v1.2.0

4 years ago

Main new feature: Windows support and pager support.

For the full changelog, see https://github.com/dbrgn/tealdeer/blob/master/CHANGELOG.md.

The binaries have been cross compiled using the musl libc. They are a bit experimental, please let me know if you experience issues with them! Currently Linux-only, support for other platforms is planned.

Detached GPG signatures are provided for every binary, they are signed with this key: https://keybase.io/dbrgn (alternative download: https://dbrgn.ch/3578F667F2F3A5FA.txt)

v1.1.0

5 years ago

Main new feature in this release: Support for a configuration file and for customizing the style/colors (without any noticeable slowdown), thanks @Voultapher for implementing this! For a full list of changes, see the CHANGELOG.

The binaries have been cross compiled using the musl libc. They are a bit experimental, please let me know if you experience issues with them! Currently Linux-only, support for other platforms is planned.

Detached GPG signatures are provided for every binary, they are signed with this key: https://keybase.io/dbrgn (alternative download: https://dbrgn.ch/3578F667F2F3A5FA.txt)

v1.0.0

6 years ago

tealdeer has been quite stable for a while now, so here's the 1.0.0 release!

The binaries have been cross compiled using the musl libc. They are a bit experimental, please let me know if you experience issues with them! Currently Linux-only, support for other platforms is planned.

Detached GPG signatures are provided for every binary, they are signed with this key: https://keybase.io/dbrgn (alternative download: https://dbrgn.ch/3578F667F2F3A5FA.txt)