{"id":17686246,"url":"https://github.com/superatomic/tldr-man","last_synced_at":"2025-08-27T01:49:23.535Z","repository":{"id":50435266,"uuid":"519083585","full_name":"superatomic/tldr-man","owner":"superatomic","description":"📚 Command-line TLDR client that displays tldr-pages as manpages.","archived":false,"fork":false,"pushed_at":"2024-03-30T03:44:03.000Z","size":179,"stargazers_count":16,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-08-16T04:12:49.804Z","etag":null,"topics":["cli","click","linux","macos","manpage","manpages","python","python-click","python3","tldr","tldr-client","tldr-man-client","tldr-pages","tldr-python-client"],"latest_commit_sha":null,"homepage":"https://pypi.org/project/tldr-man/","language":"Python","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/superatomic.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-07-29T04:50:00.000Z","updated_at":"2025-02-01T18:59:11.000Z","dependencies_parsed_at":"2024-10-24T13:10:03.488Z","dependency_job_id":"6e58d183-cb09-4d83-9e31-c7707771a7bf","html_url":"https://github.com/superatomic/tldr-man","commit_stats":null,"previous_names":["superatomic/tldr-man","superatomic/tldr-man-client"],"tags_count":14,"template":false,"template_full_name":null,"purl":"pkg:github/superatomic/tldr-man","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/superatomic%2Ftldr-man","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/superatomic%2Ftldr-man/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/superatomic%2Ftldr-man/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/superatomic%2Ftldr-man/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/superatomic","download_url":"https://codeload.github.com/superatomic/tldr-man/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/superatomic%2Ftldr-man/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":272277796,"owners_count":24905560,"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","status":"online","status_checked_at":"2025-08-26T02:00:07.904Z","response_time":60,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":["cli","click","linux","macos","manpage","manpages","python","python-click","python3","tldr","tldr-client","tldr-man-client","tldr-pages","tldr-python-client"],"created_at":"2024-10-24T10:43:50.604Z","updated_at":"2025-08-27T01:49:23.516Z","avatar_url":"https://github.com/superatomic.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv\u003e\n    \u003ch1 align=\"center\"\u003etldr-man\u003c/h1\u003e\n    \u003ch5 align=\"center\"\u003eA tldr-pages client that works just like \u003ccode\u003eman\u003c/code\u003e\u003c/h5\u003e\n\u003c/div\u003e\n\n`tldr-man` is a command-line client for [tldr-pages][tldr-pages],\na collection of community-maintained help pages for command-line tools.\nIt differs from other clients because it displays its pages as `man` pages.\n\nThis client is also able to integrate with the `man` command to fall back to displaying a tldr-page for a command when\nno manpage exists.\n\nFeatures:\n- Fully abides by the [tldr-pages client specification][client-spec].\n- Supports all page languages, not just English pages.\n- Displays tldr-pages in the same style as manpages.\n- Integrates with `man` to provide a fallback for missing manpages.\n- Supports rendering markdown formatted tldr-pages with `--render`.\n- Local cache abides by the [XDG base directory specification][xdg].\n- Supports shell completion for `bash`, `zsh`, and `fish` shells.\n- And much more!\n\n\n## Installation\n\n### With Homebrew\n\nInstall `tldr-man` with [Homebrew](https://brew.sh):\n\n```shell\nbrew install superatomic/tap/tldr-man\n```\n\n### With Pip\n\nInstall `tldr-man` with pip (version 3.10+):\n\n```shell\npip install tldr-man\n```\n\n`tldr-man` additionally depends on [`pandoc`](https://pandoc.org/installing.html) being installed.\n\nAfter installation, you can view a tldr-page with the `tldr` command.\n\n\n## Usage\n\n**Display a tldr-page for a command:**\n\n```shell\ntldr \u003cCOMMAND\u003e\n```\n\n**Update the local page cache:**\n\n```shell\ntldr --update\n```\n\n**Render a page locally:**\n\n```shell\ntldr --render path/to/page.md\n```\n\n**Print tldr manpage paths as a colon-separated list (see the [Manpage Integration](#manpage-integration) section):**\n\n```shell\ntldr --manpath\n```\n\n**Display usage information:**\n\n```shell\ntldr --help\n```\n\n\n### Setting languages\n\n[As specified by the tldr-pages client specification][client-spec-language],\ntldr-pages from other languages can be displayed by this client\n(falling back to English if the page doesn't exist for that language).\n\nTo do so, set any of the environment variables `$LANG`, `$LANGUAGE`, or `$TLDR_LANGUAGE` to the two-letter language code\nfor your language (e.g. `export LANGUAGE=es`),\nor set the `--language` option when running `tldr` (e.g. `tldr \u003cCOMMAND\u003e --language es`).\n\n\n### Setting platforms\n\nBy default, tldr-pages will be displayed based on your current platform.\nTo directly specify what platform's page to use, use the `--platform` flag.\n\nFor example, to display the macOS version of the `top` command's tldr-page, run `tldr top --platform macos`.\nThis is the default behavior on macOS,\nbut `--platform macos` is required to show the macOS version of this page on other platforms.\n\n\n## Manpage Integration\n\nThe command `man` can be set up to fall back to displaying tldr-pages if no manpages are found.\n\nTo do so,\nadd the provided line to your shell's startup script (e.g. `~/.bash_profile`, `~/.zshenv`, `~/.config/fish/config.fish`)\nto add this behavior to `man`:\n\n### Bash and Zsh\n\n```shell\nexport MANPATH=\"$MANPATH:$(tldr --manpath)\"\n```\n\n### Fish\n\n```shell\nset -gxa MANPATH (tldr --manpath)\n```\n\n[tldr-pages]: https://github.com/tldr-pages/tldr\n[client-spec]: https://github.com/tldr-pages/tldr/blob/main/CLIENT-SPECIFICATION.md\n[client-spec-language]: https://github.com/tldr-pages/tldr/blob/main/CLIENT-SPECIFICATION.md#language\n[xdg]: https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsuperatomic%2Ftldr-man","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsuperatomic%2Ftldr-man","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsuperatomic%2Ftldr-man/lists"}