ohmyzsh/plugins/plugin-helper/README.md at 8cd7a3b7857c3f89458e1379e3f3841002956c70

mirror of https://github.com/ohmyzsh/ohmyzsh.git synced 2026-03-20 03:13:33 +01:00

KhasMek 8cd7a3b785 Plugins: add a plugin helper plugin

The purpose of this plugin is to assist with the use
  and interaction of other plugins.

  Current features are as follows
  - list all plugins
  - list all enabled plugins
  - list all plugins with README files
  - print the README file of specified plugin (similar
    to the man function for other CLI programs)
  - print all aliases of specified plugin(s)
  - enable a specified plugin
  - disable a specified plugin

2015-05-03 13:11:06 -06:00

1.3 KiB

Raw Blame History

OH-MY-ZSH PLUGIN HELPER

This is a pretty straightforward plugin for oh-my-zsh that's sole purpose is to be a helper for other available OMZ plugins.

FEATURES

Function	Alias	Description
disable_plugin	phdp	Disable specified plugin
enable_plugin	phep	Enable specified plugin
print_all_plugins	phpap	List all plugins
print_enabled_plugins	phpep	List all enabled plugins
print_all_readmes	phpar	Get a list of all plugins with a README
print_aliases	phpa	Print list of aliases for specified plugin(s)
print_readme	phpr	Print README for the specified plugin

NOTES

The output of the README's in the print_readme function looks a lot better with Pandoc, but it's not required.

Mac OS

brew install pandoc

Ubuntu

sudo apt-get install pandoc

LICENSE

The project is licensed under the MIT-license.

CONTRIBUTORS

KhasMek - Creator

1.3 KiB Raw Blame History