Building Plugins

Building a plugin means writing a Node.js package that connects to the Codebolt server via WebSocket and registers capabilities using the @codebolt/plugin-sdk. This page is a brief orientation — the full developer documentation lives in Build on Codebolt.

What you can build

Plugin type	What it does	Guide
LLM Provider	Adds a custom AI provider to the model selector	Custom AI Providers →
Chat Gateway	Connects an external messaging platform to agents	Chat Gateway →
Execution	Proxies code execution to a remote environment	Proxy Execution Gateway →
UI Panel	Adds a custom panel inside the Codebolt desktop app	Dynamic Panel Plugins →
Generic	Any other application extension	Plugins Overview →

Quick start

# 1. Create a plugin folder
mkdir my-plugin && cd my-plugin
npm init -y
npm install @codebolt/plugin-sdk typescript

# 2. Add the codebolt.plugin field to package.json
# (see Build on Codebolt → Plugins for the full manifest reference)

# 3. Write src/index.ts
import plugin from '@codebolt/plugin-sdk';

plugin.onStart(async (ctx) => {
  console.log('Plugin started:', ctx.pluginId);
  // register capabilities here
});

plugin.onStop(async () => {
  // clean up
});

# 4. Build and install locally for testing
npx tsc
cp -r . ~/.codebolt/plugins/my-plugin

# 5. In Codebolt: Plugins panel → Reload → Start

Developer documentation

Everything you need to build and publish a plugin:

• Plugins Overview — architecture, plugin types, manifest reference, full SDK module list
• SDK and Lifecycle — lifecycle hooks, environment variables, start triggers
• Major Functionalities — filesystem, chat, LLM, knowledge, UI, and storage modules
• Dynamic Panel Plugins — building custom UI panels
• Packaging and Publishing — pre-publish checklist, local dev loop, codebolt plugin publish

Publishing to the marketplace

When your plugin is ready:

codebolt plugin publish --path ./my-plugin

After publishing, it appears in the Plugin Marketplace and can be installed by others. See the Packaging and Publishing guide for the full checklist.