{"id":13616305,"url":"https://github.com/eprovst/tldr","last_synced_at":"2025-04-14T00:32:03.532Z","repository":{"id":144213672,"uuid":"161186843","full_name":"eprovst/tldr","owner":"eprovst","description":"A tldr client in Go focusing on speed.","archived":true,"fork":false,"pushed_at":"2022-08-03T12:42:23.000Z","size":179,"stargazers_count":11,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-08-02T20:48:07.385Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/eprovst.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}},"created_at":"2018-12-10T14:24:23.000Z","updated_at":"2023-01-27T22:34:30.000Z","dependencies_parsed_at":"2024-01-22T00:13:33.645Z","dependency_job_id":"4182f2f3-706d-422e-a4b9-e185fd1f2929","html_url":"https://github.com/eprovst/tldr","commit_stats":null,"previous_names":["elecprog/tldr"],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eprovst%2Ftldr","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eprovst%2Ftldr/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eprovst%2Ftldr/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eprovst%2Ftldr/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/eprovst","download_url":"https://codeload.github.com/eprovst/tldr/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223611896,"owners_count":17173531,"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":[],"created_at":"2024-08-01T20:01:26.715Z","updated_at":"2024-11-08T00:31:09.504Z","avatar_url":"https://github.com/eprovst.png","language":"Go","funding_links":[],"categories":["Go"],"sub_categories":[],"readme":"\u003e **Warning**  \n\u003e This client is, currently, **unmaintained**. Another fast implementation you could try is [tealdeer](https://github.com/dbrgn/tealdeer) written in Rust.  \n\u003e For other options, see [the tldr wiki](https://github.com/tldr-pages/tldr/wiki/tldr-pages-clients).\n\ntldr\n====\n\nA [tldr](https://github.com/tldr-pages/tldr) client in Go, focusing on speed by storing pages in a database.\n\ntldr is a collection of simplified, community-driven man pages. This application provides a fast and convenient access to these pages from the command line.\n\nHere you see this client displaying the tldr page for Go:\n![screenshot](screenshot.png)\n\nAs already mentioned is this client written in Go, we also uses etcd's [bbolt database](https://github.com/etcd-io/bbolt) which makes this client super fast.\n\nApart from being fast, the choice of Go also allows us to support all platforms which Go compiles to.\n\n## Installation\nYou can use [Go](https://golang.org/)'s tooling\n\n```\ngo get github.com/elecprog/tldr\ngo install github.com/elecprog/tldr\n```\n\nor download a binary for Linux or Windows from the [release page](https://github.com/elecprog/tldr/releases/latest/).\n\n### Bash completion\nOn platforms that support it you can add bash completion by running:\n\n```\nsudo env \"PATH=$PATH\" sh -c \"tldr --bash-completion \u003e /etc/bash_completion.d/tldr\"\nsudo chmod 644 /etc/bash_completion.d/tldr\n```\n\n## Usage\n- You can print the tldr page for a command by using:\n  ```\n  tldr command\n  ```\n- This client downloads all tldr pages on the first run (resulting in a database of about 800\u0026nbsp;KB) which should only take a couple of seconds. To redownload the pages and rebuild the database you can use:\n  ```\n  tldr -u\n  ```\n  The database is then stored in the cache directory of your platform.\n- If you want all the commands matching a grep style regex, let's say `g[ie]t$`, use:\n  ```\n  tldr -s 'g[ie]t$'\n  ```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feprovst%2Ftldr","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Feprovst%2Ftldr","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feprovst%2Ftldr/lists"}