CodeBoltClient

@codebolt/client-sdk

---

Class: CodeBoltClient

Defined in: CodeBolt/packages/clientsdk/src/client.ts:140

CodeBoltClient is the main facade that provides access to all CodeBolt API modules and WebSocket connections. Each module is lazily initialized on first access to avoid unnecessary resource allocation.

Example

import { CodeBoltClient } from '@codebolt/client-sdk';

const client = new CodeBoltClient({ host: 'localhost', port: 12345 });

// Use HTTP API modules
const threads = await client.chat.getThreadsInfo();
await client.git.commit({ message: 'fix bug' });

// Use WebSocket modules
await client.sockets.shell.connect();
client.sockets.shell.send('ls -la');

// Cleanup
await client.disconnectAll();

Constructors

Constructor

new CodeBoltClient(config?: Partial<CodeBoltConfig>): CodeBoltClient;

Defined in: CodeBolt/packages/clientsdk/src/client.ts:255

Parameters

Parameter	Type
config?	Partial<CodeBoltConfig>

Returns

CodeBoltClient

Accessors

actionBlocks

Get Signature

get actionBlocks(): ActionBlocksApi;

Defined in: CodeBolt/packages/clientsdk/src/client.ts:279

Action Blocks API

Returns

ActionBlocksApi

---

actionPlans

Get Signature

get actionPlans(): ActionPlansApi;

Defined in: CodeBolt/packages/clientsdk/src/client.ts:286

Action Plans API

Returns

ActionPlansApi

---

agentDebugApi

Get Signature

get agentDebugApi(): AgentDebugApi;

Defined in: CodeBolt/packages/clientsdk/src/client.ts:292

Agent Debug API

Returns

AgentDebugApi

---

agentDeliberation

Get Signature

get agentDeliberation(): AgentDeliberationApi;

Defined in: CodeBolt/packages/clientsdk/src/client.ts:299

Agent Deliberation API

Returns

AgentDeliberationApi

---

agentExecution

Get Signature

get agentExecution(): AgentExecutionApi;

Defined in: CodeBolt/packages/clientsdk/src/client.ts:313

Agent Execution API

Returns

AgentExecutionApi

---

agentExecutionPhases

Get Signature

get agentExecutionPhases(): AgentExecutionPhasesApi;

Defined in: CodeBolt/packages/clientsdk/src/client.ts:306

Agent Execution Phases API

Returns

AgentExecutionPhasesApi

---

agentFlow

Get Signature

get agentFlow(): AgentFlowApi;

Defined in: CodeBolt/packages/clientsdk/src/client.ts:320

Agent Flow API

Returns

AgentFlowApi

---

agentPortfolioApi

Get Signature

get agentPortfolioApi(): AgentPortfolioApi;

Defined in: CodeBolt/packages/clientsdk/src/client.ts:326

Agent Portfolio API

Returns

AgentPortfolioApi

---

agents

Get Signature

get agents(): AgentsApi;

Defined in: CodeBolt/packages/clientsdk/src/client.ts:333

Agents API - agent management

Returns

AgentsApi

---

application

Get Signature

get application(): ApplicationApi;

Defined in: CodeBolt/packages/clientsdk/src/client.ts:339

Application API

Returns

ApplicationApi

---

apps

Get Signature

get apps(): AppsApi;

Defined in: CodeBolt/packages/clientsdk/src/client.ts:345

Apps API

Returns

AppsApi

---

autoTesting

Get Signature

get autoTesting(): AutoTestingApi;

Defined in: CodeBolt/packages/clientsdk/src/client.ts:351

Auto Testing API

Returns

AutoTestingApi

---

backgroundAgents

Get Signature

get backgroundAgents(): BackgroundAgentsApi;

Defined in: CodeBolt/packages/clientsdk/src/client.ts:357

Background Agents API

Returns

BackgroundAgentsApi

---

browser

Get Signature

get browser(): BrowserApi;

Defined in: CodeBolt/packages/clientsdk/src/client.ts:364

Browser API - browser automation

Returns

BrowserApi

---

calendar

Get Signature

get calendar(): CalendarApi;

Defined in: CodeBolt/packages/clientsdk/src/client.ts:370

Calendar API

Returns

CalendarApi

---

canvas

Get Signature

get canvas(): CanvasApi;

Defined in: CodeBolt/packages/clientsdk/src/client.ts:376

Canvas API

Returns

