Skip to content

Conversation

@renovate
Copy link
Contributor

@renovate renovate bot commented Oct 3, 2024

This PR contains the following updates:

Package Update Change
dbrgn/tealdeer minor v1.6.1v1.8.1

Release Notes

dbrgn/tealdeer (dbrgn/tealdeer)

v1.8.1

Compare Source

This patch release tweaks the enabled features for ureq, the library we use to
perform HTTP requests when updating the cache. In particular, support for socks
proxies is now enabled.

Changes:
  • [added] Enable ureq's socks-proxy feature ([#​451])

v1.8.0

Compare Source

One year and one day have passed since tealdeer version 1.7.0 was released, so
it's time for an update! Tealdeer 1.8 comes with a complete rewrite of the page
cache and contains many long awaited improvements around it.

Firstly, tealdeer now supports language-specific downloads. This means that only
the pages matching the configured languages are downloaded when updating the
cache. The languages used for searching pages can be configured separately to
the ones used for updating, so it is possible to download pages in languages
that are not usually queried.

Next to configuring which languages are used for searching, it is now also
possible to specify which platforms are used in the config file. Importantly,
the default behavior for page search has changed so that all platforms are
searched if no page is found for the platform that tealdeer is running on. To
restore the behavior of tealdeer 1.7, users should set

[search]
platforms = ["current", "common"]

in their config file.

Coming back to updating, the default build configuration of tealdeer now
includes multiple TLS backends. This means that tealdeer does not have to be
rebuilt to try out a different TLS backend. The used backend can be chosen in
the config file. By default, tealdeer comes with support for rustls using webpki
certificates or system certificates. Native TLS is supported, but not enabled by
default to avoid build troubles with OpenSSL and musl.

For details, please refer to the [user documentation].

