Install plugins

The recommended way to add and maintain plugins is via the CLI for speed, reliability, and reproducible setups. A manual file-based method is also available if terminal access isn’t possible.

• CLI: install, update, remove, or sync all plugins from a configuration file for consistent environments.

• Manual: place the plugin folder in the correct path; Castopod detects valid plugins automatically.

CLI Recommended

Use the CLI when server access is available; it supports version pinning and reproducible setups via configuration files.

With that, plugins are automatically tracked in two writable configuration files whenever you run the commands:

• plugins.json: lists the plugins you want to use, along with their version requirements. Think of it as a wish list of plugins.

• plugins-lock.json: records the exact versions that were actually installed, along with extra metadata. This ensures that even if a plugin is updated later, Castopod can reproduce the same working setup you had before.

Commands

• Install the latest compatible version of a plugin:

  php spark plugins:add acme/hello-world

• Install a specific version in order to pin environments:

  php spark plugins:add acme/hello-world@1.0.0

• Update a plugin to the latest available release:

  php spark plugins:update acme/hello-world

• Completely remove an installed plugin:

  php spark plugins:remove acme/hello-world

• Install all plugins listed in plugins.json:

  php spark plugins:install

Note

By default, all commands use the official Castopod plugin repository as the source for discovery, version resolution, and downloads.

You can edit the default repository by setting it in your .env:

plugins.repositoryUrl="YOUR_CUSTOM_REPOSITORY_URL"

Install manually (drag-and-drop)

If you only have FTP access or prefer a simple approach:

1. Download the plugin from plugins.castopod.org.

2. Place the plugin folder inside your Castopod installation at:
   plugins/{vendor}/{plugin-name}/