Home

Installing Plugins

...

Creating Commands

There are multiple ways to contribute new commands to rtm-cli.

• If you think the command would be helpful to most rtm-cli users, then consider creating a pull request that adds the command directly to this project. All commands are individual JavaScript files in the /src/cmd/ directory of this project.

• If you want to distribute your command(s) independently, then consider creating a Node module that can be used by rtm-cli to import your command(s) as a plugin. A plugin can include a single command or a bundle of multiple commands. By packaging your command as a Node module, users can easily install your plugin via npm.

• If you don't plan on distributing your command, the easiest way to add a plugin is as a single JavaScript file in the default plugin directory (~/.rtm.plugins/) or referenced in the plugins directive of your configuration file.

Command Documentation

• Command Structure - documentation on the structure of a command
• Plugin Example - An example plugin containing two commands and packaged as a Node module.