Installing Plugins

Robo.js plugins are npm packages that also need to be registered in your Robo's configuration.

You can install and manage plugins using the Robo CLI or manually.

Using Robo CLI

The Robo CLI installs the plugin's npm package and registers it in your Robo's configuration.

The CLI automatically uses your current package manager:

Install

Run in your terminal, replacing <package> with the plugin name:

robo add <package>

This installs the package and registers it in your Robo's configuration. To install multiple plugins at once:

robo add @robojs/ai@next @robojs/server@next

You can also create a new Robo project with plugins pre-installed:

npx create-robo@next <projectName> --plugins @robojs/ai@next @robojs/server@next

Uninstall

To remove a plugin:

robo remove <package>

This uninstalls the package and removes it from your Robo's configuration.

Updates

Update Robo.js and all installed plugins:

robo upgrade

This shows a list of available updates and changelogs for you to select.

Manually

You can install plugins manually if you prefer not to use the Robo CLI.

Package Manager

Install the plugin with your package manager:

npm install <package>

Register Plugin

Robo.js discovers plugins by scanning the /config/plugins directory.

For each plugin, create an .mjs file in /config/plugins with the same name as the plugin's package. The file should export the plugin's configuration:

// config/plugins/<package>.mjs
export default {
	// ... plugin configuration
}

Remove the file when uninstalling the plugin.

Next Steps