聊天 SDK

一个统一的 TypeScript SDK，用于在 Slack、Microsoft Teams、Google Chat、Discord、Telegram、GitHub、Linear 和 WhatsApp 上构建聊天机器人。只需编写一次机器人逻辑，即可部署到所有平台。

安装

npm install chat

为你的目标平台安装适配器：

npm install @chat-adapter/slack @chat-adapter/teams @chat-adapter/gchat @chat-adapter/discord @chat-adapter/telegram

使用

import { Chat } from "chat";
import { createSlackAdapter } from "@chat-adapter/slack";
import { createRedisState } from "@chat-adapter/state-redis";

const bot = new Chat({
  userName: "mybot",
  adapters: {
    slack: createSlackAdapter(),
  },
  state: createRedisState(),
});

bot.onNewMention(async (thread) => {
  await thread.subscribe();
  await thread.post("Hello! I'm listening to this thread.");
});

bot.onSubscribedMessage(async (thread, message) => {
  await thread.post(`You said: ${message.text}`);
});

完整的使用指南请参阅 入门指南。

支持的平台

平台	包名	提及	反应	卡片	模态框	流式传输	私信
Slack	@chat-adapter/slack	是	是	是	是	原生	是
Microsoft Teams	@chat-adapter/teams	是	只读	是	否	发布+编辑	是
Google Chat	@chat-adapter/gchat	是	是	是	否	发布+编辑	是
Discord	@chat-adapter/discord	是	是	是	否	发布+编辑	是
Telegram	@chat-adapter/telegram	是	是	部分支持	否	发布+编辑	是
GitHub	@chat-adapter/github	是	是	否	否	否	否
Linear	@chat-adapter/linear	是	是	否	否	否	否
WhatsApp	@chat-adapter/whatsapp	不适用	是	部分支持	否	否	是

功能特性

• 事件处理器 — 提及、消息、反应、按钮点击、斜杠命令、模态框
• AI 流式传输 — 使用原生 Slack 流式传输和发布+编辑回退机制流式输出大模型响应
• 卡片 — 基于 JSX 的交互式卡片（Block Kit、Adaptive Cards、Google Chat 卡片）
• 操作 — 处理按钮点击和下拉选择
• 模态框 — 带有文本输入、下拉菜单和验证的表单对话框
• 斜杠命令 — 处理 /command 调用
• 表情符号 — 类型安全、跨平台的表情符号，并支持自定义表情符号
• 文件上传 — 发送和接收文件附件
• 直接消息 — 以编程方式发起私信
• 临时消息 — 仅用户可见的消息，并带有私信回退机制

包列表

包名	描述
chat	核心 SDK，包含 Chat 类、类型定义、JSX 运行时和实用工具
@chat-adapter/slack	Slack 适配器
@chat-adapter/teams	Teams 适配器
@chat-adapter/gchat	Google Chat 适配器
@chat-adapter/discord	Discord 适配器
@chat-adapter/telegram	Telegram 适配器
@chat-adapter/github	GitHub 适配器
@chat-adapter/linear	Linear 适配器
@chat-adapter/whatsapp	WhatsApp 适配器
@chat-adapter/state-redis	Redis 状态适配器 （生产环境）
@chat-adapter/state-ioredis	ioredis 状态适配器 （替代方案）
@chat-adapter/state-pg	PostgreSQL 状态适配器 （生产环境）
@chat-adapter/state-memory	内存状态适配器 （开发环境）

AI 编码助手支持

如果你使用像 Claude Code 这样的 AI 编码助手，你可以将其配置为了解 Chat SDK：

npx skills add vercel/chat

文档

完整文档可在 chat-sdk.dev/docs 查阅。

贡献

开发环境搭建和发布流程请参阅 CONTRIBUTING.md。

许可证

MIT

Chat SDK 快速上手指南

Chat SDK 是一个统一的 TypeScript 开发工具包，让你只需编写一次机器人逻辑，即可部署到 Slack、Microsoft Teams、Discord、Telegram、GitHub 等多个平台。

环境准备

• 运行时: Node.js (建议 v18 或更高版本)
• 包管理器: npm, yarn, 或 pnpm
• 语言: TypeScript (推荐) 或 JavaScript
• 前置依赖: 无特殊系统依赖，但需根据目标平台（如 Slack、Discord）申请相应的 Bot Token 或 API 密钥。

国内加速提示：如果 npm 安装缓慢，建议使用国内镜像源：

npm config set registry https://registry.npmmirror.com

安装步骤

1. 安装核心 SDK：

   npm install chat
   

2. 安装目标平台适配器（以 Slack 为例，可根据需求替换为 teams, discord, telegram 等）：

   npm install @chat-adapter/slack
   

3. 安装状态管理适配器（生产环境推荐 Redis，开发环境可用内存版）：

   # 生产环境推荐
   npm install @chat-adapter/state-redis
   
   # 或者开发环境快速测试
   npm install @chat-adapter/state-memory
   

基本使用

以下示例展示如何创建一个监听提及消息并自动回复的简单机器人：

import { Chat } from "chat";
import { createSlackAdapter } from "@chat-adapter/slack";
import { createRedisState } from "@chat-adapter/state-redis";

const bot = new Chat({
  userName: "mybot",
  adapters: {
    slack: createSlackAdapter({
      token: process.env.SLACK_BOT_TOKEN,
      signingSecret: process.env.SLACK_SIGNING_SECRET,
    }),
  },
  state: createRedisState({
    url: process.env.REDIS_URL,
  }),
});

// 监听新的提及事件
bot.onNewMention(async (thread) => {
  await thread.subscribe(); // 订阅该线程以接收后续消息
  await thread.post("Hello! I'm listening to this thread.");
});

// 监听订阅线程中的新消息
bot.onSubscribedMessage(async (thread, message) => {
  await thread.post(`You said: ${message.text}`);
});

// 启动机器人
bot.start();

下一步：配置对应平台的环境变量（如 SLACK_BOT_TOKEN），运行代码即可启动跨平台机器人。更多高级功能（如卡片、模态框、流式输出）请参考官方文档。