mirror of
https://github.com/CopilotKit/CopilotKit.git
synced 2026-09-14 16:26:20 +08:00
Benjamin Taylor
4d74bdc5c3
Creating a Node listener or an Express handler now STARTS activation of the runtime's declared managed Channels, so `channels.ready()` becomes await-and-observe instead of the thing you must remember to call. A declared Channel connects because it was declared. The failure mode this removes: forget `ready()` and you get a process that serves HTTP, looks healthy, and is silently disconnected with zero output. Auto-start's worst case is an activation error in the logs. The generic Fetch handler stays LAZY — it is the serverless/edge entry point, where isolates freeze and recycle per request and separate cold starts would mint competing listeners for the same Channel. `createCopilotHonoHandler` stays lazy for the same reason: it is our Next.js App Router surface in practice (every `examples/showcases/*` route handler builds one at module scope), and its TSDoc now says so loudly. `activateChannels: false` remains the opt-out that opens no socket. Consequence for host code: the shutdown-handler boundary moves earlier. Signal handlers must be registered before the listener is CREATED, not merely before `ready()` — otherwise a Ctrl-C during the connect window hits Node's default handler and leaks a live gateway session. The slack and teams examples and the docs snippets are restructured accordingly. Also migrates the seven channel-package README quickstarts off the generic handler (a request handler a socket-mode bot constructs and never serves) onto the Node listener, so they inherit auto-start and agree with the docs site. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@copilotkit/channels
@copilotkit/channels is the batteries-included CopilotKit Channels package. One install
provides the engine, JSX vocabulary, UI primitives, testing API, and every supported adapter.
Channels require a CopilotKit Intelligence connection (an API key — a free tier
is available, so this is "connect your Intelligence account," not "pay for it").
There is no standalone / DIY way to run a Channel: the CopilotRuntime starts and
owns each Channel's lifecycle once Intelligence is configured.
Install
pnpm add @copilotkit/channels
Configure TypeScript to use the Channels JSX runtime:
{
"compilerOptions": {
"jsx": "react-jsx",
"jsxImportSource": "@copilotkit/channels"
}
}
import { createChannel, Message, Section } from "@copilotkit/channels";
import { slack } from "@copilotkit/channels/slack";
import { CopilotRuntime, CopilotKitIntelligence } from "@copilotkit/runtime/v2";
import { createCopilotNodeListener } from "@copilotkit/runtime/v2/node";
const channel = createChannel({
name: "support-bot", // project-unique Intelligence Channel name
adapters: [
slack({
botToken: process.env.SLACK_BOT_TOKEN!,
appToken: process.env.SLACK_APP_TOKEN!,
}),
],
});
channel.onMessage(({ thread, message }) =>
thread.post(
<Message>
<Section>Echo: {message.text}</Section>
</Message>,
),
);
// The runtime owns the Channel's lifecycle — there is no `channel.start()`.
const runtime = new CopilotRuntime({
intelligence: new CopilotKitIntelligence({
// apiUrl and wsUrl default to the managed Intelligence platform — override
// both together only for a self-hosted deployment.
apiKey: process.env.COPILOTKIT_INTELLIGENCE_API_KEY!, // free tier available
}),
identifyUser: async () => ({ id: "support-bot", name: "Support Bot" }),
channels: [channel],
});
// Creating the listener starts the Channel's connection.
const listener = createCopilotNodeListener({ runtime });
// Optional: await that activation so a broken config fails startup loudly.
await listener.channels.ready(); // listener.channels.stop() tears it down
Adapter entry points
@copilotkit/channels/slack(plus/slack/codecand/slack/render)@copilotkit/channels/teams(plus/teams/render)@copilotkit/channels/discord@copilotkit/channels/telegram@copilotkit/channels/whatsapp
One package version gives you a tested snapshot of the core engine, JSX/UI vocabulary, testing helpers, and every adapter listed above.
For adapter authoring or a selective dependency graph, install
@copilotkit/channels-core plus the direct adapter package you need, for example:
pnpm add @copilotkit/channels-core @copilotkit/channels-slack