Merge pull request #1018 from bbassie/feature/plugin-install

Add plugin install command to controller, host and ctl
This commit is contained in:
Cooldude2606 authored and GitHub committed 2026-09-12 23:35:26 +01:00
commit 8be251447a
6 files changed
+294 -24

No files matched your search

+16 -5
View File
@@ -25,17 +25,28 @@ Configure plugins available to be loaded by the controller.
The available plugins will be loaded unless they have been disabled in the configuration, see the config command for disabling plugins.
#### `plugin install <package>`
Install a plugin from npm and add it to the plugin list.
The package is passed to `npm install --save` so anything npm accepts works, including a version like `@clusterio/plugin-subspace_storage@2.0.0`.
This command refuses to run outside the directory Clusterio was installed in, as the plugin has to end up in that directory's node_modules to be found.
For example, installing the Subspace Storage plugin:
npx clusteriocontroller plugin install @clusterio/plugin-subspace_storage
Since the `plugin-list.json` is shared between controller, host and ctl you usually only need to do this once per machine.
#### `plugin add <path>`
Add plugin either by require path or relative/absolute path to the plugin directory.
A relative path must start with ./ or ../ (or .\ and ..\ on Windows) otherwise it will be assumed to be a require path for an installed package in node_modules.
This is mainly useful for plugins under development, packages published on npm are better installed with `plugin install`.
For example, installing the Subspace Storage plugin:
For example, adding a plugin checked out in the external_plugins directory:
npm install @clusterio/plugin-subspace_storage
npx clusteriocontroller plugin add @clusterio/plugin-subspace_storage
Since the `plugin-list.json` is shared between controller, host and ctl you usually only need to do this once per machine.
npx clusteriocontroller plugin add ./external_plugins/my_plugin
#### `plugin remove <name>`