@kucedr/sdk is the typed bridge between your code and Kucedr. Use it to build a focused app that opens in its own Kucedr window, or connect a separate Node.js process to the local Kucedr API.
The SDK is framework-independent. An embedded app can use plain HTML and TypeScript, React, Vue, Svelte, or any other browser stack that builds to a local HTML entry point.
Choose An Integration Mode
| Mode | Best for | Connection |
|---|---|---|
| Embedded app | Dashboards, editors, studios, and repeatable workflows with a dedicated interface | Kucedr injects a typed preload bridge into the app window. |
| External Node.js client | Scripts, command-line tools, and another local desktop app | connect() calls the authenticated API on http://127.0.0.1:8765. |
Embedded apps can use host capabilities such as theme data, app-owned storage, configured image generation, and native window controls. Protected APIs remain subject to the host's runtime authorization; for example, Coder and terminal capabilities are limited to registered Kucedr apps.
The external client intentionally exposes a smaller surface: supported app settings, workspace file operations, change events, ping(), and close(). It does not expose embedded-only window, model, Coder, or terminal APIs.
Package Status
The SDK source and TypeScript declarations live in the Kucedr repository under packages/sdk. The package is prepared as @kucedr/sdk, requires Node.js 18 or newer, and is not yet available from the public npm registry. Until it is published, install it from a local Kucedr checkout:
npm install /absolute/path/to/kucedr/packages/sdk
Apps developed inside the Kucedr repository use a local workspace dependency instead:
{
"dependencies": {
"@kucedr/sdk": "file:../../../packages/sdk"
}
}
What You Can Build
- A project dashboard that follows Kucedr's current light or dark theme.
- A media studio that uses the image model already configured in Kucedr without receiving provider credentials.
- A workspace viewer for supported text and media files.
- A local automation or reporting tool that reads workspace data through the authenticated HTTP bridge.
- A focused interface backed by isolated JSON state and app-owned files.
Start Building
Follow Build Your First App for a minimal browser app, manifest, build, and import flow. Use the SDK API Reference to choose the right namespace and understand which capabilities are embedded-only.
Kucedr apps run in a sandboxed Electron web runtime, but installed code can still access powerful host APIs. Install app folders only from sources you trust, and never store passwords or API keys in app storage.