chat

chat

A unified TypeScript SDK for building chat bots across Slack, Microsoft Teams, Google Chat, Discord, and more.

Stars: 800

Visit
 screenshot

A unified TypeScript SDK for building chat bots across various platforms like Slack, Microsoft Teams, Google Chat, Discord, GitHub, and Linear. Write bot logic once and deploy everywhere. Features include event handlers, AI streaming, interactive cards, actions, modals, slash commands, emoji support, file uploads, direct messages, and ephemeral messages. The SDK includes core classes, adapters for different platforms, and state adapters for Redis, ioredis, and in-memory storage.

README:

Chat SDK

npm version npm downloads License: MIT

A unified TypeScript SDK for building chat bots across Slack, Microsoft Teams, Google Chat, Discord, GitHub, and Linear. Write your bot logic once, deploy everywhere.

Installation

npm install chat

Install adapters for your platforms:

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

Usage

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}`);
});

See the Getting Started guide for a full walkthrough.

Supported platforms

Platform Package Mentions Reactions Cards Modals Streaming DMs
Slack @chat-adapter/slack Yes Yes Yes Yes Native Yes
Microsoft Teams @chat-adapter/teams Yes Read-only Yes No Post+Edit Yes
Google Chat @chat-adapter/gchat Yes Yes Yes No Post+Edit Yes
Discord @chat-adapter/discord Yes Yes Yes No Post+Edit Yes
GitHub @chat-adapter/github Yes Yes No No No No
Linear @chat-adapter/linear Yes Yes No No No No

Features

  • Event handlers — mentions, messages, reactions, button clicks, slash commands, modals
  • AI streaming — stream LLM responses with native Slack streaming and post+edit fallback
  • Cards — JSX-based interactive cards (Block Kit, Adaptive Cards, Google Chat Cards)
  • Actions — handle button clicks and dropdown selections
  • Modals — form dialogs with text inputs, dropdowns, and validation
  • Slash commands — handle /command invocations
  • Emoji — type-safe, cross-platform emoji with custom emoji support
  • File uploads — send and receive file attachments
  • Direct messages — initiate DMs programmatically
  • Ephemeral messages — user-only visible messages with DM fallback

Packages

Package Description
chat Core SDK with Chat class, types, JSX runtime, and utilities
@chat-adapter/slack Slack adapter
@chat-adapter/teams Teams adapter
@chat-adapter/gchat Google Chat adapter
@chat-adapter/discord Discord adapter
@chat-adapter/github GitHub adapter
@chat-adapter/linear Linear adapter
@chat-adapter/state-redis Redis state adapter (production)
@chat-adapter/state-ioredis ioredis state adapter (alternative)
@chat-adapter/state-memory In-memory state adapter (development)

AI coding agent support

If you use an AI coding agent like Claude Code, you can teach it about Chat SDK:

npx skills add vercel/chat

Documentation

Full documentation is available at chat-sdk.dev/docs.

Contributing

See CONTRIBUTING.md for development setup and the release process.

License

MIT

For Tasks:

Click tags to check more tools for each tasks

For Jobs:

Alternative AI tools for chat

Similar Open Source Tools

For similar tasks

For similar jobs