{"id":13337881,"url":"https://github.com/tldrx/tldrx","last_synced_at":"2025-03-11T07:31:37.857Z","repository":{"id":62445047,"uuid":"474227234","full_name":"tldrx/tldrx","owner":"tldrx","description":"A TLDR client with extra ❤ custom private pages.","archived":false,"fork":false,"pushed_at":"2022-12-03T13:30:22.000Z","size":186,"stargazers_count":5,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-07-11T20:29:36.935Z","etag":null,"topics":["rust","tldr","tldr-client"],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tldrx.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE-MIT","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-03-26T03:07:11.000Z","updated_at":"2024-02-26T14:47:06.000Z","dependencies_parsed_at":"2023-01-23T05:01:19.034Z","dependency_job_id":null,"html_url":"https://github.com/tldrx/tldrx","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tldrx%2Ftldrx","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tldrx%2Ftldrx/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tldrx%2Ftldrx/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tldrx%2Ftldrx/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tldrx","download_url":"https://codeload.github.com/tldrx/tldrx/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":213069724,"owners_count":15532846,"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":["rust","tldr","tldr-client"],"created_at":"2024-07-29T19:15:10.434Z","updated_at":"2024-10-23T16:31:38.974Z","avatar_url":"https://github.com/tldrx.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch1\u003eTLDRx\u003c/h1\u003e\n\n\u003cp\u003e\n  \u003ca href=\"https://github.com/tldrx/tldrx/actions/workflows/ci.yml\"\u003e\u003cimg alt=\"GitHub CI\" src=\"https://github.com/tldrx/tldrx/actions/workflows/ci.yml/badge.svg\"\u003e\u003c/a\u003e\n  \u003ca href=\"https://github.com/tldrx/tldrx#license\"\u003e\u003cimg alt=\"License\" src=\"https://img.shields.io/crates/l/tldrx\"\u003e\u003c/a\u003e\n  \u003ca href=\"https://crates.io/crates/tldrx\"\u003e\u003cimg alt=\"License\" src=\"https://img.shields.io/crates/v/tldrx\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n\u003cp\u003eEnglish | \u003ca href=\"README.zh.md\"\u003e简体中文\u003c/a\u003e\u003c/p\u003e\n\n\u003cp\u003e\n  \u003cimg src=\"docs/screenshot.png\" alt=\"screenshot\" width=\"582\"\u003e\n\u003c/p\u003e\n\n\n## Features\n\n- [x] Support private tldr pages repo. \n- [x] Support editing private tldr pages.\n- [x] Show pages with platform info attached.\n- [x] Adheres to [tldr-pages client specification](https://github.com/tldr-pages/tldr/blob/main/CLIENT-SPECIFICATION.md).[^1]\n- [x] Offline caching official tldr pages repo.\n- [x] Configurable official tldr pages archive download link.\n- [x] Honor `HTTP_PROXY` and `HTTPS_PROXY` system proxies (handy for regulation area).\n- [x] Advanced configuration: color style, platform, editor...\n- [x] Support [new tldr pages syntax](https://github.com/tldr-pages/tldr/pull/958).[^2]\n\n\n## Usages\n\nShow pages for `git commit`:\n\n    tldrx git commit\n\nUpdate local cache(Required for the first time before showing official pages):\n\n    tldrx --update\n\nEdit or create private page for `git commit`:\n\n    tldrx -e git commit\n\nFor more:\n\n    tldrx --help\n\n\n## Installation\n\nAssume you have rust cargo installed:\n\n    cargo install tldrx\n\n## Benchmarks\n\nBenchmarked in a Docker container([Dockerfile](benches/Dockerfile)) on a GitHub Acions machine([2C-7GB-SSD]) \nusing `hyperfine` with 100 round against each client. \n\n| Client [2022-10-05]                                          | Build Flags      |  Mean [ms] | Min [ms] | Max [ms] |    Relative |\n| :----------------------------------------------------------- | :--------------- | ---------: | -------: | -------: | ----------: |\n| [outfieldr](https://gitlab.com/ve-nt/outfieldr)              | `-Drelease-safe` | 23.0 ± 2.6 |     18.5 |     36.6 |        1.00 |\n| [tldrx](https://github.com/tldrx/tldrx)                      | `--release`      | 30.2 ± 3.0 |     25.5 |     43.0 | 1.32 ± 0.20 |\n| [tealdeer](https://github.com/dbrgn/tealdeer)                | `--release`      | 32.9 ± 3.5 |     27.3 |     45.4 | 1.43 ± 0.22 |\n| [tldr c client](https://github.com/tldr-pages/tldr-c-client) | `-O3`            | 76.8 ± 5.8 |     63.8 |    106.4 | 3.34 ± 0.45 |\n\nP.S. Studies shows that response within `100ms` time frame human brain would treat it as an instantaneous reaction[^3][^4].\nRecommendation here is chose a client base on the provided features that suits you while the response time is within `100ms`.\nIf you want more performance, build `tldrx` as a static binary that would reduce the dynamic library load time.\n\n\n\n## Configuration\n\nThe location of the configuration file `.tldrxrc` varies by platform\n\n- Linux `~/.tldrxrc`\n- MacOS `~/.tldrxrc`\n- Windows `%USERPROFILE%\\.tldrxrc`\n\nCreate one if not there.\n\n### Template `.tldrxrc` \n\n- `[-]` option Optional.\n- `\u003c+\u003e` option Required only if that feature you want.\n\n```toml\n\n# [-] Path to cache official tldr-pages\nofficial_pages_dir = \"/path/to/official/tldr-pages\"\n\n# \u003c+\u003e Path to private tldr-pages\nprivate_pages_dir = \"/path/to/private/tldr-pages\"\n\n# [-] Show pages for the given platform. Option: [osx | linux | ...]\nplatform = \"linux\"\n\n# [-] Colorlize the output pages Choice: [auto | on | off]\nsytled = \"auto\"\n\n# [-] Editor to edit private tldr-pages\neditor = \"vi\"\n\n```\n\n\n## License\n\nThis project is dual-licensed under [MIT](LICENSE-MIT) license and [MulanPSL-2.0](LICENSE-MulanPSL) license.\nYou can freely choose one or the other that suits you.\n\n\n\n[^1]: Use `tldrx` instead of `tldr`.\n\n[^2]: The new syntax for tldr-pages is an experimental RFC.\n\n[^3]: https://www.nngroup.com/articles/response-times-3-important-limits\n[^4]: https://en.wikipedia.org/wiki/Time_perception\n\n\n[2C-7GB-SSD]: https://docs.github.com/en/actions/using-github-hosted-runners/about-github-hosted-runners#supported-runners-and-hardware-resources\n[2022-10-05]: https://github.com/tldrx/tldrx/actions/runs/3188985781/jobs/5202273436","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftldrx%2Ftldrx","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftldrx%2Ftldrx","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftldrx%2Ftldrx/lists"}