package
Redis state adapter for Chat SDK — production subscriptions, distributed locks, cache, lists, and queues via node-redis
npm install @chat-adapter/state-redisGitHub-flavored package documentation.
Across all versions.
Download trend unavailable.
Runtime metadata.
Tagged topics.
npm package:
@chat-adapter/state-redis
Production state adapter for Chat SDK using the official redis package.
Documentation: chat-sdk.dev/adapters/official/redis · Guides: vercel.com/kb/chat-sdk
pnpm add @chat-adapter/state-redisTo scaffold a new Slack bot that uses Redis for state:
npx create-chat-sdk@latest my-bot --adapter slack redisVisit the adapters directory to see other available official and vendor-official adapters.
createRedisState() auto-detects the REDIS_URL environment variable, so you can call it with no arguments:
import { Chat } from "chat";
import { createRedisState } from "@chat-adapter/state-redis";
const bot = new Chat({
userName: "mybot",
adapters: { /* ... */ },
state: createRedisState(),
});To provide a URL explicitly:
const state = createRedisState({ url: "redis://localhost:6379" });If you already have a connected Redis client, pass it directly:
import { createClient } from "redis";
const client = createClient({ url: "redis://localhost:6379" });
await client.connect();
const state = createRedisState({ client });All keys are namespaced under a configurable prefix (default: "chat-sdk"):
const state = createRedisState({
url: process.env.REDIS_URL!,
keyPrefix: "my-bot",
});| Option | Required | Description |
|---|---|---|
url | No* | Redis connection URL (auto-detected from REDIS_URL) |
client | No | Existing redis client instance |
keyPrefix | No | Prefix for all keys (default: "chat-sdk") |
logger | No | Logger instance (defaults to ConsoleLogger("info")) |
*Either url, REDIS_URL env var, or client is required.
REDIS_URL=redis://localhost:6379For serverless deployments (Vercel, AWS Lambda), use a serverless-compatible Redis provider like Upstash.
{keyPrefix}:subscriptions - SET of subscribed thread IDs
{keyPrefix}:lock:{threadId} - Lock key with TTL@chat-adapter/state-ioredis. Neither adapter supports Redis Cluster| Feature | Supported |
|---|---|
| Persistence | Yes |
| Multi-instance | Yes |
| Subscriptions | Yes |
| Distributed locking | Yes |
| Key-value caching | Yes |
| Automatic reconnection | Yes |
| Key prefix namespacing | Yes |
If you use an AI coding agent such as OpenAI Codex, Claude Code, or Cursor, install the Chat SDK skill so it knows the SDK APIs, adapter patterns, and project conventions before writing code.
npx skills add vercel/chatThe skill references bundled documentation in node_modules/chat/docs, plus adapter guides and starter templates in the published package.
You can also install the Vercel Plugin for a broader agent toolkit — it includes the Chat SDK skill alongside specialist agents, agent slash commands, and more:
npx plugins add vercel/vercel-pluginThe plugin is optional; the skill alone is enough to build with Chat SDK.
For agent-readable documentation, see chat-sdk.dev/llms.txt (page index) or chat-sdk.dev/llms-full.txt (full text).
MIT
vercel-release-bot
infra+release@vercel.com