Module Commands

Here are the commands for managing modules:

Install modules

Install modules from various sources:

Starter modules:

pimp module install alacritty

Git repositories:

pimp module install https://github.com/pimpmyrice-modules/alacritty

Multiple modules:

pimp module install alacritty i3 polybar

Clone modules from various sources:

Starter modules:

pimp module clone alacritty

Git repositories:

pimp module clone https://github.com/pimpmyrice-modules/alacritty
# or using ssh
pimp module clone git@github.com:pimpmyrice-modules/alacritty.git

Local directories:

pimp module clone ./development/pimp-modules/alacritty

With custom output directory:

pimp module clone alacritty --out=~/custom-modules/

Initialize a module (runs the module's init steps):

pimp module init alacritty

Run a command defined in a module:

pimp module run slideshow start

With arguments:

pimp module run slideshow start --duration=30 --transition=fade

Create a new module:

pimp module create my_custom_module

Delete one or more modules:

pimp module delete alacritty

Multiple modules:

pimp module delete alacritty i3 polybar

List all installed modules:

pimp module list

Edit a module in your editor:

pimp module edit alacritty

Rewrite one or more modules (useful for updating after config changes):

pimp module rewrite alacritty i3