Reference
Dry, complete, mostly auto-generated. This section is for when you need the exact signature, schema, or type — not for learning how Codebolt works.
The reference is organized by SDK, since each targets a different developer:
| SDK / Package | Who it's for | Start here |
|---|---|---|
| codeboltjs | Agent authors — writing or extending agents | codeboltjs Reference |
| Codebolt CLI | Command-line users — running CodeBolt, scaffolding extensions, and server commands | Codebolt CLI Reference |
| Agent Framework | Framework internals — processor pipeline, tool system, multi-agent teams | Agent Framework Reference |
| Plugin SDK | Plugin authors — hooks, UI panels, providers, commands | Plugin SDK Reference |
| Client SDK | UI / integration authors — bots, IDE extensions, CI runners | Client SDK Reference |
Which reference for which job
"I'm building an agent"
→ codeboltjs → API Access for every ctx.* method.
→ codeboltjs → Type Reference for TypeScript types.
"I need the agent loop internals — processors, tools, team coordination" → Agent Framework Reference.
"I'm using the CLI" → Codebolt CLI Reference.
"I'm building a plugin" → Plugin SDK Reference.
"I'm building a custom UI, bot, or integration" → Client SDK Reference.
"I'm exposing tools via MCP" → codeboltjs → MCP Access.
Auto-generation
Most of this reference is generated from TypeScript source — TypeDoc for class/interface/function docs, regenerated on every release. Hand-editing reference pages is discouraged; they drift. The prose guides in Build on Codebolt are the right place for explanations and examples.
See also
- Build on Codebolt — the guides that the reference complements
- System Internals — the mental model