CanvasApi

---

capability

Get Signature

get capability(): CapabilityApi;

Defined in: CodeBolt/packages/clientsdk/src/client.ts:382

Capability API

Returns

CapabilityApi

---

chat

Get Signature

get chat(): ChatApi;

Defined in: CodeBolt/packages/clientsdk/src/client.ts:388

Chat API - thread management, messaging, steps, and steering

Returns

ChatApi

---

codebaseIndex

Get Signature

get codebaseIndex(): CodebaseIndexApi;

Defined in: CodeBolt/packages/clientsdk/src/client.ts:394

Codebase Index API

Returns

CodebaseIndexApi

---

codeboltTools

Get Signature

get codeboltTools(): CodeboltToolsApi;

Defined in: CodeBolt/packages/clientsdk/src/client.ts:401

Codebolt Tools API

Returns

CodeboltToolsApi

---

codemap

Get Signature

get codemap(): CodemapApi;

Defined in: CodeBolt/packages/clientsdk/src/client.ts:408

Codemap API

Returns

CodemapApi

---

contextAssembly

Get Signature

get contextAssembly(): ContextAssemblyApi;

Defined in: CodeBolt/packages/clientsdk/src/client.ts:414

Context Assembly API

Returns

ContextAssemblyApi

---

contextRuleEngine

Get Signature

get contextRuleEngine(): ContextRuleEngineApi;

Defined in: CodeBolt/packages/clientsdk/src/client.ts:421

Context Rule Engine API

Returns

ContextRuleEngineApi

---

controllk

Get Signature

get controllk(): ControllkApi;

Defined in: CodeBolt/packages/clientsdk/src/client.ts:428

Controllk API

Returns

ControllkApi

---

editorApi

Get Signature

get editorApi(): EditorApi;

Defined in: CodeBolt/packages/clientsdk/src/client.ts:434

Editor API

Returns

EditorApi

---

environmentDebugApi

Get Signature

get environmentDebugApi(): EnvironmentDebugApi;

Defined in: CodeBolt/packages/clientsdk/src/client.ts:440

Environment Debug API

Returns

EnvironmentDebugApi

---

environments

Get Signature

get environments(): EnvironmentsApi;

Defined in: CodeBolt/packages/clientsdk/src/client.ts:447

Environments API

Returns

EnvironmentsApi

---

eventLog

Get Signature

get eventLog(): EventLogApi;

Defined in: CodeBolt/packages/clientsdk/src/client.ts:454

Event Log API

Returns

EventLogApi

---

file

Get Signature

get file(): FileApi;

Defined in: CodeBolt/packages/clientsdk/src/client.ts:467

File API

Returns

FileApi

---

fileRead

Get Signature

get fileRead(): FileReadApi;

Defined in: CodeBolt/packages/clientsdk/src/client.ts:473

File Read API

Returns

FileReadApi

---

fileUpdateIntents

Get Signature

get fileUpdateIntents(): FileUpdateIntentsApi;

Defined in: CodeBolt/packages/clientsdk/src/client.ts:460

File Update Intents API

Returns

FileUpdateIntentsApi

---

git

Get Signature

get git(): GitApi;

Defined in: CodeBolt/packages/clientsdk/src/client.ts:479

Git API - git operations

Returns

GitApi

---

history

Get Signature

get history(): HistoryApi;

Defined in: CodeBolt/packages/clientsdk/src/client.ts:485

History API

Returns

HistoryApi

---

hooks

Get Signature

get hooks(): HooksApi;

Defined in: CodeBolt/packages/clientsdk/src/client.ts:491

Hooks API

Returns

HooksApi

---

iconView

Get Signature

get iconView(): IconViewApi;

Defined in: CodeBolt/packages/clientsdk/src/client.ts:497

Icon View API

Returns

IconViewApi

---

inbox

Get Signature

get inbox(): InboxApi;

Defined in: CodeBolt/packages/clientsdk/src/client.ts:503

Inbox API

Returns

InboxApi

---

jobs

Get Signature

get jobs(): JobsApi;

Defined in: CodeBolt/packages/clientsdk/src/client.ts:509

Jobs API

Returns

JobsApi

---

knowledge

Get Signature

get knowledge(): KnowledgeApi;

Defined in: CodeBolt/packages/clientsdk/src/client.ts:522

Knowledge API

Returns

KnowledgeApi

---

knowledgeGraph

Get Signature

