{"id":16593551,"url":"https://github.com/mattmc3/zman","last_synced_at":"2025-10-25T14:11:27.108Z","repository":{"id":72495227,"uuid":"331676236","full_name":"mattmc3/zman","owner":"mattmc3","description":"Use fzf to quickly browse Zsh manuals","archived":false,"fork":false,"pushed_at":"2024-08-26T22:30:18.000Z","size":2133,"stargazers_count":27,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-02-27T14:30:11.191Z","etag":null,"topics":["zsh","zsh-plugin"],"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/mattmc3.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}},"created_at":"2021-01-21T15:50:55.000Z","updated_at":"2025-02-13T20:35:16.000Z","dependencies_parsed_at":"2023-03-11T03:30:15.801Z","dependency_job_id":null,"html_url":"https://github.com/mattmc3/zman","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/mattmc3%2Fzman","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mattmc3%2Fzman/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mattmc3%2Fzman/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mattmc3%2Fzman/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mattmc3","download_url":"https://codeload.github.com/mattmc3/zman/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243830915,"owners_count":20354850,"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":["zsh","zsh-plugin"],"created_at":"2024-10-11T23:27:10.487Z","updated_at":"2025-10-25T14:11:27.017Z","avatar_url":"https://github.com/mattmc3.png","language":"Shell","readme":"# zman\n\n[![License](https://img.shields.io/badge/license-MIT-007EC7)](/LICENSE)\n[![works with prezto](https://img.shields.io/badge/works%20with-%E2%9D%AF%E2%9D%AF%E2%9D%AF%20prezto-red)](#install-for-prezto)\n[![works with ohmyzsh](https://img.shields.io/badge/works%20with-%20%E2%9E%9C%20oh--my--zsh-C2D33F)](#install-for-oh-my-zsh)\n\n\u003e Use `fzf` to quickly browse Zsh manuals\n\n![zman](https://raw.githubusercontent.com/mattmc3/zman/resources/img/zman.gif)\n\n## Description\n\nThis plugin scrapes the Zsh documentation for index words and phrases and lets you\nquickly navigate to the online docs. It uses [fzf] to provide fuzzy searching. Be sure\nyou have it installed prior to using this plugin.\n\n## Why do you need this plugin?\n\nIf you have ever tried to find some Zsh documentation from the command line, you know\nhow tricky that can be. First, you probably try `man` out of habit:\n\n```zsh\n% man zstyle\nNo manual entry for zstyle\n```\n\nThen, assuming you have [run-help set up properly](https://stackoverflow.com/questions/4405382/how-can-i-read-documentation-about-built-in-zsh-commands),\nmaybe you try that.\n\n```zsh\n% run-help zstyle\nzstyle See the section `The zsh/zutil Module' in zshmodules(1)\n```\n\nInstead of taking you where you want to go, it tells you you need to search yet again,\nso you do:\n\n```zsh\n% run-help zshmodules\n# finally, you're in the docs!\n# but, you still have to search once more by typing '/zstyle'\n```\n\nI got tired of all that and decided there's got to be a better way. With this plugin,\nyou simply do the following:\n\n```zsh\n% zman zstyle\n# fuzzy finder opens with your initial 'zstyle' query.\n# pick one of the options and your browser opens right to the online manual\n```\n\nIf you don't want to make a selection, `CTRL-c` cancels as you would expect.\n\n## Installation\n\n### Install with a Zsh plugin manager\n\nTo install using a Zsh plugin manager, add the following to your .zshrc\n\n- [antidote]: `antidote install mattmc3/zman`\n- [zcomet]: `zcomet load mattmc3/zman`\n- [zgenom]: `zgenom load mattmc3/zman`\n- [znap]: `znap source mattmc3/zman`\n\n### Install manually, without a plugin manager\n\nTo install manually, first clone the repo:\n\n```zsh\ngit clone https://github.com/mattmc3/zman ${ZDOTDIR:-~}/.zplugins/zman\n```\n\nThen, in your .zshrc, add the following line:\n\n```zsh\nsource ${ZDOTDIR:-~}/.zplugins/zman/zman.zsh\n```\n\n### Install for Oh-My-Zsh\n\nTo install with [Oh-My-Zsh][ohmyzsh], first clone the repo from an interactive Zsh session:\n\n```zsh\n# make sure your $ZSH_CUSTOM is set\nZSH_CUSTOM=${ZSH_CUSTOM:-~/.oh-my-zsh/custom}\n\n# now, clone the plugin\ngit clone https://github.com/mattmc3/zman $ZSH_CUSTOM/plugins/zman\n```\n\nThen, add the plugin to your Oh-My-Zsh plugins list in your .zshrc\n\n```zsh\n# in your .zshrc, add this plugin to your plugins list\nplugins=(... zman)\n```\n\n### Install for Prezto\n\nTo install with [Prezto][prezto], first clone the repo from an interactive Zsh session:\n\n```zsh\n# make sure your $ZPREZTODIR is set\nZPREZTODIR=${ZPREZTODIR:-~/.zprezto}\n# clone the repo to a prezto contrib dir\ngit clone https://github.com/mattmc3/zman $ZPREZTODIR/contrib/zman/external\n# set up the contrib\necho \"source \\${0:A:h}/external/zman.plugin.zsh\" \u003e $ZPREZTODIR/contrib/zman/init.zsh\n```\n\nThen, add the plugin to your Prezto plugins list in .zpreztorc\n\n```zsh\nzstyle ':prezto:load' pmodule \\\n  ... \\\n  zman \\\n  ...\n```\n\n[ohmyzsh]: https://github.com/ohmyzsh/ohmyzsh\n[prezto]: https://github.com/sorin-ionescu/prezto\n[zshzoo]: https://github.com/zshzoo/zshzoo\n[antidote]: https://github.com/mattmc3/antidote\n[zcomet]: https://github.com/agkozak/zcomet\n[zgenom]: https://github.com/jandamm/zgenom\n[znap]: https://github.com/marlonrichert/zsh-snap\n[fzf]: https://github.com/junegunn/fzf\n\n","funding_links":[],"categories":["Plugins"],"sub_categories":["ZSH on Windows"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmattmc3%2Fzman","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmattmc3%2Fzman","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmattmc3%2Fzman/lists"}