{"id":13582464,"url":"https://github.com/mstruebing/tldr","last_synced_at":"2025-04-07T06:06:35.982Z","repository":{"id":49252998,"uuid":"107006485","full_name":"mstruebing/tldr","owner":"mstruebing","description":"Golang command line client for tldr https://github.com/tldr-pages/tldr","archived":false,"fork":false,"pushed_at":"2024-03-04T04:23:22.000Z","size":967,"stargazers_count":263,"open_issues_count":4,"forks_count":22,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-03-31T04:06:21.399Z","etag":null,"topics":["cli","cli-app","golang","hacktoberfest","help","manpage","manpages","tldr"],"latest_commit_sha":null,"homepage":"","language":"Go","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/mstruebing.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"docs/CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"docs/CODE_OF_CONDUCT.md","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":"2017-10-15T11:31:48.000Z","updated_at":"2025-03-17T01:17:44.000Z","dependencies_parsed_at":"2024-06-20T08:28:43.445Z","dependency_job_id":null,"html_url":"https://github.com/mstruebing/tldr","commit_stats":null,"previous_names":["mstruebing/tldr-go-client"],"tags_count":14,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mstruebing%2Ftldr","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mstruebing%2Ftldr/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mstruebing%2Ftldr/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mstruebing%2Ftldr/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mstruebing","download_url":"https://codeload.github.com/mstruebing/tldr/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247601447,"owners_count":20964864,"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":["cli","cli-app","golang","hacktoberfest","help","manpage","manpages","tldr"],"created_at":"2024-08-01T15:02:44.383Z","updated_at":"2025-04-07T06:06:35.958Z","avatar_url":"https://github.com/mstruebing.png","language":"Go","funding_links":["https://www.buymeacoffee.com/mstruebing"],"categories":["Go"],"sub_categories":[],"readme":"# tldr\n\n\u003ca href=\"https://www.buymeacoffee.com/mstruebing\" target=\"_blank\"\u003e\u003cimg src=\"https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png\" alt=\"Buy Me A Coffee\" style=\"height: 41px !important;width: 174px !important;box-shadow: 0px 3px 2px 0px rgba(190, 190, 190, 0.5) !important;-webkit-box-shadow: 0px 3px 2px 0px rgba(190, 190, 190, 0.5) !important;\" \u003e\u003c/a\u003e\n\n[![CI](https://github.com/mstruebing/tldr/actions/workflows/main.yml/badge.svg)](https://github.com/mstruebing/tldr/actions/workflows/main.yml)\n[![codecov](https://codecov.io/gh/mstruebing/tldr/branch/master/graph/badge.svg)](https://codecov.io/gh/mstruebing/tldr)\n[![Go Report Card](https://goreportcard.com/badge/github.com/mstruebing/tldr-go-client)](https://goreportcard.com/report/github.com/mstruebing/tldr-go-client)\n\nThis tool shows the most common used parameter to different CLI-tools.\nThis prevents long reading of help-flag output and man pages.\n\n![Example Output](https://raw.githubusercontent.com/mstruebing/tldr/master/docs/example.png \"Example Output\")\n\n\n## Usage\n\n```\nusage: tldr [OPTION]... SEARCH\n\navailable commands:\n    -v, --version           print version and exit\n    -h, --help              print this help and exit\n    -u, --update            update local database\n    -p, --platform PLATFORM select platform, supported are linux / osx / sunos / common\n    -a, --list-all          list all available commands for the current platform\n    -f, --path PATH\t\t\trender a local page(file) for testing purposes\n    -r, --random\t\t\tprint a random page\n```\n\n## Install\n\nJust copy the executable anywhere on your system, preferably in some folder where \nyour `$PATH` variable will find it.\n\nExecutables to every release can be found on the release page of this repository.\n\nIf you want to build it yourself see below.\n\nOn Arch Linux you can simply:\n\n`yaourt -S tldr-go-client-git` or `trizen -S tldr-go-client-git`, or any other aur-helper.\nThis also auto install bash and zsh completions.\n\n### [Docker (mstruebing/tldr)](https://hub.docker.com/r/mstruebing/tldr)\n\nYou can use a docker image:\n\n`docker pull mstruebing/tldr` and execute it via: `docker run -it mstruebing/tldr tldr tar` for example.\nIf you want to connect into the container and execute more commands you can use `docker run -it mstruebing/tldr sh`.\n\n## Dependencies\n\nYou __don't__ need __any__ runtime dependencies.\n\nTo build it yourself you just need golang(1.8 and 1.9 are currently tested) installed.\n\n## Building\n\nIf you want to build it yourself you can use the `Makefile` and type `make build`.\nThis will put the `tldr` binary in a `bin` folder.\nIf you want to compile it without it just do a `go build` in the root of this repository.\n\nTo install it on your system you can do a simple `sudo make install` in the root of this repository.\nThis will build the executable file and install it to `/usr/bin` as well as zsh and bash autocompletions.\nYou can install it into an other directory with:\n\n```\nINSTALL_DIR=/path/where/you/want/the/binary/to/live sudo make install\n```\n\nMake sure you have this directory in your `$PATH`.\nOtherwise you can build the executable yourself and copy it wherever you want. Or simply adjust the `Makefile` to your needs.\n\n\n|command | effect|\n|---|---|\n|`make build` |builds the binary for your current platform and places it in `./bin/`|\n|`make install` | runs build and copies the binary to `~/bin/`|\n|`make test` | runs tests|\n|`make build-all-binaries` | builds all binaries for currently supported platforms|\n|`make compress-all-binaries` | runs build-all-binaries and compresses them|\n|`make clean` | cleans `./bin/` and cache folders|\n\n## Autocompletion\n\nCurrently this tool provides autocompletion for zsh and bash.\n\n### Bash\nIn bash you simply need to source the file (`source autocomplete.bash`).\n\n```\nsource autocompletion/autocomplete.bash\n```\n\nYou can put this into your `.bashrc`:\n\n```\nsource \u003cpath/to/repo\u003e/autocompletion/autocomplete.bash\n```\n\n### Zsh\n\nCurrently only tested with `oh-my-zsh`:\nIn zsh you need to copy or symlink `autocomplete.zsh` to `$ZSH_CUSTOM/plugins/tldr/_tldr`.\n\ncopy:\n```\nmkdir -p $ZSH_CUSTOM/plugins/tldr \u0026\u0026 \ncp autocompletion/autocomplete.zsh $ZSH_CUSTOM/plugins/tldr/_tldr\n```\n\nsymlink:\n```\nmkdir -p $ZSH_CUSTOM/plugins/tldr \u0026\u0026 \nln -s autocompletion/autocomplete.zsh $ZSH_CUSTOM/plugins/tldr/_tldr\n```\n\nAnd then define it in your `.zshrc` as a plugin:\n\n```\nplugins=(git tldr otherPlug)\n```\n\n## Contribution\n\nPlease read [CONTRIBUTING.md](https://github.com/mstruebing/tldr/tree/master/docs/CONTRIBUTING.md)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmstruebing%2Ftldr","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmstruebing%2Ftldr","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmstruebing%2Ftldr/lists"}