{"id":13617143,"url":"https://github.com/psibi/tldr-hs","last_synced_at":"2026-03-07T14:31:39.983Z","repository":{"id":18849357,"uuid":"85435498","full_name":"psibi/tldr-hs","owner":"psibi","description":"Haskell tldr client","archived":false,"fork":false,"pushed_at":"2022-07-22T14:42:46.000Z","size":241,"stargazers_count":99,"open_issues_count":5,"forks_count":15,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-12-11T05:55:33.124Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Haskell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/psibi.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-03-18T22:16:30.000Z","updated_at":"2025-11-08T18:55:24.000Z","dependencies_parsed_at":"2022-07-25T06:46:58.722Z","dependency_job_id":null,"html_url":"https://github.com/psibi/tldr-hs","commit_stats":null,"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"purl":"pkg:github/psibi/tldr-hs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/psibi%2Ftldr-hs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/psibi%2Ftldr-hs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/psibi%2Ftldr-hs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/psibi%2Ftldr-hs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/psibi","download_url":"https://codeload.github.com/psibi/tldr-hs/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/psibi%2Ftldr-hs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30217435,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-07T14:02:48.375Z","status":"ssl_error","status_checked_at":"2026-03-07T14:02:43.192Z","response_time":53,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":[],"created_at":"2024-08-01T20:01:37.450Z","updated_at":"2026-03-07T14:31:38.891Z","avatar_url":"https://github.com/psibi.png","language":"Haskell","funding_links":[],"categories":["Haskell"],"sub_categories":[],"readme":"# tldr\n\n[![Build Status](https://dev.azure.com/psibi2000/tldr-hs/_apis/build/status/psibi.tldr-hs?branchName=master)](https://dev.azure.com/psibi2000/tldr-hs/_build/latest?definitionId=5?branchName=master)\n\n[![Hackage](https://img.shields.io/hackage/v/tldr.svg)](https://hackage.haskell.org/package/tldr)\n[![Stackage Nightly](http://stackage.org/package/tldr/badge/nightly)](http://stackage.org/nightly/package/tldr)\n[![Stackage LTS](http://stackage.org/package/tldr/badge/lts)](http://stackage.org/lts/package/tldr)\n\nHaskell client for tldr\n\n\u003c!-- markdown-toc start - Don't edit this section. Run M-x markdown-toc-refresh-toc --\u003e\n**Table of Contents**\n\n- [tldr](#tldr)\n    - [Installation](#installation)\n    - [Usage](#usage)\n    - [Offline caching](#offline-caching)\n    - [Snapshot](#snapshot)\n\n\u003c!-- markdown-toc end --\u003e\n\n\n## Installation\n\nSee Github releases: https://github.com/psibi/tldr-hs/releases\n\nExecutables are available for all the three major platforms: Linux, Windows and MacOS.\n\nOr\n\n1. [Install stack](https://docs.haskellstack.org/en/stable/README/#how-to-install)\n2. `stack install tldr`\n\n## Usage\n\n``` shellsession\n$ tldr --help\ntldr - Simplified and community-driven man pages\n\nUsage: tldr [-v|--version] ((-u|--update) | [-p|--platform PLATFORM]\n            [-L|--language LOCALE] COMMAND | (-a|--about))\n  tldr Client program\n\nAvailable options:\n  -h,--help                Show this help text\n  -v,--version             Show version\n  -u,--update              Update offline cache of tldr pages\n  -p,--platform PLATFORM   Prioritize a specific platform while searching. Valid\n                           values include linux, osx, windows, sunos\n  -L,--language LOCALE     Preferred language for the page returned\n  COMMAND                  name of the command\n  -a,--about               About this program\n  --auto-update-interval DAYS\n                           Perform an automatic update if the cache is older\n                           than DAYS\n```\n\nOr a much better example of the usage:\n\n``` shellsession\n$ tldr tldr\ntldr\nSimplified man pages. More information: https://tldr.sh.\n\n - Get typical usages of a command (hint: this is how you got here!):\n   tldr {{command}}\n\n - Show the tar tldr page for linux:\n   tldr -p {{linux}} {{tar}}\n\n - Get help for a git subcommand:\n   tldr {{git checkout}}\n```\n\n## Offline caching\n\nOn the first run, this program caches all available tldr pages. Since\nthe number of available tldr pages rises quickly, it is recommended to\nregularly update the cache.  Such an update can be run manually with:\n\n``` shellsession\n$ tldr --update\n```\n\nStarting with version `0.9.0`, users of this client can enable automatic\nupdates by running it with the option `--auto-update-interval DAYS`\nspecified.  The client will then check whether the cached version of the\ntldr pages is older than `DAYS` days and perform an update in that case.\nTo enable this functionality permanently, users can put the line\n`alias tldr=\"tldr --auto-update-interval DAYS\"` in their shell\nconfiguration file (e.g. `.bashrc`, `.zshrc`) with the desired update\ninterval specified.\n\n## Snapshot\n\n![tldr](https://cloud.githubusercontent.com/assets/737477/24076451/2a5a604c-0c57-11e7-9bf7-13d76e8e7f12.png)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpsibi%2Ftldr-hs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpsibi%2Ftldr-hs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpsibi%2Ftldr-hs/lists"}