Skip to main content

Custom Interfaces

Build your own interface on top of Codebolt: a chat panel, a CLI, an IDE extension, a web dashboard, a mobile companion, or a product-specific front-end.

If you want to use an existing UI (desktop app, web app, IDE extensions), see Using Codebolt. This section is for building new ones.

When to build a custom UI​

  • The built-in interfaces don't fit your workflow — an ops dashboard, a game interface, a custom CLI shape.
  • You're embedding Codebolt in a larger application (your internal portal, a bespoke editor).
  • You want agent interaction from a device or context the built-ins don't cover.
  • You're building a vertical product on top of Codebolt — a "Codebolt for X" app.

In This Section​

Two shapes of client​

ShapeWhat it isWhen
Full-control UIYour app speaks directly to the server over WebSocket + routesYou own the whole UX — branding, layout, device
Panel / widgetA UI surface embedded inside Codebolt via dynamic panelsYou want to extend the existing app with a new view

Build a panel if your UI should appear inside the Codebolt desktop app. Build a full UI if it runs somewhere else entirely.

Pick the lightest starting point that matches your needs:

  • I want a complete custom application: start with Client SDK.
  • I want a custom chat experience in React: start with Chat Widget.
  • I want to understand how the existing clients work: start with Existing UIs.
  • I want UI inside the existing app: start with Dynamic Panels.

Quickstart​

Minimal shape:

  1. Start the backend with codebolt --server.
  2. Connect a client using @codebolt/client-sdk.
  3. If you need chat UI quickly, use Chat Widget.
  4. If you need UI inside the existing app, use Dynamic Panels.

See also​