bbassieandClaude Fable 5.1
5606d5d553
Installing a plugin used to take two steps, npm install followed by plugin add, and both silently did their work in whatever directory they were run from. The new plugin install <package> subcommand runs npm install --save and then discovers the plugin through the existing loadPluginList logic, so the plugin list is updated in the same step. The command refuses to run outside a Clusterio installation, detected by the package.json the installer writes or one that depends on a Clusterio package. plugin add with a bare package name warns in the same situation. Reinstalling a plugin that is already listed reports it as such instead of failing. Installing a package without the clusterio-plugin keyword fails. Fixes #1008 Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Clusterio Command Line Interface
Provides a command line interface for managing a Clusterio cluster.
Note that this document only describes the options and commands for managing clusterioctl itself, see Managing a cluster for the available commands used for managing a cluster.
Usage
npx clusterioctl <command>
Common options:
-
--plugin-list <file>JSON file to use for storing the list of plugins that are available to ctl. Defaults toplugin-list.jsonand will be created if it does not exist. See theplugincommand for managing this list. -
--config <file>JSON file to use for storing configuration for ctl. Defaults toconfig-control.jsonand will be created if it does not exist. See theconfigcommand for inspecting and modifying the configuration.
plugin <command>
Configure plugins available to be loaded by ctl. The available plugins will be automatically loaded and the commands they provide will be added to the ctl utility.
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 clusterioctl 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, adding a plugin checked out next to the Clusterio installation:
npx clusterioctl plugin add ../my_plugin
plugin remove <name>
Remove a plugin by its name. This should be done before uninstalling the plugin, otherwise there will be an error when Clusterio tries to load the info from the plugin. Removing and unistalling a plugin is usually not neccessary as the functions provided by the plugin can be disabled in the config.
For example, uninstalling the Subspace Storage plugin:
npx clusterioctl plugin remove subspace_storage
npm uninstall @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 list
Lists the plugins set up to be available by name followed by path.
config-control
Manage the ctl configuration. This allows setting the url and token to the controller to manage.
config-control set <config-entry> [value]
Set a config entry to the given value. If value is not provided the entry is set to null. If the config entry is of type object the value must be a valid JSON serialization of an object.
See docs/configuration.md in the main repositiory for the available configuration.
config-control show <config-entry>
Shows the value for a single config entry.
config-control list
Lists up all configuration entries with their currently configured values.
See Also
Managing a cluster for the available commands used for managing a cluster.
The Clusterio repository for instructions on how to set up a cluster.