Plugin Reference

Plugin Location

The default location for plugins is $HOME/.rtm.plugins/. Plugins placed in this directory can be either individual JavaScript files or directories containing Node packages that export RTM CLI commands.

Additional locations for plugins can be added to the plugins property in the configuration file (See the description for plugins in the configuration property table in the Configuration Reference). This property can contain individual plugin locations or additional directories that contain multiple plugins.

Installing Plugins

Manual Install

You can manually download the plugin from its source (such as GitHub) and place the plugin in the default plugin location ($HOME/.rtm.plugins/).

Optionally, you can put the plugin in a different location and reference its location in the plugins property of your configuration file.

NPM Download

If the plugin is available via npm, you can use npm to download the package into your plugins directory ($HOME/.rtm.plugins/):

$ cd ~/.rtm.plugins/
$ npm pack rtm-cli-plugin-example
$ tar -xvzf rtm-cli-plugin-example-*.tgz
$ mv package/ rtm-cli-plugin-example
$ rm rtm-cli-plugin-example-*.tgz

If the plugin has any dependencies, they can be installed using npm:

$ cd rtm-cli-plugin-example
$ npm install

GitHub Download

If the plugin is available on GitHub, you can download the repository archive and install the plugin into your plugins directory ($HOME/.rtm.plugins/):

$ cd ~/.rtm.plugins/
$ curl -L https://github.com/dwaring87/rtm-cli-plugin-example/archive/master.zip > master.zip
$ unzip master.zip
$ mv rtm-cli-plugin-example-master/ rtm-cli-plugin-example
$ rm master.zip

If the plugin has any dependencies, they can be installed using npm:

$ cd rtm-cli-plugin-example
$ npm install