{"id":13448494,"url":"https://github.com/raylee/tldr-sh-client","last_synced_at":"2026-01-17T02:57:47.180Z","repository":{"id":43860664,"uuid":"48976785","full_name":"raylee/tldr-sh-client","owner":"raylee","description":"Simplified and community-driven man pages","archived":false,"fork":false,"pushed_at":"2024-01-19T15:35:26.000Z","size":1386,"stargazers_count":729,"open_issues_count":0,"forks_count":48,"subscribers_count":17,"default_branch":"main","last_synced_at":"2025-09-17T16:32:21.036Z","etag":null,"topics":["shell","tldr"],"latest_commit_sha":null,"homepage":"http://tldr-pages.github.io/","language":"Shell","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/raylee.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}},"created_at":"2016-01-04T05:35:53.000Z","updated_at":"2025-09-17T06:02:12.000Z","dependencies_parsed_at":"2024-02-17T05:45:16.621Z","dependency_job_id":null,"html_url":"https://github.com/raylee/tldr-sh-client","commit_stats":null,"previous_names":["raylee/tldr"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/raylee/tldr-sh-client","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/raylee%2Ftldr-sh-client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/raylee%2Ftldr-sh-client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/raylee%2Ftldr-sh-client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/raylee%2Ftldr-sh-client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/raylee","download_url":"https://codeload.github.com/raylee/tldr-sh-client/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/raylee%2Ftldr-sh-client/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28492593,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-17T02:39:23.645Z","status":"ssl_error","status_checked_at":"2026-01-17T02:34:19.649Z","response_time":85,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: 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":["shell","tldr"],"created_at":"2024-07-31T05:01:47.157Z","updated_at":"2026-01-17T02:57:47.160Z","avatar_url":"https://github.com/raylee.png","language":"Shell","funding_links":[],"categories":["Shell","Command-Line Productivity"],"sub_categories":[],"readme":"# tldr\n\nA fully-functional POSIX shell client for [tldr-pages](https://github.com/tldr-pages/tldr).\nThis version aims to be the easiest, smallest, and most universal client to set up\non a new account, without sacrificing any features. It uses only `/bin/sh` features\nand `curl`, and tested on Linux, OSX, FreeBSD, with `bash`, `sh`, `dash`, `ksh`,\n`zsh`, `csh`.\n\n![tldr screenshot](Screenshot.png?raw=true)\n\n## Installation\n```bash\nmkdir -p ~/bin\ncurl -o ~/bin/tldr https://raw.githubusercontent.com/raylee/tldr/master/tldr\nchmod +x ~/bin/tldr\n```\n\nThen try using the command! If you get an error such as _-bash: tldr: command not found_,\nyou may need to add `~/bin` to your `$PATH`. On OSX edit `~/.bash_profile`\n(`~/.bashrc` on Linux), and add the following line to the bottom of the file:\n```bash\nexport PATH=$PATH:~/bin\n```\n\nIf you'd like to enable shell completion (eg. `tldr w\u003ctab\u003e\u003ctab\u003e` to get a\nlist of all commands which start with w) then add the following to the same\nstartup script:\n\n```bash\ncomplete -W \"$(tldr 2\u003e/dev/null --list)\" tldr\n```\n\nOr for `~/.zshrc`, add:\n```bash\n[ -f ~/bin/tldr ] \u0026\u0026 compctl -k \"($( tldr 2\u003e/dev/null --list))\" tldr\n```\n\n## Prerequisites\n\n`curl` and `unzip` need to be available somewhere in your `$PATH`. The script is otherwise self-contained.\n\n## Usage\n\n```\ntldr [options] \u003ccommand\u003e\n\n[options]\n  -l, --list             show all available pages\n  -L, --language [code]  override language detection, set preferred language\n  -p, --platform [name]  show page from specific platform\n  -u, --update           update cached copies of tldr page files\n  -h, --help             this help overview\n  -v, --version          show version information\n  -n, --no-cache         display pages directly from GitHub (watch ratelimits)\n\n\u003ccommand\u003e\n  Show the tldr page for command.\n\nThe client caches a copy of the tldr pages under $(cache_dir)\nBy default, cached copies will be refreshed after $(cache_days) days.\n\nExamples:\n\tShow an overivew of unzip:\n\t\ttldr unzip\n\tShow commands for all platforms:\n\t\ttldr -l -p all\n\tIf you have fzf installed, try:\n\t\ttldr -l -p all | fzf --preview 'tldr {}' \n\tShow the Russian page for tar:\n\t\ttldr -L ru tar\n\tList pages in the Android section:\n\t\ttldr -p android -l\n```\n\n\n## Customization\nYou can change the styling of the output from `tldr` by defining some environment variables. For\nexample, try adding the following lines to your `~/.bash_profile` file (OSX) or `~/.bashrc` file\n(Linux).\n\n```bash\nexport TLDR_HEADER='magenta bold underline'\nexport TLDR_QUOTE='italic'\nexport TLDR_DESCRIPTION='green'\nexport TLDR_CODE='red'\nexport TLDR_PARAM='blue'\n```\n\nPossible settings are: `black`, `red`, `green`, `yellow`, `blue`, `magenta`, `cyan`,\n`white`, `onblue`, `ongrey`, `reset`, `bold`, `underline`, `italic`, `eitalic`, `default`\n_(some variables may not work in some shells)_.\n\nNB: You will need to log into a new session to see the effect. Just run the commands in the\nterminal directly to see the change immediately and temporarily.\n\n## Contributing\n\nThis is the result of a Sunday afternoon project. It's been lightly tested under Mac OS X 10.9\nand Ubuntu Linux 15.10. I've tried to make the project as portable as possible, but if there's\nsomething I missed I'd love your help.\n\n* Want a new feature? Feel free to file an issue for a feature request.\n* Find a bug? Open an issue please, or even better send me a pull request.\n\nContributions are always welcome at any time!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fraylee%2Ftldr-sh-client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fraylee%2Ftldr-sh-client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fraylee%2Ftldr-sh-client/lists"}