@cometchat/skills-cli 2.4.1 → 3.0.0

package/README.md

@@ -1,65 +1,73 @@
 # @cometchat/skills-cli
 
-> CLI for the CometChat Skills v2 architecture. Detect, view, apply, verify, and manage CometChat React UI Kit integrations from the command line.
+> CLI for CometChat dashboard authentication + app-credential provisioning.
 
 ```bash
-npx @cometchat/skills-cli@latest detect
+npx @cometchat/skills-cli@latest auth login
 ```
 
 ## Why this exists
 
-CometChat Skills v1 was 5500+ lines of agent-readable Markdown that walked AI assistants through React UI Kit integrations. v2 moves the logic into this CLI, leaving the skill files as ~30-line glue that just calls these commands. Result: 92% smaller skills, deterministic behavior, idempotent re-runs, transactional file writes, and shared logic across every supported AI agent.
+This CLI is a **pure dashboard/API client**. Its only job is authenticating
+against the CometChat dashboard and fetching your app credentials (App ID /
+Region / Auth Key). It knows nothing about UI Kit, React, frameworks, or
+codegen — the CometChat **skills** own framework detection, env-file writing,
+and all code generation. The CLI just gets you authenticated and hands the
+skills a neutral `.cometchat/config.json` to build on.
+
+> **3.0.0 is a breaking re-architecture.** Earlier versions (≤2.x) also did
+> framework detection, integration codegen, and `.env` writing. All of that
+> moved into the skills. Only `auth`, `provision`, and `config` remain.
 
 ## Commands
 
 | Command | Purpose |
 |---|---|
-| `cometchat detect [path]` | Fingerprint a project: framework, version, router, env prefix, credentials, existing integration |
-| `cometchat experiences` | List the 3 chat experiences and their metadata |
-| `cometchat view --experience N --framework F` | Pure dry-run preview of `apply` |
-| `cometchat apply --experience N --framework F` | Perform the integration. Transactional. Idempotent. |
-| `cometchat install` | Install the deps the integration needs (auto-detects pnpm/npm/yarn/bun) |
-| `cometchat verify` | Run AST checks: css imports, init order, no auth key in source, error UI |
-| `cometchat info` | Drift detection via SHA-256 checksums |
-| `cometchat uninstall [--force]` | Remove only the files this integration owns |
+| `cometchat auth <login\|logout\|status\|signup>` | Dashboard device-auth. Opens your browser at the CometChat dashboard and stores the bearer token in the OS keychain (falling back to a chmod-600 file). |
+| `cometchat provision <run\|list\|create\|use>` | Dashboard app operations. Fetches App ID / Region / Auth Key, prints them as JSON, and writes a neutral `.cometchat/config.json`. Writes **no** framework env file. |
+| `cometchat config <init\|get\|set\|show\|path>` | Manage `.cometchat/config.json` — credential/app state only (appId, region, authKey + app metadata). |
 
 All commands accept `--json` for machine-readable output.
 
 ## Quick start
 
 ```bash
-# 1. Auto-detect your project
-npx @cometchat/skills-cli@latest detect --json
+# 1. Authenticate against the dashboard (opens your browser)
+npx @cometchat/skills-cli@latest auth login
 
-# 2. Preview the integration without writing anything
-npx @cometchat/skills-cli@latest view --experience 1 --framework reactjs
+# 2. List the apps on your account
+npx @cometchat/skills-cli@latest provision list --json
 
-# 3. Apply + auto-install in one command
-npx @cometchat/skills-cli@latest apply --experience 1 --framework reactjs --auto-install
+# 3. End-to-end: pick/create an app, fetch creds, write .cometchat/config.json
+npx @cometchat/skills-cli@latest provision run --json
 
-# 4. Verify the integration
-npx @cometchat/skills-cli@latest verify
+# …or select a specific app by id
+npx @cometchat/skills-cli@latest provision use --app-id <id> --json
 
-# 5. Check status anytime
-npx @cometchat/skills-cli@latest info
+# 4. Inspect the local config the skills read
+npx @cometchat/skills-cli@latest config show --json
 ```
 
-## Frameworks supported
-
-- React.js (Vite or CRA)
-- Next.js (App Router or Pages Router, 13/14/15/16)
-- React Router (v6 library mode + v7 framework mode)
-- Astro (React islands with `client:only="react"`)
-
-Each framework × experience (1-3) ships with a registry template at [@cometchat/skills-registry](https://www.npmjs.com/package/@cometchat/skills-registry).
-
-## Safety guarantees
+## What `provision` writes
+
+`provision` writes **only** `.cometchat/config.json`, a neutral credential/app
+record:
+
+```json
+{
+  "version": 1,
+  "appId": "…",
+  "region": "us",
+  "authKey": "…",
+  "appName": "My Chat",
+  "plan": "…",
+  "industry": "…"
+}
+```
 
-- **Transactional writes** — apply either succeeds completely or rolls back. No partial integrations.
-- **Refuse-to-overwrite** — apply will not silently replace files that contain user code. Pass `--force-overwrite` to override.
-- **Idempotency** — re-running apply with the same arguments is a safe no-op.
-- **Drift detection** — `info` re-checksums every owned file and reports user edits.
-- **Clean uninstall** — `uninstall` only removes files in `.cometchat/state.json`'s `files_owned` list.
+It does **not** write any framework env file (`.env` / `VITE_` /
+`NEXT_PUBLIC_` / …) and takes **no** `--framework` flag. The skill reads
+`config.json` and writes the framework-specific env itself.
 
 ## License
 
@@ -67,4 +75,4 @@ MIT — © CometChat
 
 ## Repository
 
-Source + tests + roadmap live at <https://github.com/cometchat-team/cometchat-skills>
+Source + tests live at <https://github.com/cometchat/cometchat-skills>