Skip to main content

Sockets API

Socket modules provide real-time WebSocket communication with the Codebolt server. Access via client.sockets.<module>.

All socket modules extend TypedEventEmitter and provide:

  • .on(event, handler) — listen for an event
  • .off(event, handler) — remove a listener
  • .once(event, handler) — listen once
import { CodeBoltClient } from '@codebolt/clientsdk';

const client = new CodeBoltClient();

// Listen for task updates
client.sockets.tasks.on('taskAdded', (data) => {
  console.log('New task:', data);
});

// Listen for chat messages
client.sockets.chat.on('message', (data) => {
  console.log('Message:', data);
});

// Listen across all sockets
client.onAllEvents((event) => {
  console.log(`[${event.socketName}] ${event.eventName}`, event.data);
});

Available Sockets​

SocketDescription
agentDebugAgent debugging events
agentPortfolioAgent portfolio updates
aiTerminalAI terminal interaction
backgroundAgentBackground agent events
browserBrowser automation events
calendarCalendar events
capabilityCapability updates
chatChat message streaming
codeboltCodebolt core events
contextAssemblyContext assembly events
debugDebug session events
editorEditor synchronization
environmentDebugEnvironment debug events
episodicMemoryMemory events
eventLogEvent log entries
fileUpdateIntentFile update events
iconViewIcon view updates
jobsJob monitoring events
knowledgeKnowledge base events
kvStoreKey-value store events
localModelLocal model events
lspLanguage Server Protocol
mainMain connection events
orchestratorOrchestration events
persistentMemoryPersistent memory events
projectStructureProject structure changes
reviewMergeCode review/merge events
roadmapRoadmap updates
shellPTY terminal — send commands, resize, receive output
swarmSwarm coordination events
systemAlertSystem alerts
tasksTask update events
updateRequestUpdate notifications