Downloads:
47
Downloads of v 1.6.0:
29
Last Update:
11 Jul 2024
Package Maintainer(s):
Software Author(s):
- Danilo Bargen
Tags:
man oss docs man-pages documentation tldr cli command-line foss- Software Specific:
- Software Site
- Software Source
- Software License
- Software Docs
- Software Issues
- Package Specific:
- Package Source
- Package outdated?
- Package broken?
- Contact Maintainers
- Contact Site Admins
- Software Vendor?
- Report Abuse
- Download
tealdeer
- 1
- 2
- 3
1.6.0 | Updated: 11 Jul 2024
- Software Specific:
- Software Site
- Software Source
- Software License
- Software Docs
- Software Issues
- Package Specific:
- Package Source
- Package outdated?
- Package broken?
- Contact Maintainers
- Contact Site Admins
- Software Vendor?
- Report Abuse
- Download
Downloads:
47
Downloads of v 1.6.0:
29
Maintainer(s):
Software Author(s):
- Danilo Bargen
tealdeer 1.6.0
Legal Disclaimer: Neither this package nor Chocolatey Software, Inc. are affiliated with or endorsed by Danilo Bargen. The inclusion of Danilo Bargen trademark(s), if any, upon this webpage is solely to identify Danilo Bargen goods or services and not for commercial purposes.
- 1
- 2
- 3
Some Checks Have Failed or Are Not Yet Complete
Not All Tests Have Passed
Deployment Method: Individual Install, Upgrade, & Uninstall
To install tealdeer, run the following command from the command line or from PowerShell:
To upgrade tealdeer, run the following command from the command line or from PowerShell:
To uninstall tealdeer, run the following command from the command line or from PowerShell:
Deployment Method:
This applies to both open source and commercial editions of Chocolatey.
1. Enter Your Internal Repository Url
(this should look similar to https://community.chocolatey.org/api/v2/)
2. Setup Your Environment
1. Ensure you are set for organizational deployment
Please see the organizational deployment guide
2. Get the package into your environment
Option 1: Cached Package (Unreliable, Requires Internet - Same As Community)-
Open Source or Commercial:
- Proxy Repository - Create a proxy nuget repository on Nexus, Artifactory Pro, or a proxy Chocolatey repository on ProGet. Point your upstream to https://community.chocolatey.org/api/v2/. Packages cache on first access automatically. Make sure your choco clients are using your proxy repository as a source and NOT the default community repository. See source command for more information.
- You can also just download the package and push it to a repository Download
-
Open Source
-
Download the package:
Download - Follow manual internalization instructions
-
-
Package Internalizer (C4B)
-
Run: (additional options)
choco download tealdeer --internalize --source=https://community.chocolatey.org/api/v2/
-
For package and dependencies run:
choco push --source="'INTERNAL REPO URL'"
- Automate package internalization
-
Run: (additional options)
3. Copy Your Script
choco upgrade tealdeer -y --source="'INTERNAL REPO URL'" [other options]
See options you can pass to upgrade.
See best practices for scripting.
Add this to a PowerShell script or use a Batch script with tools and in places where you are calling directly to Chocolatey. If you are integrating, keep in mind enhanced exit codes.
If you do use a PowerShell script, use the following to ensure bad exit codes are shown as failures:
choco upgrade tealdeer -y --source="'INTERNAL REPO URL'"
$exitCode = $LASTEXITCODE
Write-Verbose "Exit code was $exitCode"
$validExitCodes = @(0, 1605, 1614, 1641, 3010)
if ($validExitCodes -contains $exitCode) {
Exit 0
}
Exit $exitCode
- name: Install tealdeer
win_chocolatey:
name: tealdeer
version: '1.6.0'
source: INTERNAL REPO URL
state: present
See docs at https://docs.ansible.com/ansible/latest/modules/win_chocolatey_module.html.
chocolatey_package 'tealdeer' do
action :install
source 'INTERNAL REPO URL'
version '1.6.0'
end
See docs at https://docs.chef.io/resource_chocolatey_package.html.
cChocoPackageInstaller tealdeer
{
Name = "tealdeer"
Version = "1.6.0"
Source = "INTERNAL REPO URL"
}
Requires cChoco DSC Resource. See docs at https://github.com/chocolatey/cChoco.
package { 'tealdeer':
ensure => '1.6.0',
provider => 'chocolatey',
source => 'INTERNAL REPO URL',
}
Requires Puppet Chocolatey Provider module. See docs at https://forge.puppet.com/puppetlabs/chocolatey.
4. If applicable - Chocolatey configuration/installation
See infrastructure management matrix for Chocolatey configuration elements and examples.
This package was approved by moderator TheCakeIsNaOH on 13 Jul 2024.
Crate | CI (Linux/macOS/Windows) |
---|---|
[![Crates.io][crates-io-badge]][crates-io] | [![GitHub CI][github-actions-badge]][github-actions] |
A very fast implementation of tldr in
Rust: Simplified, example based and community-driven man pages.
If you pronounce "tldr" in English, it sounds somewhat like "tealdeer". Hence the project name :)
Goals
High level project goals:
- [x] Download and cache pages
- [x] Don't require a network connection for anything besides updating the cache
- [x] Command line interface similar or equivalent to the NodeJS client
- [x] Comply with the tldr client specification
- [x] Advanced highlighting and configuration
- [x] Be fast
A tool like tldr
should be as frictionless as possible to use and show the
output as fast as possible.
We think that tealdeer
reaches these goals. We put together a (more or less)
reproducible benchmark that compiles a handful of clients from source and
measures the execution times on a cold disk cache. The benchmarking is run in a
Docker container using sharkdp's hyperfine
(Dockerfile).
Client (50 runs, 17.10.2021) | Programming Language | Mean in ms | Deviation in ms | Comments |
---|---|---|---|---|
outfieldr |
Zig | 9.1 | 0.5 | no user configuration |
tealdeer |
Rust | 13.2 | 0.5 | |
fast-tldr |
Haskell | 17.0 | 0.6 | no example highlighting |
tldr-hs |
Haskell | 25.1 | 0.5 | no example highlighting |
tldr-bash |
Bash | 30.0 | 0.8 | |
tldr-c |
C | 38.4 | 1.0 | |
tldr-python-client |
Python | 87.0 | 2.4 | |
tldr-node-client |
JavaScript / NodeJS | 407.1 | 12.9 |
<!-- Badges -->
[github-actions]: https://github.com/dbrgn/tealdeer/actions?query=branch%3Amain
[github-actions-badge]: https://github.com/dbrgn/tealdeer/actions/workflows/ci.yml/badge.svg?branch=main
[crates-io]: https://crates.io/crates/tealdeer
[crates-io-badge]: https://img.shields.io/crates/v/tealdeer.svg
From: https://github.com/dbrgn/tealdeer/blob/v1.6.0/LICENSE-MIT
LICENSE
Copyright (C) 2015-2021 Danilo Bargen and contributors
Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
of the Software, and to permit persons to whom the Software is furnished to do
so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
VERIFICATION
Verification is intended to assist the Chocolatey moderators and community
in verifying that this package's contents are trustworthy.
Package can be verified like this:
1. Go to https://github.com/dbrgn/tealdeer/releases/tag/v1.6.0, and download from there.
x86_64: https://github.com/dbrgn/tealdeer/releases/download/v1.6.0/tealdeer-windows-x86_64-msvc.exe
to download the ZIP archive and extract the executables. You may wish to rename one of the files.
2. You can use one of the following methods to obtain the SHA512 checksum:
- Use powershell function 'Get-FileHash'
- Use Chocolatey utility 'checksum.exe'
checksum-x86_64: 6f2f4ddf4fb858e1ff529b542881af6a21ad6802da1e17cadbeca82d4ae6b1678c0f052b378db2ab1b82b8b8a54d8ce7aceb9d07125222578624b50e92e26097
File 'LICENSE.txt' obtained from:
https://github.com/dbrgn/tealdeer/blob/v1.6.0/LICENSE-MIT
md5: A419E3E145A7EEF208D84DC3D3E1E32D | sha1: EB1A61F35B185385B2CDCABF5BFFC2047DC0C38F | sha256: 05524C36ABA7214A2DB11E7970F9F50B438E739E87CA15788612F8ECDDB1EC83 | sha512: 6F2F4DDF4FB858E1FF529B542881AF6A21AD6802DA1E17CADBECA82D4AE6B1678C0F052B378DB2AB1B82B8B8A54D8CE7ACEB9D07125222578624B50E92E26097
Log in or click on link to see number of positives.
- tealdeer.1.6.0.nupkg (bd1c5cca23da) - ## / 68
- tealdeer.exe (05524c36aba7) - ## / 70
In cases where actual malware is found, the packages are subject to removal. Software sometimes has false positives. Moderators do not necessarily validate the safety of the underlying software, only that a package retrieves software from the official distribution point and/or validate embedded software against official distribution point (where distribution rights allow redistribution).
Chocolatey Pro provides runtime protection from possible malware.
Add to Builder | Version | Downloads | Last Updated | Status |
---|---|---|---|---|
tealdeer 1.6.0 | 29 | Thursday, July 11, 2024 | Approved | |
tealdeer 1.5.0 | 18 | Saturday, June 8, 2024 | Approved |
Copyright © 2015 - 2024, Danilo Bargen and contributors
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.
-
- vcredist140 (≥ 14.20.27508.1)
Ground Rules:
- This discussion is only about tealdeer and the tealdeer package. If you have feedback for Chocolatey, please contact the Google Group.
- This discussion will carry over multiple versions. If you have a comment about a particular version, please note that in your comments.
- The maintainers of this Chocolatey Package will be notified about new comments that are posted to this Disqus thread, however, it is NOT a guarantee that you will get a response. If you do not hear back from the maintainers after posting a message below, please follow up by using the link on the left side of this page or follow this link to contact maintainers. If you still hear nothing back, please follow the package triage process.
- Tell us what you love about the package or tealdeer, or tell us what needs improvement.
- Share your experiences with the package, or extra configuration or gotchas that you've found.
- If you use a url, the comment will be flagged for moderation until you've been whitelisted. Disqus moderated comments are approved on a weekly schedule if not sooner. It could take between 1-5 days for your comment to show up.