{"id":33623546,"url":"https://github.com/tunacuma/zsh-vi-man","last_synced_at":"2025-12-02T23:01:41.264Z","repository":{"id":326282958,"uuid":"1104899260","full_name":"TunaCuma/zsh-vi-man","owner":"TunaCuma","description":"Zsh vi-mode plugin for instant man-page help — press Shift-K to open a command’s man page with the option under your cursor auto-searched. 🔍","archived":false,"fork":false,"pushed_at":"2025-11-27T19:18:55.000Z","size":2835,"stargazers_count":58,"open_issues_count":4,"forks_count":1,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-11-29T16:55:08.426Z","etag":null,"topics":["antigen","command-line-tool","man-page","oh-my-zsh","productivity","shell","shell-script","terminal","vi-keybinds","vim","zgen","zinit","zplug","zsh","zsh-plugin","zsh-plugins"],"latest_commit_sha":null,"homepage":"","language":"Shell","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/TunaCuma.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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-11-26T21:11:24.000Z","updated_at":"2025-11-29T16:50:55.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/TunaCuma/zsh-vi-man","commit_stats":null,"previous_names":["tunacuma/zsh-vi-man"],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/TunaCuma/zsh-vi-man","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TunaCuma%2Fzsh-vi-man","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TunaCuma%2Fzsh-vi-man/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TunaCuma%2Fzsh-vi-man/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TunaCuma%2Fzsh-vi-man/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/TunaCuma","download_url":"https://codeload.github.com/TunaCuma/zsh-vi-man/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TunaCuma%2Fzsh-vi-man/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":27436946,"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","status":"online","status_checked_at":"2025-12-01T02:00:06.371Z","response_time":60,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["antigen","command-line-tool","man-page","oh-my-zsh","productivity","shell","shell-script","terminal","vi-keybinds","vim","zgen","zinit","zplug","zsh","zsh-plugin","zsh-plugins"],"created_at":"2025-12-01T19:00:49.873Z","updated_at":"2025-12-02T23:01:41.246Z","avatar_url":"https://github.com/TunaCuma.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n\n# 📖 zsh-vi-man\n\n**Smart man page lookup for zsh vi mode**\n\nPress `Shift-K` on any command or option to instantly open its man page\n\n[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)\n[![Zsh](https://img.shields.io/badge/Shell-Zsh-green.svg)](https://www.zsh.org/)\n\n\u003cbr\u003e\n\n\u003cimg src=\"demo.gif\" alt=\"zsh-vi-man demo\" width=\"700\"\u003e\n\n\u003c/div\u003e\n\n\u003cbr\u003e\n\n## ✨ Features\n\n\u003ctable\u003e\n\u003ctr\u003e\n\u003ctd width=\"50%\"\u003e\n\n### 🎯 Smart Detection\n\nAutomatically finds the right man page for subcommands\n\n```\ngit commit → man git-commit\ndocker run → man docker-run\n```\n\n\u003c/td\u003e\n\u003ctd width=\"50%\"\u003e\n\n### 🔍 Option Jumping\n\nOpens man page directly at the option definition\n\n```\ngrep -r    → jumps to -r entry\nls --color → jumps to --color entry\n```\n\n\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd width=\"50%\"\u003e\n\n### 🔗 Combined Options\n\nWorks with combined short options\n\n```\nrm -rf    → finds both -r and -f\ntar -xvf  → finds -x, -v, -f\n```\n\n\u003c/td\u003e\n\u003ctd width=\"50%\"\u003e\n\n### 📝 Value Extraction\n\nHandles options with values\n\n```\n--color=always     → searches --color\n--output=file.txt  → searches --output\n```\n\n\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd width=\"50%\"\u003e\n\n### 🔀 Pipe Support\n\nDetects correct command in pipelines\n\n```\ncat file | grep -i  → opens man grep\ntree | less -N      → opens man less\n```\n\n\u003c/td\u003e\n\u003ctd width=\"50%\"\u003e\n\n### 🛠️ Multiple Formats\n\nSupports various man page styles\n\n```\nGNU: -R, -r, --recursive\njq:  --slurp / -s:\nfind: -name, -type, -exec\n```\n\n\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/table\u003e\n\n\u003cbr\u003e\n\n## 📦 Installation\n\n\u003cdetails open\u003e\n\u003csummary\u003e\u003cb\u003ezinit\u003c/b\u003e\u003c/summary\u003e\n\n```zsh\nzinit light TunaCuma/zsh-vi-man\n```\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003e\u003cb\u003eantidote\u003c/b\u003e\u003c/summary\u003e\n\nAdd to your `.zsh_plugins.txt`:\n\n```\nTunaCuma/zsh-vi-man\n```\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003e\u003cb\u003eoh-my-zsh\u003c/b\u003e\u003c/summary\u003e\n\n```bash\ngit clone https://github.com/TunaCuma/zsh-vi-man \\\n  ${ZSH_CUSTOM:-~/.oh-my-zsh/custom}/plugins/zsh-vi-man\n```\n\nThen add to your `.zshrc`:\n\n```zsh\nplugins=(... zsh-vi-man)\n```\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003e\u003cb\u003eManual\u003c/b\u003e\u003c/summary\u003e\n\n```bash\ngit clone https://github.com/TunaCuma/zsh-vi-man ~/.zsh-vi-man\necho 'source ~/.zsh-vi-man/zsh-vi-man.plugin.zsh' \u003e\u003e ~/.zshrc\n```\n\n\u003c/details\u003e\n\n\u003cbr\u003e\n\n## 🚀 Usage\n\n1. Type a command (e.g., `ls -la` or `git commit --amend`)\n2. Press `Escape` to enter vi normal mode\n3. Move cursor to any word\n4. Press **`K`** to open the man page\n\n\u003cbr\u003e\n\n### Examples\n\n| Command                | Cursor On      | Result                               |\n| :--------------------- | :------------- | :----------------------------------- |\n| `ls -la`               | `ls`           | Opens `man ls`                       |\n| `ls -la`               | `-la`          | Opens `man ls`, jumps to `-l`        |\n| `git commit --amend`   | `commit`       | Opens `man git-commit`               |\n| `grep --color=auto`    | `--color=auto` | Opens `man grep`, jumps to `--color` |\n| `cat file \\| sort -r`  | `-r`           | Opens `man sort`, jumps to `-r`      |\n| `find . -name \"*.txt\"` | `-name`        | Opens `man find`, jumps to `-name`   |\n\n\u003cbr\u003e\n\n## ⚙️ Configuration\n\nSet these variables **before** sourcing the plugin:\n\n```zsh\n# Change the trigger key (default: K)\nZVM_MAN_KEY='?'\n\n# Use a different pager (default: less)\nZVM_MAN_PAGER='bat'\n```\n\n\u003cbr\u003e\n\n## 🔌 Integration with zsh-vi-mode\n\nThis plugin works seamlessly with [zsh-vi-mode](https://github.com/jeffreytse/zsh-vi-mode). It automatically detects zsh-vi-mode and hooks into its lazy keybindings system.\n\nFor best results, source this plugin **after** zsh-vi-mode:\n\n```zsh\nsource /path/to/zsh-vi-mode.zsh\nsource /path/to/zsh-vi-man.zsh\n```\n\n\u003cbr\u003e\n\n## 📄 License\n\nMIT License - see [LICENSE](LICENSE) for details.\n\n\u003cdiv align=\"center\"\u003e\n\n---\n\nMade with ❤️ by [Tuna Cuma](https://github.com/TunaCuma)\n\n\u003c/div\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftunacuma%2Fzsh-vi-man","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftunacuma%2Fzsh-vi-man","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftunacuma%2Fzsh-vi-man/lists"}