{"id":13607282,"url":"https://github.com/tldr-pages/tlrc","last_synced_at":"2025-04-12T11:31:57.566Z","repository":{"id":154251700,"uuid":"628100992","full_name":"tldr-pages/tlrc","owner":"tldr-pages","description":"A tldr client written in Rust","archived":false,"fork":false,"pushed_at":"2024-05-13T07:54:08.000Z","size":385,"stargazers_count":186,"open_issues_count":2,"forks_count":9,"subscribers_count":6,"default_branch":"main","last_synced_at":"2024-05-13T08:29:29.867Z","etag":null,"topics":["hacktoberfest","rust","tldr","tldr-pages"],"latest_commit_sha":null,"homepage":"http://tldr.sh/tlrc/","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/tldr-pages.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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},"funding":{"liberapay":"tldr-pages"}},"created_at":"2023-04-14T23:19:32.000Z","updated_at":"2024-07-29T13:40:35.391Z","dependencies_parsed_at":null,"dependency_job_id":"db675904-5a7d-4e61-b646-00a92e0a7bd6","html_url":"https://github.com/tldr-pages/tlrc","commit_stats":null,"previous_names":["tldr-pages/tlrc"],"tags_count":17,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tldr-pages%2Ftlrc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tldr-pages%2Ftlrc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tldr-pages%2Ftlrc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tldr-pages%2Ftlrc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tldr-pages","download_url":"https://codeload.github.com/tldr-pages/tlrc/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248560182,"owners_count":21124608,"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","tldr-pages"],"created_at":"2024-08-01T19:01:17.269Z","updated_at":"2025-04-12T11:31:57.560Z","avatar_url":"https://github.com/tldr-pages.png","language":"Rust","funding_links":["https://liberapay.com/tldr-pages"],"categories":["Tool","Rust","hacktoberfest","Dev-Utilities"],"sub_categories":["TUI Tool"],"readme":"\u003cdiv align=\"center\"\u003e\n\n# tlrc\n\nA [tldr](https://github.com/tldr-pages/tldr) client written in Rust.\n\n[![CI](https://img.shields.io/github/actions/workflow/status/tldr-pages/tlrc/ci.yml?label=CI\u0026logo=github\u0026labelColor=363a4f\u0026logoColor=d9e0ee)](https://github.com/tldr-pages/tlrc/actions/workflows/ci.yml)\n[![release](https://img.shields.io/github/v/release/tldr-pages/tlrc?\u0026logo=github\u0026color=cba6f7\u0026logoColor=d9e0ee\u0026labelColor=363a4f)][latest-release]\n[![crates.io](https://img.shields.io/crates/v/tlrc?\u0026logo=rust\u0026color=cba6f7\u0026logoColor=d9e0ee\u0026labelColor=363a4f)][crate]\n[![license](https://img.shields.io/github/license/tldr-pages/tlrc?color=b4befe\u0026labelColor=363a4f)](/LICENSE)\n\u003cbr\u003e\n[![github downloads](https://img.shields.io/github/downloads/tldr-pages/tlrc/total?logo=github\u0026color=94e2d5\u0026logoColor=d9e0ee\u0026labelColor=363a4f)][latest-release]\n[![matrix](https://img.shields.io/matrix/tldr-pages%3Amatrix.org?logo=matrix\u0026color=94e2d5\u0026logoColor=d9e0ee\u0026labelColor=363a4f\u0026label=tldr-pages%20matrix)](https://matrix.to/#/#tldr-pages:matrix.org)\n\n![screenshot](https://github.com/tldr-pages/tlrc/assets/126529524/daa76702-f437-4a99-adfb-7830a6f33eb9)\n\n\u003c/div\u003e\n\n## Installation\n\n\u003ca href=\"https://repology.org/project/tlrc/versions\"\u003e\n    \u003cimg src=\"https://repology.org/badge/vertical-allrepos/tlrc.svg?exclude_unsupported=1\" alt=\"Packaging status\" align=\"right\"\u003e\n\u003c/a\u003e\n\n### Linux/macOS using Homebrew\n\nInstall [tlrc](https://formulae.brew.sh/formula/tlrc) with Homebrew:\n\n```shell\nbrew install tlrc\n```\n\n### Linux/macOS using Nix\n\nInstall [tlrc](https://search.nixos.org/packages?channel=unstable\u0026show=tlrc) from nixpkgs.\n\n### Arch Linux\n\nInstall [tlrc](https://aur.archlinux.org/packages/tlrc) (from source) or [tlrc-bin](https://aur.archlinux.org/packages/tlrc-bin) (prebuilt) from the AUR.\n\n### openSUSE\n\nInstall [tlrc](https://software.opensuse.org/package/tlrc) with Zypper:\n\n```shell\nzypper install tlrc\n```\n\n### Windows using Winget\n\nInstall [tlrc](https://github.com/microsoft/winget-pkgs/tree/master/manifests/t/tldr-pages/tlrc) with Winget:\n\n```shell\nwinget install tldr-pages.tlrc\n```\n\n### Windows using Scoop\n\nInstall [tlrc](https://scoop.sh/#/apps?q=tlrc\u0026id=67f36cdb01b1573ed454af11605b7b8efc732dc7) with Scoop:\n\n```shell\nscoop install tlrc\n```\n\n### macOS using MacPorts\n\nInstall [tlrc](https://ports.macports.org/port/tlrc/details) with MacPorts:\n\n```shell\nport install tlrc\n```\n\n### NetBSD\n\nInstall [tlrc](https://ftp.netbsd.org/pub/NetBSD/NetBSD-current/pkgsrc/net/tlrc/index.html) with `pkgin`:\n\n```shell\npkgin install tlrc\n```\n\n### From crates.io\n\nTo build [tlrc][crate] from a source tarball, run:\n\n```shell\ncargo install tlrc --locked\n```\n\n\u003e [!NOTE]\n\u003e Shell completion files and the man page will not be installed that way.\n\n### From GitHub Releases\n\nYou can find prebuilt binaries [here][latest-release].\n\n## Usage\n\nSee `man tldr` or the [online manpage](https://tldr.sh/tlrc). For a brief description, you can also run:\n\n```shell\ntldr --help\n```\n\n## Configuration\n\nTlrc can be customized with a [TOML](https://toml.io) configuration file. To get the default path for your system, run:\n\n```shell\ntldr --config-path\n```\n\nTo generate a default config file, run:\n\n```shell\ntldr --gen-config \u003e \"$(tldr --config-path)\"\n```\n\nor copy the below example.\n\n### Configuration options\n\n```toml\n[cache]\n# Override the cache directory ('~' will be expanded to your home directory).\ndir = \"/path/to/cache\"\n# Override the base URL used for downloading tldr pages.\n# The mirror must provide files with the same names as the official tldr pages repository:\n# mirror/tldr.sha256sums            must point to the SHA256 checksums of all assets\n# mirror/tldr-pages.LANGUAGE.zip    must point to a zip archive that contains platform directories with pages in LANGUAGE\nmirror = \"https://github.com/tldr-pages/tldr/releases/latest/download\"\n# Automatically update the cache if it's older than max_age hours.\nauto_update = true\nmax_age = 336 # 336 hours = 2 weeks\n# Specify a list of desired page languages. If it's empty, languages specified in\n# the LANG and LANGUAGE environment variables are downloaded.\n# English is implied and will always be downloaded.\n# You can see a list of language codes here: https://github.com/tldr-pages/tldr\n# Example: [\"de\", \"pl\"]\nlanguages = []\n\n[output]\n# Show the title in the rendered page.\nshow_title = true\n# Show the platform name ('common', 'linux', etc.) in the title.\nplatform_title = false\n# Prefix descriptions of examples with hyphens.\nshow_hyphens = false\n# Use a custom string instead of a hyphen.\nexample_prefix = \"- \"\n# Set the max line length. 0 means to use the terminal width.\n# If a description is longer than this value, it will be split\n# into multiple lines.\nline_length = 0\n# Strip empty lines from output.\ncompact = false\n# In option placeholders, show the specified option style.\n# Example: {{[-s|--long]}}\n# short  : -s\n# long   : --long\n# both   : [-s|--long]\noption_style = \"long\"\n# Print pages in raw markdown.\nraw_markdown = false\n\n# Number of spaces to put before each line of the page.\n[indent]\n# Command name.\ntitle = 2\n# Command description.\ndescription = 2\n# Descriptions of examples.\nbullet = 2\n# Example command invocations.\nexample = 4\n\n# Style for the title of the page (command name).\n[style.title]\n# Fixed colors:       \"black\", \"red\", \"green\", \"yellow\", \"blue\", \"magenta\", \"cyan\", \"white\", \"default\",\n#                     \"bright_black\", \"bright_red\", \"bright_green\", \"bright_yellow\", \"bright_blue\",\n#                     \"bright_magenta\", \"bright_cyan\", \"bright_white\"\n# 256color ANSI code: { color256 = 50 }\n# RGB:                { rgb = [0, 255, 255] }\n# Hex:                { hex = \"#ffffff\" }\ncolor = \"magenta\"\nbackground = \"default\"\nbold = true\nunderline = false\nitalic = false\ndim = false\nstrikethrough = false\n\n# Style for the description of the page.\n[style.description]\ncolor = \"magenta\"\nbackground = \"default\"\nbold = false\nunderline = false\nitalic = false\ndim = false\nstrikethrough = false\n\n# Style for descriptions of examples.\n[style.bullet]\ncolor = \"green\"\nbackground = \"default\"\nbold = false\nunderline = false\nitalic = false\ndim = false\nstrikethrough = false\n\n# Style for command examples.\n[style.example]\ncolor = \"cyan\"\nbackground = \"default\"\nbold = false\nunderline = false\nitalic = false\ndim = false\nstrikethrough = false\n\n# Style for URLs inside the description.\n[style.url]\ncolor = \"red\"\nbackground = \"default\"\nbold = false\nunderline = false\nitalic = true\ndim = false\nstrikethrough = false\n\n# Style for text surrounded by backticks (`).\n[style.inline_code]\ncolor = \"yellow\"\nbackground = \"default\"\nbold = false\nunderline = false\nitalic = true\ndim = false\nstrikethrough = false\n\n# Style for placeholders inside command examples.\n[style.placeholder]\ncolor = \"red\"\nbackground = \"default\"\nbold = false\nunderline = false\nitalic = true\ndim = false\nstrikethrough = false\n```\n\n[latest-release]: https://github.com/tldr-pages/tlrc/releases/latest\n[crate]: https://crates.io/crates/tlrc\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftldr-pages%2Ftlrc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftldr-pages%2Ftlrc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftldr-pages%2Ftlrc/lists"}