feat: Update Cli, MCP

Author: Deathgiver

apps/cli/README.md

@@ -2,229 +2,253 @@
 
 CLI for interacting with the ChatbotX API.
 
-## 1. Set API Configuration (Required)
+Commands are automatically generated from the ChatbotX public API spec — no manual update needed when new APIs are added.
 
-Before running other commands, save your API key:
+---
+
+## Installation
 
 ```bash
-chatbotx config set --apiKey <yourApiKey>
+npm install -g chatbotx-cli
+# or
+pnpm add -g chatbotx-cli
 ```
 
-You can also save a custom API URL:
+---
 
-```bash
-chatbotx config set --apiUrl https://cloud.chatbotx.io
-```
+## Setup
+
+### 1. Set API Configuration
 
-Save both API key and API URL in one command:
+Before running any command, save your API key and URL:
 
 ```bash
 chatbotx config set --apiKey <yourApiKey> --apiUrl <yourApiUrl>
 ```
 
-If you are in local/dev environment with a self-signed certificate, you can temporarily disable TLS certificate validation:
+- `--apiKey` — Workspace API key (found in ChatbotX Settings → Developer → API Keys)
+- `--apiUrl` — Base API URL of your instance, e.g. `https://app.chatbotx.io/api`
+
+You can also set them individually:
 
 ```bash
-chatbotx config set --allowSelfSignedCert true
+chatbotx config set --apiKey <yourApiKey>
+chatbotx config set --apiUrl https://app.chatbotx.io/api
 ```
 
-You can also set it per-run using environment variable:
+Or via environment variables:
 
 ```bash
-CHATBOTX_ALLOW_SELF_SIGNED_CERT=true chatbotx tags list
+export CHATBOTX_API_KEY=your_api_key
+export CHATBOTX_API_URL=https://app.chatbotx.io/api
 ```
 
-Preferred (more secure) approach is to trust your CA certificate:
+For local dev with a self-signed certificate:
 
 ```bash
-NODE_EXTRA_CA_CERTS=/path/to/ca.pem chatbotx tags list
+chatbotx config set --allowSelfSignedCert true
+# or
+export CHATBOTX_ALLOW_SELF_SIGNED_CERT=true
 ```
 
-Notes:
+### 2. Global Options
 
-- The CLI supports the global option `--apiUrl` if you want to override the stored base URL for a single run.
-- The default base URL is `https://cloud.chatbotx.io`.
+Available on every command:
 
-## 2. Commands: `tags`
+| Option | Description |
+|---|---|
+| `--apiKey` | Override API key for this run |
+| `--apiUrl` | Override API URL for this run |
+| `--allowSelfSignedCert` | Disable TLS cert validation |
+| `--refresh-spec` | Force re-fetch the OpenAPI spec (clears cache) |
 
-### List all tags
+---
 
-```bash
-chatbotx tags list
-```
+## Commands
 
-### Create a new tag
+### `config`
 
 ```bash
-chatbotx tags create --name <tagName>
+chatbotx config set --apiKey <key> --apiUrl <url>
 ```
 
-### Show tag details
+---
 
-```bash
-chatbotx tags show --id <tagId>
-```
-
-### Show tag details by name
+### `workspace`
 
 ```bash
-chatbotx tags show-by-name --name <tagName>
+chatbotx workspace list                  # Get workspace info
 ```
 
-### Update a tag
+---
 
-```bash
-chatbotx tags update --id <tagId> --name <newTagName>
-```
-
-### Delete a tag
+### `workspace-members`
 
 ```bash
-chatbotx tags delete --id <tagId>
+chatbotx workspace-members list          # List workspace members
 ```
 
-## 3. Commands: `custom-fields`
+---
 
-### List all custom fields
+### `channels`
 
 ```bash
-chatbotx custom-fields list
+chatbotx channels list                   # List channels
 ```
 
-### Create a new custom field
+---
+
+### `inbox-teams`
 
 ```bash
-chatbotx custom-fields create --name <fieldName> --customFieldType <type>
+chatbotx inbox-teams list                # List inbox teams
 ```
 
-Valid `customFieldType` values:
-
-- `shortText`
-- `number`
-- `date`
-- `datetime`
-- `boolean`
-- `longText`
+---
 
-### Show custom field details
+### `tags`
 
 ```bash
-chatbotx custom-fields show --id <customFieldId>
+chatbotx tags list                       # Get all tags
+chatbotx tags create --name <name>       # Create a new tag
+chatbotx tags show <id>                  # Get tag by ID
+chatbotx tags update <id> --name <name>  # Update tag name
+chatbotx tags delete <id>                # Delete tag
+chatbotx tags find-by-name <name>        # Find tag by name
 ```
 
-### Show custom field details by name
+---
+
+### `custom-fields`
 
 ```bash
-chatbotx custom-fields show-by-name --name <fieldName>
+chatbotx custom-fields list                        # Get all custom fields
+chatbotx custom-fields create --name <name> ...    # Create a custom field
+chatbotx custom-fields show <id>                   # Get custom field by ID
+chatbotx custom-fields find-by-name <name>         # Find custom field by name
 ```
 
-## 4. Commands: `contacts`
+---
 
-### Get contact by ID
+### `bot-fields`
 
 ```bash
-chatbotx contacts show --contactId <contactId>
+chatbotx bot-fields list                           # Get all bot fields
+chatbotx bot-fields create ...                     # Create a bot field
+chatbotx bot-fields show <key>                     # Get bot field by key/name
+chatbotx bot-fields update <key> --value <value>   # Update bot field value
+chatbotx bot-fields delete <key>                   # Unset bot field value
 ```
 
