Skip to main content

Installing Plugins

Plugins can be installed from the marketplace, from a local directory, or via the CLI. Once installed they appear in the Plugins panel where you can start, stop, reload, and configure them.

From the marketplace​

  1. Open the Plugins panel — bottom bar → Plugins dropdown, or View → Plugins.
  2. Click Browse Marketplace at the top of the panel.
  3. Search or browse by category (LLM Providers, Chat Gateways, Execution, UI).
  4. Click a plugin card to see its description, required configuration, and reviews.
  5. Click Install. Codebolt downloads the plugin into ~/.codebolt/plugins/ and starts it automatically if it has a startup trigger.

From a local directory​

If you have a plugin as a local folder (downloaded manually, shared by a colleague, or one you're developing):

# Copy to global plugins directory
cp -r ./my-plugin ~/.codebolt/plugins/my-plugin

# Or copy to the current project only
cp -r ./my-plugin ./.codeboltPlugins/my-plugin

Then open the Plugins panel and click Reload to discover the new plugin.

Configuring a plugin after install​

Most plugins require some configuration before they work — an API key, a bot token, a server URL. After installation:

  1. Find the plugin in the Plugins panel.
  2. Click the Configure (gear) icon.
  3. Fill in the required fields. These are stored securely in Codebolt's key-value store — not in plain files.
  4. Click Save, then Start if the plugin doesn't start automatically.

For chat gateway plugins, a configuration UI panel opens directly inside Codebolt where you enter your platform credentials.

Managing installed plugins​

The Plugins panel shows all discovered plugins with their status:

StatusMeaning
runningPlugin process is active and connected
stoppedPlugin is installed but not running
errorPlugin crashed or failed to connect
loadingPlugin process is starting up

Actions available per plugin:

  • Start / Stop — manually control the plugin process
  • Reload — stop, rebuild detection, and restart (useful during development)
  • Configure — open the settings form or UI panel
  • Uninstall — remove the plugin files from the plugin directory
  • View logs — open the Plugin Debug panel for this plugin's WebSocket traffic and errors

Scoping a plugin to one project​

By default, installing a plugin puts it in ~/.codebolt/plugins/ where it's active globally. To scope it to a single project:

codebolt plugin install <plugin-name> --project

Or move the plugin folder manually:

mv ~/.codebolt/plugins/my-plugin ./.codeboltPlugins/my-plugin

Project-scoped plugins override global plugins of the same name.

Updating plugins​

In the Plugins panel, plugins with available updates show an Update badge. Click it to update. Or update all at once: Plugins panel → ⋯ menu → Update all.

Uninstalling​

Plugins panel → plugin card → ⋯ menu → Uninstall. This stops the process and removes the plugin directory.