vercel__chat/packages/create-chat-sdk

create-chat-sdk

npm package: create-chat-sdk

Scaffold a webhook-only Chat SDK bot project from the command line.

Documentation: chat-sdk.dev/docs/create-chat-sdk · Guides: vercel.com/kb/chat-sdk

Usage

npm create chat-sdk@latest my-bot

With another package manager:

pnpm create chat-sdk@latest my-bot
yarn create chat-sdk my-bot
bunx create-chat-sdk@latest my-bot

Non-interactive mode

Pass platform and state adapters with --adapter:

npm create chat-sdk@latest -- my-bot --adapter slack redis -y

With npm, the -- separator is required — npm consumes flags before it instead of forwarding them to the CLI. pnpm create and yarn create forward flags without it.

Adapter values come from the chat/adapters catalog. The default interactive prompt lists official adapters. Pass --vendor to list vendor-official adapters instead. For automation and coding agents, pass official or vendor adapter slugs directly with --adapter. Community adapters are not scaffolded.

When the CLI detects a coding agent environment, it announces the detection and automatically runs in non-interactive mode. Pass at least one platform adapter with --adapter; the state adapter defaults to memory. If no project name is provided, the default name is my-bot. Pass --interactive to force prompts.

Vercel Connect

The Slack, Discord, GitHub, Linear, Notion, and Telegram adapters can use Vercel Connect for outbound credentials. Pass --connect, or choose Vercel Connect at the interactive auth-mode prompt:

npm create chat-sdk@latest -- my-bot --adapter slack --connect -y

The generated bot spreads the matching helper from @vercel/connect/chat into the adapter factory, adds @vercel/connect to dependencies, and lists each connector UID (such as SLACK_CONNECTOR) in .env.example. Native webhook verification secrets are retained for adapters such as Notion and Telegram.

Options

Usage: create-chat-sdk [options] [name]

Arguments:
  name                      name of the project

Options:
  -d, --description <text>  project description
  --adapter <values...>     platform or state adapters to include
  --vendor                  list vendor-official adapters in the interactive
                            prompt
  --connect                 authenticate Slack, Discord, GitHub, Linear,
                            Notion, and Telegram adapters with Vercel Connect
  --pm <manager>            package manager to use (npm, yarn, pnpm, bun)
  -y, --yes                 skip prompts and accept defaults
  --interactive             always prompt, even when a coding agent
                            environment is detected
  -f, --force               overwrite generated files in an existing directory
  -s, --skip-install        skip dependency installation
  --no-git                  skip git repository initialization
  -q, --quiet               suppress non-essential output
  -h, --help                display help for command

Color output follows the NO_COLOR standard — set NO_COLOR=1 to disable colors.

Generated project

The generated project is a minimal Next.js API app:

• src/lib/bot.ts — generated Chat SDK bot configuration
• src/app/api/webhooks/[platform]/route.ts — dynamic webhook route
• src/app/api/chat/route.ts — generated only when the Web adapter is selected
• .env.example — generated from selected adapter env specs
• next.config.ts — generated server config and externals
• package.json — generated adapter, peer, and extra dependencies
• .chat-sdk.json — generated file ownership used by safe --force reruns

The template does not include pages, layouts, or a client UI.

Development

pnpm --filter create-chat-sdk build
pnpm --filter create-chat-sdk typecheck
pnpm --filter create-chat-sdk test

AI Coding Agents

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/chat

The 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-plugin

The 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).

Documentation

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

• Getting Started — first steps with Chat SDK
• Platform Adapters — supported platform adapters
• State Adapters — persistence, locking, and dedupe options
• Adapters — full adapter catalog

License

MIT