{"id":13337911,"url":"https://github.com/k3mist/tldr","last_synced_at":"2025-03-11T08:32:12.994Z","repository":{"id":57674334,"uuid":"111954620","full_name":"k3mist/tldr","owner":"k3mist","description":"tldr in golang -  Simplified and community-driven man pages","archived":false,"fork":false,"pushed_at":"2023-04-21T21:03:43.000Z","size":47681,"stargazers_count":17,"open_issues_count":0,"forks_count":4,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-07-30T20:54:27.816Z","etag":null,"topics":["command-line","console","documentation","golang","man-page","manpages","shell","terminal","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/k3mist.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","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":"2017-11-24T20:50:12.000Z","updated_at":"2024-04-11T08:57:45.000Z","dependencies_parsed_at":"2024-06-20T02:52:15.214Z","dependency_job_id":"8205ebc8-8bc7-4593-a186-bbd1c937657c","html_url":"https://github.com/k3mist/tldr","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/k3mist%2Ftldr","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/k3mist%2Ftldr/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/k3mist%2Ftldr/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/k3mist%2Ftldr/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/k3mist","download_url":"https://codeload.github.com/k3mist/tldr/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":221216903,"owners_count":16778653,"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":["command-line","console","documentation","golang","man-page","manpages","shell","terminal","tldr"],"created_at":"2024-07-29T19:15:10.677Z","updated_at":"2024-10-23T17:30:32.223Z","avatar_url":"https://github.com/k3mist.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# tldr in golang\n\n[TLDR pages](https://tldr-pages.github.io/) - Simplified and community-driven man pages\n\n![Terminal](terminal.png)\n\n## Install\n\n```\ngo install bitbucket.org/djr2/tldr@latest\n```\n\n## Download\n\n* [Distributions](https://bitbucket.org/djr2/tldr/src/master/dist/)\n\n## Building and Build Requirements\n\n* go\n* upx -- https://github.com/upx/upx\n* tar\n\n```\nbin/build\n```\n\nThe build script will compile and compress the tldr executables.\n\nThe build script currently supports the following platforms and architectures;\n\n* darwin arm64\n* darwin amd64\n* linux arm64\n* linux amd64\n* windows amd64\n\nTo a build a specific platform version run the below commands. \nIt is important to replace `[platform]` with the desired operating system and \n`[arch]` with the desired platform architecture to build the executable correctly.\n\nSupported Go build platforms and architectures can be found here;\nhttps://golang.org/doc/install/source#environment\n\nIt is not necessary to run upx but it greatly reduces executable size.\n\n```bash\nGOOS=[platform] GOARCH=[arch] go build -ldflags=\"-s -w\" -o tldr\nupx --brute tldr # executable compression\n```\n\n## Usage\n\n```\nUsage:\n  -c page\n      clear cache for a tldr page\n      page -- Use `clearall` to clear entire cache\n      -p is required if clearing cache for a specific platform\n  -debug string\n      enables debug logging (default \"disable\")\n  -p platform\n      platform of the tldr page\n      platform -- common, linux, osx, sunos, windows (default \"common\")\n```\n\n### View a tldr\n```\ntldr \u003cpage\u003e\n```\n\n### View a tldr for a specific platform\n```\ntldr -p osx \u003cpage\u003e\n```\n\n### Clear a tldr\n```\ntldr -c \u003cpage\u003e\n```\n\n### Clear a tldr for a specific platform\n```\ntldr -c \u003cpage\u003e -p osx\n```\n\n### Clear entire cache\n```\ntldr -c clearall\n```\n\n## Configuration\n\nA configuration is created the first time `tldr` is run.\n\nThe configuration is located at;\n```\n$HOME/.tldr/config.json\n```\n\nPages repository URI, Zip URI, and all of the output colors are\nconfigurable.\n\nBelow is the default configuration.\n\n```\n{\n\"pages_uri\": \"\",\n\"zip_uri\": \"\",\n\"banner_color_1\": 36,\n\"banner_color_2\": 34,\n\"tldr_color\": 97,\n\"header_color\": 34,\n\"header_decor_color\": 97,\n\"platform_color\": 90,\n\"description_color\": 0,\n\"example_color\": 36,\n\"hypen_color\": 0,\n\"syntax_color\": 31,\n\"variable_color\": 0\n}\n```\n\nIf plain (default) terminal text is desired set all color options to `0`.\n\n`pages_uri` and `zip_uri` when left blank will use the official TLDR\nlocations.\n\nThese can be used to test pages from a custom repository\nor any zip collection that follows the official TLDR directory format\nand file specification.\n\nPages: `https://raw.githubusercontent.com/tldr-pages/tldr/main/pages/`\n\nZip: `https://tldr-pages.github.io/assets/tldr.zip`\n\nTo reset the configuration back to its defaults delete `config.json`\nand it will be recreated. Or copy and paste the configuration from\nthis README above.\n\n## License\n\n[MIT License](https://bitbucket.org/djr2/tldr/src/master/LICENSE.md)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fk3mist%2Ftldr","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fk3mist%2Ftldr","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fk3mist%2Ftldr/lists"}