get knowledgeGraph(): KnowledgeGraphApi;

Defined in: CodeBolt/packages/clientsdk/src/client.ts:515

Knowledge Graph API

Returns

KnowledgeGraphApi

---

kvStore

Get Signature

get kvStore(): KvStoreApi;

Defined in: CodeBolt/packages/clientsdk/src/client.ts:528

KV Store API

Returns

KvStoreApi

---

languageServer

Get Signature

get languageServer(): LanguageServerApi;

Defined in: CodeBolt/packages/clientsdk/src/client.ts:534

Language Server API

Returns

LanguageServerApi

---

llm

Get Signature

get llm(): LlmApi;

Defined in: CodeBolt/packages/clientsdk/src/client.ts:541

LLM API - language model operations

Returns

LlmApi

---

localModels

Get Signature

get localModels(): LocalModelsApi;

Defined in: CodeBolt/packages/clientsdk/src/client.ts:547

Local Models API

Returns

LocalModelsApi

---

mail

Get Signature

get mail(): MailApi;

Defined in: CodeBolt/packages/clientsdk/src/client.ts:553

Mail API

Returns

MailApi

---

mcp

Get Signature

get mcp(): McpApi;

Defined in: CodeBolt/packages/clientsdk/src/client.ts:559

MCP API

Returns

McpApi

---

memory

Get Signature

get memory(): MemoryApi;

Defined in: CodeBolt/packages/clientsdk/src/client.ts:572

Memory API

Returns

MemoryApi

---

memoryIngestion

Get Signature

get memoryIngestion(): MemoryIngestionApi;

Defined in: CodeBolt/packages/clientsdk/src/client.ts:565

Memory Ingestion API

Returns

MemoryIngestionApi

---

orchestrator

Get Signature

get orchestrator(): OrchestratorApi;

Defined in: CodeBolt/packages/clientsdk/src/client.ts:578

Orchestrator API

Returns

OrchestratorApi

---

persistentMemory

Get Signature

get persistentMemory(): PersistentMemoryApi;

Defined in: CodeBolt/packages/clientsdk/src/client.ts:585

Persistent Memory API

Returns

PersistentMemoryApi

---

planner

Get Signature

get planner(): PlannerApi;

Defined in: CodeBolt/packages/clientsdk/src/client.ts:592

Planner API

Returns

PlannerApi

---

profile

Get Signature

get profile(): ProfileApi;

Defined in: CodeBolt/packages/clientsdk/src/client.ts:598

Profile API

Returns

ProfileApi

---

projects

Get Signature

get projects(): ProjectsApi;

Defined in: CodeBolt/packages/clientsdk/src/client.ts:611

Projects API - project management

Returns

ProjectsApi

---

projectStructure

Get Signature

get projectStructure(): ProjectStructureApi;

Defined in: CodeBolt/packages/clientsdk/src/client.ts:604

Project Structure API

Returns

ProjectStructureApi

---

requirementPlan

Get Signature

get requirementPlan(): RequirementPlanApi;

Defined in: CodeBolt/packages/clientsdk/src/client.ts:617

Requirement Plan API

Returns

RequirementPlanApi

---

reviewMerge

Get Signature

get reviewMerge(): ReviewMergeApi;

Defined in: CodeBolt/packages/clientsdk/src/client.ts:624

Review Merge API

Returns

ReviewMergeApi

---

roadmap

Get Signature

get roadmap(): RoadmapApi;

Defined in: CodeBolt/packages/clientsdk/src/client.ts:630

Roadmap API

Returns

RoadmapApi

---

shadowGit

Get Signature

get shadowGit(): ShadowGitApi;

Defined in: CodeBolt/packages/clientsdk/src/client.ts:636

Shadow Git API

Returns

ShadowGitApi

---

sockets

Get Signature

get sockets(): CodeBoltSockets;

Defined in: CodeBolt/packages/clientsdk/src/client.ts:737

Socket namespace providing lazy access to all WebSocket connections

Returns

CodeBoltSockets

---

specs

Get Signature

get specs(): SpecsApi;

Defined in: CodeBolt/packages/clientsdk/src/client.ts:642

Specs API

Returns

SpecsApi

---

swarm

Get Signature

get swarm(): SwarmApi;

Defined in: CodeBolt/packages/clientsdk/src/client.ts:648

Swarm API

Returns

SwarmApi

---

system

Get Signature

get system(): SystemApi;

