Cometchat
Add CometChat chat & messaging and voice & video calls to any React, Next.js, React Native, Angular, Android, iOS, or Flutter project through your AI coding agent. Works with Claude Code, Cursor, Codex, VS Code Copilot, Windsurf, Cline, Kiro, and 50+ more agents.
npx -y skills add cometchat/cometchat-skills --skill cometchatAssembled from the repository path, not quoted from the project. Check it against their README if it does not work.
One thing to look at
- no licenseNo license file was found in the repository. Code published without one is not open source by default, so using it at work is a question for whoever answers licensing questions where you are.
What its author says it does
Copied from the file, not written here
Entry-point for CometChat integration in any React, React Native, Angular, Android, Flutter, or iOS project — web (React/Next.js/React Router/Astro), React Native (Expo/bare), Angular (12-15), native Android (V6 stable, V5 legacy), Flutter (V6 stable, V5 legacy), and native iOS (V5 stable). Detects the framework, gathers requirements through an interactive conversation, and writes production-quality integration code.
The file declares its own license as MIT. That is the author’s claim about this one file, and it is not the same thing as the license GitHub reports for the repository, which is listed with the other numbers below.
SKILL.md
191.2 KB, as published. Nobody here has run it
Ground truth: the
cometchat detect --jsonoutput + the per-platform*-coreskills this dispatcher routes to + thepackages/registrycatalogs. (Official docs linked below.) Verify symbols against the installed package/source before relying on them.
Use this skill when
The user wants to add CometChat to any kind of project. Trigger phrases:
/cometchat(or invoke the cometchat skill via your agent's mechanism — keyword "cometchat" or "integrate chat" works in most agents)- "add cometchat", "integrate cometchat", "add chat to my app"
- "add messaging", "add chat ui", "add in-app chat"
- Customize an existing CometChat integration — "make the chat match my brand", "change the chat colors / theme", "style the message bubbles", "translate the chat / add a language", "change the notification (or call) sounds". These route through this dispatcher too: detect the framework, then load the family's
*-theming+*-customization(+cometchat-i18nfor localization) skills. If.cometchat/state.jsonalready exists, jump to the Step 7 iteration menu's customization options instead of re-running Phase A.
This is the entry point for every framework. Do NOT invoke framework-specific skills directly — this dispatcher detects the framework first and routes to the right ones.
Supported frameworks:
| Family | Frameworks |
|---|---|
| Web | React (Vite/CRA), Next.js, React Router v6/v7, Astro |
| React Native | Expo (managed + Expo Router), bare RN CLI |
| Angular | Angular 17-21 (standalone components; @cometchat/chat-uikit-angular@5) |
| Android | V6 stable (Compose + Kotlin Views, chatuikit-{compose,kotlin}-android:6.x) / V5 legacy (Java + Kotlin Views, chat-uikit-android:5.x) |
| Flutter | V6 stable (Bloc-based, cometchat_chat_uikit:^6.0) / V5 legacy (GetX-based, cometchat_chat_uikit:^5.2) |
| iOS | V5 stable (Swift; SwiftUI + UIKit hosting; CometChatUIKitSwift:~> 5.1) |
The web family loads @cometchat/chat-uikit-react + @cometchat/chat-sdk-javascript. The RN family loads @cometchat/chat-uikit-react-native + @cometchat/chat-sdk-react-native. The Angular family loads @cometchat/chat-uikit-angular + @cometchat/chat-sdk-javascript. The Android family loads com.cometchat:chatuikit-{compose,kotlin}-android:6.x (V6 — stable, recommended) or com.cometchat:chat-uikit-android:5.x (V5 — legacy) from Maven Central. The Flutter family loads cometchat_chat_uikit:^6.0 (V6 — stable, recommended; calls fold into the same package) or cometchat_chat_uikit:^5.2 (V5 — legacy; pair with cometchat_calls_uikit:^5.0 for calls) from the Cloudsmith Dart pub-hosted registry. The dispatcher decides which set after Step 1's detection.
How v3 works
v3 skills are interactive and conversational. You don't just detect the framework and dump code. You have a conversation with the developer to understand their project, their use case, and exactly where chat should go — THEN you write code that fits.
Pattern skills (loaded from your context as plain files — not via your agent's skill-loading mechanism):
cometchat-core(web) /cometchat-native-core(RN) /cometchat-angular-core(Angular) /cometchat-android-{v5,v6}-core(Android) /cometchat-flutter-{v5,v6}-core(Flutter) — init, login, provider chain, env vars, anti-patternscometchat-components(web) /cometchat-native-components(RN) /cometchat-angular-components(Angular) /cometchat-android-v5-componentsorcometchat-android-v6-{compose,kotlin}-components(Android) /cometchat-flutter-v6-components(V6 only — V5 splits into-conversations/-messages/-users-groups) — component catalog, props, compositioncometchat-placement(web) /cometchat-native-placement(RN) /cometchat-angular-placement(Angular) /cometchat-android-v5-placementorcometchat-android-v6-{compose,kotlin}-placement(Android) /cometchat-flutter-v6-placement(V6 only) — WHERE to put chat- One per-framework skill (
cometchat-{react,nextjs,react-router,astro}-patterns,cometchat-native-{expo,bare}-patterns,cometchat-angular-patterns, the v5/v6 Android sub-tree, or the Flutter v5/v6 sub-tree) — framework-specific details
Key principle: ask, don't assume. Every piece of information you need from the user should be asked explicitly. Don't guess the route path, don't guess where the trigger button goes, don't guess the auth system.
Steps
Clarification contract (ALL coding agents) — read
references/asking-questions.md. Everywhere the steps below say "ask the user", "render anAskUserQuestion", "MUST ask", or "NON-NEGOTIABLE prompt", they mean: follow that contract.AskUserQuestionis only Claude Code's name for it — on Codex / Cursor / Gemini CLI / Windsurf / any agent without that primitive, render the question as a numbered text list and WAIT for a real answer (never default, never infer; auto/approval mode does not authorize skipping). Map the answer by value/label, not ordinal position, accept a free-text fallback, and if running headless, STOP and emit the question rather than guessing. This contract governs every prompt in this skill and all skills it routes to.
Step 1 — Detect framework + map the project
If the CLI itself can't run — degrade, don't dead-end. Every step below calls
npx @cometchat/skills-cli …. That can fail to launch (no network to fetch the package, npx/Node absent, a sandbox that blocks process spawn or the npm registry) — distinct from the CLI running and returning a JSONerror(handled in the error-handling section near the end). When a command can't launch at all:
detect→ detect by hand. Everything the CLI's detector keys on is in the files this step already tells you to read:package.jsondeps (@cometchat/chat-uikit-react→ web,…-react-native→ RN,…-angular→ Angular),pubspec.yaml(Flutter),build.gradle(Android),Podfile/Package.swift(iOS), plus the router/version markers. Determine the framework + version from those and continue.config show→ treat as no saved config; read.cometchat/config.jsondirectly if it exists, else proceed greenfield and ask the questions.- Action commands (
auth login,apply-feature,builder export,verify) genuinely need the CLI. If one can't run, don't silently skip it — tell the user it's unavailable, give the manual dashboard equivalent (e.g. fetch creds from app.cometchat.com → Credentials; toggle the extension in Extensions), and continue best-effort. Never STOP the whole flow just becausenpxis unavailable — manual detection + reading the project is a complete substitute for routing.
First, check if .cometchat/config.json exists:
npx @cometchat/skills-cli config show --json
If config exists with previous answers, tell the user:
"I see you've set up CometChat before. Using your saved config: Framework: {framework}, App: {appId}, Intent: {intent}. Want to continue with these, or start fresh?"
If no config, run detection:
npx @cometchat/skills-cli detect --json
The JSON output includes framework (one of reactjs, nextjs, react-router, astro, expo, react-native, angular, android, flutter, ios, or null), framework-specific fields (router, expo_mode, react_native_version, android_version, flutter_version, env_prefix), and a compatibility.supported flag. If supported is false, stop and surface the warnings.
If framework === null — greenfield with no project at all (ENG-35718)
A null framework means the working directory has no recognizable scaffold — no package.json, no pubspec.yaml, no AndroidManifest.xml, no Podfile, no Xcode project. The earlier behavior dumped the user into a vague "want me to create one?" with two unlabeled options. Replace it with a named-scaffold prompt so the user picks a target deterministically:
"I don't see a project here yet. Want me to create one? Pick the closest match — you can change details after:
- React (Vite) — fastest web demo;
npm create vite@latest cometchat-demo -- --template react-ts- Next.js (App Router) — production-grade web with SSR;
npx create-next-app@latest cometchat-demo --typescript --app- Expo (managed) — fastest mobile demo;
npx create-expo-app@latest cometchat-demo --template- Other — tell me what framework you're using and I'll skip the scaffold step.
What sounds right?"
Render this as an AskUserQuestion with the same 4 options. After the user picks, run the scaffold command, cd into the new directory, then re-run detect so the rest of the dispatcher behaves as if framework had been detected normally. Do NOT proceed to Step 2 without a real framework — every step below assumes one exists.
If the user declines all four (chooses "Other" and then says "no, I just wanted to look around"), stop politely and tell them: "You can run /cometchat again from inside a React / Next.js / Expo / Angular / Android / iOS / Flutter project and I'll detect it automatically." Don't try to integrate into an empty directory — every subsequent step will fail.
Android — android_version is load-bearing. When framework === "android", the detect output includes android_version: "v5" | "v6" | null. The cohort selects which V5 or V6 pattern set to load — V6 (stable + recommended, chatuikit-{compose,kotlin}-android:6.x, Compose + Kotlin Views split) and V5 (legacy, chat-uikit-android:5.x, Java + Kotlin Views) are different SDKs with different APIs. Treat them as separate routing targets even though both live under --family android. V6 went GA 2026-05-25 (docs) — was beta in earlier /cometchat releases; the prompt + recommendation flipped from V5 → V6 in v4.3.0.
If android_version is null, the project is greenfield (no cometchat dep yet). Ask the user:
"Which CometChat Android UI Kit do you want to use? V6 is the latest stable SDK (recommended; Compose + Kotlin Views split, went GA 2026-05-25). V5 is the legacy SDK (Java + Kotlin Views — still supported but no new features)."
Save the choice into .cometchat/config.json under androidVersion:
npx @cometchat/skills-cli config save --android-version v5 --json
The CLI accepts --android-version v5 / v6 and --flutter-version v5 / v6 flags (added 2026-05-22 — F46 fix). Subsequent /cometchat runs read this from config and don't re-ask.
Flutter — flutter_version is load-bearing too. When framework === "flutter", the detect output includes flutter_version: "v5" | "v6" | null. V6 (stable + recommended) is Bloc-based (cometchat_chat_uikit:^6.0, calls folded into the same package). V5 (legacy) is GetX-based (cometchat_chat_uikit:^5.2; pair with cometchat_calls_uikit:^5.0 for calls). The two cohorts have different state-management primitives, different barrel exports, and different theme APIs — never mix them. Same --family flutter install ships both sets; routing picks the right one. V6 went GA 2026-05-25 (docs) at version 6.0.1 — was 6.0.0-beta2 in earlier /cometchat releases; the prompt + recommendation flipped from V5 → V6 in v4.3.0.
If flutter_version is null, ask the user:
"Which CometChat Flutter UI Kit do you want to use? V6 is the latest stable SDK (recommended; Bloc-based, calls folded into the same package, went GA 2026-05-25 at 6.0.1). V5 is the legacy SDK (GetX-based — still supported but no new features)."
Save the choice into .cometchat/config.json under flutter_version.
Then read the project yourself — this is critical.
For web frameworks (reactjs, nextjs, react-router, astro):
package.json— name, dependencies, scripts- The source directory structure — list all directories under
src/orapp/ - Find the router:
createBrowserRouter,app/directory,pages/,react-router.config.ts,astro.config.* - Find the layout:
App.tsx,layout.tsx,root.tsx,Layout.astro - Find the nav: components with "nav", "header", "sidebar" in name
- Find existing pages/routes: list them so you can reference them later
For React Native (expo, react-native):
package.json— name, RN version, all dependencies, scripts- Entry file —
index.jsorApp.{tsx,jsx}orapp/_layout.tsx(Expo Router) - Navigation — look for
@react-navigation/native,@react-navigation/stack,@react-navigation/bottom-tabs, orexpo-router - Existing screens — list all files under
screens/,src/screens/,app/, or wherever routes live - Existing nav structure — read the root navigator to see stack vs tab vs drawer layout
For Angular (angular):
package.json— name,@angular/coreversion (17-21 supported; the v5 kit's peer range is>=17 <22), all@angular/*depsangular.json— workspace config; identify the project name +sourceRoot; thebuild.options.stylesarray (where the kit'scss-variables.cssis registered) + theassetsglob- Bootstrap — standalone:
src/main.ts(bootstrapApplication) +src/app/app.config.ts(providers). v5 is standalone-first — there is no NgModule/CUSTOM_ELEMENTS_SCHEMA. (A legacy NgModule app must migrate to standalone, or pin the v4legacykit — different skill.) - Routing —
src/app/app.routes.ts(provideRouter/loadComponent); list all routes - Layout —
src/app/app.component.{ts,html}; identify nav, sidebar, header components - Existing pages/components — list under
src/app/pages/,src/app/components/, or wherever the project organizes them - Environment files —
src/environments/environment.ts(and.prod.ts); credentials live here, NOT in.env
For Android (android):
settings.gradle(or.kts) — module list; usually:appplus optional library modules- Root
build.gradle(or.kts) — top-level plugins, repositories, classpath versions - App
build.gradle(or.kts) — dependencies (this is where the cometchat dep lives), Android plugin,applicationId,minSdk/targetSdk/compileSdk,buildConfigFieldentries AndroidManifest.xml— root<application>class, permissions,<activity>entries, deep links- Source dirs:
app/src/main/java/<pkg>/(Java) and/orapp/src/main/kotlin/<pkg>/(Kotlin) - For V6 stack split: presence of
androidx.compose.ui:uiorcompose.material3in deps signals Compose; otherwise Kotlin Views (XML layouts underapp/src/main/res/layout/). Many V6 projects have both — ask the user which surface chat lands in. gradle.propertiesandlocal.properties— credentials live here ascometchat.appId=.../cometchat.region=.../cometchat.authKey=..., exposed to code asBuildConfigfields viabuildConfigFieldin the appbuild.gradle. NOT in.env.Applicationclass (e.g.MyApp extends android.app.Application) — init goes inonCreate(). Note the class FQN; you'll wireCometChatUIKit.init(this, settings, callback)here.
For Flutter (flutter):
pubspec.yaml— package name + Dart SDK constraint + Flutter SDK constraint +dependencies:(this is wherecometchat_chat_uikitlives)- For V5: a typical project has BOTH
cometchat_chat_uikit:^5.2ANDcometchat_calls_uikit:^5.0if calls are needed. V6 folds calls into the singlecometchat_chat_uikit:^6.0package (no separate calls package; depends oncometchat_calls_sdk: >=5.0.2 <6.0.0transitively). lib/— Dart source. The app entry islib/main.dart(thevoid main() => runApp(...)site); init goes inmain()or in a top-levelStateful/State.initState().lib/<config>.dart(or similar) — credentials. There is NO Flutter.envconvention — credentials are typically defined asconstDart values in a config file, OR injected at compile time via--dart-define=COMETCHAT_APP_ID=...flags read inside Dart withString.fromEnvironment. NOT a.envfile at runtime.android/app/build.gradleandios/Runner/Info.plist— platform-specific config (FCM service registration, Push capabilities, microphone/camera Info.plist entries for calls). Flutter projects DO have these subdirs but they're configured Flutter-side; do not run the native skill flows.- For V5 vs V6: V5 uses GetX (
getin deps); V6 uses flutter_bloc +equatable. Their controllers, observers, and theming are different — match the integration code to the detected cohort.
For iOS (ios):
<App>.xcodeprojand/or<App>.xcworkspace— Xcode project / workspace. The.xcworkspaceis preferred when CocoaPods is in use (open it, NOT the .xcodeproj).Podfile(CocoaPods) — pinpod 'CometChatUIKitSwift', '~> 5.1'and runpod install. Look forplatform :ios, '13.0'(or higher) — V5 needs iOS 13+.Package.swift(Swift Package Manager) —dependencies:block addshttps://github.com/cometchat/cometchat-uikit-ios. Both SPM and CocoaPods are supported; check which the project uses.- App entry —
<App>App.swift(SwiftUI) orAppDelegate.swift+SceneDelegate.swift(UIKit). Init goes in@main struct App.init()(SwiftUI) orapplication(_:didFinishLaunchingWithOptions:)(UIKit). Info.plist— for calls addNSMicrophoneUsageDescription+NSCameraUsageDescription; for push add the APNs entitlement and aBackgroundModesentry withremote-notification(andvoipfor VoIP push).- Credentials: NO
.envat runtime. Use aSecrets.swiftconst enum/struct (gitignored) or an*.xcconfigfile withCOMETCHAT_APP_ID = ...exposed as Build Settings. The skill teaches both. - Mixed-stack apps (SwiftUI + UIKit): the kit ships UIKit
UIViewControllers and exposes them viaUIViewControllerRepresentablefor SwiftUI hosting. Identify which surface chat lands in (SwiftUI screen vs UIKit nav stack) and follow the matching pattern.
Store this mental map — you'll use it throughout the conversation.
Post-detect order of operations — run these gates IN THIS ORDER
The moment
detect --jsonreturns, run the following in order before you write anything or commit to a plan. Each is detailed in its own subsection below; this is the precedence when more than one applies:
- Pattern skills installed? (see "Pattern skills not installed? — CHECK THIS FIRST") — if the framework's pattern skills aren't loaded, install them and have the user re-run now, before anything else. A late discovery is the worst-timed interruption.
version_conflictgate (see "Version-conflict pre-flight") — STOP if the installed UI Kit major doesn't match what the skills target, or both V5+V6 are declared.coexistencegate (see "Coexistence pre-flight") — STOP if a competing chat/calling SDK is present; carry the Firebase/SW advisories into the push journey.- Step 1.5 "I see you" summary (below) — only once the gates pass, narrate what you found, then continue to Step 2.
Gates 1–3 are hard stops that can each send the user away to fix something; run them before the Step 1.5 summary so you don't narrate a plan you then have to retract. (The subsections appear below in roughly this order, but this list is the authoritative precedence.)
Then show the user what you found — Step 1.5 (the "I see you" moment)
This is the most important moment of the whole flow. After running detection + reading the project, narrate what you found in 3–5 specific, observation-grounded bullets BEFORE asking any question. The user should feel that you understand their project before deciding whether to trust you with it.
The shape (use it verbatim — the structure earns trust):
Taking a look at your project...
- {Framework} + {Build tool} {version} {with TypeScript / JavaScript / etc., as detected}
- {Router or nav state} — {one observation about how routing is set up, or "no router yet" for greenfield}
- {Auth system status} — {"NextAuth detected → I'll wire token-based login", or "no auth detected → I'll start with dev mode + a test user; you can upgrade later"}
- {Existing CometChat state} — {"existing
cometchat/folder with X — I'll patch around it", or "fresh start — no prior CometChat code"}- {One personal observation} — {something specific you noticed: "Tailwind classes throughout", "shadcn/ui components", "monorepo with apps/* and packages/*"}
Ready to set this up? I'll walk you through account setup, then ask where chat should live.
The rules for this moment:
- Be specific, not generic. "Vite + React 19 + TypeScript" beats "a React project." Read the actual versions from
package.json. - Five bullets max. Beyond five, it stops feeling observational and starts feeling like a recital. Cut to what's interesting about the project.
- Lead with what's load-bearing. Framework + version, router, auth, existing CometChat, then one personal touch. The personal touch is what makes it land — show you actually looked.
- Skip the bullet if there's nothing to say. No router on greenfield → say "no router yet"; don't invent one. No auth → say "no auth detected"; don't list every package you didn't find.
- End with a single confident question. Not five questions. The flow continues into Step 2 (credentials) or Step 3 (placement) — let the next step ask.
Examples of good vs bad bullets:
| ✓ Good (specific, observational) | ✗ Bad (generic, unfounded) |
|---|---|
| "Vite + React 19 + TypeScript, Tailwind for styling" | "A React project with TypeScript" |
"React Router v7 detected (routes.ts + react-router.config.ts)" | "Some routing is configured" |
"NextAuth in auth.config.ts — I'll mint CometChat tokens server-side via your existing session cookie" | "Authentication is set up" |
"shadcn/ui detected (components/ui/*) — I'll use your existing Button + Dialog primitives in the chat trigger" | "Some UI components are present" |
"Monorepo: apps/web is your dashboard, apps/marketing is the public site — I'll integrate into apps/web" | "This is a monorepo" |
For greenfield projects (the test case):
Taking a look at your project...
- Vite + React 19 + TypeScript — fresh
cometchat-test-appscaffold- No router yet — for the demo, chat will mount in
src/App.tsxdirectly; we can move it to a route later- No auth system detected — I'll set you up in dev mode; we'll pick a test user (default
cometchat-uid-1throughuid-5) when I confirm credentials in the next step; production auth is a one-flag upgrade later- Fresh start — no existing CometChat code to patch around
Ready to set this up? I'll get you a CometChat account first, then ask where chat should live.
This moment costs ~5 seconds of conversation but anchors the rest. Skip it and the user feels like they're talking to a script. Run it well and the rest of the flow feels effortless.
Compatibility baselines (the CLI enforces these):
- Web: react@<18 → upgrade required; nextjs@<13 → warning; astro@<4 → warning
- RN: react-native@<0.70 → upgrade required; expo@<49 → upgrade required
- Angular: @angular/core@<17 → upgrade required (v5 kit peer range is
>=17 <22); skill verified against v21 standalone - Android V5: minSdk@<21 → upgrade required; minSdk@<24 → warning; AGP@<7.0 → warning
- Android V6: minSdk@<28 → upgrade required (V6 raised the floor from API 23 to API 28); Kotlin@<1.9 → warning; for Compose stack, Compose BOM@<2024.x → warning
- Flutter V5: Dart SDK <2.17 → upgrade required; Flutter <2.5 → warning; Android
minSdk 24(Flutter platform default) when V5 is in use - Flutter V6: Dart SDK <2.17 → upgrade required; Flutter <2.5 → warning; Android
minSdk 26REQUIRED (cometchat_calls_sdk in V6 raised the floor) - iOS V5: iOS deployment target <13 → upgrade required; Swift <5.0 → upgrade required; Xcode 15+ requires
ENABLE_USER_SCRIPT_SANDBOXING = NOin Build Settings (or thepost_installPodfile hook)
Version-conflict pre-flight — STOP if detect reports version_conflict (P0-6)
(Gate 2 in the post-detect order above — runs after the pattern-skills check, before the coexistence gate and the Step 1.5 summary.)
The moment
detect --jsonreturns, checkversion_conflict. If it is non-null, STOP — do NOT write integration code yet. It fires when the project already has a CometChat UI Kit at a major version these skills don't target (e.g.chat-uikit-reactv5 in a v6-targeted web project), or when BOTH a V5 and a V6 UI Kit are declared (Android/Flutter half-migrated / duplicate tree). Proceeding emits guidance for the wrong major →duplicate class/unresolved reference/ won't-compile failures the user can't easily trace. Surfaceversion_conflict.detailto the user and ask how to reconcile (upgrade the installed kit to the targeted major, or load the matching-version skills, or remove the cohort they're not integrating) before Step 2. Re-rundetectafter they fix it. This is a gate, not a warning.
Coexistence pre-flight — STOP if detect reports a competing chat SDK (P0-10)
(Gate 3 in the post-detect order above — runs after the version-conflict gate, before the Step 1.5 summary.)
Also check
coexistencein the samedetect --jsonoutput. It surfaces three collisions you must resolve before mounting CometChat:
coexistence.competing_sdkslists other chat / calling / push providers already in the project (Sendbird, Stream, Twilio, PubNub, TalkJS, Agora, OneSignal). If any entry haskind: "chat"or"calling", STOP — silently adding CometChat means two chat providers mounted in one tree, duplicate WebSocket connections, and a confusing double UI. Ask the user (use the clarification contract —references/asking-questions.md):"I see {name} ({coordinate}) already in this project. How do you want to proceed?"
- Replace it — I'll integrate CometChat and leave the old SDK's code in place for you to remove (I won't delete it without confirmation).
- Run alongside — keep both, namespaced; chat stays on {name}, CometChat powers a new surface. (Heavier; two realtime stacks.)
- Switch fully — integrate CometChat now and you'll migrate {name}'s usages over later.
WAIT for the answer; route accordingly. Never auto-delete the competing SDK's files or deps — that's the user's call.
coexistence.existing_firebase: true— the project already wires Firebase. CometChat push is FCM-based, so on the-pushjourney you must reuse the same Firebase app (don't callinitializeAppa second time) and merge rather than overwritefirebase-messaging-sw.js. Carry this fact into the push skill; it's an advisory, not a hard stop for chat-only integration.coexistence.existing_service_workers— lists existing SW files at paths CometChat web push would write to. Before generatingfirebase-messaging-sw.js, confirm you won't clobber the app's offline/caching logic; merge the messaging handlers into the existing worker instead.A competing chat/calling SDK is a gate (ask before proceeding). Firebase + service-worker entries are advisories you must honour on the push journey.
Pattern skills not installed? — CHECK THIS FIRST
(Gate 1 in the post-detect order above — the highest-precedence gate; run it before the version-conflict/coexistence gates and before the Step 1.5 summary, even though it appears last in this section for readability.)
Run this check the moment
detectreturns a framework — BEFORE the Step 1.5 "I see you" summary, BEFORE credentials (Step 2), BEFORE anyAskUserQuestion, and BEFORE creating a Visual Builder. It is a gate, not a contingency. If the framework's pattern skills are missing, install them and tell the user to re-run right now. Do NOT lazily discover the gap later (e.g. when you try to read a pattern skill at code-gen) — agents don't hot-reload skills mid-session (see the re-run note below), so discovering it late forces the user to re-run after they've logged in, picked an app, and customized their Visual Builder. That's the worst-timed possible interruption. Catch it at second 5, not at the finish line.
The dispatcher routes to web pattern skills (cometchat-{core,components,placement,*-patterns}), RN pattern skills (cometchat-native-{core,components,placement,*-patterns}), or Angular pattern skills (cometchat-angular-{core,components,placement,patterns}) based on the detected framework. If the matching set isn't loaded — i.e. the user has only the dispatcher in .claude/skills/, OR they installed only @cometchat/skills (web) but the project is RN/Angular, OR vice versa — install the missing package yourself. Do NOT stop and ask the user to run the npx command manually — that turns a 0-step recovery into a 2-step recovery for no benefit.
To check whether the pattern skills are loaded, attempt to read cometchat-core/SKILL.md (web), cometchat-native-core/SKILL.md (RN), or cometchat-angular-core/SKILL.md (Angular) from your loaded skills context. If the read fails, the package isn't installed — run the installer.
If framework is expo or react-native AND cometchat-native-core is NOT loaded:
npx @cometchat/skills add --family native
If framework is reactjs, nextjs, react-router, or astro AND cometchat-core is NOT loaded:
npx @cometchat/skills add --family web
Important —
--family <name>is non-negotiable. Without the family flag,npx @cometchat/skills add(default) installs only the cross-family base skills (cometchat dispatcher + i18n + a11y + calls dispatcher). It does NOT installcometchat-core,cometchat-react-patterns,cometchat-placement, etc. — the framework-specific skills with the actual integration patterns. Running base-only twice doesn't load the missing skills; only--family <name>does. Skipping the flag here causes the agent to write integration code from training memory instead of from the framework-specific skills, which produces real bugs (e.g. theminHeight: 0flex-shrink trap incometchat-react-patternsrule 6a — only in that skill).
If framework is angular AND cometchat-angular-core is NOT loaded:
npx @cometchat/skills add --family angular
If framework is android AND neither cometchat-android-v5-core nor cometchat-android-v6-core is loaded:
npx @cometchat/skills add --family android
This installs both V5 and V6 skill sets — the dispatcher's Step 4 routing picks the correct one based on android_version.
If framework is flutter AND neither cometchat-flutter-v5-core nor cometchat-flutter-v6-core is loaded:
npx @cometchat/skills add --family flutter
Same shape as Android — installs both V5 and V6 skill sets; routing picks the right one based on flutter_version.
If framework is ios AND cometchat-ios-core is NOT loaded:
npx @cometchat/skills add --family ios
iOS only ships V5 today (no V6 beta yet), so there's no version-detection step — the install command lands the single iOS skill set.
After the install completes, tell the user:
"I just installed the {family} pattern skills into your workspace. Please re-run
/cometchatto continue — your config is saved in.cometchat/config.jsonand credentials in.env, so the next run picks up at code generation without re-asking the questions you've already answered."
Why re-run rather than continue in this session: Claude Code, Cursor, Cline, Kiro, and other modern AI coding agents snapshot the skill set at session start and do NOT hot-reload SKILL.md mid-session. Even though the install writes the new skill files into .claude/skills/ (or .cursor/skills/ / .kiro/skills/ / .agents/skills/ — your agent's skills dir), your in-context skill set is the snapshot. Continuing would mean writing code from training memory — which the skills explicitly forbid (this is the same failure mode that produced the UIKitSettingsBuilder and getLoggedinUser casing bugs at v2.2.0). The re-run is the only safe path.
Non-default IDE — pass --ide. The default installer target is claude (.claude/skills/). If the dispatcher's own SKILL.md was loaded from a different location, pass the matching flag:
| Dispatcher loaded from | Install command |
|---|---|
.claude/skills/cometchat/SKILL.md (default) | npx @cometchat/skills add |
.agents/skills/cometchat/SKILL.md (Replit / Cursor / Copilot / Cline / Codex) | npx @cometchat/skills add --ide replit |
.cursor/skills/cometchat/SKILL.md (legacy Cursor path) | npx @cometchat/skills add --ide cursor |
.kiro/skills/cometchat/SKILL.md | npx @cometchat/skills add --ide kiro |
You can usually infer the IDE from where the dispatcher itself was loaded. If uncertain, default to claude. (Same logic applies to @cometchat/skills-native for RN projects.)
Do NOT attempt to write web UI Kit code into an RN project (CSS imports + <a href> + document.* fail at runtime) or RN UI Kit code into a web project (react-native-gesture-handler, @gorhom/bottom-sheet, native bubble components have no browser equivalents). Likewise, never use the React UI Kit (@cometchat/chat-uikit-react) in an Angular project — it's a different package (@cometchat/chat-uikit-angular) with NgModule imports, kebab-case selectors, content-projection slots, and no React reconciler. And never mix V5 and V6 skill sets within Android or Flutter — the artifact coordinates, package names, state-management primitives (V5 GetX vs V6 Bloc on Flutter; V5 Java/Views vs V6 Compose+Kotlin on Android), and theme system differ; the skills target one cohort each.
Step 2 — Set up credentials (onboarding)
CRITICAL: All onboarding happens via CLI commands. NEVER send the user to a browser or dashboard for credential copy-pasting. The CLI handles signup, login, app creation, and credential writing — all from the terminal — for every framework.
Hard rule — signup flows MUST ask, not infer
For Sign-Up paths specifically (Step 2b → 2b.5 → 2b.6 → 2c), the following structured prompts are NON-NEGOTIABLE and MUST be rendered via AskUserQuestion:
| Prompt | When | Skipped only if |
|---|---|---|
| Role (Step 2b.6) | After auth me if meta.role === null | auth me returned a non-null role |
| Intent (Step 2b.6) | After auth me if meta.intent === null | auth me returned a non-null intent |
| App name (Step 2c) | Before provision setup | NEVER — even if a suggested default exists, user must explicitly confirm |
| Region (Step 2c) | Before provision setup | last_app.region exists AND user accepted the "use same region?" confirmation |
| Industry (Step 2c) | Before provision setup | last_app.industry exists AND user accepted the "same industry?" confirmation |
| Product (Step 3.0 Tier 3) | After Step 2c if Tier 1 (auth me last_app.product) AND Tier 2 (natural-language inference from slash-command + prior turn) both returned null | Tier 1 OR Tier 2 resolved a non-null value |
Auto-mode classifiers do NOT authorize bypassing these prompts. "Allowed by auto mode classifier" applies to Bash/tool approvals — it does NOT apply to structured user prompts. The agent must surface each prompt regardless of approval mode. Rationalizations like "fresh test scaffold = just exploring, skip the prompt" or "moving forward without stops for the demo" are explicit spec violations — the dashboard's /select-product + /create-app + /choose-role + /choose-intent flows ask these in the browser; the CLI flow MUST ask them in the terminal for parity. Skipping them silently picks defaults that affect downstream Step 3a (intent → archetype) and Step 3b.1 (industry → recommendation upsells) — the user can't correct values they never saw asked.
If config has appId set, verify credentials are in .env and skip to Step 3.
Otherwise check:
npx @cometchat/skills-cli auth status --json
If status is "logged-in", skip to Step 2b.5 (fetch dashboard profile).
If status is "logged-out", ask:
Ask the user (preserve this exact shape — question, header, multiSelect, options[].label, options[].description — agents have varying primitive names but they all support this structured form):
- question: "Let's set up CometChat. Do you have an account?"
- header: "Account"
- multiSelect: false
- options:
- label: "Create a new account", description: "Free signup — I'll handle it right here, no browser needed."
- label: "Sign in to existing account", description: "Log in and pick one of your apps."
- label: "I'll paste credentials myself", description: "I already have my App ID, Region, and Auth Key."
Option 1 → Step 2b. Option 2 → Step 2a. Option 3 → Step 2d.
Step 2a — Sign in (existing account, browser flow)
npx @cometchat/skills-cli auth login
This command:
- Generates a short-lived session via the CLI auth API.
- Opens
https://app.cometchat.com/login?sessionId=<hex>in the user's default browser. - Polls the auth API every 5 seconds for up to 15 minutes.
- When the user finishes signing in, the dashboard marks the session authenticated. The next poll receives the bearer token and stores it in the OS keychain.
- Prints
✓ Logged in as <email> (backend: keychain-macos).
Let the CLI block — do NOT background it, do NOT race it with other prompts.
Terminal error handling (surface verbatim, stop, do not retry silently):
ACCESS_DENIED— user clicked Deny in the dashboard.EXPIRED— 15-minute window elapsed.TIMEOUT— max polls exhausted before user authorized.ABORTED— user Ctrl-C'd the CLI.NETWORK— couldn't reach the auth host.ALREADY_AUTHENTICATED— this session was already consumed. Re-runauth loginto mint a fresh session.AUTH_FAILED— the bearer was rejected (401) — e.g. a stored token expired or was revoked, surfaced by a laterauth me/auth status. Re-runauth loginto re-authenticate. (Distinct from the device-auth codes above: this is the post-login "my session went stale" case, normalized from a 401 incometchat-api.ts.)API_ERROR:<code>(and any unlisted code) — an unexpected server-side error; do NOT pattern-match it. Fall through to the generic handler: show the CLI'shuman_message/suggestionif present, then the rawerrorin parentheses (see the error-handling rule near the end of this skill).
After success, verify via auth status --json and proceed to Step 2b.5.
Step 2b — Sign up (new account, browser flow)
npx @cometchat/skills-cli auth signup
Same polling flow as Step 2a, but the CLI opens the signup URL. The browser handles email, name, password, verification email, role, industry. The CLI never sees any of those values.
No role / name / verification-code questions in the chat. The dashboard owns that flow now; skipping it keeps the user's password and verification code out of the transcript.
Error codes match Step 2a. After success, verify via auth status --json and proceed to Step 2b.5.
Step 2b.5 — Fetch the user's dashboard profile
The dashboard's signup flow (/auth/signup → /choose-role → /choose-intent) collects the user's name, email, role, and product intent during browser onboarding — none of those values touch the CLI. Now that the bearer token is in the keychain, fetch them via cometchat auth me so the rest of this skill can:
- Greet the user by name in subsequent steps
- Skip the placement-intent question (Step 3a) when
meta.intent === "exploring"(the user already told the dashboard they're just exploring) - Tailor explanation depth by
meta.role(frontend developer → UI examples; engineering manager → architecture trade-offs)
npx @cometchat/skills-cli auth me --json
Response shape:
{
"status": "logged-in",
"email": "[email protected]",
"name": "Your Name",
"role": "frontend",
"other_role": null,
"intent": "building",
"last_app": {
"id": "27xxxxx",
"name": "my-marketplace-chat",
"region": "us",
"industry": "online_marketplaces",
"technology": "react",
"product": "chat-messaging"
}
}
Field meanings (from the dashboard's signup screens):
-
role:"frontend"/"backend"/"fullstack_engineer"/"startup_founder"/"product_leader/manager"/"engineering_leader/manager"/"others"(whenothers,other_rolecarries the freeform value) -
intent:"building"/"evaluating"/"exploring"(this is the dashboard's intent — distinct from Step 3a'splacement_intentwhich asks about app archetype) -
last_app: most-recently-created app on the user's account (ornullif they have none). The dashboard's/create-appand/select-productscreens writeindustry,technology,productinto the app'smetadata— we surface them here so Step 2c can pre-fill region/industry instead of asking again. -
last_app.product: the surface the user picked on the dashboard's/select-productscreen —"chat-messaging"/"voice-video"/"ai-agent"/"byo-agent"/null. Load-bearing for Step 3.0 — it decides which dispatcher (chat or calls) handles the integration.chat-messagingruns the existing chat flow;voice-videohands off tocometchat-calls;ai-agentandbyo-agentare out of scope for/cometchattoday and point at the AI Agents docs.Dashboard ↔ canonical mapping (load-bearing — wired in
cometchat-api.ts:listApps):Dashboard metadata.featuresCanonical last_app.productchatchat-messagingcallingvoice-videoaiAgentai-agentbyo-agentbyo-agentThe dashboard's
/select-productis single-select and writesmetadata.features = "<dashboard-key>"; the CLI maps it to canonical at the API boundary so downstream code only sees canonical values. If dashboard sends an unknown key (e.g.moderation),productis leftundefinedand Step 3.0 infers from natural language or asks at routing time.The combined value
chat-messaging+voice-videois CLI-only — surfaced in Step 3.0's prompt as "Both Chat and Calling" when inference can't tell. The dashboard picker doesn't expose "Both" today.
Store the response in working memory. Reference these fields downstream:
- Step 2c (new app): if
last_appis non-null, default--regionand--industryto the values fromlast_appand only ask the user to confirm — do NOT re-prompt from scratch. - Step 3.0 (product branch): route by
last_app.product.chat-messagingcontinues into Step 3a;voice-videoshort-circuits to thecometchat-callsdispatcher;ai-agentandbyo-agentexit with a docs pointer. - Step 3a: if
meta.intent === "exploring", skip the placement-intent question and route straight to the "Just exploring" branch (one route/screen with<CometChatConversations />andcometchat-uid-1pre-logged-in). - Step 3b.1 (industry tailoring): use
last_app.industryto layer industry-specific upsells onto the placement recommendation — moderation features for dating apps, HIPAA-aware production patterns for healthcare, link-preview for marketplaces, etc. Augment, don't replace. - Step 5 explanations: if
meta.role === "frontend", lead with concrete component composition + CSS examples; ifmeta.role === "engineering_leader/manager", lead with placement architecture trade-offs (where state lives, what gets cached, how routing fits the project's pattern). - Greeting: if
meta.nameis non-null, greet by name in any user-facing message during the rest of the flow ("Got it, Swapnil — let's pick an app").
Failure modes — each is non-blocking; degrade to the original generic flow:
status: "logged-out"→ bearer expired between Step 2a/b and now (rare). Re-runauth loginand retry.status: "auth-required"→ 401 from server. Same fix.status: "error"→ network or unexpected. Skip silently, proceed to Step 2b.6 (will ask role + intent there).nameisnull→ no greeting (don't ask, the dashboard will collect it on next browser visit).roleisnull→ ask in Step 2b.6 (this is the case for accounts that signed up viaauth signupfrom the CLI — they never saw the dashboard's/choose-rolescreen).intentisnull→ ask in Step 2b.6.last_app.productisnull(orlast_appitself isnull) → resolved in Step 3.0 via natural-language inference, falling back to a prompt only if ambiguous. Do NOT ask product upfront in Step 2b.6 — the dashboard's/select-productis a structured form because a UI can't read intent; the agent flow can.last_appisnull→ ask region/industry normally in Step 2c.
After this step, proceed to Step 2b.6.
Step 2b.6 — Backfill role + intent if missing
The dashboard's /choose-role and /choose-intent screens collect two profile fields used to tailor the rest of the integration:
roleshapes the depth and angle of code explanations in Step 5intentdecides whether Step 3a's placement question is needed (exploringshort-circuits to a single screen)
(product is resolved separately in Step 3.0 via natural-language inference + lazy ask — not here.)
If auth me returned non-null values for both, skip this step entirely and go to Step 2c — the dashboard already collected them, do not re-ask.
If either is null (typical for accounts created via cometchat auth signup rather than the dashboard browser flow), ask the user. The options below mirror the dashboard exactly so anyone who later visits the dashboard sees consistent terminology.
If role === null — ask the user (preserve the structured shape — question/header/multiSelect/options[].label/options[].description — agents have varying primitive names but all support this form):
-
question: "What's your role? (We'll tailor explanations to match.)"
-
header: "Role"
-
multiSelect: false
-
options (label → store as
rolevalue):Label rolevalueFrontend Developer frontendBackend Developer backendFullstack Developer fullstack_engineerFounder startup_founderProduct Manager product_leader/managerEngineering Manager engineering_leader/managerOther othersIf the user picks Other, follow up with a free-form question for
other_role(single short text field; store the freeform value inother_role).
If intent === null — ask the user (preserve the structured shape):
-
question: "What brings you to CometChat?"
-
header: "Intent"
-
multiSelect: false
-
options (use the dashboard's exact wording):
Label Description shown under the label intentvalueI'm building Integrating chat into my app now. buildingI'm evaluating Comparing options for my team. evaluatingI'm exploring Just looking around for now. exploring
Do NOT ask for product in this step. The dashboard's /select-product is a structured form because a UI can't read intent; the CLI/agent flow is conversational and the user has often already said what they want. Asking upfront ("Chat & Messaging? Voice & Video? Both?") is friction the dashboard has but the agent doesn't need.
The product decision happens in Step 3.0 (Branch by product), where it actually matters for routing. Step 3.0 first tries to infer from the user's slash-command args and prior turn, and only falls back to a prompt if it can't tell. By then the agent has more context (the framework is detected, credentials are set up, the user has shared more about their goal), so inference works better than upfront.
This step (Step 2b.6) is for role + intent only — those are profile fields the dashboard collected upfront, so we collect them here too if they're missing.
Store the answers in working memory under the same keys (role, other_role, intent, product) as if they had come from auth me. Downstream steps (3.0 + 3a + 5) treat dashboard-supplied and CLI-collected values identically.
Note: These answers are not yet persisted back to the dashboard
/meendpoint — they only live for the current session. A follow-up will add acometchat auth me --updatemode that PATCHes them server-side so the next session won't re-ask. Until then, the user may be asked again in a fresh session.
After this step, proceed to Step 2c.
Step 2c — Pick or create an app
Run this immediately — do NOT ask the user to go to any dashboard:
npx @cometchat/skills-cli provision list --json
If the user has existing apps, show them and ask which to use:
"I found these CometChat apps on your account:
- my-marketplace-chat (us) — Developer plan
- test-app (eu) — Developer plan
Which one should I use, or should I create a new one?"
For an existing app, fetch credentials and wire everything in one call. Pass --framework from Step 1 detection (one of reactjs, nextjs, react-router, astro, expo, react-native):
npx @cometchat/skills-cli provision setup \
--app-id "<selected-appId>" --framework "<framework>" --json
This creates/updates the env file with the correct prefix AND writes .cometchat/config.json in one step. Output is compact: { appId, region, framework, envFile, configPath } — no authKey echoed back.
If no apps exist (or user wants new), collect via structured AskUserQuestion prompts — NON-NEGOTIABLE. Do NOT silently default app name / region / industry on signup flows. The agent must surface each prompt and let the user pick. Auto-mode does NOT authorize bypassing these — they're load-bearing for the rest of the integration (industry drives Step 3b.1 recommendations downstream).
-
App name — SUGGEST
<project-name>-chatfrom package.jsonname, then ask the user to confirm or override (preserve the structured shape):- question: "What should we name your CometChat app?"
- header: "App name"
- Pre-filled default:
<project-name>-chat. User must explicitly accept or change before the CLI runsprovision setup.
-
Region — if Step 2b.5 returned
last_app.region, default to that value and ask only"Use the same region as your <last_app.name> app (<region>)? [Y/n]". Otherwise MUST ask via structured prompt:- question: "Which region for your CometChat app?"
- header: "Region"
- options: US (recommended), EU, India
Region key mapping (CLI expects lowercase):
Label --regionvalueUS usEU euIndia in -
Industry — if Step 2b.5 returned
last_app.industry, default to that value and ask only"Same industry as your previous app (<industry>)? [Y/n]". Otherwise MUST ask via structured prompt:- question: "What industry is your app in? (Drives industry-specific recommendations downstream.)"
- header: "Industry"
- options — full 11-option set (see table below); do NOT pick a default like
saas_businesseswithout asking
Industry key mapping — present these labels (verbatim from the dashboard's /create-app set, canonical in packages/cli/src/utils/onboarding-options.ts INDUSTRIES) and pass the mapped --industry value:
| Label | --industry value |
|---|---|
| Online Marketplaces | online_marketplaces |
| Healthcare | healthcare |
| Dating | dating |
| Events & Streaming | events_and_streaming |
| Online Education | online_education |
| Community & Social | community_and_social |
| SaaS & Multi-Tenant | saas_businesses |
| Sports & Gaming | sports_and_gaming |
| Team Comms & Workflows | team_comms_and_workflows |
| On-Demand Services | on_demand_services |
| Other | other |
Confirm before creating, then:
npx @cometchat/skills-cli provision setup \
--name "<name>" --region "<region>" --industry "<industry_key>" \
--framework "<framework>" --json
The authKey is written to the env file but is NOT echoed to stdout, so credentials don't appear multiple times in the transcript.
Tell the user: "Your CometChat account and app are ready. Credentials saved to <envFile>. Let's set up the integration."
Step 2d — Paste keys manually
Tell the user which env vars to set based on the detected framework:
| Framework | Env file | Variables |
|---|---|---|
| reactjs (Vite) | .env | VITE_COMETCHAT_APP_ID, VITE_COMETCHAT_REGION, VITE_COMETCHAT_AUTH_KEY |
| nextjs | .env.local | NEXT_PUBLIC_COMETCHAT_APP_ID, NEXT_PUBLIC_COMETCHAT_REGION, NEXT_PUBLIC_COMETCHAT_AUTH_KEY |
| react-router | .env | VITE_COMETCHAT_APP_ID, VITE_COMETCHAT_REGION, VITE_COMETCHAT_AUTH_KEY |
| astro | .env | PUBLIC_COMETCHAT_APP_ID, PUBLIC_COMETCHAT_REGION, PUBLIC_COMETCHAT_AUTH_KEY |
| expo (managed + Expo Router) | .env | EXPO_PUBLIC_COMETCHAT_APP_ID, EXPO_PUBLIC_COMETCHAT_REGION, EXPO_PUBLIC_COMETCHAT_AUTH_KEY |
| react-native (bare CLI) | .env | COMETCHAT_APP_ID, COMETCHAT_REGION, COMETCHAT_AUTH_KEY (paired with react-native-dotenv) |
| angular | src/environments/environment.ts | cometchat: { appId, region, authKey } (TypeScript object — Angular does NOT use .env) |
| android | local.properties (gitignored) → BuildConfig | cometchat.appId, cometchat.region, cometchat.authKey in local.properties; expose to code via buildConfigField "String", "COMETCHAT_APP_ID", "\"...\"" in app/build.gradle. Code reads BuildConfig.COMETCHAT_APP_ID. |
| flutter | lib/cometchat_config.dart (or --dart-define flags) | A const Dart class with appId, region, authKey. Add lib/cometchat_config.dart to .gitignore so the file isn't committed. For CI, use --dart-define=COMETCHAT_APP_ID=... and read via String.fromEnvironment('COMETCHAT_APP_ID') instead. Flutter does NOT load .env at runtime. |
| ios | Secrets.swift (gitignored) or *.xcconfig Build Settings | A const enum/struct in Secrets.swift: enum Secrets { static let appId = "..."; static let region = "..."; static let authKey = "..." }. Add Secrets.swift to .gitignore. For CI, define them in an .xcconfig file (COMETCHAT_APP_ID = ...) and read via Bundle.main.object(forInfoDictionaryKey: "COMETCHAT_APP_ID") after exposing them in Info.plist. iOS does NOT load .env at runtime. |
"Grab your credentials from https://app.cometchat.com → Your App → API & Auth Keys. Create the env file above and tell me when done."
Bare RN extra step. Bare RN doesn't ship a public-env-prefix convention — pair the env file with react-native-dotenv:
npm install --save-dev react-native-dotenv
and add the plugin to babel.config.js:
module.exports = {
presets: ["module:@react-native/babel-preset"],
plugins: [["module:react-native-dotenv"]],
};
Then import { COMETCHAT_APP_ID, COMETCHAT_REGION, COMETCHAT_AUTH_KEY } from "@env"; in the provider.
iOS — write to Secrets.swift or an .xcconfig, NOT .env. iOS has no runtime .env lookup. The CLI's provision setup --framework ios writes a .env only as a credentials handoff. During Step 5, migrate values into one of:
Secrets.swiftconst enum (preferred for local dev):
Use as:// Secrets.swift (add to .gitignore) enum Secrets { static let cometchatAppID = "<APP_ID>" static let cometchatRegion = "<REGION>" static let cometchatAuthKey = "<AUTH_KEY>" // dev only }UIKitSettings().set(appID: Secrets.cometchatAppID).set(region: Secrets.cometchatRegion).set(authKey: Secrets.cometchatAuthKey).build()..xcconfigBuild Settings (preferred for CI; secrets stay out of source files):
Expose as Info.plist entries (// Secrets.xcconfig (add to .gitignore; reference from project Build Settings) COMETCHAT_APP_ID = <APP_ID> COMETCHAT_REGION = <REGION> COMETCHAT_AUTH_KEY = <AUTH_KEY>$(COMETCHAT_APP_ID)etc.) and read viaBundle.main.object(forInfoDictionaryKey: "COMETCHAT_APP_ID") as? String.
Never read .env at runtime in iOS. The handoff .env exists only so the integration agent can find the values during initial setup.
Flutter — write to a Dart const file, NOT .env. Flutter has no runtime .env lookup. The CLI's provision setup --framework flutter writes a .env only as a credentials handoff. During Step 5, migrate values into one of:
- Dart const file (preferred for local dev, simpler):
Then in// lib/cometchat_config.dart (add to .gitignore) class CometChatConfig { static const String appId = '<APP_ID>'; static const String region = '<REGION>'; static const String authKey = '<AUTH_KEY>'; // dev only }main.dart:import 'cometchat_config.dart'; final settings = (UIKitSettingsBuilder() ..appId = CometChatConfig.appId ..region = CometChatConfig.region ..authKey = CometChatConfig.authKey ..subscriptionType = CometChatSubscriptionType.allUsers) .build(); --dart-defineflags (preferred for CI; secrets never hit the repo):
Run withconst appId = String.fromEnvironment('COMETCHAT_APP_ID'); const region = String.fromEnvironment('COMETCHAT_REGION'); const authKey = String.fromEnvironment('COMETCHAT_AUTH_KEY');flutter run --dart-define=COMETCHAT_APP_ID=... --dart-define=COMETCHAT_REGION=... --dart-define=COMETCHAT_AUTH_KEY=....
Never read .env at runtime in Flutter. The handoff .env exists only so the integration agent can find the values during initial setup.
Android — write to local.properties + expose via BuildConfig. Android has no runtime .env lookup; credentials are injected at compile time as BuildConfig fields. The CLI's provision setup --framework android writes a .env as a credentials handoff — you (the agent) must during Step 5 mirror those values into:
local.properties(project root, gitignored):cometchat.appId=<APP_ID> cometchat.region=<REGION> cometchat.authKey=<AUTH_KEY> # dev only — omit / use auth tokens in productionapp/build.gradle(or.kts) — read those properties and surface them viabuildConfigField:def localProps = new Properties() def localPropsFile = rootProject.file('local.properties') if (localPropsFile.exists()) localProps.load(new FileInputStream(localPropsFile)) android { defaultConfig { buildConfigField "String", "COMETCHAT_APP_ID", "\"${localProps['cometchat.appId'] ?: ''}\"" buildConfigField "String", "COMETCHAT_REGION", "\"${localProps['cometchat.region'] ?: ''}\"" buildConfigField "String", "COMETCHAT_AUTH_KEY", "\"${localProps['cometchat.authKey'] ?: ''}\"" } buildFeatures { buildConfig true } }- Application code reads
BuildConfig.COMETCHAT_APP_IDetc. — never hardcoded strings, never read from.envat runtime.
Angular — write to src/environments/environment.ts, NOT .env. Angular bundles environment.ts into the build at compile time; there is no runtime .env lookup. Insert (or extend) the cometchat block:
// src/environments/environment.ts
export const environment = {
production: false,
cometchat: {
appId: "<APP_ID>",
region: "<REGION>",
authKey: "<AUTH_KEY>", // dev only — omit from environment.prod.ts
},
};
Then import { environment } from "../environments/environment"; and access environment.cometchat.appId in the init service. The CLI's provision setup --framework angular writes a .env as a credentials handoff — you (the agent) must migrate the values into environment.ts during Step 5. Never read .env from Angular runtime code.
After they confirm, verify:
npx @cometchat/skills-cli config init --json
Never log the Auth Key
After writing credentials, don't echo the Auth Key back in the transcript. Confirm as ✓ Wrote <PREFIX>COMETCHAT_AUTH_KEY (hidden).
Step 3 — Interactive requirements gathering
This is the core of v3. A multi-step conversation that gathers everything you need before writing a single line of code.
Step 3 sub-flow order (NON-NEGOTIABLE — run in this exact order)
- 3.0 — Branch by product (chat vs calls) — sets
product - 3.1 — Customization preference (Visually vs In code) — sets
customize← MUST run before 3a - 3a — Intent ("What are you building?")
- 3b — Recommendation (skip on Visually path per §3.1)
- 3c — Placement
- 3d — Authentication
- 3e — User mapping (optional)
- 3f — Plan confirmation
Common skip-bug (observed 2026-05-22 in a real Android run): the agent runs 3a + 3c after Step 2 (provision) and goes straight to writing code, skipping 3.1 entirely. Step 3.1 must fire on EVERY chat-messaging integration on a builder-supported platform (react, react-native, ios, android, flutter — see §3.1 table). The only exception is Angular, which auto-routes to In-code with the explicit fallback note.
The customer-visible symptom of the skip: agent never asks "How do you want to customize your chat experience? Visually vs In code". Customer gets the In-code path silently. Visual Builder feature is invisible to them.
3.0. Branch by product (chat vs calls)
product decides which dispatcher (chat or calls) handles the rest of Step 3. Resolve it in this priority order:
1. Use last_app.product if non-null — set by the dashboard's /select-product screen. Trust it.
2. Otherwise, infer from the user's slash-command args + prior turn. Most users name what they want; don't make them re-pick from a list:
| User said something like… | Set product to |
|---|---|
| "add chat", "integrate messaging", "build chat", "I want messaging" | chat-messaging |
| "add calling", "integrate voice/video", "add video calls", "set up voip" | voice-video |
| "add both chat and calls", "chat with calling on top", "messaging and calls" | chat-messaging+voice-video |
Confirm inferred values briefly so the user can redirect if you guessed wrong:
"Got it — setting up Chat & Messaging. (If you wanted calling instead, say so and I'll switch.)"
3. Only if you can't tell (plain /cometchat with no further context, ambiguous wording like "set up CometChat") — MUST ask via AskUserQuestion. NON-NEGOTIABLE. Do NOT silently default to chat-messaging or rationalize a shortcut (e.g. "fresh test scaffold → just exploring") to skip this prompt. Auto-mode does NOT authorize bypassing. The product decision drives Step 3a (chat) vs cometchat-calls dispatcher handoff — getting it wrong forces a re-run.
-
question: "Which surface do you want to add to your app?"
-
header: "Product"
-
multiSelect: false
-
options:
Label Description shown under the label productvalueChat & Messaging Real-time user to user & group chats. chat-messagingVoice & Video Calling In-app calling & conferencing. voice-videoBoth Chat and Calling I want chat with calling on top — chat is the main surface, calls ride alongside. chat-messaging+voice-videoAI Agent / BYO Agent intentionally hidden —
/cometchatdoesn't yet ship integration paths for those products. Step 3.0's routing table below still gracefully handlesai-agent/byo-agentvalues that arrive fromauth me(real dashboard signups), pointing the user at the AI Agents docs.
Once product is resolved, route — the rest of Step 3 is chat-shaped, and a calls-only integration shouldn't sit through it.
product value | Branch | What runs |
|---|---|---|
chat-messaging | Continue to 3a | Existing chat flow — placement intent, recommendation, framework skills, scaffold chat surfaces. |
voice-video | Hand off to cometchat-calls | Stop here. Invoke the cometchat-calls dispatcher with the framework + family + credentials already established. Calls dispatcher routes to the per-family cometchat-{family}-calls skill in standalone mode — no chat UI Kit, full calls surface, VoIP push wired by default, IncomingCall mounted at app root. |
chat-messaging+voice-video | Run 3a–6 (chat), THEN hand off to cometchat-calls in additive mode | Full chat flow first. After Step 6 verifies the chat integration, invoke cometchat-calls in additive mode — patches the existing provider to mount IncomingCall at root, adds call buttons inline on chat surfaces, opt-in VoIP push. Skip apply-feature calls — cometchat-calls covers it end-to-end. |
ai-agent / byo-agent | Offer chat-first scaffold + docs pointer (ENG-35724) | Don't dead-end. Tell the user: "AI Agents have their own integration path at https://www.cometchat.com/docs/ai-agents — but the agent UI lives inside a chat surface. Want me to set up the chat integration first? Once chat is wired, you can plug the AI Agent (or your BYO model) into the same cometchat-features flow without re-doing the integration." If yes, treat product = "chat-messaging" and continue to 3a. If no, exit politely (don't push). Two segments hit this dead-end and bounced out — give them a path forward without rebuilding the AI integration in this dispatcher today. |
If config has placement_intent set from a previous run, confirm it and skip to Step 3b. The product branch above still runs first — a chat-mode integration that's now adding calls re-enters via the chat-messaging+voice-video row, not the chat-only row.
Why this branch comes before 3a: Step 3a's options are all chat archetypes (Messaging app, Marketplace, SaaS, …). For a voice-video product, that taxonomy doesn't apply — the user isn't picking where chat lives, they're picking where the call trigger lives (profile button vs /calls route vs always-on lock-screen-ringer). The cometchat-calls dispatcher owns its own placement question with the right options for the calls surface.
3.1 — Customization preference (Visually vs In code)
Only runs if product includes chat-messaging (skip entirely for voice-video — the Visual Builder is chat-only today).
Only runs if the resolved framework maps to a builder-supported platform. Use this table — these are the same cohorts the dashboard's Visual Builder emits code for:
| Skills cohort/framework | Builder platform value | If Visually picked |
|---|---|---|
reactjs, nextjs, react-router, astro | react | Build with React UI Kit, mount via <CometChatApp /> |
expo, react-native | react-native | Build with RN UI Kit, mount in app root. cometchat builder export --platform react-native IS supported — it copies the builder's src/config/ (store.ts + config.json) and patches config.json with the JSON-envelope settings. |
android-v5, android-v6 | android | Build with Android UI Kit (V5 schema; V6 customers get a one-line migration shim) |
ios | ios | Build with iOS UI Kit |
flutter-v5, flutter-v6 | flutter | Build with Flutter UI Kit (V5 schema; V6 same shim story as Android) |
angular | not supported | See "Angular" note below — auto-route to In code with an explicit one-time message. |
Native Visually exports are V5-shaped today (F22 — transitional). The Android, Flutter (and iOS) Builder canonicals emit V5-flavored UI Kit screens; a V6 native project's own code is untouched, but the Builder-exported screens come in at the V5 schema (the "migration shim" noted above bridges them). If a V6 native customer wants a single-version (pure-V6) dependency tree, the In-code path is the cleaner choice. React/Next/Astro and React Native are unaffected (web is V6-native; RN uses the
src/config/store envelope, not a V5 canonical). The per-familycometchat-{android-v6,flutter-v6}skills carry the full warning — surface this at the choice so the decision is informed.
Angular — explicit fallback
The dashboard's Visual Builder export pipeline doesn't have an Angular emitter — https://preview.cometchat.com/downloads/cometchat-builder-{platform}.zip ships only react, react-native, ios, android, flutter. Skills can't bridge that gap by emitting Angular code from React/JSON output because the kit's Angular package (@cometchat/chat-uikit-angular) uses different selectors, modules, and content-projection slots than React.
For Angular projects:
-
Do NOT show the Visually-vs-In-code prompt. It's a dead choice — there's no Visually path to take.
-
Surface this once, then move on. Print a brief, friendly note in the chat — single message, no follow-up question:
"The Visual Builder doesn't ship Angular code yet (the dashboard's export covers React / React Native / iOS / Android / Flutter today). I'll set up the code-driven Angular integration instead — you can theme via CSS variables (
--cometchat-*, scoped to.cometchat) later. Want to be notified when an Angular Visual Builder lands? Drop a 👍 on https://github.com/cometchat/cometchat-skills/discussions/categories/feature-requests."Tweak wording to fit the conversation tone (greeting the user by name if
meta.nameis set, etc.) but keep it factual: WHY it's missing + WHAT we're doing instead + WHERE to register interest. -
Set
customize=codein.cometchat/config.jsonso subsequent/cometchatreruns skip the prompt silently. Run via Bash:npx @cometchat/skills-cli config save --customize code --json -
Continue to Step 3a (intent). The rest of the chat flow proceeds as normal —
cometchat-angular-{core,components,placement,patterns}handle the actual code emission. -
Stale
customize=visualfrom a previous framework? Ifauth me/config carriescustomize=visualfrom a prior run on a different framework, OVERWRITE it tocodefor this Angular session — sameconfig savecall as above — and surface the same note. The dispatcher must never try to callbuilder create --platform angular(the CLI rejects it with "Missing or invalid --platform"; the customer would see a confusing CLI error instead of the explanatory note).
Next.js Pages Router — explicit fallback (F17)
Visual Builder is architecturally incompatible with Next.js Pages Router. The canonical's src/CometChat/ has 25+ per-component CSS imports, but Pages Router enforces "global CSS only in pages/_app.tsx" — Webpack fails the build on the first component import. App Router tolerates per-component CSS; Pages Router does not. There's no client-side workaround short of rewriting the canonical's styling architecture.
The CLI guards this — builder create --platform react will refuse when detect.router === "pages" with an explicit F17 message. The dispatcher must surface this BEFORE calling the CLI, same shape as the Angular fallback:
For Next.js Pages Router projects (detect.framework === "nextjs" AND detect.router === "pages"):
-
Do NOT show the Visually-vs-In-code prompt. Same dead choice as Angular.
-
Surface this once:
"Visual Builder isn't compatible with your Pages Router setup — the canonical's per-component CSS imports break Pages Router's strict 'global CSS in
_app.tsxonly' rule (F17). Two options: migrate to App Router (the Next.js 13+ default), or stay on Pages Router and I'll use the code-driven integration. Want to be notified when Pages Router compatibility lands? https://github.com/cometchat/cometchat-skills/discussions/categories/feature-requests" -
Set
customize=codein.cometchat/config.json:npx @cometchat/skills-cli config save --customize code --json -
Continue to Step 3a (intent).
cometchat-nextjs-patterns§4 covers the Pages Router provider mount (_app.tsxwithnext/dynamic+ssr: false). -
App Router projects (
detect.router === "app") are fully supported by Visual Builder — proceed with the Visually-vs-In-code prompt as normal.
If config has customize set from a previous run AND the framework is in the builder-supported table above, confirm it ("Continuing the visual-builder flow you started last time — builder ID abc123. Re-fetch latest config? [Y/n]" for customize=visual; just "Continuing in-code customization." for customize=code) and skip the question. On Y for the re-fetch, jump straight to the builder fetch step below.
If .cometchat/builder.json already exists (customer started a builder in a prior /cometchat invocation but didn't finish), surface it before asking: "Found an existing builder for this project (abc123, created 3 days ago). Resume it, start fresh, or switch to code-driven?" — three options via AskUserQuestion. "Resume" jumps to the builder fetch step; "Start fresh" creates a new one; "Code-driven" sets customize=code and falls through to 3a.
Otherwise, ask:
AskUserQuestion:
- Question: "How do you want to customize your chat experience?"
- Header: "Customize"
- Options — which one is listed first and labeled "(Recommended)" depends on the framework:
- Default (web React / Next.js App Router / React Router v7 / Astro, React Native, Android, Flutter, iOS): present Visually first, labeled "(Recommended)". This is deliberate — the Visual Builder is the headline path. Do NOT reorder In-code ahead of it or mark In-code recommended, even though In-code is the historical default. (Frameworks that don't support the builder — Angular, Next.js Pages Router — skip this prompt entirely per the notes above, so they never reach here.)
- iOS: now a full default (no carve-out). ENG-35337 is RESOLVED end-to-end: the iOS Visual Builder export BUILDS and LAUNCHES —
pod 'CometChatBuilder'(1.1.2) + UIKitSwift 5.1.13 + CallsSDK 5.0.0 →xcodebuildBUILD SUCCEEDED, installed + launched clean on a physical iPhone (verified 2026-06-17; the earlier sim-onlyEXCLUDED_ARCHSquirk was an environment issue, not a project defect). Do NOT pin> 1.1.2— a1.1.3may not exist (seecometchat-ios-core§Visual Builder). iOS gets the same Visually-recommended default as every other builder-supported platform. - Visually — configure in the browser (no code) — "Open CometChat's UI Kit Builder in your browser to enable/disable features and configure colors, layout, and styling through settings — no code (it's a configuration tool, not a drag-and-drop canvas). Then come back here and I'll wire the result into your app."
- In code — code-driven defaults — "I'll scaffold a clean integration with sensible defaults. You customize later by editing files / CSS variables."
Persist the answer to .cometchat/config.json as customize: "visual" | "code" so reruns don't re-ask.
If the customer picks "In code": continue to Step 3a as before. Nothing else in Step 3 changes for the In-code path.
If the customer picks "Visually": run the visual-builder sub-flow below, then resume the rest of Step 3 (3a intent and 3c placement still run — placement asks where the single <CometChatApp /> mount goes; the visually-customized features replace what 3b would otherwise recommend).
3.1.v — Visually sub-flow
-
Create the builder. Run via Bash:
cometchat builder create \ --app-id <appId-from-config> \ --platform <react|react-native|ios|android|flutter from the table above> \ --jsonParse the JSON. On success, you get
{ status: "created", builderId, builderUrl, appId, platform, createdAt }. Cache file.cometchat/builder.jsonis written automatically by the CLI.Error handling:
Not logged in→ runcometchat auth login(or hand back to Step 1 auth) and retry.AUTH_SCOPE(token lacksvcb:write) → tell the customer: "Your CometChat account doesn't have the Visual Builder add-on enabled — falling back to code-driven customization." Setcustomize=codeand continue to Step 3a.- Any other API error → print the error, set
customize=code(graceful fallback), continue to 3a.
-
Open the builder URL in the customer's default browser. Try the OS-appropriate command via Bash:
- macOS:
open "<builderUrl>" - Linux:
xdg-open "<builderUrl>"(suppress stderr — many SSH-only / headless boxes don't have a display) - Windows:
start "" "<builderUrl>"
If the open command exits non-zero (headless, no display, locked down), don't treat it as a failure — print the URL prominently with: "Couldn't open your browser automatically. Open this URL on a machine where you can use a browser:
<builderUrl>"Either way, print the URL itself in the terminal so the customer can copy/paste if the auto-open failed silently.
Tell the customer (F31, verified 2026-05-22 via headless Playwright): "If you're not already logged into app.cometchat.com in your browser, you'll see the dashboard signup/login screen first. Log in with the SAME account you used to run
cometchat auth login(typically your work email) — the dashboard will then redirect you to the Visual Builder UI for this specific builder ID." Without this heads-up, customers seeing the signup screen think skills opened the wrong URL. - macOS:
-
Wait for the customer. Customizing in the Visual Builder typically takes minutes to hours — the customer may walk away. Use
AskUserQuestionto block:- Question: "When you're done customizing in the browser, let me know."
- Header: "Builder"
- Options:
- Done — fetch my customization and integrate — Customer finished customizing in the browser.
- Skip — use code-driven defaults instead — Customer changed their mind / didn't want to customize after all. Set
customize=codeand continue to 3a (do NOT delete the builder — customer can come back to it later). - Cancel — exit
/cometchat— Customer wants to stop entirely. Exit cleanly.
-
Export the per-builder integration (only on "Done"). The CLI command depends on the platform
cometchat detectresolved:Detected framework --platformvalueDefault --outputLayout kind reactjs, nextjs, react-router, astro reactsrc/CometChat(orsrc/app/CometChatfor Next App Router via--output)single-dir react-native, expo react-nativesrc/configsingle-dir flutter flutterchat_buildersingle-dir ios iosCometChatselective — 3 files: MessagesVC.swift, ThreadedMessagesVC.swift, cometchat-builder-settings.json android androidcometchatselective — 2 files: BuilderSettingsHelper.kt, cometchat-builder-settings.json (agent rewrites package decl + moves to app/src/main/java/<package>/cometchat/ — see cometchat-android-v6-core §"Visual Builder integration") For example, on a React Vite project:
cometchat builder export --platform react --json(No
--idneeded — the CLI reads it from.cometchat/builder.json. Pass--output <dir>for non-default destinations likesrc/app/CometChatfor Next.js App Router.)This single command mirrors the dashboard's Export-button workflow:
- Downloads the canonical static template ZIP from
preview.cometchat.com/downloads/cometchat-builder-<platform>.zip - Fetches the customer's per-builder settings via
GET /vcb/builders/{id} - Applies F3 + F10 missing-field defaults (
inAppSounds,mentionAll) - Unzips the template into a temp dir
- Patches the platform's Settings file:
- React —
CometChatSettings.tswithexport const CometChatSettings = <settings>;+ sentinel comment - React Native —
config.jsonwith{ builderId, name, settings }envelope (no sentinel — JSON forbids//) - Flutter —
assets/sample_app/cometchat-builder-settings.jsonwith the same envelope (no sentinel) - iOS / Android —
cometchat-builder-settings.jsonwith the same envelope (no sentinel)
- React —
- Copies the platform-relevant subdirectory (or files, for selective layouts) to
--output
The command runs an F25 case-collision pre-check (warns if a lowercase
src/cometchat/with In-code-shape files exists alongside the intendedsrc/CometChat/output, on macOS APFS / HFS+ default).Parse the returned JSON:
{ status: "exported", builderId, appId, platform, output, settings_file, builder_name, dashboardSetupNeeded }. Skills' Step 5 file-emission section then patches the customer's existing project to wire in the exported integration (entry file, package.json, tsconfig — seecometchat-core§11.2).4a. Enable the dashboard side of the toggled-on features — DO NOT SKIP. The Visual Builder's feature toggles control UI visibility only — they show/hide a feature's buttons in the exported app. Extension- and AI-backed features (polls, message translation, collaborative document/whiteboard, stickers, smart replies, conversation starter/summary) also need their server-side capability enabled ("Requires Dashboard setup" in the builder docs), which is a separate backend store the builder export never touches. If you skip this, the customer sees the poll button in their builder app, clicks it, and it fails at runtime. The export tells you exactly which ones: iterate
dashboardSetupNeededfrom the export JSON and run the matching enable for each —type: "extension"→cometchat apply-feature <id> --app-id <appId>(no code change, idempotent, survives resync).type: "ai-feature"→cometchat apply-feature <id> --app-id <appId> --openai-key sk-...(ask the customer for their OpenAI key once; if they don't have one, tell them the AI feature's UI will show but won't return results until a key is set in the dashboard).
Run these now, before continuing. This is the step that makes the Visual Builder flow and enable-features compose — the builder draws the UI,
apply-featureturns on the capability behind it. (dashboardSetupNeededis[]on older CLI builds that predate this field — if it's absent, fall back to scanning the exportedsettings.chatFeatures.deeperUserEngagement/aiUserCopilotfortruevalues and map them:messageTranslation→message-translation,polls→polls,collaborativeWhiteboard→collaborative-whiteboard,collaborativeDocument→collaborative-document,stickers→stickers,conversationStarter→conversation-starter,conversationSummary→conversation-summary,smartReply→smart-replies.)Error handling:
NOT_FOUND(builder was deleted out-of-band, or token's appId mismatch) → offer to create a fresh one (builder createagain) OR fall back to code-driven.--output directory already exists→ on first emit this means the customer has a previous integration to overwrite; surface to the customer and re-run with--forceif they confirm. On resync (step 7 iteration), use--forcedirectly percometchat-core§11.6.Failed to download template ZIP→ network issue or wrong CC_BUILDER_HOST env override; surface the error verbatim.- Note: the per-builder settings are ALWAYS populated. The dashboard returns a full default config on
builder create(typing indicators, threads, media, theme, etc.) — verified 2026-05-19 against the real/vcb/buildersendpoint. "Customer said done but never customized" is indistinguishable from "customer kept the defaults" without diffing against the canonical default blob; don't try to detect it. Always export with whatever comes back.
- Downloads the canonical static template ZIP from
-
Continue to Step 3a. The intent question (3a) and the placement question (3c) still run — intent feeds the recommendation, but in the Visually path the recommendation is effectively pre-decided by the builder. Skills should phrase 3a as: "Just for context — what kind of app is this? (This won't change your visual customizations; it helps me set the right defaults for placement.)" and skip 3b entirely (no "Here's why I recommend X" — they already chose visually).
3.1.f — Failure-mode summary
| Failure | What skills does |
|---|---|
Framework is angular | Dashboard's Visual Builder has no Angular emitter. Surface the one-time explanation note (see "Angular — explicit fallback" above), set customize=code, route to the code-driven Angular flow. NEVER call builder create --platform angular (the CLI rejects it). |
auth login token has no vcb:write scope | Tell customer their account lacks the add-on; auto-fall-through to In code; do not block. |
Customer's network can't reach apimgmt.cc-cluster-2.io (corp firewall) | builder create errors with network failure; fall back to In code; warn customer the Visual Builder requires outbound HTTPS. |
open / xdg-open / start exits non-zero | Treat as soft failure; print URL prominently; continue to wait for "done". |
| Customer closes the terminal mid-wait | Builder persists server-side. On next /cometchat run, the .cometchat/builder.json cache triggers the "found existing builder" prompt at the top of 3.1. |
| Customer says "Done" but didn't actually customize | The builder is never truly empty — create returns full defaults (verified 2026-05-19). Emit with what comes back; if they want to tweak later, they use the iteration menu's "Re-sync visual builder" option. |
builder create returns ERR_BAD_REQUEST even with valid --platform and a fresh name | The dashboard backend enforces ONE active builder per app — if any prior builder exists and is still "active", subsequent POST /vcb/builders calls reject. Detect via cometchat builder list --json (if any builder exists, reuse its builderId instead of creating new). Surface to the customer: "Found an existing builder on this app — reusing it. Reset it via the dashboard if you want to start fresh." Verified against real dashboard 2026-05-21. |
| Builder ID expired / deleted server-side | builder fetch returns NOT_FOUND; offer to create fresh or fall to code. |
Stale customize=visual config from a previous (non-Angular) framework | Overwrite to customize=code for the Angular session; surface the Angular note once. Do NOT prompt the customer to "resume" a builder that targets the wrong platform. |
Customer is migrating In-code → Visually on the same project (existing src/cometchat/ lowercase dir from a prior In-code integration) | CASE-COLLISION RISK on macOS APFS / HFS+ default (case-insensitive) — src/cometchat/ and src/CometChat/ resolve to the SAME directory. cometchat builder export runs an automatic pre-check: if src/cometchat/ exists AND contains In-code-shape files (init.ts / CometChatProvider.tsx) BUT NOT Visual-shape files (CometChatApp.tsx + context/), it bails with the F25 message and asks the agent to mv src/cometchat src/cometchat.bak first. (If the lowercase dir is just the customer's own previous Visual export — CometChatApp.tsx + context/ present — the check skips: that's a resync, not a migration.) F25 finding, 2026-05-22. |
3a. "What are you building?"
If config has intent set, confirm it and move on.
If meta.intent === "exploring" from Step 2b.5 (the user already told the dashboard during signup that they're just exploring), skip the rest of Step 3 entirely and route to the "Just exploring" branch — scaffold the minimal integration in Step 5 (one route/screen showing <CometChatConversations /> with cometchat-uid-1 pre-logged-in). Do not ask the placement-intent question; the user has already said "show me the simplest thing."
Otherwise, ask the user (preserve this exact shape — question, header, multiSelect, options[].label, options[].description — agents have varying primitive names but all support this structured form):
- question: "What kind of app are you building?"
- header: "Your app"
- multiSelect: false
- options:
- label: "Messaging app", description: "Chat is the main feature — like Slack, Discord, WhatsApp, or Telegram."
- label: "Marketplace or platform", description: "Buyers and sellers communicate — like Airbnb, eBay, OfferUp, or Depop."
- label: "SaaS or productivity", description: "Team chat or support chat inside a product — like Notion, Intercom, or Linear."
- label: "Social or community", description: "User profiles with messaging — like a dating app or community forum."
- label: "Support or helpdesk", description: "Customer-to-agent communication."
- label: "Just exploring", description: "Quick demo — fastest path to see chat working."
If "Just exploring": skip the rest of Step 3 and scaffold the minimal integration in Step 5 — one route/screen showing <CometChatConversations /> with cometchat-uid-1 pre-logged-in.
3b. Show what you recommend and why
This is the second wow moment after the detection summary. Don't just list a placement — tell the user why. Two sentences of reasoning earn confidence; a table alone reads like a lookup.
The recommendation has two layers:
- The placement — what you'll set up (route / drawer / modal / tab / widget)
- The reason — why this fits the user's archetype (one or two sentences grounded in how their kind of app actually works)
When you write your response, lead with the reason, then the concrete placement, then offer to override:
For a marketplace app, I'd put a "Chat with seller" drawer on your product page + an inbox at
/messages.The drawer keeps buyers in the buying flow — they can ask a question without losing the listing. The inbox is for going back to past conversations. Two surfaces, one integration.
Sound right, or want to try a different shape?
That's the shape. The recommendation tables below are the what; the reasoning column is the why you should narrate.
Web family (reactjs, nextjs, react-router, astro):
| Intent | Placement | Why |
|---|---|---|
| Messaging app | Dedicated messages page (route you pick), two-pane: conversation list + active chat | Chat IS the product. Users land directly on it; the route is the home of your app. |
| Marketplace | "Chat with seller" drawer on the product page + inbox at /messages | Drawer keeps buyers in the buying flow; the inbox handles "go back to a past conversation." |
| SaaS / dashboard | Modal triggered from your navbar + full messages page | Modal feels lightweight (chat without leaving your work); the page is for serious conversations. |
| Social / community | Full messenger page with tabs: Chats, Calls, Users, Groups | Discovery matters as much as messaging — users want to find people, not just their existing threads. |
| Support | Floating widget bubble in the bottom-right | One-way customer-to-team — minimal cognitive load on the customer; your team triages from the dashboard. |
React Native family (expo, react-native):
| Intent | Placement | Why |
|---|---|---|
| Messaging app | Dedicated "Messages" bottom tab → conversations → thread | Mobile users expect chat as a first-class destination; a tab puts it one tap away. |
| Marketplace | "Chat with seller" button on the product screen → modal thread + Inbox stack screen | Modal preserves the buying context; the Inbox is the "back to a conversation" entry point. |
| SaaS / productivity | "Chat" stack screen accessible from nav, optionally bottom sheet for quick replies | Stack screen for focused conversations; bottom sheet for fast back-and-forth without leaving your current work. |
| Social / community | "Messages" bottom tab + "Message" button on profile screens → modal thread | Tab handles discovery; per-profile button is the "I want to talk to THIS person" path. |
| Support | Modal triggered from a "Help" or "Support" button in header/settings | Lightweight, doesn't compete with your product's primary tabs. |
When explaining, reference the ASCII diagrams from cometchat-placement (web) or cometchat-native-placement (RN) so the user can visualize the shape.
One sentence to hand them control: end the recommendation with "Sound right, or want to try a different shape?" — never "Which would you like?" The first phrasing implies you've thought it through and they can override; the second implies you're just collecting answers.
3b.1 — Tailor the recommendation by last_app.industry
If auth me returned last_app.industry, layer the industry-specific upsell onto the placement archetype recommendation. Do NOT replace it — augment it. Industry is a hint, not a rule.
| Industry value | What to add to the recommendation |
|---|---|
healthcare | Mention HIPAA-aware patterns: server-minted auth tokens (NEVER Auth Key), Moderation Rules API (Profanity / AI Image Moderation / Malware & Virus Scanner — configured via apply-feature → /moderation/rules, NOT legacy extensions), audit-log retention, recording consent. Point at cometchat-{family}-production and cometchat-features for the moderation suite. |
dating | Suggest enabling Profanity Filter + Image Moderation + Sentiment Analysis upfront — dating apps almost always want them. Suggest a "Report user" button next to the message header. |
online_marketplaces | Confirm the drawer-on-product-page placement (default for marketplace archetype). Suggest enabling Link Preview (buyers share product URLs) and Quick Replies for sellers. |
community_and_social | Suggest enabling Reactions + Mentions + Threaded Conversations (these are default-on but worth surfacing as design-system colors). Recommend the tab-based "full messenger" placement. |
online_education | Suggest a /messages route + a "Help" button in the navbar (instructor support). Mention Recording for class sessions if calls product is also enabled — but flag that recording is a paid plan add-on (contact CometChat support to enable; not self-service / no CLI toggle). |
events_and_streaming | Suggest the floating widget for live audience chat. If calls product is enabled, recommend group calls + screen-share for hosts. |
sports_and_gaming | Suggest tab-based messenger + Reactions + GIPHY/Stipop sticker integration (gamer apps lean heavily on stickers). |
team_comms_and_workflows | Match Slack-like patterns: dedicated /messages route, threaded conversations on, mentions on. Skip the floating widget. |
on_demand_services | Marketplace drawer pattern. Mention auto-translate for cross-language driver/rider chat. |
saas_businesses | Modal-from-navbar default (matches the SaaS archetype). Suggest server-minted auth tokens + user-mgmt API for tenant scoping. |
other / null | No industry-specific upsell — recommendation stays at the archetype level only. |
Phrase the upsell as a follow-up after the base recommendation, not a replacement:
"For the marketplace archetype, I'll set up the chat-with-seller drawer + /messages inbox. Since this is a marketplace app (per your dashboard), I'll also enable Link Preview by default — buyers and sellers share product URLs in chat all the time, and the preview helps. You can disable it after with
cometchat apply-feature link-preview --remove."
Don't drown the user — pick at most 2 industry-specific suggestions per session. The verification matrix in the iteration menu surfaces the rest later.
Ask: "Does this sound right, or do you want a different approach?" Let them override.
3c. Ask where things should go
Show the user their actual project structure — list the pages/routes/screens you found in Step 1. Then ask placement-specific questions appropriate to the family.
Web — Route placement (messaging, social):
"I found these pages in your project:
- / (home)
- /about
- /products
- /profile
Where should the messages page live?"
Default: /messages. Let user type a custom path.
Web — Drawer placement (marketplace):
"Which page should have the 'Chat' button that opens the drawer? I found these pages: ..."
Read the picked page. Look for existing buttons, actions, or interactive elements. Ask whether to wire to the existing button or add a new one.
Web — Modal placement (SaaS):
"Where should the 'Open chat' button go? I found these components that look like navigation: ..."
Web — Widget placement (support):
"Should the widget appear on all pages, or only specific ones?"
RN — Bottom tab placement (messaging, social):
"I found these bottom tabs in your navigator at App.tsx:
- Home
- Profile
- Settings
Where should the 'Messages' tab go? (At the end, or pick a position.)"
RN — Stack screen placement (saas, marketplace inbox):
"I found these stack screens in your root navigator: ...
What should I call the chat screen? Default: MessagesScreen."
RN — Modal placement (marketplace, support):
"Which screen should have the 'Chat' button that opens the modal? I found these screens: ..."
Read the picked screen. Look for existing buttons. Ask whether to wire to it or add a new one.
RN — BottomSheet placement (quick reply, support):
"Bottom sheets slide up from below. Should the sheet be:
- Draggable (user can dismiss by swiping down) — uses @gorhom/bottom-sheet
- Fixed overlay — uses CometChat's built-in CometChatBottomSheet
Which one?"
Combinations (marketplace = drawer/modal + inbox): ask both questions in sequence — they're separate components wired into separate places.
Expo Router projects — adapt screen names to file paths:
- Stack screen →
app/messages.tsx(or the path the user picks) - Bottom tab → file under
app/(tabs)/messages.tsx+ updateapp/(tabs)/_layout.tsx - Modal →
app/(modals)/chat.tsxwithpresentation: "modal"in the parent_layout.tsx
3d. Detect and ask about authentication
Read the project's package.json and source files. Look for auth.
Web auth libraries:
next-auth/@auth/core→ NextAuth@clerk/nextjs/@clerk/clerk-react→ Clerk@supabase/supabase-js+ auth usage → Supabase Authfirebase/firebase/auth→ Firebase Authpassport→ Passport.jsjsonwebtoken/jose→ Custom JWT
RN auth libraries:
firebase/@react-native-firebase/auth→ Firebase Auth@clerk/clerk-expo/@clerk/clerk-react-native→ Clerk@supabase/supabase-js+ auth usage → Supabase Authreact-native-auth0→ Auth0aws-amplify+ auth module → AWS Cognito@react-native-google-signin/google-signin→ Google Sign-In (usually paired with something above)expo-auth-session/expo-secure-store→ Expo Auth Session (custom)
None detected → no auth.
Report what you found and ask:
If auth detected:
"I see you're using [NextAuth / Firebase Auth / etc.]. Here's how CometChat will work with it:
- Development (now): I'll use CometChat's Auth Key for quick testing with pre-seeded users (cometchat-uid-1 through uid-5).
- Production (later): Your server will mint per-user auth tokens via the CometChat REST API. I can set this up now or later (see
cometchat-production/cometchat-native-production).Start with dev mode for now? You can upgrade to production auth anytime by choosing 'Set up production auth' from the menu."
If no auth detected:
"I don't see an authentication system in your project yet. For now, I'll set up CometChat with a hardcoded test user (cometchat-uid-1).
When you add auth later, run
/cometchatagain and choose 'Set up production auth' to connect them."
3d.1. Confirm the dev-mode UID (ALWAYS ASK — ENG-35717)
After committing to dev mode (whether or not auth was detected), always ask the user which UID to log in with before scaffolding. Do not silently pick cometchat-uid-1 (or superhero1, or any other guess) and hard-code it. Two testers reported the agent committing to a default UID without confirming — and one of those defaults was flagged as a Bot in their dashboard, which makes auth-key login fail with an opaque error.
The shape:
"Which UID should I log in as for dev mode? The default is
cometchat-uid-1— your CometChat app ships withcometchat-uid-1throughcometchat-uid-5pre-seeded so you can chat between browser windows. Use the default, or paste your own UID?"
Hard caveat — call this out alongside the question whenever you're emitting an auth-key dev login:
⚠️ If the UID is marked as a "Bot" in the dashboard, auth-key login will fail with
Auth token creation not allowed for this bot <uid>and the chat surface will render but not connect. Bot users only accept auth-token login (server-side mint) — the dev auth-key flow refuses them by design. If you hit that error, go to Dashboard → Users → click the UID → toggle the "Bot" switch off, OR pick a non-bot UID. The defaultcometchat-uid-1is NOT a bot in a fresh CometChat app, but if you've reused an app where someone flagged it as a bot earlier, this trap fires.
Use whatever UID the user chooses (or cometchat-uid-1 if they confirm the default) in the generated init.ts / CometChatProvider. Do not invent a UID like superhero1 from older docs — the canonical pre-seeded test users are cometchat-uid-1 through cometchat-uid-5.
⚠️ Only
cometchat-uid-1…cometchat-uid-5are pre-seeded — a custom UID MUST be created before login. A CometChat app ships exactly these five test users. If the user pastes any other UID (e.g.alice,test-user-7), it does not exist yet, and devCometChatUIKit.login(uid)will fail with user-not-found (ERR_UID_NOT_FOUND/ "user not found"). So: if the chosen UID is not one ofcometchat-uid-1..5, create it first before wiring login. The Auth Key can create users (it has create + login scope — seecometchat-production's key table), so create it via the create-user REST call, then log in:# Create the custom user first (Auth Key works for create — server-side / one-time) curl -X POST "https://<APP_ID>.api-<REGION>.cometchat.io/v3/users" \ -H "apikey: <AUTH_KEY>" -H "Content-Type: application/json" \ -d '{"uid":"<custom-uid>","name":"<Display Name>"}'Then
CometChatUIKit.login("<custom-uid>")succeeds. (The five seeded UIDs skip this — they already exist.) Prefer steering the user to a seededcometchat-uid-Nfor a quick demo; only create a custom user when they specifically want their own UID.
3e. Ask about user mapping (if auth detected)
If the user has auth AND wants to set up production mode now:
"How should your app's users map to CometChat users?
- Use your existing user ID as the CometChat UID (simplest)
- Generate a separate CometChat UID and store it alongside your user record
- Let me just set up dev mode for now"
If they share an example, validate it's CometChat-compatible (alphanumeric, underscores, hyphens — no spaces or special chars; max 100 chars). Firebase UIDs, Clerk user IDs, Supabase UUIDs, and Auth0 sub claims are all CometChat-compatible by default.
3f. Confirm the plan — the third wow moment
This is the trust contract. Show EXACTLY what you'll do BEFORE doing it. Three sections, in this order:
- Files I'll create — new files, with a one-line purpose for each
- Files I'll modify — existing files, with the specific edit (not "wrap with provider" alone — say "wrap the children of
<Layout>with<CometChatProvider>at line ~14") - Files I won't touch — call out the load-bearing files that stay untouched (auth config, route definitions outside the chat surface, your existing components). This is the reassurance.
Then dependencies + auth mode + an approval line that hands the user control.
The shape (use it verbatim — three sections + reassurance):
Here's the plan:
Files I'll create
cometchat/CometChatProvider.tsx— wraps the kit's auth + theme providers, gates render on logincometchat/init.ts— module-level CometChat.init + login, called from the providerapp/messages/page.tsx— full-page messages route (your inbox)app/components/ChatDrawer.tsx— the "chat with seller" drawer for product pages.env.local— your CometChat App ID + Region + Auth Key (gitignored)Files I'll modify
app/layout.tsx— wrap{children}with<CometChatProvider>(one line, around line 14)app/products/[id]/page.tsx— add the<ChatDrawer />trigger button next to the seller info (your existing layout stays)app/components/Navbar.tsx— add a<Link href="/messages">Messages</Link>next to your existing nav itemsFiles I won't touch
auth.config.ts— your NextAuth setup stays as-is; we'll wire CometChat to it in production-auth mode latertailwind.config.ts,globals.css— no styling changes outsidecometchat/- Anything under
app/products/,app/cart/, etc. — your existing routes are untouchedDependencies
@cometchat/chat-sdk-javascript,@cometchat/chat-uikit-reactAuth mode Development (Auth Key for now; production auth is a one-flag upgrade later)
Estimated time ~30 seconds to write the code, ~1 minute for
npm installto finish.If anything looks off, just tell me what to change. Otherwise, say "go" and I'll write it.
The rules for this moment:
- Be specific in the modify section. "Wrap with provider" is vague. "Wrap
{children}with<CometChatProvider>at line ~14" tells the user exactly what to expect when they git-diff later. - List the don't-touch files explicitly. Users worry about agents stomping their auth config, their tailwind, their routes. Naming what stays untouched defuses that worry up front.
- Estimated time matters. Two short numbers — a few seconds to write code, a couple minutes for
npm install. Sets expectations; reduces "is it stuck?" mid-flow. - End with a hand-off, not a yes/no. "Say 'go' and I'll write it. Or tell me what to change." Beats "Proceed? [y/n]" — it implies the user can adjust without throwing the whole plan away.
- Never abbreviate the plan in subsequent runs. Every integration deserves a fresh, full plan. If the user has been through this before, they can skim — but don't pre-skim for them.
Web example (Next.js + NextAuth, marketplace): see the shape above.
Web example (Vite + React, greenfield messaging app):
Here's the plan:
Files I'll create
src/cometchat/CometChatProvider.tsx— wraps the kit's providers, gates render on loginsrc/cometchat/init.ts—CometChat.init+CometChat.login(withcometchat-uid-1for dev)src/components/ChatScreen.tsx— your full-page chat surface (conversations + messages).env— your CometChat App ID + Region + Auth Key (gitignored)Files I'll modify
src/main.tsx— wrap<App />with<CometChatProvider>(line ~10)src/App.tsx— render<ChatScreen />instead of the Vite default (you can move it to a route later)Files I won't touch
vite.config.ts,tsconfig.*— no build config changessrc/index.css,src/App.css— kit ships its own CSS; your styles stayDependencies
@cometchat/chat-sdk-javascript,@cometchat/chat-uikit-reactAuth mode Development (Auth Key +
cometchat-uid-1; you can log in ascometchat-uid-1–uid-5to chat with yourself across browser windows)Estimated time ~30 seconds to write, ~1 minute for
npm install.Say "go" or tell me what to change.
RN example (Expo Router, messaging):
Here's the plan:
Files I'll create
cometchat/CometChatProvider.tsx— four-wrapper chain (gesture handler → safe area → theme → CometChat)cometchat/init.ts— init + login, module-level guardapp/(tabs)/messages.tsx— your Messages tab.env—EXPO_PUBLIC_COMETCHAT_APP_ID+ region + auth keyFiles I'll modify
app/_layout.tsx— wrap with the four-wrapper chain (line ~10)app/(tabs)/_layout.tsx— add the Messages tab as the third entry, after Home and Profileindex.js—import 'react-native-gesture-handler'at line 1 (mandatory; without it release builds break silently)Files I won't touch
app.json— no Expo config changes for dev mode (production push needs them, but that's later)- Your existing
app/(tabs)/index.tsx,profile.tsx— stay as-isDependencies (via
npx expo install)@cometchat/chat-uikit-react-native,@cometchat/chat-sdk-react-native,react-native-gesture-handler,react-native-reanimated,react-native-safe-area-context,react-native-screens,@react-native-async-storage/async-storage,@react-native-community/netinfo,react-native-video,react-native-image-picker,react-native-document-picker,react-native-vector-icons,react-native-fsAuth mode Development (Auth Key).
Estimated time ~30 seconds to write, ~3 minutes for
expo install(RN deps are heavier).Say "go" or tell me what to change.
Bare RN variant — same as Expo, except:
npm installinstead ofnpx expo install- Run
cd ios && pod install(~1-2 min extra) - Patch
ios/<Name>/Info.plist,android/app/src/main/AndroidManifest.xmlfor camera/mic permissions - Add
ios/<Name>/PrivacyInfo.xcprivacy(Apple Privacy Manifest) - Patch
android/build.gradlefor the async-storage Maven repo (v3+)
Surface these in the "Files I'll modify" section so the user knows they're coming.
After approval — the writing moment:
When the user says "go", narrate progress as you work. Don't be silent for 30 seconds while you write 5 files. Brief structured updates, one per beat:
✓ Created
cometchat/CometChatProvider.tsx✓ Createdcometchat/init.ts✓ Modifiedsrc/main.tsx(wrapped App with provider) ✓ Wrote.env(Auth Key hidden) Installing dependencies (this takes ~1 minute)...
The structured beats make the writing feel like a contract being executed, not a black box churning.
If the user says no or wants changes: go back to the relevant question and re-ask. Don't try to negotiate the plan in-line — the plan is atomic. Adjust the source decision, then regenerate the plan.
Step 4 — Reference pattern skills
All skills are already loaded in your context as .claude/skills/ (or .cursor/skills/ / .kiro/skills/ / .agents/skills/ — your agent's skills dir) files. NEVER explicitly load CometChat skills via your agent's skill-loading mechanism — the skills are already in your context. Just read and follow them directly.
For web frameworks:
cometchat-core— initialization, provider, CSS, anti-patternscometchat-components— component catalog, composition patterns- Framework-specific:
reactjs→cometchat-react-patternsnextjs→cometchat-nextjs-patternsreact-router→cometchat-react-router-patternsastro→cometchat-astro-patterns
cometchat-placement— placement pattern for the chosen approach
For React Native:
cometchat-native-core— init, login, four-wrapper provider chain, env vars, anti-patternscometchat-native-components— component catalog- Framework-specific:
expo(managed + Expo Router) →cometchat-native-expo-patternsreact-native(bare CLI) →cometchat-native-bare-patterns
cometchat-native-placement— placement pattern (stack/tab/modal/bottom-sheet/embed)
For Angular:
cometchat-angular-core— init viaCometChatUIKit.initFromSettings(cometchat-settings.json)inmain.ts(recommended; GA in@cometchat/chat-uikit-angular >= 5.0.3), or theUIKitSettingsBuilderfallback — standalone bootstrap, env config inenvironment.ts, login order, anti-patterns. v5 is standalone — NOCUSTOM_ELEMENTS_SCHEMA, no NgModule (those are v4 mental models).cometchat-angular-components— component catalog (kebab-case<cometchat-*>selectors,[input]/(output)bindings, view slots, standaloneimports: []— not NgModule)angular→cometchat-angular-patterns— standalone providers,loadComponentlazy routes, functional route guards, NgZone, environment file editingcometchat-angular-placement— placement pattern (route, modal, drawer, embedded panel)
For Android — branches by android_version:
If android_version === "v5":
cometchat-android-v5-core— Gradle deps,UIKitSettings.UIKitSettingsBuilder,CometChatUIKit.init()inApplication.onCreate(), login, theme requirements (CometChatTheme.DayNight→ Material 2 parent)cometchat-android-v5-components— View classes (CometChatConversations,CometChatMessageList,CometChatMessageComposer, …),setUser/setGroup, listener setters (setOnItemClick,setOnSendButtonClick), thread-mode rule (setParentMessage(long)on list,setParentMessageId(long)on composer)cometchat-android-v5-placement— Activity, Fragment, BottomSheet placement, navigationcometchat-android-v5-customization—CometChatTextFormatter, message templates,CometChatMessageEvents.addListener, DataSource decoratorscometchat-android-v5-extensions— registrar (PollsExtension,StickerExtension,SmartRepliesExtensionextendingExtensionsDataSource) vs decorator pattern; never construct decorators directly
If android_version === "v6", additionally branch by UI stack (Compose vs Kotlin Views — ask the user if both are present):
cometchat-android-v6-core— Gradle deps forchatuikit-{compose,kotlin}-android:6.x+chatuikit-core, init, login, message sendingcometchat-android-v6-events—CometChatEventsSharedFlows + sealed event classes- Compose stack →
cometchat-android-v6-compose-{components,placement,theming,customization}— Composables,CometChatTheme { ... },BubbleFactory, slot lambdas - Kotlin Views stack →
cometchat-android-v6-kotlin-{components,placement,theming,customization}— custom View classes,setOnItemClick,BubbleFactoryabstract class,setBubbleFactories cometchat-android-v6-builder-settings—UIKitSettingsBuilderknobs (calling, presence, etc.)
Both V5 and V6 share cometchat-android-{v5,v6}-{features,extensions,push,production,testing,troubleshooting} for cross-cutting concerns.
For Flutter — branches by flutter_version:
If flutter_version === "v5":
cometchat-flutter-v5-core— pubspec deps,UIKitSettings.UIKitSettingsBuilder,CometChatUIKit.init(), login, GetX-based controller pattern,subscriptionTyperequirement, theme caching rule, listener lifecyclecometchat-flutter-v5-conversations/-messages/-users-groups/-calls— widget-by-widget catalog (V5 splits its component catalog across these four skills)cometchat-flutter-v5-theming—CometChatThemeHelper,CometChatColorPalette,CometChatSpacing,CometChatTypography, dark modecometchat-flutter-v5-customization—DataSource,DataSourceDecorator,CometChatMessageTemplate,CometChatTextFormatter, slot viewscometchat-flutter-v5-events—CometChatMessageEvents.addListener,CometChatGroupEvents,CometChatUserEvents,CometChatCallEvents,CometChatUIEventscometchat-flutter-v5-push— FCM/APNs/VoIP setup;CometChatNotifications.registerPushToken()is the public surface (sample-appPNRegistryis a wrapper users copy)cometchat-flutter-v5-production— server-minted auth tokens, ProGuard, release buildscometchat-flutter-v5-troubleshooting— pubspec resolution, GetX errors, runtime crashes
If flutter_version === "v6":
cometchat-flutter-v6-core— pubspec deps (singlecometchat_chat_uikit: ^6.0package),UIKitSettingsBuilder, init, login, message sending. TheenableCalls/CallingConfiguration()knobs live incometchat-flutter-v6-calls.cometchat-flutter-v6-components— full Bloc-driven widget catalogcometchat-flutter-v6-conversations/-messages/-users-groups/-calls— per-widget deep divescometchat-flutter-v6-features— feature catalogcometchat-flutter-v6-placement— route, modal sheet, embedded widget — where chat lives in the appcometchat-flutter-v6-theming—CometChatThemeHelper,CometChatColorPalette(V6 names),CometChatThemeModecometchat-flutter-v6-customization—BubbleFactory<T>,CometChatMessageTemplate, text formatters, slot widgetscometchat-flutter-v6-events— Bloc-based event streams, listener registrationcometchat-flutter-v6-production— server-minted auth tokens, ProGuardcometchat-flutter-v6-troubleshooting— pubspec, Bloc, theme cache
For projects migrating from V5 to V6, ALSO load cometchat-flutter-v6-migration — V5→V6 breaking changes (GetX → Bloc, theme API rewrite, BuilderSettings removal, callMain entry-point removal).
For iOS — single cohort (V5 only today):
cometchat-ios-core— Installation (CocoaPods + SPM),UIKitSettings,CometChatUIKit(uiKitSettings:)constructor init, login (.success/.onErrorswitch — NOT Swift's standardResult.failure), AppDelegate vs SwiftUI App-struct init sites, anti-patternscometchat-ios-components— Component catalog:CometChatConversations,CometChatUsers,CometChatGroups,CometChatGroupMembers,CometChatMessageHeader/List/Composer,CometChatIncomingCall/OutgoingCall/OngoingCall/CallButtons/CallLogs,CometChatSearch,CometChatReactionList,CometChatThreadedMessageHeader. Build aMessagesVCby composing header + list + composer (the kit does NOT ship a pre-builtCometChatMessagesUIViewController).cometchat-ios-placement— Navigation controller, modal, tab bar, embedded view — where chat lives. Mixed SwiftUI + UIKit hosting viaUIViewControllerRepresentable.cometchat-ios-customization— Custom message templates, text formatters, DataSource/Decorator pattern, custom views.cometchat-ios-theming—CometChatThemecolor tokens,CometChatTypography.setFont(name:), dark mode.cometchat-ios-features— Feature catalog: calls, polls, reactions, AI, extensions.cometchat-ios-production— Server-minted auth tokens, user management.cometchat-ios-push— APNs + VoIP, CallKit integration, token lifecycle.cometchat-ios-troubleshooting— SPM/CocoaPods errors, Xcode build issues, Info.plist gotchas, runtime crashes.
Step 5 — Write the integration
Execute the confirmed plan. The order of operations is the same for every framework, but the file names + provider shape differ.
Branch by customize (from Step 3.1):
-
customize=visual→ emit a singleCometChatAppwrapper that consumes the builder config cached in.cometchat/builder.json(thesettingsblob returned bycometchat builder fetch). The wrapper is one file per platform (CometChatApp.tsxfor web/RN,CometChatApp.ktfor Android,CometChatApp.swiftfor iOS,cometchat_app.dartfor Flutter); the customer's existing entry file gets a single<CometChatApp />mount. Per-framework emit templates are documented in the per-family skills (cometchat-{family}-core§ "Visual Builder integration"). The CSS-variable / theme overrides the customer chose in the Visual Builder are inlined verbatim — skills does NOT re-derive them. Then skip the framework-specific steps below and go straight to dependency install + environment variables. -
customize=code(default) → run the framework-specific steps below as normal.
Web — common steps:
- CometChatProvider — follow the framework skill's provider pattern. Use the correct env var prefix. Module-level
initializedguard. Mount at the level agreed in Step 3f. - Chat component(s) — follow the placement skill's pattern.
- Wire into existing project — READ each file before modifying. Add the route, nav link, drawer/modal trigger.
- CSS import — add once at the root level per framework conventions.
- Environment variables — write the env file with the correct prefix.
- Install dependencies:
npm install @cometchat/chat-sdk-javascript @cometchat/chat-uikit-react
React Native — common steps:
-
Entry file (
index.js/App.tsx/app/_layout.tsx) — verifyimport "react-native-gesture-handler";is line 1. Not line 2, not after another import. Non-negotiable. -
CometChatProvider — follow
cometchat-native-core§ 6. Module-levelinitializedguard. Module-levelloginInFlightpromise for login concurrency. -
Four-wrapper chain — wrap the app's root in this exact order:
<GestureHandlerRootView style={{ flex: 1 }}> <SafeAreaProvider> <CometChatThemeProvider> <CometChatProvider> {/* navigator / Expo Router <Stack> */} </CometChatProvider> </CometChatThemeProvider> </SafeAreaProvider> </GestureHandlerRootView> -
Chat screen(s) — follow
cometchat-native-placement's pattern. -
Every
<CometChatMessageList>MUST passhideReplyInThreadOption={true}(see hard rules). -
Wire into existing project — READ each file before modifying.
-
Environment variables — write
.envwith the correct prefix (EXPO_PUBLIC_for Expo, bare forreact-native). -
Install dependencies:
Expo managed:
npx expo install @cometchat/chat-uikit-react-native @cometchat/chat-sdk-react-native \ react-native-gesture-handler react-native-reanimated react-native-safe-area-context \ react-native-screens @react-native-async-storage/async-storage \ @react-native-community/netinfo react-native-video react-native-image-picker \ react-native-document-picker react-native-vector-icons react-native-fsBare RN:
npm install @cometchat/chat-uikit-react-native @cometchat/chat-sdk-react-native \ react-native-gesture-handler react-native-reanimated react-native-safe-area-context \ react-native-screens @react-native-async-storage/async-storage \ @react-native-community/netinfo react-native-video react-native-image-picker \ react-native-document-picker react-native-vector-icons react-native-fs cd ios && pod install && cd ..Reanimated plugin (both): verify
react-native-reanimated/pluginis the LAST entry inbabel.config.jspluginsarray. Metro cache is sensitive to plugin order. -
Native config (bare RN only):
ios/<Name>/Info.plist— addNSCameraUsageDescription,NSPhotoLibraryUsageDescription,NSMicrophoneUsageDescriptionandroid/app/src/main/AndroidManifest.xml— addCAMERA,RECORD_AUDIO,READ_MEDIA_IMAGES,READ_EXTERNAL_STORAGEpermissionsios/<Name>/PrivacyInfo.xcprivacy— add the 3 required API codes (C617.1, CA92.1, 35F9.1) — matching the kit's own SampleApp manifest. AddE174.1(DiskSpace) only if your app does explicit free-space checks. Seecometchat-native-bare-patterns.android/build.gradle— async-storage Maven repo if v3+
Expo managed — all of this goes in
app.jsonunderpluginsandios.infoPlist/android.permissions. Seecometchat-native-expo-patterns.
iOS — common steps:
- Migrate credentials to
Secrets.swiftor an.xcconfig— ifprovision setupwrote a.env(iOS handoff), do the migration documented in Step 2d above. Confirm the secrets file is in.gitignore. - Add the kit dep:
- CocoaPods: add
pod 'CometChatUIKitSwift', '~> 5.1'toPodfile→pod install. Open the.xcworkspace(NOT.xcodeproj). For Xcode 15+, setENABLE_USER_SCRIPT_SANDBOXING = NOin Build Settings (or add thepost_installPodfile hook that does this for every pod target). - SPM: in Xcode → File → Add Package Dependencies →
https://github.com/cometchat/cometchat-uikit-ios(latest 5.x). Or add the package URL to yourPackage.swiftif you're an SPM-only app.
- CocoaPods: add
- Init in your app entry point — UIKit: in
AppDelegate.application(_:didFinishLaunchingWithOptions:). SwiftUI: in@main struct App.init(). The init takes aUIKitSettingsand aResult<Bool, Error>completion:CometChatUIKit(uiKitSettings: settings) { result in switch result { case .success: ... case .failure(let error): ... } }. The explicit.init(...)form (CometChatUIKit.init(uiKitSettings: ...) { ... }) compiles identically in Swift and is what the kit's sample apps use — both are fine. Note that this completion uses Swift's standardResult.failure, NOT the kit's.onErrorenum which only appears in login/logout callbacks (see step 4). - Login order —
CometChatUIKit.login(uid:)(dev) or.login(authToken:)(production). The login callback uses.success/.onErrorcases (NOT Swift's standardResult.failure). - Place chat in your app — for UIKit nav stacks, push your composed
MessagesVC(header + list + composer). For SwiftUI, wrap each kitUIViewControllerin aUIViewControllerRepresentable. The kit does NOT ship a pre-builtCometChatMessagesorCometChatConversationsWithMessages— compose your own. - Info.plist permissions — for calls add
NSMicrophoneUsageDescription+NSCameraUsageDescription. For push add the APNs entitlement + aBackgroundModesentry (remote-notification, plusvoipfor VoIP push). - Verify —
xcodebuild -workspace <App>.xcworkspace -scheme <App> -configuration Debug build(CocoaPods) or-project <App>.xcodeproj -scheme <App> ...(SPM). Skipxcodebuild testandxcodebuild run-app— those need a simulator and longer compile time than CI usually permits.
Flutter — common steps:
- Migrate credentials to a Dart const file or
--dart-define— ifprovision setupwrote a.env(Flutter handoff), do the migration documented in Step 2d above. Confirmlib/cometchat_config.dartis in.gitignoreif you go the const-file route. - Add the cometchat dep to
pubspec.yamland runflutter pub get:- V5:
cometchat_chat_uikit: ^5.2.14(andcometchat_calls_uikit: ^5.0.15if calls are needed). Both packages live on the Cloudsmith Dart pub registry, so you'll also need a--hosted-urlflag in your CI scripts:dart pub add cometchat_chat_uikit:^5.2.14 --hosted-url https://dart.cloudsmith.io/cometchat/cometchat/. - V6:
cometchat_chat_uikit: ^6.0(single package — calls fold in).
- V5:
- Imports — V5 has TWO barrels. For chat-only V5 apps, only the chat barrel is needed:
import 'package:cometchat_chat_uikit/cometchat_chat_uikit.dart';. For V5 + calls, ADD a second import:import 'package:cometchat_calls_uikit/cometchat_calls_uikit.dart';— the calls barrel does NOT re-export the chat barrel, so chat widgets aren't reachable through it alone. V6 has ONE barrel:import 'package:cometchat_chat_uikit/cometchat_chat_uikit.dart';. - Init in
main.dart—CometChatUIKit.init(uiKitSettings: settings, onSuccess: ..., onError: ...). V5 and V6 share the same init signature (callback-style); the difference is what comes after — V5 wires GetX controllers; V6 wiresBlocProviders. Always setsubscriptionType: CometChatSubscriptionType.allUserson the builder. - Place chat in your app — Flutter routing is in code (
Navigator.push/go_router/etc.). Wire chat screens into your app's existing navigation. V6 has a dedicated placement skill for route/modal/embed patterns; V5 covers the same ground inside its per-widget skills. - AndroidManifest + Info.plist — for calls, add the platform permissions (microphone, camera, modify-audio-settings on Android;
NSMicrophoneUsageDescription+NSCameraUsageDescriptionon iOS). For push, register the FCM service / configure APNs entitlements percometchat-flutter-{v5,v6}-push(V5) or the troubleshooting skill (V6). - Verify —
flutter analyzefirst (catches Dart compile + import errors), thenflutter build apk --debug(Android) orflutter build ios --debug --no-codesign(iOS). The build catches dep-resolution / native-config issues.
Android — common steps:
- Migrate credentials to
local.properties+BuildConfig— ifprovision setupwrote a.env(Android handoff), do the migration documented in Step 2d above. Confirmlocal.propertiesis in.gitignore(it is by default inng new-style scaffolds and Android Studio templates, but verify). - Add the cometchat dep to
app/build.gradle(or.kts):- V5:
implementation 'com.cometchat:chat-uikit-android:5.+' - V6 Compose:
implementation 'com.cometchat:chatuikit-compose-android:6.+'(pluscompose-bomif not already present) - V6 Kotlin Views:
implementation 'com.cometchat:chatuikit-kotlin-android:6.+' - Both V6 stacks: add both
chatuikit-compose-androidANDchatuikit-kotlin-android(pluschatuikit-coreif the kit splits it out)
- V5:
- Theme parent (V5 only) —
Applicationtheme must inherit fromCometChatTheme.DayNight(which itself parents onTheme.MaterialComponents.DayNight.NoActionBar). Inheriting fromTheme.AppCompat.*orTheme.Material3.*causesUnsupportedOperationExceptionat inflate time. V6 doesn't share this requirement — Compose has its ownCometChatTheme { }block; Kotlin Views uses style attrs. - Init in
Application.onCreate()—CometChatUIKit.init(this, settings, callback). Wirelogin(uid, callback)inside the init success callback.Applicationclass must be registered inAndroidManifest.xmlvia<application android:name=".MyApp" …>. - Place chat in your app — V5: Activity / Fragment with the View classes (
CometChatConversationsetc.). V6 Compose: Composable screens via NavHost. V6 Kotlin Views: same Activity/Fragment shape as V5 but with V6 View classes. - AndroidManifest permissions —
INTERNETis mandatory; for calls addRECORD_AUDIO,CAMERA,MODIFY_AUDIO_SETTINGS,BLUETOOTH_CONNECT(API 31+). - ProGuard/R8 — for release builds, add
-keep class com.cometchat.** { *; }toproguard-rules.proto prevent stripping. - Verify —
./gradlew :app:assembleDebug(orapp:assembleDebugfrom project root) catches Gradle/AGP/dependency issues; the kit's compile-time annotation processors surface schema errors here.
Angular — common steps:
- Migrate credentials into
environment.ts— ifprovision setupwrote a.env(Angular fallback), extendsrc/environments/environment.tswith acometchat: { appId, region, authKey }block. Mirror inenvironment.prod.tsWITHOUT theauthKey(production uses server-minted auth tokens — seecometchat-angular-production). - No
CUSTOM_ELEMENTS_SCHEMA— UI Kit v5 ships real Angular standalone components (not web components). Importing the component class is all that's needed; the schema is a v4 mental model and should NOT be added. - Init service + APP_INITIALIZER — follow
cometchat-angular-core§ 1-3.new UIKitSettingsBuilder().setAppId().setRegion().setAuthKey().build(), thenCometChatUIKit.init(settings)returns a Promise — chain login (login(uid)takes a bare string in v5). Wire asAPP_INITIALIZERso init completes before any component renders. - Import the component classes — into the host standalone component's
imports: [], e.g.CometChatConversationsComponent,CometChatMessageListComponentfrom@cometchat/chat-uikit-angular. There is no NgModule and no*-with-messagescomposite in v5 — compose the message components yourself.cometchat-angular-componentslists the selector ↔ class pairing. - Wire chat into existing project — READ each file before modifying. Add the route, nav link, modal trigger.
- Theming — inject
CometChatThemeServiceto control palette/typography. Seecometchat-angular-theming. - Install dependencies:
npm install @cometchat/chat-uikit-angular @cometchat/chat-sdk-javascript
Step 5 — common to ALL frameworks
After the framework-specific work above, every integration ends the same way:
-
Update config.json — save all the choices in one call:
npx @cometchat/skills-cli config save \ --intent "<intent>" \ --placement "<type>" \ --placement-path "<path>" \ --auth-mode "<mode>" --jsonPass only the fields you have —
config saveaccepts any subset. -
Record state so Phase B commands work — DO NOT SKIP. Every Phase B command (
info,status,doctor,verify,uninstall,apply-theme,apply-feature,add-widget,add-user-mgmt,production-auth) reads.cometchat/state.jsonto know what the integration looks like. Without this step, every one of them reports "not integrated in this project" even though the code is there.Pass every file you wrote (owned) and every existing file you patched:
npx @cometchat/skills-cli state record \ --framework "<framework>" \ --placement "<type>" \ --placement-path "<path>" \ --auth-mode "<mode>" \ --files-owned "<comma-list of new files>" \ --files-patched "<comma-list of path:patch_id pairs>" \ --json--files-owned— comma-separated list of every NEW file you wrote (provider, drawer, inbox page, screen). The CLI computes SHA-256 checksums for each so it can detect drift later.--files-patched— comma-separatedpath:patch_idpairs for every EXISTING file you modified.patch_idcan be any stable label —v3/<filename>is a reasonable default.
If this call errors (CLI flag mismatch, missing
--framework, etc.), surface the error and retry. A completed Phase A with a missing state.json is worse than a visible error — the user discovers the breakage later when they try to add a feature or run diagnostics.
Exception — "Just exploring" / demo mode (web only):
npx @cometchat/skills-cli apply --experience 1 --framework <detected>
npx @cometchat/skills-cli verify --json
npx @cometchat/skills-cli install
For RN demo mode, scaffold the minimal integration directly — there's no apply template path for RN.
Step 6 — Verify + show result
Run a TypeScript check to verify the code compiles:
npx tsc --noEmit
Angular projects: prefer npx ng build --configuration development (Angular's compiler validates templates, NgModule shape, and DI graph — tsc alone misses template type errors).
Android projects: run ./gradlew :app:assembleDebug (or gradlew.bat :app:assembleDebug on Windows). The Gradle build catches dependency-resolution errors (wrong cometchat coords), Kotlin/Java compile errors (wrong method signatures), BuildConfig field errors (missing buildConfigField declarations), and AndroidManifest issues. Do NOT start an emulator or run the app — keep verification to the build step.
Flutter projects: run flutter analyze (catches Dart compile + null-safety + import errors), then flutter build apk --debug for Android-side verification (or flutter build ios --debug --no-codesign for iOS-side). Skip flutter run — it starts an emulator/device session that can't be observed from CI.
iOS projects: run xcodebuild -workspace <App>.xcworkspace -scheme <App> -configuration Debug -destination 'generic/platform=iOS' build (CocoaPods) or the -project variant (SPM). The build catches CocoaPods/SPM dep-resolution errors, Swift compile errors, missing Info.plist keys, and signing-config issues. Do NOT run xcodebuild test or boot a simulator.
Do NOT run npx @cometchat/skills-cli verify — it checks for CLI-generated .cometchat/state.json that's authored by cometchat apply, not by AI integration. Use tsc (or ng build / ./gradlew :app:assembleDebug / flutter analyze / xcodebuild build for Angular / Android / Flutter / iOS) instead.
RN extra: do not start Metro automatically — let the user do that in their own terminal. Metro blocks the terminal and cannot be meaningfully observed from here.
Surface any common issues:
Web:
Module not found: @cometchat/chat-uikit-react→ install didn't complete- CSS variable warnings → CSS import not at root or wrong path
RN:
Cannot find module '@cometchat/chat-uikit-react-native'→ install didn't completeJSX element 'GestureHandlerRootView' has no corresponding closing tag→ wrapper chain partially appliedProperty 'hideReplyInThreadOption' does not exist on type '...'→ older UI Kit types installed; on RN make sure@cometchat/chat-uikit-react-native@^5is resolved (the prop exists from v5 onwards)
Then:
Web result message:
"CometChat is integrated! Here's what was set up:
- <list of new + patched files> ✓
- Provider + CSS wired ✓
- Dependencies installed ✓
Run
npm run dev(orng servefor Angular) and open the app:
- Vite (reactjs): http://localhost:5173
- Next.js: http://localhost:3000/chat
- React Router v7: http://localhost:5173/chat
- Astro: http://localhost:4321/chat
- Angular: http://localhost:4200"
RN result message:
"CometChat is integrated! Here's what was set up:
- <list of new + patched files> ✓
- Provider + four-wrapper chain ✓
import 'react-native-gesture-handler'verified at line 1 ✓- Dependencies installed ✓
hideReplyInThreadOption={true}on MessageList ✓Next steps:
Expo managed:
npx expo start --clear- Open the app in Expo Go (if no native modules) or a dev build
Bare RN:
npm start -- --reset-cache- In another terminal:
npm run iosornpm run android"
Common ending — what you'll see on first load (every framework):
Pre-seeded test data — chat works immediately, no dashboard setup needed:
Every CometChat app ships with 5 pre-created test users (
cometchat-uid-1throughcometchat-uid-5), a "Hello" test group, and sample messages between them. Your integration is logged in ascometchat-uid-1by default, so on first load the conversation list is already populated — you'll see existing 1:1 threads and the test group with message history. Open any conversation and reply; round-trip is ~50ms. Receipts, typing indicators, presence, and reactions all work out of the box.Want to see real-time delivery between two users? Open the integration in two browser windows (or two simulators on RN), and temporarily change the login UID in your provider —
cometchat-uid-2in one window,cometchat-uid-1in the other. Messages from one arrive live in the other without refresh.The dashboard at
https://app.cometchat.comis useful later for creating real users, configuring extensions, and viewing analytics — but you don't need it to confirm the integration is working.What would you like to do next?"
Step 7 — Iteration menu
Render this as the interactive picker (the AskUserQuestion structured form), NOT a flat "reply with a number" text dump. The catch: the picker primitive caps at 4 options, and this menu has 9 (web) / 11 (RN) leaves — so present it as a two-level picker: first a category picker (≤4 options), then, after the user picks a category, a sub-picker (≤4 options) listing that category's actions. Every sub-picker ends with a "← Back" option that returns to the category picker; selecting a leaf runs that action and, when it completes, returns to the category picker (until the user picks "I'm done"). Preserve the question / header / multiSelect:false / options[].label / options[].description shape at both levels. Map answers by label, not ordinal.
Non-picker agents (Codex / Cursor / Gemini CLI / any without the picker primitive): per the Clarification contract (§top), render the flat numbered leaf list instead (all 9/11 leaves, grouped under their category headings) and accept a number or free text. The two-level nesting is a picker-UX nicety, not a semantic requirement — the leaves are identical either way.
Web — category picker (level 1):
- question: "What would you like to do next?" · header: "Next step" · multiSelect: false
- options:
- label: "Customize", description: "Themes & brand colors, a component's look, or language & sounds."
- label: "Add to your app", description: "A feature (calls, reactions, polls, AI, …) or a floating chat widget."
- label: "Production & operations", description: "Server-side auth, user management, diagnostics."
- label: "I'm done", description: "Exit."
Web — sub-pickers (level 2):
- Customize → (a) "Customize look and feel (themes)" — "Pick a preset (slack, whatsapp, imessage, discord, notion) or set brand colors." · (b) "Customize a component" — "Custom bubbles, headers, composer actions, details views — I'll read the docs and write it." · (c) "Localize & configure sounds" — "Translate the UI / change language and tune notification + call sounds. Read
cometchat-i18n+cometchat-theming/cometchat-customization." · (d) "← Back" - Add to your app → (a) "Add a feature" — "Browse ~35 features — calls, reactions, polls, AI, and more." · (b) "Add a floating chat widget" — "An overlay button + drawer on top of your existing app." · (c) "← Back"
- Production & operations → (a) "Set up production auth" — "Replace the dev Auth Key with a server-side token endpoint. Read
cometchat-production." · (b) "Set up user management" — "Server endpoints for creating, updating, deleting CometChat users." · (c) "Run diagnostics" — "Check for drift, missing env vars, broken imports." · (d) "← Back"
RN — category picker (level 1):
- question: "What would you like to do next?" · header: "Next step" · multiSelect: false
- options:
- label: "Customize", description: "Themes, a component, or language & sounds."
- label: "Add to your app", description: "A feature or another chat placement."
- label: "Production & operations", description: "Push notifications, auth, user management, testing."
- label: "Troubleshoot or finish", description: "Fix an issue, or exit."
RN — sub-pickers (level 2):
- Customize → (a) "Customize look and feel (themes)" — "Colors, typography, dark mode — edit CometChatThemeProvider." · (b) "Customize a component" — "Custom bubbles, headers, message composer actions, empty states." · (c) "Localize & configure sounds" — "Translate the UI / change language and tune notification + call sounds. Read
cometchat-i18n+cometchat-native-theming." · (d) "← Back" - Add to your app → (a) "Add a feature" — "Calls, reactions, polls, extensions, AI agent — browse the catalog." · (b) "Add another placement" — "Add a modal chat, a bottom sheet, or another tab — without touching the existing integration." · (c) "← Back"
- Production & operations → (a) "Set up push notifications" — "APNs + FCM setup, CometChat dashboard config, client registration, tap-to-deep-link. Required for production." · (b) "Set up production auth" — "Replace the dev Auth Key with a server-minted auth token. Read
cometchat-native-production." · (c) "Set up user management" — "Server endpoints for creating, updating, deleting CometChat users." · (d) "Set up testing" — "Jest + React Native Testing Library setup, mocks for the UI Kit / SDK, E2E with Detox or Maestro." · (e) "← Back" (this category has 4 actions + Back = 5; if your picker is hard-capped at 4, drop "Set up testing" to a follow-up "More…" entry or surface it via free-text — never silently omit it) - Troubleshoot or finish → (a) "Troubleshoot an issue" — "Metro cache, pod install, iOS privacy manifest, push notifications, native module linking." · (b) "I'm done" — "Exit." · (c) "← Back"
Visual Builder option (conditional — only if .cometchat/builder.json exists):
If .cometchat/builder.json is present in the project (the customer picked Visually in Step 3.1), add an extra leaf under the "Customize" category sub-picker (it's a customization action):
- label: "Re-sync visual builder", description: "Re-fetch your latest builder customizations from the dashboard and update the emitted code. Use this after you've gone back to the browser and tweaked colors / features / layout."
When selected:
- Read
.cometchat/builder.jsonto learn the platform. - Surface to customer: "This will re-download the latest Visual Builder template + your current settings, and replace the
src/CometChat/directory entirely. Customer hand-edits inside that directory will be lost (per the SKILLS-AUTO-GENERATED contract). Continue?" viaAskUserQuestion(Continue / Cancel). - On Continue: run
cometchat builder export --platform <p> --force --jsonvia Bash. The--forceflag is required (it explicitly authorizes replacing the existing directory). - Parse the returned JSON. On
status: "exported", surface a brief summary: "Re-synced from builder<builderId>. Latest sync:<settings_file>." - Run
cometchat verify --builder --jsonto confirm the integration is still intact (settings file valid, canonical wrappers present, entry file wired, deps declared). - Re-render the iteration menu.
For theme customization: read the framework-appropriate theming skill and write the customization code.
For adding features: read the framework-appropriate features skill. The canonical public decision-reference for which integration method (UI Kit / UI Kit Builder / Widget Builder / SDK) supports a feature, what dashboard setup it needs, and whether code is required is the Features & Extensions Guide — consult it (WebFetch or docs MCP) for any "can the builder do X? / is feature Y code-or-dashboard?" question; it outranks the local catalog.json snapshot when they disagree. Features fall into eight buckets (matching the catalog type field and apply-feature's dispatch):
- default — already enabled by the UI Kit, no action needed.
- extension — pure boolean toggle. Run
cometchat apply-feature <id>(web/RN withstate.json) orcometchat apply-feature <id> --app-id <X>(native cohorts: iOS / Android / Flutter / Angular). Hits the dashboard API; no browser visit required. - ai-feature —
smart-replies,conversation-summary,conversation-starter. Runcometchat apply-feature <id> --openai-key sk-...(add--app-id <X>for native). The CLI sets the OpenAI key on the app's AI settings, then flips the toggle in one call. - dashboard-only — third-party API keys / multi-field config (Giphy, Stipop, Tenor, Chatwoot, Intercom, Disappearing Messages, Message Shortcuts). The CLI returns
manual-action-requiredand prints the dashboard path — these genuinely need the user to configure third-party credentials. - package-install — calls. Run
npm install @cometchat/calls-sdk-javascript(or the framework's calls SDK). - component-swap —
rich-text-formatting. Runcometchat apply-feature rich-text-formatting. - calls-feature — voice/video calling sub-features (
screen-share,virtual-background,call-recording, etc.).apply-featureverifies the calls SDK is installed + the platform supports it, then records the choice and points at the family'scometchat-*-callsreference; the actual wiring is aCallSettingsBuilderflag in code. ⚠call-recordingis a PAID plan add-on — there is NO dashboard toggle / API call the CLI can flip; the user must contact CometChat support to enable it on their plan. Never claim recording was "enabled." - moderation — profanity/image-moderation/data-masking/etc. Run
cometchat apply-feature <id> --config-json <…>— itPUTs the rule config then enables via the/moderation/rulesRules API (NOT the legacy extensions). Returnsconfig-requiredif no config is supplied.
Ask which feature, look it up in packages/registry/v6/features/catalog.json (or run cometchat features info <id>) to learn its bucket, then execute the right recipe. Never tell the user to "open the dashboard and flip a toggle" for an extension or ai-feature — that's what cometchat apply-feature <id> does for them.
Enable-features on a Visual-Builder (Visually) project — two layers, both required.
apply-featureand the Visual Builder operate on independent backend stores:apply-featuretoggles the dashboard extension (server-side capability —/apps/{appId}/extensions); the builder'schatFeaturestoggle controls whether the feature's UI is shown in the exported builder app (/vcb/builders/{id}). They compose, but they're complementary — for an extension/AI-backed feature on a Visually-customized project you need both: (1)apply-feature <id>for the capability, and (2) the builder's toggle ON so the exported UI actually surfaces it. If the customer enabled an extension viaapply-featurebut the builder app doesn't show it, the builder toggle is OFF → have them flip it in the Visual Builder and re-sync (builder export --force). Because the two stores are independent,apply-feature'd extensions always survive a resync —builder exportnever reads or writes the extensions store. (On the In-code path there's no builder:apply-featureis sufficient because the UI Kit'sdefaultExtensions[]auto-surfaces any enabled extension.)
For component customization: read the customization + components skills, then write the customization code directly. Ask the user what they want to customize, read the relevant component's props from the catalog, propose changes.
For production auth: read the framework-appropriate production skill. It's interactive — ask the user about their auth system and generate the server-side token endpoint for their backend.
For push notifications (RN only): read cometchat-native-push. Structured 12-section walkthrough.
For testing (RN only): read cometchat-native-testing. Ask the user whether they want unit tests (Jest + RNTL), E2E (Detox vs Maestro), or both.
For troubleshooting (RN): read cometchat-native-troubleshooting and match the symptom to a triage table. (Web: option 7 "Run diagnostics" runs cometchat doctor against .cometchat/state.json.)
Re-rendering the menu after each action
After every Phase B action completes, you MUST re-render the menu via your agent's structured-question primitive with the exact same option set (web: 8 options, RN: 10) — same question, header, multiSelect: false, same labels and descriptions, verbatim. This gives the user arrow-key selection in their terminal.
Do NOT:
- Present the options as a prose bullet list — forces typed answers, worse UX.
- Invent new options based on what the user just did. The canonical set doesn't change between iterations.
- Skip the menu and ask freeform "What's next?" — always route through your agent's structured-question primitive.
- Drop options or add new ones. The user expects the same choices every time, even if some are redundant with what they just did (they may want to do the same kind of action twice).
The iteration loop is the whole point of Phase B. Re-rendering the canonical menu via your agent's structured-question primitive after every action is how the user controls the session.
Step 8 — Self-verification before declaring success
This is a process-level audit — distinct from the per-framework build verification in Step 6. Before saying "done", "integration complete", or rendering the iteration menu, run through this checklist mentally. Each item targets a silent-skip failure mode that has bitten real testers in Round 1 (ENG-3571x cluster). Any "no" answer means the skill was misapplied — fix before declaring success.
Why this exists: Round-1 testers reported 8+ incidents where the build succeeded but the agent had silently skipped a load-bearing process step (Step 1.5 "I see you" omitted, Step 3.1 prompt skipped, plan never confirmed, env-var pre-flight bypassed, RN-bare "done" lying without a smoke test). Build-output verification catches compile errors. This checklist catches process-skip errors — which are the ones that ship to customers.
Process checks (must all be YES):
- Step 1.5 "I see you" moment — Did I render 3–5 specific, observation-grounded bullets about the user's project BEFORE asking any question? (Not generic — must cite actual files/deps/router config I read in Step 1.)
- Step 2 credentials confirmed — Did I run
npx @cometchat/skills-cli config show --jsonAFTER Step 2 and verifyappIdis non-empty + the env file exists + contains the framework-appropriate keys? (No silent moves past empty credentials.) - Step 2b.5/2b.6 dashboard prompts — On signup paths, did I render the structured
AskUserQuestionprompts for role, intent, app name, region, industry? (No silent defaults — auto-mode does NOT authorize bypass.) - Step 3.0 product branch — Did I resolve product (chat / calls / both) via auth-me OR natural-language inference OR an explicit
AskUserQuestion? (If both inference paths returned null, the prompt MUST have fired — non-negotiable.) - Step 3.1 customize prompt — On supported platforms (
reactjs,nextjs,react-router,astro,expo,react-native,angular,android,flutter), did I render the Visually-vs-In-code prompt? (Or surface the explicit fallback note for unsupported platforms like Pages Router + Astro?) Common skip-bug: doing 3a + 3c without 3.1 — observed 2026-05-22 on a real Android run. - Step 3d.1 UID confirmation — Did I ask the user which UID to log in as (with the bot-caveat warning), OR did I silently default to
cometchat-uid-1? (ENG-35717 — silent default is the bug.) - Step 3f trust-contract plan — Did I render the three-section plan (Files I'll create / Files I'll modify / Files I won't touch) + dependencies + auth mode + estimated time, and did the user say "go" before any file write?
- Step 5 state.json written — Did I write
.cometchat/state.jsonwithfiles_owned+files_patchedafter the implementation completed? (Required for Step 7 iteration menu to detect prior integration.) - Step 6 verification — Did I run the framework-appropriate build command (
tsc --noEmit/npm run build/flutter analyze/./gradlew :app:assembleDebug/xcodebuild build) and confirm success? - RN-bare smoke (if applicable) — Did I additionally run
pod install+npx react-native run-{ios,android}and confirm Metro bundle reached 100%? (RN-bare "done" lies are the canonical regression — ENG-35718.) - Step 7 iteration menu — Did I re-render the canonical menu via
AskUserQuestion(8 options web / 11 options RN — verbatim labels and descriptions) AFTER the action completed?
Rationalization checks (if any of these crossed my mind, I skipped a rule):
- "The user said 'just do it' / 'I trust you, skip the plan'" → Step 3f plan confirmation is the trust contract; skip it and a regression will silently break their existing surfaces (ENG-35713 location-sharing-wipes-attachments). Always show the plan.
- "Pattern skills are probably loaded, I won't check" → Step 1 pattern-skill-presence check (cometchat-react-patterns etc.) is non-optional; if absent, the agent writes from training memory + emits the bugs the patterns explicitly prevent.
- "The user is in auto-mode / seems impatient, so I'll skip the prompt" → Auto-mode authorizes Bash approvals, NOT structured-question bypasses. Surface every required prompt regardless.
- "I already know this framework, I can skip framework-specific patterns skill" → Pattern skills carry version-pinned traps (e.g. Next.js 15+
dynamic(ssr:false)Client-Component rule, RN doc-picker GuardedResultAsyncTask swap) that don't exist in training data. ALWAYS read the patterns skill before emitting code for that framework. - "I'll write code now and migrate to production-auth later" → Production-auth migration is a SEPARATE iteration-menu action with its own skill (
cometchat-{family}-production). Wire dev mode first, surface the production-upgrade path explicitly, let the user choose when to do it.
If ANY of those rationalizations matches what I was about to do, STOP and apply the skipped rule before continuing.
Hard rules
Always (every framework)
- Ask, don't assume. Every integration decision should be confirmed.
- Always run
detectfirst. Do not assume the framework. - Always use
npx @cometchat/skills-clifor CLI commands. - NEVER replace existing project files unless the user chose demo mode.
- ALWAYS read existing files before modifying them.
- ALWAYS show the plan (Step 3f) and get confirmation before writing.
- Every
<CometChatMessageList>must passhideReplyInThreadOption={true}unless the user has explicitly opted into thread support and you've built the thread screen too. Without it, tapping a message shows a "Reply in Thread" action that leads to a broken (undefined) thread view. - NEVER build a custom search UI. The UI Kit ships
<CometChatSearch>— full dual-scope search across conversations + messages with built-in filter chips, pagination, and result highlighting. Any request involving "search", "find messages", "search conversations" MUST use the built-in component (andshowSearchBar/onSearchBarClickedonCometChatConversationsfor web;hideSearch={false}for RN). Do NOT create custom search bars, hand-rolled result lists, or filter UIs. - Check the kit catalog FIRST — do not invent custom UI when the kit has it. Before writing any custom component, sidebar, back button, header action, user/group details panel, or action sheet, look up the framework's
*-componentsskill and confirm whether the kit already ships that surface. Testers found the agent rebuilding things the kit already provides — custom search bars, custom back buttons, custom user/group details views — leading to inconsistent UX + extra code that then breaks at edge cases. Rule: enumerate kit options, name the one you'll use, then write code. If the kit genuinely doesn't have it, say so explicitly before building custom (ENG-35712). - Preserve existing functionality when adding features. Before adding a new feature (e.g. location-sharing, custom message type), re-list what's already integrated (attachments, polls, message history, composer extensions) and confirm the addition is additive. If the change would remove or override an existing surface, surface that to the user as a warning and get explicit consent. Testers found that adding location-sharing wiped out the attachment menu + polls + visible message history — that's a regression the agent must not introduce silently (ENG-35713).
- Split multi-axis customization prompts into sequenced single-axis ops. When a user prompt bundles multiple changes ("change the receiver bubble color AND show time on the side instead of bottom AND change the sender content view"), don't try to satisfy them all in one edit — testers got the wrong fields swapped (sender vs receiver, whole bubble vs content view). Restate the changes back as a numbered list, confirm, and apply one at a time, verifying each before moving on. Honor the bubble-override / content-view distinction explicitly (ENG-35713).
- Default to file-per-concern, NOT single-file (ENG-35715). Scaffold provider, init, components, and screens as separate files in a
cometchat/(web/Angular/RN) or<package>/cometchat/(Android/Flutter/iOS) folder. ONLY collapse to a single file when the developer explicitly opts in ("just give me one file" / "single-file demo"). The default plan in Step 3f already lists 3-5 files — keep it that way; testers complained that some quick-start paths dumped everything intoApp.tsxand made it impossible to refactor later. When in doubt, ask: "Should I split this into multiple files (provider / init / screens) or keep it in a single file for the demo?" - Auto dark/light theme is the default, NOT a follow-up prompt (ENG-35715). Every kit ships a theme system that switches by OS color scheme — the React kit's
<CometChatThemeProvider>, the RN kit'suseColorScheme()-driven theme, Android'sCometChatTheme.DayNightparent style, Flutter'sCometChatThemeMode.system, iOS'straitCollection.userInterfaceStyle. The scaffold MUST wire this on the first pass without asking. If the developer explicitly says "light mode only" or "dark mode only," then pin; otherwise honor the OS. Testers found that the agent only applied one theme until they manually asked for dark mode — fix that by defaulting to system. - Provider exposes a
telemetrycallback prop for init/login lifecycle (ENG-35715). When generating any provider (CometChatProvider.tsx/CometChatModule.ts/ AndroidCometChatInitProvider.kt/ FlutterCometChatBootstrap), accept an optionaltelemetry?: (event: TelemetryEvent) => voidprop and fire it at four phases:init_started,init_finished,login_started,login_finished— plusinit_failed/login_failedwith the error payload. Developers want this for their own analytics; without the hook they have to monkey-patch the kit or wrap every method. The hook is opt-in (do nothing if not passed) so it doesn't bloat the happy path. - Confirm
appId+region+authKeyare populated BEFORE Step 5 code emission (ENG-35718). Two testers shipped code with emptyimport.meta.env.VITE_COMETCHAT_APP_IDvalues because the agent moved on without confirming the env file was actually written. Pre-flight check after Step 2 / before Step 4 — runnpx @cometchat/skills-cli config show --json, verifyappIdis non-empty AND the env file referenced exists AND the file contains the three keys. For Angular/Android/Flutter/iOS this pre-flight checks the handoff.envthatprovision setupwrites — NOT the platform-native file (environment.ts/local.properties/ Dart const /Secrets.swift), because the migration into that native file happens later in Step 5. Verify the native runtime file has the values as a separate, post-migration check at the end of Step 5 (a re-run of this gate after migration is fine — it then accepts the native file). If any check fails, STOP and prompt: "Your credentials aren't in<envFile>yet. Paste them now or runauth loginto fetch them, then I'll continue." Do NOT proceed silently. - Pull dashboard feature state BEFORE recommending what to enable (ENG-35716). Before suggesting "do you want to turn on reactions / polls / message-translation / AI-replies", run
npx @cometchat/skills-cli features list --json(orfeatures get --json --feature <name>for one), parse the response, and lead with what's already enabled vs disabled in the user's dashboard. Two testers complained: the agent claimed features were "not implemented" and asked them to enable manually, while their dashboard had them on already. Rule: read dashboard state first, recommend deltas (turn ON the ones the user wants that are currently OFF), and TELL the user what's already on so they don't waste a round-trip enabling something live. - Auto-resolve credentials from
auth me/provision listwhen the user is already logged in (ENG-35716). Ifauth status --jsonreturns"logged-in"AND the env file is missing or empty, runprovision list --jsonto see if the user has an existing app on the dashboard. If exactly one, suggest using it: "You're already logged in and your dashboard has the app<app.name>(region<app.region>). Use those credentials? [Y/n]" — thenprovision setup --app-id <id> --jsonwrites the env file. The user shouldn't have to copy-paste credentials they already have in their account. - RN-bare integrations require a smoke-test before declaring success (ENG-35718). "Done" lying on RN bare is the canonical "app didn't even run once" failure. After the last file write, the dispatcher MUST attempt: (a)
cd ios && pod install && cd ..(iOS), (b)npx react-native run-ios --no-packagerORnpx react-native run-android(whichever the user wants first), (c) tail the Metro output for "BUNDLE → 100%" and the first frame render in the simulator/emulator. If pods install fails or Metro errors mid-bundle, surface the raw error and DON'T declare success. Bare RN is the family with the most "looks done but broken" failures because there are 8+ moving parts (Cocoapods, Hermes, autolinking, gesture-handler, reanimated, async-storage native modules, Metro cache). One smoke is worth the 2-minute wait. - Fuzzy-match free-form answers before rejecting them (ENG-35724). When the user types a value that isn't in the structured-prompt enum — e.g. "chatting" for the industry picker, "shop" for marketplace, "video meet" for voice-video — DO NOT bounce them back to the picker. Map to the closest enum value, restate it back, and confirm: "By 'chatting' I think you mean Community & Social — does that match? [Y/n]". One round-trip saved per prompt. Use the structured form's
options[].label+options[].descriptionas the match corpus; cosine-similarity on the lowercase tokens or a simple substring + synonym table is enough — the agent can do this in-line without an external tool. If similarity is below a confidence threshold (say, < 0.4), then ask the user to pick from the list — but explain the rejection: "I couldn't tell which of these fits — could you pick one?". - Emitted code must be lint-clean for the project's lint config (ENG-35724). Every
.ts/.tsx/.kt/.swift/.dartthe agent writes should pass the user's existingeslint/tsc --noEmit/ktlint/swiftlint/dart analyzewith zero new warnings or info-level issues. Before declaring success, run the project's lint command (readpackage.json'sscripts.lintor use sane defaults:npx eslint .for JS,flutter analyzefor Flutter, etc.). If new warnings appear from kit imports the user can't suppress, document them in a one-line// eslint-disable-next-line <rule>comment with a reason — DON'T leave noise that the user has to clean up. Testers complained that every scaffold introduced 5–15 info-level lints that pile up if multiple features are added in sequence. - For component names and props, use the framework-appropriate
*-componentsskill or docs MCP — never invent from training data. - After writing code, record state in
.cometchat/state.json(Step 5 step 11) so the iteration menu can detect the integration in a future session. Timing: record AFTER the RN-bare smoke-test passes (when one is required by the rule above); for all other frameworks, record immediately after the final file write. If the smoke-test fails, do NOT write state.json yet — fix the failure first, then record once the build succeeds. - NEVER explicitly load CometChat skills via your agent's skill-loading mechanism. They're already in your context as
.claude/skills/,.cursor/skills/,.kiro/skills/, or.agents/skills/files. Just read and follow them directly.
Web only
- CSS import goes once at the root level per framework conventions. The framework skill (cometchat-{react,nextjs,react-router,astro}-patterns) tells you exactly where.
- For drawer / widget animations, animate
right/left, NEVERtransform/translate-*. Atransformon a CometChat-containing element creates a new containing block that re-anchors absolutely-positioned overlays (emoji picker, action sheet, reactions, thread panel) to the transformed element instead of the viewport. Tailwind utilitiestranslate-x-*,-translate-x-*,scale-*,rotate-*,transform-*are also banned for this reason. Seecometchat-placement§ 10.
React Native only
import "react-native-gesture-handler"must be line 1 of the entry file. Not line 2. Not after another import. This is non-negotiable.- All four wrappers are required, in this order:
GestureHandlerRootView → SafeAreaProvider → CometChatThemeProvider → CometChatProvider. Omitting any of them breaks gestures, safe areas, theming, or login state — and it fails silently in dev. - Login API is
CometChatUIKit.login({ uid })orCometChatUIKit.login({ authToken })— same method, different object key. There is nologinWithAuthToken. Passing a bare string likelogin("cometchat-uid-1")silently fails on RN.
Angular only
CUSTOM_ELEMENTS_SCHEMAis required in any NgModule that hosts CometChat components. Kit atom elements (<cometchat-avatar>,<cometchat-status-indicator>,<cometchat-badge>, etc.) are LitElement web components, not Angular standalone modules — without the schema Angular throwsCan't bind to '...'. The schema goes in the module'sschemas: [CUSTOM_ELEMENTS_SCHEMA]array, not inimports.- Credentials live in
src/environments/environment.ts, NOT.env. Angular bundlesenvironment.tsat compile time; there is no runtime.envlookup. The CLI'sprovision setup --framework angularwrites a.envonly as a credentials handoff — migrate the values intoenvironment.ts(andenvironment.prod.tsminus theauthKey) during integration. - Init runs through
APP_INITIALIZER, not a wrapper component. Angular has no React-style provider tree —CometChatUIKit.init(settings)must complete before any chat component renders. Wire it as{ provide: APP_INITIALIZER, useFactory, deps: [...], multi: true }in the root module. - Login API is
CometChatUIKit.login({ uid })(object form), NOT a bare string. Same shape as the React Native UI Kit. CallingCometChatUIKit.login("cometchat-uid-1")silently fails on Angular too — always pass the credentials object:login({ uid })for dev,login({ authToken })for production. - Angular v5 kit has TWO event-binding patterns (corrected 2026-06-02 — was wrong in v4 era). New-style event names (no
on*prefix) are@Output()— bind with round brackets:(itemClick)="handler($event)",(closeClick),(sendButtonClick),(threadRepliesClick),(textChange),(backClick),(conversationClick), etc. Legacyon*-prefix names that still exist as@Input()callbacks are:onAccept,onDecline,onVoiceCallClick,onVideoCallClick,onError,onSuccess— bind with square brackets:[onError]="handlerFn". Names likeonItemClick,onSendButtonClick,onThreadRepliesClick,onTextChange,onCloseClickeddo not exist at all in v5 — use the round-bracket Output form above. Seecometchat-angular-components§"Binding conventions" for the full mapping. [messagesRequestBuilder]is plural.[messageRequestBuilder](singular) on<cometchat-message-list>silently no-ops — the input doesn't exist.auxiliaryButtonViewis correctly spelled (two i's) — corrected 2026-06-02. Earlier versions of this rule said to "match a kit typoauxilaryButtonView" — that was wrong. The kit (cometchat-message-composer.component.ts) uses the correctly-spelledauxiliaryButtonViewand earlierauxilary-typo claims were the source of confusion, not the kit.CometChatThemeServiceis the v4 theme entry point, NOT the legacy v3CometChatThemeclass. Inject the service; accessthemeService.themefor palette/typography control.
Android only
- Never mix V5 and V6 artifacts.
chat-uikit-android:5.xandchatuikit-{compose,kotlin}-android:6.xare different SDKs with different package paths, theme systems, and APIs. The dispatcher routes byandroid_version; treat the cohort as a hard switch. - V5 app theme must inherit from
CometChatTheme.DayNight— the kit itself parents onTheme.MaterialComponents.DayNight.NoActionBar(Material 2). UsingTheme.AppCompat.*orTheme.Material3.*triggersUnsupportedOperationException: Failed to resolve attributeat inflate time. V6 has no equivalent rule — Compose usesCometChatTheme { … }, Kotlin Views uses kit-defined style attrs. - Init in
Application.onCreate(), not in an Activity.CometChatUIKit.init(context, settings, callback)must complete before any chat View / Composable inflates. Wirelogin(...)inside the init success callback. The<application android:name=".MyApp">registration inAndroidManifest.xmlis non-negotiable. - Credentials live in
local.properties+BuildConfig, NOT.env. Android has no runtime.envlookup; surface secrets viabuildConfigFieldand readBuildConfig.COMETCHAT_APP_IDetc. in code. The CLI'sprovision setup --framework androidwrites a.envonly as a credentials handoff — migrate during integration. INTERNETpermission is mandatory. Without it, the SDK silently fails to connect — no error, no symptom except missing data.- V5 thread-mode method asymmetry.
CometChatMessageListusessetParentMessage(long)(noIdsuffix).CometChatMessageComposerusessetParentMessageId(long). Different methods on different classes — the same value, two names. Never usesetParentMessageIdon the list. - V5 extensions: registrar vs decorator.
setExtensions(...)accepts registrars (PollsExtension,StickerExtension,SmartRepliesExtension— extendingExtensionsDataSource). NEVER add*ExtensionDecoratorinstances directly — they extendDataSourceDecoratorand won't compile in aList<ExtensionsDataSource>. The decorator chain is built by the registrar'senable()method internally. - V6 Kotlin Views —
setOnItemClick, NOTsetOnItemClickListener. The kit doesn't expose*Listener-suffixed setters; use the bare callback name. Same for other V6 setters — check the actual View class before guessing. - V6 reaction list takes
baseMessage, notmessage.CometChatReactionList(baseMessage = ...)(Compose) orreactionList.setBaseMessage(...)(Kotlin Views). The baremessageparam/setter doesn't exist in V6. - Push notifications:
CometChatNotifications.registerPushToken/unregisterPushTokenis the only public surface. Sample-app helpers likeCometChatVoIP,FCMService,FCMMessageDTOare NOT exported fromchatuikit-*artifacts — they live in the master sample apps. Copy the pattern; don't import them as kit classes. - R8/ProGuard rule for release. Add
-keep class com.cometchat.** { *; }toproguard-rules.pro. Without it, release builds strip kit classes and crash withClassNotFoundException.
Flutter only
- Never mix V5 and V6 packages.
cometchat_chat_uikit:^5.2(V5, GetX-based, calls in a separatecometchat_calls_uikit:^5.0package) andcometchat_chat_uikit: ^6.0(V6, Bloc-based, calls bundled in) are different SDKs with different state-management primitives, theme APIs, and barrel exports. The skills target one cohort each — pick V6 for new projects, V5 for legacy projects, never both in the same app. - V5 has TWO barrels; V6 has ONE. V5 chat widgets (
CometChatConversations,CometChatMessageList,CometChatMessageComposer) are reachable ONLY throughpackage:cometchat_chat_uikit/cometchat_chat_uikit.dart. The calls package barrel re-exportscometchat_uikit_shared+cometchat_sdk+cometchat_calls_sdkbut NOTcometchat_chat_uikit— using only the calls import will fail to resolve chat widgets. V6 ships a single package, so the chat barrel covers both chat AND calls. subscriptionTypeis required onUIKitSettingsBuilder. Omitting it silently disables presence and typing-indicator events — no error is thrown, just no presence updates. Always set..subscriptionType = CometChatSubscriptionType.allUsers(or..forFriends/..forRoles).CometChatUIKit.login(uid)takes a String, not an object. Both V5 and V6 use the bare-string form for dev login. For production:CometChatUIKit.loginWithAuthToken(token, ...).- Cache theme values in
didChangeDependencies(), notbuild().CometChatThemeHelper.getColorPalette(context)allocates and resolves tokens on every call — running it inbuild()causes jank during keyboard animations and theme changes. - Listener IDs must be unique + removed in
dispose(). Hardcoded listener IDs collide across screens; missingdispose()removal leaks listeners across navigations. Use a per-instance ID and remove it on teardown. - Credentials live in a Dart const file or
--dart-define, NOT.env. Flutter doesn't read.envat runtime; the CLI'sprovision setup --framework flutterwrites a.envonly as a credentials handoff — migrate during Step 5. ComponentTogglesandCallScreenOverlaydo not exist in V6. Per-widget feature flags (e.g.disableReactions,hideReplyInThreadOption) replace v5'sBuilderSettings. In-call UI isCometChatOngoingCallwidget +CometChatDisplayIncomingCallOverlay, not an overlay class with.show().- AI widget availability varies across V6 versions. Some AI widgets (
CometChatAIAssistantChatHistory,CometChatAIConversationSummary) are exported in 6.0.1 (the GA cut); others were added in later patches or are still rolling out. If an import errors with "undefined name", the symbol isn't in that version. Drive AI features via dashboard-enabled extensions for the most stable path — the kit surfaces AI replies/summaries inside the existing message list and composer regardless. - V6 conversations slot signatures are asymmetric.
subtitleView/leadingView/titleViewtake(BuildContext, Conversation)(two-arg).trailingViewandlistItemViewtake just(Conversation)(single-arg). Match the source — guessing one shape across all four breaks template type-checking. Seecometchat-flutter-v6-conversationsfor the example. PNRegistryis sample-app code, not a kit API. The kit's only public push surface isCometChatNotifications.registerPushToken(token, providerId, platform)andunregisterPushToken(). Use the kit API directly, or copy the sample-appPNRegistryhelper into your project.
iOS only
- No
CometChatMessages/CometChatConversationsWithMessages/CometChatDetailsexist. These look like "pre-built composite UIViewControllers" but the kit doesn't ship them. Build your ownMessagesVCby composingCometChatMessageHeader+CometChatMessageList+CometChatMessageComposer(sample app:SampleApp/View Controllers/CometChat Components/MessagesVC.swift). Same for details — compose your own. - Init completion uses Swift's standard
Result<Bool, Error>(case .success/case .failure), NOT the kit's.success/.onErrorenum that only appears in login/logout callbacks. TheCometChatUIKit(uiKitSettings:)andCometChatUIKit.init(uiKitSettings:)forms are identical in Swift; both compile and the kit's sample apps use the explicit.initform. - Login result switches on
.success/.onError— NOT Swift's.failure. The kit ships its ownResult-shaped enum for login callbacks. Add@unknown default: breakto silence the compiler warning. - App theme parent is irrelevant on iOS — but pod-side: Xcode 15+ requires
ENABLE_USER_SCRIPT_SANDBOXING = NOin Build Settings (or thepost_installPodfile hook). Without it, the resource-bundle build phase silently fails and assets/strings load empty at runtime. pod 'CometChatUIKitSwift', '~> 5.1', NOT~> 5.0— the binary target ships at 5.1.x (5.1.12 at last verification); the older pin would resolve to a stale subrelease.CometChatLocalize.set(key:value:)does not exist. Public API is locale-only:set(locale: Language)/set(locale: String). Override individual keys via your app'sLocalizable.stringsinstead.- iOS font override uses
overrideFont(family:)on theTypographystruct (corrected 2026-06-02). Verified atcometchat-uikit-ios-v5/CometChatUIKitSwift/Components/Shared/Helpers/CometChatTheme/Typography.swift:108: the actual API ismutating func overrideFont(family: CometChatFontFamily)on theTypographystruct value — NOTCometChatTypography.setFont(name:)as earlier versions of this rule claimed. To customize fonts: instantiate aCometChatFontFamily(with regular/medium/semibold/bold faces) then callmyTypography.overrideFont(family: customFamily).CometChatTypography.fontFamily = "Avenir"does not compile either way. CometChatGroupMembers()takes zero args; pass the group viaset(group:). There is noCometChatGroupMembers(group:)initializer.CometChatCallButtons(width:height:)requires explicit dimensions; there is no zero-arg initializer.CometChatThreadHeaderdoes NOT exist — the real class isCometChatThreadedMessageHeader.- Avatar
cornerRadiusis aCGFloaton aCometChatCornerStylestruct — there is no.circleenum case. For a circular avatar, set a value larger than half the dimension. hideSearchdefaults totrueonCometChatUsers/CometChatGroups/CometChatConversations(inherited fromCometChatListBase). To SHOW the built-in search bar, setvc.hideSearch = false— the search bar is hidden out of the box, which catches developers expecting it to render automatically.- Open the
.xcworkspace, not the.xcodeproj, when CocoaPods is in use. Opening the bare project skips thePodsworkspace and Build Settings will show "no such module 'CometChatUIKitSwift'" at compile time.
Error handling
If the CLI's --json output includes human_message / suggestion fields, show those to the user. Then show the raw error in parentheses for debuggability. If retryable: false, do NOT offer a retry.
For RN: if a command errors (e.g., pod install fails, npx expo install fails), surface the raw error output and consult cometchat-native-troubleshooting for the relevant triage table before retrying. Don't loop silently.
If the user's project is bare RN with ios/ and android/ but no package.json scripts for ios/android (common when React Native was added incrementally to an existing native app), flag that and pause. Writing integration code won't help if the app can't build.
Optional: docs MCP
For deeper component customization:
claude mcp add --transport http cometchat-docs https://www.cometchat.com/docs/mcp
Not required for integration or Phase B CLI flows.
Skill routing reference
Web family
| Skill | When to load |
|---|---|
cometchat-core | Always — before any integration code |
cometchat-components | Always — before writing component code |
cometchat-placement | When integrating — for placement patterns |
cometchat-react-patterns | framework = reactjs |
cometchat-nextjs-patterns | framework = nextjs |
cometchat-react-router-patterns | framework = react-router |
cometchat-astro-patterns | framework = astro |
cometchat-theming | When customizing themes |
cometchat-features | When adding features |
cometchat-customization | When writing custom formatters, events, request-builder filters |
cometchat-production | When setting up production auth |
cometchat-troubleshooting | When diagnosing problems |
React Native family
| Skill | When to load |
|---|---|
cometchat-native-core | Always — before any integration code |
cometchat-native-components | Always — before writing component code |
cometchat-native-placement | When integrating — for placement patterns |
cometchat-native-expo-patterns | framework = expo (managed + Expo Router) |
cometchat-native-bare-patterns | framework = react-native (bare CLI) |
cometchat-native-theming | When customizing themes |
cometchat-native-features | When adding features |
cometchat-native-customization | When writing custom text formatters, events, request-builder filters, or DataSource decorators |
cometchat-native-production | When setting up production auth or user management |
cometchat-native-push | When setting up push notifications |
cometchat-native-testing | When adding tests |
cometchat-native-troubleshooting | When diagnosing problems |
Angular family
| Skill | When to load |
|---|---|
cometchat-angular-core | Always — before any integration code |
cometchat-angular-components | Always — before writing component code |
cometchat-angular-placement | When integrating — for placement patterns (route, modal, drawer, embed) |
cometchat-angular-patterns | framework = angular — module organization, lazy loading, environment files |
cometchat-angular-theming | When customizing themes (CometChatThemeService) |
cometchat-angular-features | When adding features (calls, polls, reactions, AI, extensions) |
cometchat-angular-customization | When writing custom views via content projection, <ng-template> slots, DataSource decorators |
cometchat-angular-production | When setting up production auth (server-minted auth tokens) or user management |
cometchat-angular-troubleshooting | When diagnosing problems (build errors, schema errors, Zone.js issues) |
Android V5 family (live — chat-uikit-android:5.x)
| Skill | When to load |
|---|---|
cometchat-android-v5 | Dispatcher entry — android_version === "v5" |
cometchat-android-v5-core | Always — Gradle deps, UIKitSettings.UIKitSettingsBuilder, init/login, theme parent |
cometchat-android-v5-components | Always — View class catalog (CometChatConversations, CometChatMessageList, …) |
cometchat-android-v5-placement | When integrating — Activity / Fragment / BottomSheet placement |
cometchat-android-v5-theming | When customizing themes — colors.xml, theme attrs, dark mode |
cometchat-android-v5-features | When adding features — calls, reactions, polls, AI, extensions |
cometchat-android-v5-customization | When writing custom Views, message templates, CometChatTextFormatter, event listeners |
cometchat-android-v5-extensions | When working with extensions (PollsExtension / StickerExtension registrars + custom decorator pattern) |
cometchat-android-v5-production | When setting up production auth (server-minted auth tokens) or user management |
cometchat-android-v5-push | When setting up push notifications (FCM, token lifecycle, deep-link) |
cometchat-android-v5-testing | When adding tests (Espresso, Robolectric, mocking the kit/SDK) |
cometchat-android-v5-troubleshooting | When diagnosing problems (Gradle, manifest, ProGuard, lifecycle) |
Android V6 family (stable, GA 2026-05-25 — chatuikit-{compose,kotlin}-android:6.x)
| Skill | When to load |
|---|---|
cometchat-android-v6 | Dispatcher entry — android_version === "v6" |
cometchat-android-v6-core | Always — Gradle deps, init, login, message sending |
cometchat-android-v6-events | Always — CometChatEvents SharedFlows + sealed event classes |
cometchat-android-v6-builder-settings | When configuring UIKitSettingsBuilder (calling, presence, etc.) |
cometchat-android-v6-features | When adding features — calls, reactions, polls, AI agent, extensions |
cometchat-android-v6-extensions | When working with extensions / DataSource interfaces |
cometchat-android-v6-production | When setting up production auth or user management |
cometchat-android-v6-push | When setting up push notifications |
cometchat-android-v6-testing | When adding tests (Espresso, Compose UI tests, Robolectric, mocking) |
cometchat-android-v6-troubleshooting | When diagnosing problems (Gradle, Compose runtime, R8, BuildConfig) |
cometchat-android-v6-compose-components | UI stack = Compose — Composable component catalog |
cometchat-android-v6-compose-placement | UI stack = Compose — NavHost, modal, bottom sheet placement |
cometchat-android-v6-compose-theming | UI stack = Compose — CometChatTheme { … }, LocalColorScheme/LocalTypography |
cometchat-android-v6-compose-customization | UI stack = Compose — BubbleFactory, slot lambdas, custom Composables |
cometchat-android-v6-kotlin-components | UI stack = Kotlin Views — custom View class catalog |
cometchat-android-v6-kotlin-placement | UI stack = Kotlin Views — Activity / Fragment / BottomSheet placement |
cometchat-android-v6-kotlin-theming | UI stack = Kotlin Views — style attrs, colors.xml, dark mode |
cometchat-android-v6-kotlin-customization | UI stack = Kotlin Views — custom Views, BubbleFactory abstract class, setBubbleFactories |
Flutter V5 family (live — cometchat_chat_uikit:^5.2)
| Skill | When to load |
|---|---|
cometchat-flutter-v5 | Dispatcher entry — flutter_version === "v5" |
cometchat-flutter-v5-core | Always — pubspec deps, init/login, GetX patterns, theme caching, listener lifecycle |
cometchat-flutter-v5-conversations | When integrating — CometChatConversations widget |
cometchat-flutter-v5-messages | When integrating — CometChatMessages, CometChatMessageList, CometChatMessageComposer, CometChatMessageHeader, threads |
cometchat-flutter-v5-users-groups | When integrating — CometChatUsers, CometChatGroups, CometChatGroupMembers |
cometchat-flutter-v5-calls | When adding voice/video — CometChatCallButtons, CometChatIncomingCall, CometChatOutgoingCall, CometChatOngoingCall, CometChatCallLogs |
cometchat-flutter-v5-theming | When customizing themes — CometChatThemeHelper, CometChatColorPalette, dark mode |
cometchat-flutter-v5-customization | When writing custom bubbles, templates, formatters, slot views, DataSource decorators |
cometchat-flutter-v5-events | When subscribing to SDK events (CometChatMessageEvents, etc.) |
cometchat-flutter-v5-production | When setting up production auth (server-minted tokens) and ProGuard |
cometchat-flutter-v5-push | When setting up FCM / APNs / VoIP push |
cometchat-flutter-v5-troubleshooting | When diagnosing problems (pubspec, GetX, Pod errors, runtime crashes) |
Flutter V6 family (stable, GA 2026-05-25 — cometchat_chat_uikit: ^6.0)
| Skill | When to load |
|---|---|
cometchat-flutter-v6 | Dispatcher entry — flutter_version === "v6" |
cometchat-flutter-v6-core | Always — pubspec deps, init/login, message sending |
cometchat-flutter-v6-components | Always — Bloc-driven widget catalog |
cometchat-flutter-v6-conversations | When integrating CometChatConversations (Bloc, request builder, callbacks) |
cometchat-flutter-v6-messages | When integrating CometChatMessages, list/header/composer composition |
cometchat-flutter-v6-users-groups | When integrating CometChatUsers/CometChatGroups/CometChatGroupMembers |
cometchat-flutter-v6-calls | When adding voice/video — incoming/outgoing/ongoing screens |
cometchat-flutter-v6-features | When adding features — calls, polls, reactions, AI, extensions |
cometchat-flutter-v6-placement | When deciding placement — route, modal sheet, embedded widget |
cometchat-flutter-v6-theming | When customizing themes — CometChatThemeHelper, CometChatColorPalette, light/dark schemes |
cometchat-flutter-v6-customization | When writing bubble factories, message templates, text formatters, slot widgets |
cometchat-flutter-v6-events | When subscribing to Bloc-based event streams |
cometchat-flutter-v6-production | When setting up production auth and external-backend recipes |
cometchat-flutter-v6-troubleshooting | When diagnosing problems (pubspec, Bloc, theme cache, build errors) |
cometchat-flutter-v6-migration | When migrating from V5 — GetX → Bloc, theme API rewrite, breaking changes |
iOS family (V5 stable — CometChatUIKitSwift:~> 5.1)
iOS only ships V5 today; no V6 beta yet. When V6 lands, this section will fork like Android and Flutter do.
| Skill | When to load |
|---|---|
cometchat-ios | Dispatcher entry — framework === "ios" |
cometchat-ios-core | Always — Installation (CocoaPods + SPM), UIKitSettings builder, CometChatUIKit(uiKitSettings:) constructor init, login order |
cometchat-ios-components | Always — UIViewController + SwiftUI view catalog, custom MessagesVC composition pattern |
cometchat-ios-placement | When integrating — UINavigationController, modal, tab bar, embedded view, SwiftUI hosting |
cometchat-ios-theming | When customizing themes — CometChatTheme color tokens, CometChatTypography.setFont(name:), dark mode |
cometchat-ios-customization | When writing custom message templates, formatters, DataSource decorators, custom views |
cometchat-ios-features | When adding features — calls, polls, reactions, AI, extensions |
cometchat-ios-production | When setting up production auth (server-minted auth tokens) and user management |
cometchat-ios-push | When setting up APNs + VoIP push, CallKit |
cometchat-ios-troubleshooting | When diagnosing problems — SPM/CocoaPods errors, Xcode build issues, Info.plist, runtime crashes |