{"id":17720608,"url":"https://github.com/freed-wu/zsh-help","last_synced_at":"2025-05-07T22:29:32.499Z","repository":{"id":180449289,"uuid":"665162082","full_name":"Freed-Wu/zsh-help","owner":"Freed-Wu","description":"A zsh plugin to colorize `XXX --help`.","archived":false,"fork":false,"pushed_at":"2025-05-05T18:18:25.000Z","size":26,"stargazers_count":14,"open_issues_count":1,"forks_count":2,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-05-05T19:39:32.287Z","etag":null,"topics":["bat","color","command-line-tool","help","man","zsh"],"latest_commit_sha":null,"homepage":"","language":"Shell","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/Freed-Wu.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,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-07-11T15:12:57.000Z","updated_at":"2025-04-11T04:07:58.000Z","dependencies_parsed_at":null,"dependency_job_id":"70d0855c-c71c-4c58-8240-31168b60c679","html_url":"https://github.com/Freed-Wu/zsh-help","commit_stats":null,"previous_names":["freed-wu/zsh-help"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Freed-Wu%2Fzsh-help","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Freed-Wu%2Fzsh-help/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Freed-Wu%2Fzsh-help/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Freed-Wu%2Fzsh-help/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Freed-Wu","download_url":"https://codeload.github.com/Freed-Wu/zsh-help/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252964531,"owners_count":21832709,"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":["bat","color","command-line-tool","help","man","zsh"],"created_at":"2024-10-25T15:28:27.716Z","updated_at":"2025-05-07T22:29:32.475Z","avatar_url":"https://github.com/Freed-Wu.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# zsh-help\n\n[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/Freed-Wu/zsh-help/main.svg)](https://results.pre-commit.ci/latest/github/Freed-Wu/zsh-help/main)\n[![github/workflow](https://github.com/Freed-Wu/zsh-help/actions/workflows/main.yml/badge.svg)](https://github.com/Freed-Wu/zsh-help/actions)\n\n[![github/downloads](https://shields.io/github/downloads/Freed-Wu/zsh-help/total)](https://github.com/Freed-Wu/zsh-help/releases)\n[![github/downloads/latest](https://shields.io/github/downloads/Freed-Wu/zsh-help/latest/total)](https://github.com/Freed-Wu/zsh-help/releases/latest)\n[![github/issues](https://shields.io/github/issues/Freed-Wu/zsh-help)](https://github.com/Freed-Wu/zsh-help/issues)\n[![github/issues-closed](https://shields.io/github/issues-closed/Freed-Wu/zsh-help)](https://github.com/Freed-Wu/zsh-help/issues?q=is%3Aissue+is%3Aclosed)\n[![github/issues-pr](https://shields.io/github/issues-pr/Freed-Wu/zsh-help)](https://github.com/Freed-Wu/zsh-help/pulls)\n[![github/issues-pr-closed](https://shields.io/github/issues-pr-closed/Freed-Wu/zsh-help)](https://github.com/Freed-Wu/zsh-help/pulls?q=is%3Apr+is%3Aclosed)\n[![github/discussions](https://shields.io/github/discussions/Freed-Wu/zsh-help)](https://github.com/Freed-Wu/zsh-help/discussions)\n[![github/milestones](https://shields.io/github/milestones/all/Freed-Wu/zsh-help)](https://github.com/Freed-Wu/zsh-help/milestones)\n[![github/forks](https://shields.io/github/forks/Freed-Wu/zsh-help)](https://github.com/Freed-Wu/zsh-help/network/members)\n[![github/stars](https://shields.io/github/stars/Freed-Wu/zsh-help)](https://github.com/Freed-Wu/zsh-help/stargazers)\n[![github/watchers](https://shields.io/github/watchers/Freed-Wu/zsh-help)](https://github.com/Freed-Wu/zsh-help/watchers)\n[![github/contributors](https://shields.io/github/contributors/Freed-Wu/zsh-help)](https://github.com/Freed-Wu/zsh-help/graphs/contributors)\n[![github/commit-activity](https://shields.io/github/commit-activity/w/Freed-Wu/zsh-help)](https://github.com/Freed-Wu/zsh-help/graphs/commit-activity)\n[![github/last-commit](https://shields.io/github/last-commit/Freed-Wu/zsh-help)](https://github.com/Freed-Wu/zsh-help/commits)\n[![github/release-date](https://shields.io/github/release-date/Freed-Wu/zsh-help)](https://github.com/Freed-Wu/zsh-help/releases/latest)\n\n[![github/license](https://shields.io/github/license/Freed-Wu/zsh-help)](https://github.com/Freed-Wu/zsh-help/blob/main/LICENSE)\n[![github/languages](https://shields.io/github/languages/count/Freed-Wu/zsh-help)](https://github.com/Freed-Wu/zsh-help)\n[![github/languages/top](https://shields.io/github/languages/top/Freed-Wu/zsh-help)](https://github.com/Freed-Wu/zsh-help)\n[![github/directory-file-count](https://shields.io/github/directory-file-count/Freed-Wu/zsh-help)](https://github.com/Freed-Wu/zsh-help)\n[![github/code-size](https://shields.io/github/languages/code-size/Freed-Wu/zsh-help)](https://github.com/Freed-Wu/zsh-help)\n[![github/repo-size](https://shields.io/github/repo-size/Freed-Wu/zsh-help)](https://github.com/Freed-Wu/zsh-help)\n[![github/v](https://shields.io/github/v/release/Freed-Wu/zsh-help)](https://github.com/Freed-Wu/zsh-help)\n\nA zsh plugin to colorize `XXX --help`.\n\n![help](https://github.com/victor-gp/cmd-help-sublime-syntax/assets/32936898/ddfe38cb-e7ee-4a8d-803b-c693ee0b6482)\n\n## Dependencies\n\n- [bat](https://github.com/sharkdp/bat): this plugin will do nothing if `bat`\n  is not installed.\n\n## Install\n\nThis plugin respects\n[zsh plugin standard](https://github.com/zdharma-continuum/Zsh-100-Commits-Club/blob/master/Zsh-Plugin-Standard.adoc),\nso if you use any plugin manager and follow the instructions of your plugin\nmanager, it can be installed correctly.\n\n## Customize\n\n### Colorize More Options\n\nBy default, the plugin colorizes `--help`, `-?`, `--help-all`, etc. You can\ncustomize it to colorize more options like:\n\n```zsh\nalias -g -- '-h=-h | -help'\n```\n\nBecause many software use `-h` to represent `--human-readable`, `--hex`, etc.\nnot `--help`, this plugin doesn't colorize `-h` by default.\n\n### Function `-help()`\n\nYou can redefine function `-help()` to customize the colorization.\nSuch as:\n\n```zsh\n-help() {\n  bat -plhelp --paging=always --color=always\n}\n```\n\nwill use a pager like less to display `XXX --help`. More options can be\nfound by `bat --help`.\n\n### Force to Colorize\n\nYou can `XXX -h | -help` to force to colorize `XXX -h`.\n\n## Similar Projects\n\n- [manpager](https://github.com/Freed-Wu/manpager): colorize `man XXX` by\n  `export MANPAGER=manpager`.\n- [lesspipe](https://github.com/wofr06/lesspipe): colorize `less XXX` by\n  `export LESSOPEN='|lesspipe.sh %s'`.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffreed-wu%2Fzsh-help","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffreed-wu%2Fzsh-help","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffreed-wu%2Fzsh-help/lists"}