{"id":13711782,"url":"https://dbrgn.github.io/tealdeer","last_synced_at":"2025-05-06T21:32:10.008Z","repository":{"id":37612163,"uuid":"48739367","full_name":"tealdeer-rs/tealdeer","owner":"tealdeer-rs","description":"A very fast implementation of tldr in Rust.","archived":false,"fork":false,"pushed_at":"2025-03-21T23:26:44.000Z","size":2612,"stargazers_count":5005,"open_issues_count":29,"forks_count":131,"subscribers_count":18,"default_branch":"main","last_synced_at":"2025-05-06T21:26:50.621Z","etag":null,"topics":["hacktoberfest","rust","tldr"],"latest_commit_sha":null,"homepage":"https://tealdeer-rs.github.io/tealdeer/","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tealdeer-rs.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE-APACHE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2015-12-29T09:23:05.000Z","updated_at":"2025-05-06T21:13:54.000Z","dependencies_parsed_at":"2022-07-11T23:16:15.162Z","dependency_job_id":"f4210f31-7fd8-4ac7-a8c8-527d02b98a1b","html_url":"https://github.com/tealdeer-rs/tealdeer","commit_stats":{"total_commits":445,"total_committers":72,"mean_commits":6.180555555555555,"dds":"0.31235955056179776","last_synced_commit":"1d9153e37e131ca56071213ba40ec01b16158ebf"},"previous_names":["tealdeer-rs/tealdeer","dbrgn/tealdeer"],"tags_count":18,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tealdeer-rs%2Ftealdeer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tealdeer-rs%2Ftealdeer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tealdeer-rs%2Ftealdeer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tealdeer-rs%2Ftealdeer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tealdeer-rs","download_url":"https://codeload.github.com/tealdeer-rs/tealdeer/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252772135,"owners_count":21801861,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["hacktoberfest","rust","tldr"],"created_at":"2024-08-02T23:01:11.560Z","updated_at":"2025-05-06T21:32:09.932Z","avatar_url":"https://github.com/tealdeer-rs.png","language":"Rust","funding_links":[],"categories":["Command line - Linux"],"sub_categories":["Learning resources"],"readme":"# tealdeer\n\n![teal deer](docs/src/deer.png)\n\n|Crate|CI (Linux/macOS/Windows)|\n|:---:|:---:|\n|[![Crates.io][crates-io-badge]][crates-io]|[![GitHub CI][github-actions-badge]][github-actions]|\n\nA very fast implementation of [tldr](https://github.com/tldr-pages/tldr) in\nRust: Simplified, example based and community-driven man pages.\n\n\u003cimg src=\"docs/src/screenshot-default.png\" alt=\"Screenshot of tldr command\" width=\"600\"\u003e\n\nIf you pronounce \"tldr\" in English, it sounds somewhat like \"tealdeer\". Hence the project name :)\n\nIn case you're in a hurry and just want to quickly try tealdeer, you can find static\nbinaries on the [GitHub releases page](https://github.com/tealdeer-rs/tealdeer/releases/)!\n\n\n## Docs (Installing, Usage, Configuration)\n\nUser documentation is available at \u003chttps://tealdeer-rs.github.io/tealdeer/\u003e!\n\nThe docs are generated using [mdbook](https://rust-lang.github.io/mdBook/index.html).\nThey can be edited through the markdown files in the `docs/src/` directory.\n\n\n## Goals\n\nHigh level project goals:\n\n- [x] Download and cache pages\n- [x] Don't require a network connection for anything besides updating the cache\n- [x] Command line interface similar or equivalent to the [NodeJS client][node-gh]\n- [x] Comply with the [tldr client specification][client-spec]\n- [x] Advanced highlighting and configuration\n- [x] Be fast\n\nA tool like `tldr` should be as frictionless as possible to use and show the\noutput as fast as possible.\n\nWe think that `tealdeer` reaches these goals. We put together a (more or less)\nreproducible benchmark that compiles a handful of clients from source and\nmeasures the execution times on a cold disk cache. The benchmarking is run in a\nDocker container using sharkdp's [`hyperfine`][hyperfine-gh]\n([Dockerfile][benchmark-dockerfile]).\n\n| Client (50 runs, 17.10.2021)      | Programming Language | Mean in ms | Deviation in ms | Comments                |\n| :---:                             | :---:                | :---:      | :---:           | :---:                   |\n| [`outfieldr`][outfieldr-gh]       | Zig                  | 9.1        | 0.5             | no user configuration   |\n| `tealdeer`                        | Rust                 | 13.2       | 0.5             |                         |\n| [`fast-tldr`][fast-tldr-gh]       | Haskell              | 17.0       | 0.6             | no example highlighting |\n| [`tldr-hs`][hs-gh]                | Haskell              | 25.1       | 0.5             | no example highlighting |\n| [`tldr-bash`][bash-gh]            | Bash                 | 30.0       | 0.8             |                         |\n| [`tldr-c`][c-gh]                  | C                    | 38.4       | 1.0             |                         |\n| [`tldr-python-client`][python-gh] | Python               | 87.0       | 2.4             |                         |\n| [`tldr-node-client`][node-gh]     | JavaScript / NodeJS  | 407.1      | 12.9            |                         |\n\nAs you can see, `tealdeer` is one of the fastest of the tested clients.\nHowever, we strive for useful features and code quality over raw performance,\neven if that means that we don't come out on top in this friendly competition.\nThat said, we are still optimizing the code, for example when the `outfieldr`\ndevelopers [suggested to switch][outfieldr-comment-tls] to a native TLS\nimplementation instead of the native libraries.\n\n## Development\n\nCreating a debug build with logging enabled:\n\n    $ cargo build --features logging\n\nRelease build without logging:\n\n    $ cargo build --release\n\nTo enable the log output, set the `RUST_LOG` env variable:\n\n    $ export RUST_LOG=tldr=debug\n\nTo run tests:\n\n    $ cargo test\n\nTo run lints:\n\n    $ rustup component add clippy\n    $ cargo clean \u0026\u0026 cargo clippy\n\n\n## MSRV (Minimally Supported Rust Version)\n\nWhen publishing a tealdeer release, the Rust version required to build it\nshould be stable for at least a month.\n\n\n## License\n\nLicensed under either of\n\n * Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or\n   http://www.apache.org/licenses/LICENSE-2.0)\n * MIT license ([LICENSE-MIT](LICENSE-MIT) or\n   http://opensource.org/licenses/MIT) at your option.\n\n\n### Contribution\n\nUnless you explicitly state otherwise, any contribution intentionally submitted\nfor inclusion in the work by you, as defined in the Apache-2.0 license, shall\nbe dual licensed as above, without any additional terms or conditions.\n\nThanks to @severen for coming up with the name \"tealdeer\"!\n\n\n[node-gh]: https://github.com/tldr-pages/tldr-node-client\n[c-gh]: https://github.com/tldr-pages/tldr-c-client\n[hs-gh]: https://github.com/psibi/tldr-hs\n[fast-tldr-gh]: https://github.com/gutjuri/fast-tldr\n[bash-gh]: https://4e4.win/tldr\n[outfieldr-gh]: https://gitlab.com/ve-nt/outfieldr\n[python-gh]: https://github.com/tldr-pages/tldr-python-client\n\n[benchmark-dockerfile]: https://github.com/tealdeer-rs/tealdeer/blob/main/benchmarks/Dockerfile\n[client-spec]: https://github.com/tldr-pages/tldr/blob/main/CLIENT-SPECIFICATION.md\n[hyperfine-gh]: https://github.com/sharkdp/hyperfine\n[outfieldr-comment-tls]: https://github.com/tealdeer-rs/tealdeer/issues/129#issuecomment-833596765\n\n\u003c!-- Badges --\u003e\n[github-actions]: https://github.com/tealdeer-rs/tealdeer/actions?query=branch%3Amain\n[github-actions-badge]: https://github.com/tealdeer-rs/tealdeer/actions/workflows/ci.yml/badge.svg?branch=main\n[crates-io]: https://crates.io/crates/tealdeer\n[crates-io-badge]: https://img.shields.io/crates/v/tealdeer.svg\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/dbrgn.github.io%2Ftealdeer","html_url":"https://awesome.ecosyste.ms/projects/dbrgn.github.io%2Ftealdeer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/dbrgn.github.io%2Ftealdeer/lists"}