{"id":13337917,"url":"https://github.com/principis/tldr-sharp","last_synced_at":"2025-03-11T08:32:02.632Z","repository":{"id":46266459,"uuid":"156990915","full_name":"principis/tldr-sharp","owner":"principis","description":"C# tldr-pages client","archived":false,"fork":false,"pushed_at":"2024-12-18T18:58:03.000Z","size":2809,"stargazers_count":22,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-12-18T19:42:01.013Z","etag":null,"topics":["csharp","mono","tldr","tldr-pages"],"latest_commit_sha":null,"homepage":"","language":"C#","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/principis.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSES/CC0-1.0.txt","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":"2018-11-10T14:54:04.000Z","updated_at":"2024-12-18T18:55:58.000Z","dependencies_parsed_at":"2023-01-23T11:15:41.975Z","dependency_job_id":"701a75c5-b031-4b3b-99d1-8aa05839ca81","html_url":"https://github.com/principis/tldr-sharp","commit_stats":null,"previous_names":[],"tags_count":38,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/principis%2Ftldr-sharp","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/principis%2Ftldr-sharp/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/principis%2Ftldr-sharp/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/principis%2Ftldr-sharp/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/principis","download_url":"https://codeload.github.com/principis/tldr-sharp/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243000817,"owners_count":20219748,"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":["csharp","mono","tldr","tldr-pages"],"created_at":"2024-07-29T19:15:10.727Z","updated_at":"2025-03-11T08:32:02.302Z","avatar_url":"https://github.com/principis.png","language":"C#","funding_links":[],"categories":[],"sub_categories":[],"readme":"# tldr-sharp\n\nA C# based, feature-rich command-line client for [tldr-pages](https://github.com/tldr-pages/tldr).\n\n![tldr screenshot](screenshot.png)\n\n## Requirements\n\n- .NET Runtime 6.0 (or newer). Download it from [here](https://dotnet.microsoft.com/en-us/download).\n\n## Installation\n\n### Linux\n\n#### Ubuntu/Debian\n\nInstall the [latest](https://github.com/principis/tldr-sharp/releases/latest/) Debian package.\n\n#### Fedora\ntldr-sharp is available in [COPR](https://copr.fedorainfracloud.org/coprs/principis/tldr-sharp/)\n\n```sh\nsudo dnf copr enable principis/tldr-sharp\nsudo dnf --refresh install tldr-sharp\n```\n\n#### Manual\n\nDownload and extract the latest [release](https://github.com/principis/tldr-sharp/releases/latest/).\n\n```sh\nmkdir tldr-sharp\ntar xzf \u003cversion\u003e.tar.gz -C tldr-sharp\nsudo chown -R root:root tldr-sharp\nsudo cp -pr tldr-sharp /usr/local/lib/\nsudo ln -s /usr/local/lib/tldr-sharp/tldr-sharp /usr/local/bin/tldr-sharp\n```\n\n### Windows\n\n_Note: Your antivirus may detect tldr-sharp as a virus._\n\nIt is recommended to use the new [Windows Terminal](https://aka.ms/terminal), so the highlighting works as expected.\n\n#### Installer\n\nDownload and run the [installer](https://github.com/principis/tldr-sharp/releases/latest/).\n\n#### Manual installation\n\n* Download the latest [release](https://github.com/principis/tldr-sharp/releases)\n* Extract to a folder of choice, for example `C:\\ProgramData\\tldr-sharp`\n* Copy `tldr-sharp.exe` to `tldr.exe`\n* Add it to the path\n    * Open Control Panel (old style)\n    * On the **System** page, click **Advanced system settings** on the left-hand side\n    * In the dialog window, click on the **Environment Variables** button\n    * In **User variables** select `Path` and click **Edit**\n    * In the popup, click **New** and add the path where you've installed tldr-sharp as\n      follows: `C:\\ProgramData\\tldr-sharp`\n* Reboot to make sure the Path is updated\n\nYou can now use tldr-sharp by entering `tldr tar` in your favorite shell.\n\n## Usage\n\n```\nUsage: tldr command [options]\nSimplified and community-driven man pages\n  -a, --list-all             List all pages\n  -c, --clear-cache          Clear the local cache\n  -f, --render=VALUE         Render a specific markdown file\n  -h, --help                 Display this help text\n  -l, --list                 List all pages for the current platform and\n                               language\n      --list-platforms       List all platforms\n      --list-languages       List all languages\n  -L, --language, --lang=VALUE\n                             Specifies the preferred language\n  -m, --markdown             Show the markdown source of a page\n  -p, --platform=VALUE       Override the default platform\n  -s, --search=VALUE         Search for a string\n  -u, --update               Update the local cache\n      --self-update          Check for tldr-sharp updates\n  -v, --version              Show version information\n```\n\n## License\n\n* This project is licensed under GPL-3.0-or-later.\n* Some configuration and scripts are licensed under CC0-1.0.\n\nFor more accurate information, check the individual files.\n\n## Contributing\n\nContributions are always welcome! Please open an issue first.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprincipis%2Ftldr-sharp","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fprincipis%2Ftldr-sharp","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprincipis%2Ftldr-sharp/lists"}