Module


Download

Downloads one or more ProcessWire modules.

$ wireshell module:download {module-class},{module-class}

Available options:

--github : Download module via github; use this option if the module is not added to the ProcessWire module directory yet
--branch : Define specific branch to download from, if you use this option, --github is required

Examples

Separate module names with commas to download two or more modules at once.

$ wireshell module:download FlagPages,ImageExtra

Download module via github.

$ wireshell module:download ContinentsAndCountries --github=justb3a/processwire-countries

If you want to download a branch, you have to provide the --github option, too.

$ wireshell module:download FlagPages --github=marcus-herrmann/ProcessWire-FlagPages --branch=develop

Enable

Enable and install a module. If the module is not found in the particular installation, wireshell downloads it first.

$ wireshell module:enable {module-class},{module-class}

Available options:

--github : Download module via github; use this option if the module is not added to the ProcessWire module directory yet
--branch : Define specific branch to download from, if you use this option, --github is required

Examples

Separate module names with commas to enable two or more modules at once.

$ wireshell module:download FlagPages,ImageExtra

Download and enable module via github.

$ wireshell module:download ContinentsAndCountries --github=justb3a/processwire-countries

Download develop branch and enable module.

$ wireshell module:download FlagPages --github=marcus-herrmann/ProcessWire-FlagPages --branch=develop

Disable

Disables and uninstalls one or more modules.

$ wireshell module:disable {class-name} {class-name}

Available options:

--rm : Remove module files

Examples

Deinstall modules but keep files.

$ wireshell module:disable FlagPages ImageExtra

Deinstall modules and remove files.

$ wireshell module:disable --rm FlagPages ImageExtra

Upgrade

Upgrades given module(s).

$ wireshell module:upgrade {class-name} {class-name}*

* This argument is optional. If you want to check for module updates, just skip it.

Available options:

--check : Just check for module upgrades.

Examples

Check if module upgrades are available.

$ wireshell module:upgrade

An upgrade is available for:
  - FlagPages: 0.0.8 -> 0.2.3
  - ImageExtra: 0.0.1 -> 0.0.3

Download and upgrade existing module ImageExtra.

$ wireshell module:upgrade ImageExtra

An upgrade for ImageExtra is available: 0.0.3
Downloading module ImageExtra...
  840.40 KB/840.40 KB ▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓  100%

 Preparing module...

 Module ImageExtra downloaded successfully.

Module `ImageExtra` was updated successfully.

Generate

Generates a module via modules.pw.

$ wireshell module:generate {class-name}

Available options:

--title : Module title
--mod-version : Module version
--author : Module author
--link : Module link
--summary : Module summary
--type : Module type
--extends : Module extends
--implements : Module implements (Interface)
--require-pw : ProcessWire version compatibility
--require-php : PHP version compatibility
--is-autoload : autoload = true
--is-singular : singular = true
--is-permanent : permanent = true
--with-external-json : external json config file
--with-copyright : Adds copyright in comments
--with-uninstall : Adds uninstall method
--with-sample-code : Adds sample code
--with-config-page : Adds config page

Examples

For more information on values and module authoring, visit the great generator modules.pw.