-### List contacts by custom field value
+---
 
-```bash
-chatbotx contacts list-by-custom-field --customFieldId <customFieldId> --customFieldValue <value>
-```
-
-### List tags of a contact
+### `contacts`
 
 ```bash
-chatbotx contacts list-tags --contactId <contactId>
-```
+# Basic CRUD
+chatbotx contacts create --phoneNumber <phone> --email <email> --gender <gender>
+chatbotx contacts show <contactId>
+chatbotx contacts find-by-custom-field --customFieldId <id> --value <value>
 
-### Add a tag to a contact
+# Tags
+chatbotx contacts list-tags <contactId>
+chatbotx contacts add-tag <contactId> <tagId>
+chatbotx contacts delete-tag <contactId> <tagId>
 
-```bash
-chatbotx contacts add-tag --contactId <contactId> --tagId <tagId>
-```
-
-### Delete a tag from a contact
+# Custom fields
+chatbotx contacts list-custom-fields <contactId>
+chatbotx contacts show-custom-field <contactId> <customFieldId>
+chatbotx contacts add-custom-field <contactId> <customFieldId> --value <value>
+chatbotx contacts delete-custom-field <contactId> <customFieldId>
 
-```bash
-chatbotx contacts delete-tag --contactId <contactId> --tagId <tagId>
+# Messaging
+chatbotx contacts add-message <contactId> --text <message>
+chatbotx contacts add-message <contactId> --flowId <id> --nodeId <id>
 ```
 
-### List custom fields of a contact
+---
+
+### `conversations`
 
 ```bash
-chatbotx contacts list-custom-fields --contactId <contactId>
+chatbotx conversations create ...        # Create a conversation
 ```
 
-### Get a contact's custom field value
+---
+
+### `broadcasts`
 
 ```bash
-chatbotx contacts get-custom-field-value --contactId <contactId> --customFieldId <customFieldId>
+chatbotx broadcasts list                 # Get all broadcasts
 ```
 
-### Update a contact custom field value
+---
+
+### `flows`
 
 ```bash
-chatbotx contacts update-custom-field-value --contactId <contactId> --customFieldId <customFieldId> --value <customFieldValue>
+chatbotx flows list                      # Get all flows
 ```
 
-### Delete a contact custom field
+---
+
+### `sequences`
 
 ```bash
-chatbotx contacts delete-custom-field --contactId <contactId> --customFieldId <customFieldId>
+chatbotx sequences list                  # List sequences
+chatbotx sequences show <id>             # Get sequence details
 ```
 
-### Send a message to a contact
+---
+
+### `saved-replies`
 
 ```bash
-chatbotx contacts send-message --contactId <contactId> --channel <channel> --content <message> --files <file1,file2> --flowId <flowId> --clientId <clientId>
+chatbotx saved-replies list              # List saved replies
 ```
 
-Valid `channel` values:
-
-- `webchat`
-- `messenger`
-- `whatsapp`
-- `zalo`
+---
 
-### Create a new contact
+### `whatsapp-message-templates`
 
 ```bash
-chatbotx contacts create --phoneNumber <phoneNumber> --email <email> --gender <male|female|unknown> --firstName <firstName> --lastName <lastName>
+chatbotx whatsapp-message-templates list # List WhatsApp message templates
 ```
 
-## 5. Commands: `bot-fields`
+---
 
-### Get bot field by ID
+### `error-logs`
 
 ```bash
-chatbotx bot-fields show --id <botFieldId>
+chatbotx error-logs list                 # List error logs
 ```
 
-### Update bot field value
+---
 
-```bash
-chatbotx bot-fields update --id <botFieldId> --value <value>
-```
+## Caching
 
-### Unset bot field value
+The CLI caches the API spec at `~/.chatbotX/openapi-cache.json` for 1 hour to avoid fetching on every run.
 
 ```bash
-chatbotx bot-fields delete --id <botFieldId>
-```
+# Force refresh the spec cache
+chatbotx --refresh-spec <command>
 
-## 6. Commands: `flows`
+# Or delete the cache manually
+rm ~/.chatbotX/openapi-cache.json
+```
 
-### List all flows
+Cache TTL can be overridden via environment variable:
 
 ```bash
-chatbotx flows list
+CHATBOTX_SPEC_CACHE_TTL_SECONDS=300 chatbotx tags list
 ```
 
-## 7. Commands: `broadcasts`
+---
 
-### List all broadcasts
+## Getting Help
 
 ```bash
-chatbotx broadcasts list
+chatbotx --help                          # List all command groups
+chatbotx tags --help                     # List actions for a group
+chatbotx tags create --help              # Show options for a specific action
 ```

apps/cli/package.json

@@ -25,20 +25,16 @@
     "command-line"
   ],
   "dependencies": {
-    "@chatbotx.io/public-apis": "workspace:*",
     "@t3-oss/env-core": "^0.13.11",
-    "ky": "^2.0.2",
     "yargs": "^18.0.0",
     "zod": "^4.3.6"
   },
   "devDependencies": {
-    "@chatbotx.io/typescript-config": "workspace:*",
-    "@chatbotx.io/vitest-config": "workspace:*",
     "@types/node": "~24.12.2",
     "@types/yargs": "^17.0.35",
     "dotenv-cli": "^11.0.0",
     "tsdown": "0.21.10",
-    "tsup": "^8.5.1",
+    "tsx": "^4.0.0",
     "typescript": "^5",
     "vitest": "^3.2.4"
   }