Defined in: CodeBolt/packages/clientsdk/src/client.ts:654

System API

Returns

SystemApi

---

taskActivity

Get Signature

get taskActivity(): TaskActivityApi;

Defined in: CodeBolt/packages/clientsdk/src/client.ts:660

Task Activity API

Returns

TaskActivityApi

---

tasks

Get Signature

get tasks(): TasksApi;

Defined in: CodeBolt/packages/clientsdk/src/client.ts:667

Tasks API - task management

Returns

TasksApi

---

templates

Get Signature

get templates(): TemplatesApi;

Defined in: CodeBolt/packages/clientsdk/src/client.ts:673

Templates API

Returns

TemplatesApi

---

terminalProcesses

Get Signature

get terminalProcesses(): TerminalProcessesApi;

Defined in: CodeBolt/packages/clientsdk/src/client.ts:679

Terminal Processes API

Returns

TerminalProcessesApi

---

themes

Get Signature

get themes(): ThemesApi;

Defined in: CodeBolt/packages/clientsdk/src/client.ts:686

Themes API

Returns

ThemesApi

---

threads

Get Signature

get threads(): ThreadsApi;

Defined in: CodeBolt/packages/clientsdk/src/client.ts:698

Threads API - thread CRUD

Returns

ThreadsApi

---

threadSteps

Get Signature

get threadSteps(): ThreadStepsApi;

Defined in: CodeBolt/packages/clientsdk/src/client.ts:692

Thread Steps API

Returns

ThreadStepsApi

---

todos

Get Signature

get todos(): TodosApi;

Defined in: CodeBolt/packages/clientsdk/src/client.ts:704

Todos API

Returns

TodosApi

---

updateRequests

Get Signature

get updateRequests(): UpdateRequestsApi;

Defined in: CodeBolt/packages/clientsdk/src/client.ts:710

Update Requests API

Returns

UpdateRequestsApi

---

users

Get Signature

get users(): UsersApi;

Defined in: CodeBolt/packages/clientsdk/src/client.ts:717

Users API

Returns

UsersApi

---

vectorDb

Get Signature

get vectorDb(): VectorDbApi;

Defined in: CodeBolt/packages/clientsdk/src/client.ts:723

Vector DB API

Returns

VectorDbApi

---

workspace

Get Signature

get workspace(): WorkspaceApi;

Defined in: CodeBolt/packages/clientsdk/src/client.ts:729

Workspace API

Returns

WorkspaceApi

Methods

addConnections()

addConnections(socketNames: string[]): Promise<void>;

Defined in: CodeBolt/packages/clientsdk/src/client.ts:938

Parameters

Parameter	Type
socketNames	string[]

Returns

Promise<void>

---

disconnectAll()

disconnectAll(): Promise<void>;

Defined in: CodeBolt/packages/clientsdk/src/client.ts:934

Disconnect all active WebSocket connections. Safe to call even if no sockets have been initialized.

Returns

Promise<void>

---

getActiveConnections()

getActiveConnections(): string[];

Defined in: CodeBolt/packages/clientsdk/src/client.ts:946

Returns

string[]

---

getConfig()

getConfig(): Readonly<CodeBoltConfig>;

Defined in: CodeBolt/packages/clientsdk/src/client.ts:962

Returns the resolved configuration

Returns

Readonly<CodeBoltConfig>

---

getHttpClient()

getHttpClient(): HttpClient;

Defined in: CodeBolt/packages/clientsdk/src/client.ts:967

Returns the underlying HttpClient for advanced usage

Returns

HttpClient

---

onAllEvents()

onAllEvents(callback: (event: SocketEvent) => void): UnsubscribeFn;

Defined in: CodeBolt/packages/clientsdk/src/client.ts:950

Parameters

Parameter	Type
callback	(event: SocketEvent) => void

Returns

UnsubscribeFn

---

onEvents()

onEvents(filter: EventFilter, callback: (event: SocketEvent) => void): UnsubscribeFn;

Defined in: CodeBolt/packages/clientsdk/src/client.ts:954

Parameters

Parameter	Type
filter	EventFilter
callback	(event: SocketEvent) => void

Returns

UnsubscribeFn

---

removeConnections()

removeConnections(socketNames: string[]): Promise<void>;

Defined in: CodeBolt/packages/clientsdk/src/client.ts:942

Parameters

Parameter	Type
socketNames	string[]

Returns

Promise<void>