Plugins

Plugins will contain things such as Commands, Functions, Aliases, Auto Completion Scripts, and more. Plugins are focused on enhancing your experience in the shell.

Searching for Plugins

Plugins are listed in an index defined by PMS_PLUGIN_INDEX. By default this uses the plugins.txt file in the PMS installation directory. Each line is formatted as code|name|description|repo.

Use the plugin index to find new plugins:

pms plugin search <term>

Omit <term> to list all indexed plugins.

Installing Plugins

Install a plugin using its code from the index:

pms plugin install example

You can also install directly from a Git repository:

pms plugin install https://example.com/your/plugin.git

The repository is cloned into your local PMS plugins directory and enabled automatically.

Updating Plugins

Update a plugin to its latest commit:

pms plugin update <plugin>

Replace <plugin> with the name of the plugin's directory.

Completion Scripts

Plugins can ship shell completion files by placing them in a completions directory inside the plugin. PMS adds this directory to the shell's lookup path when the plugin loads. For zsh, the directory is appended to fpath before compinit runs so that the shell can find the completion functions automatically.