Installation
ChatCops consists of three packages. Install only what you need.
Widget (Client-Side)
Section titled “Widget (Client-Side)”CDN (Recommended)
Section titled “CDN (Recommended)”The simplest way — no build step required:
<script src="https://cdn.jsdelivr.net/npm/@chatcops/widget/dist/chatcops.min.js" data-api-url="https://your-api.com/chat"></script>For bundler-based projects (Vite, webpack, Next.js):
npm install @chatcops/widgetimport { ChatCops } from '@chatcops/widget';
ChatCops.init({ apiUrl: 'https://your-api.com/chat', theme: { accent: '#6366f1' }, branding: { name: 'My Assistant' },});Server
Section titled “Server”npm install @chatcops/serverThe server package includes adapters for Express, Vercel, and Cloudflare Workers:
// Expressimport { chatcopsMiddleware } from '@chatcops/server';
// Vercel Edgeimport { chatcopsVercelHandler } from '@chatcops/server';
// Cloudflare Workersimport { chatcopsCloudflareHandler } from '@chatcops/server';Core (Optional)
Section titled “Core (Optional)”Only needed if building custom integrations:
npm install @chatcops/coreProvides direct access to providers, tools, knowledge base, and i18n:
import { createProvider } from '@chatcops/core';import { LeadCaptureTool } from '@chatcops/core/tools';import { FAQKnowledgeSource } from '@chatcops/core/knowledge';Requirements
Section titled “Requirements”- Widget: Any modern browser (Chrome, Firefox, Safari, Edge)
- Server: Node.js 22+ (Express), or edge runtime (Vercel/Cloudflare)
- TypeScript: Full type definitions included in all packages