Changes:
  • [added] Resolve paths in config [directories] relative to the config directory ([#​306])
  • [added] Add common platform to CLI ([#​401])
  • [added] Add configuration option for archive_source ([#​337])
  • [added] Allows configuring TLS backend ([#​386])
  • [added] Add args: --edit-page and --edit-patch ([#​388])
  • [added] Add an option to specify a custom config file to be used ([#​422])
  • [added] Upload binaries from build step as artifact ([#​423])
  • [added] Add search.languages and updates.download_languages settings ([#​430])
  • [added] Add search.platforms config option and search all platforms by default ([#​435])
  • [added] Add display.show_title option to display command titles in output ([#​439])
  • [chore] Various test improvements ([#​399])
  • [chore] Add tests for osx/macos alias ([#​407])
  • [chore] Move most of main to try_main ([#​400])
  • [chore] Only create a single temporary directory in integration tests ([#​411])
  • [chore] Replace reqwest with ureq ([#​417])
  • [chore] Introduce Language struct ([#​425])
  • [chore] Cache rewrite ([#​416])
  • [chore] Allow references in Config ([#​429])
  • [docs] Highlight code examples in user docs ([#​440])
  • [removed] Remove native-tls from default feature set ([#​436])
Contributors to this version:

Thanks!

Notes to package maintainers
  1. The MSRV has been bumped to 1.85.
  2. Consider whether you want to include the native-tls feature in your build
    of tealdeer. The feature is disabled for the binaries in the GitHub release
    because we target musl, but it might work out of the box for your
    distribution.
  3. We have added the ignore-online-tests feature to automatically mark all
    tests that require an internet connection as skipped, so you can use this
    feature instead of maintaining a list of these tests yourself.

v1.7.2

Compare Source

This patch release updates the zip dependency to mitigate a potential security
vulnerability. A successful attack against tealdeer users would require
manipulation of the tldr pages archive downloaded during an update. As the
archive is downloaded from a trusted source (the tldr-pages organization), it
seems very unlikely that running a version of tealdeer prior to 1.7.2 poses a
security risk. Nevertheless, it cannot hurt to rule out any chance of an attack
by updating tealdeer to version 1.7.2.

For more details, please see GHSA-94vh-gphv-8pm8.

  • [security] Require zip >= 2.3.0
  • [chore] Run CI on backport branches and on dispatch

v1.7.1

Compare Source

This patch release updates the yansi dependency to version 1, so that the
previous versions of yansi can be removed from the package sets of Linux
distributions. This change should not impact the behavior of tealdeer.

Changes:
  • [chore] Upgrade yansi: 0.5.1 -> 1.0.1 ([#​389])
Contributors to this version:

Thanks!

v1.7.0

Compare Source

It's been 24 months since the last release, time for tealdeer 1.7.0! Thanks to
16 individual contributors, a few nice changes and features are included in
this release.

One change is that you can query multiple platforms at once. For example:

tldr --platform openbsd --platform linux df

This will show the df page for OpenBSD (if available), followed by Linux (if
available), with fallback to the current platform on which tealdeer runs.

What's that openbsd thing up there? Yes, there's now support for the BSD
platforms freebsd, netbsd and openbsd
.

And since we're already talking about platform support: Our binary releases
now include builds for ARM64 (aka aarch64) on macOS (Apple Silicon, M1/M2/M3)
and Linux
. (Keep in mind that binary releases are generated in CI and are
unsigned. For a trusted build, please compile from source.)

There's also a breaking change for the folks using custom pages and
patches
: These
files now use a .md extension. Old files will continue to work, but will
result a deprecation warning being printed when used.

On a personal note, this will be the last release from me
(Danilo) as primary maintainer of tealdeer. For
details, see #​376.

Changes:
  • [added] Allow querying multiple platforms ([#​300])
  • [added] Add BSD platform support ([#​354])
  • [added] Allow building with native-tls in addition to rustls ([#​303])
  • [changed] Change custom page files to use a .md file extension ([#​322])
  • [changed] Update to clap v4 for doing command line parsing ([#​298])
  • [changed] Performance optimization in LineIterator ([#​314])
  • [changed] Performance optimizations by tweaking Cargo flags ([#​355])
  • [changed] Include completions in published crate ([#​333])
  • [changed] Minimal supported Rust version is now 1.75 ([#​298])
  • [fixed] Fix bash/zsh/fish completions when cache is empty ([#​327], [#​331])
  • [docs] Publish docs only when tagging a release ([#​362])
  • [docs] List Scoop and Debian packages ([#​305], [#​315])
  • [docs] Add "Tips and Tricks" chapter to user manual ([#​342])
  • [docs] Various docs improvements ([#​293])
  • [chore] Improvements to CI workflows ([#​324])
  • [chore] Update Cargo.toml license field following SPDX 2.1 ([#​336])
  • [chore] Dependency updates
Contributors to this version:

Thanks!


Configuration

📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 Automerge: Enabled.

Rebasing: Whenever PR is behind base branch, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.


  • If you want to rebase/retry this PR, check this box

This PR was generated by Mend Renovate. View the repository job log.

@renovate renovate bot added the dependencies label Oct 3, 2024
@renovate renovate bot force-pushed the renovate/dbrgn-tealdeer-1.x branch from 5971a01 to 76d83dd Compare November 14, 2024 21:36
@renovate renovate bot changed the title Update dependency dbrgn/tealdeer to v1.7.0 Update dependency dbrgn/tealdeer to v1.7.1 Nov 14, 2024
@renovate renovate bot force-pushed the renovate/dbrgn-tealdeer-1.x branch from 76d83dd to cc70c28 Compare March 18, 2025 23:25
@renovate renovate bot changed the title Update dependency dbrgn/tealdeer to v1.7.1 Update dependency dbrgn/tealdeer to v1.7.2 Mar 18, 2025
@renovate renovate bot force-pushed the renovate/dbrgn-tealdeer-1.x branch from cc70c28 to 5f78a62 Compare October 3, 2025 21:26
@renovate renovate bot changed the title Update dependency dbrgn/tealdeer to v1.7.2 Update dependency dbrgn/tealdeer to v1.8.0 Oct 3, 2025
@renovate renovate bot force-pushed the renovate/dbrgn-tealdeer-1.x branch from 5f78a62 to b0c7072 Compare November 11, 2025 22:58
@renovate renovate bot changed the title Update dependency dbrgn/tealdeer to v1.8.0 Update dependency dbrgn/tealdeer to v1.8.1 Nov 11, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant