@chatbotkit/cli 1.20.0 → 1.21.1

package/README.md

@@ -7,37 +7,95 @@
 
 # ChatBotKit CLI
 
-The ChatBotKit CLI is a command-line interface for the ChatBotKit SDK. It provides a set of commands to help you manage your ChatBotKit projects.
+A powerful command-line interface for ChatBotKit that provides both API management commands and an autonomous AI agent mode for interactive development tasks.
 
-## Getting Started
+## Installation
 
-To begin using the ChatBotKit CLI, follow these steps:
+Install globally via npm:
 
-1. **Installation**: Add the SDK to your project using npm:
+```bash
+npm install --global @chatbotkit/cli
+```
 
-   ```bash
-   npm install --global @chatbotkit/cli
-   ```
+## Authentication
 
-2. **Help**: Get help on the available commands:
+Set your ChatBotKit API token as an environment variable:
 
-   ```bash
-   cbk --help
-   ```
+```bash
+export CHATBOTKIT_API_TOKEN=<your token here>
+```
 
-3. **Usage**: Use the CLI to interact with ChatBotKit:
+### Environment Configuration
 
-   Keep in mind that you will need to authenticate with your ChatBotKit token first.
+The CLI automatically loads environment variables from the following locations (in order of precedence):
 
-   ```bash
-   export CHATBOTKIT_API_TOKEN=<your token here>
-   ```
+1. `.env.local` - Project-specific local configuration (current directory)
+2. `.env` - Project configuration (current directory)
+3. `~/.cbk/env` - Global user configuration (home directory fallback)
 
-   Then you can use the CLI to interact with ChatBotKit:
+This allows you to store your API token globally in `~/.cbk/env` for convenience, while still being able to override it per-project using local `.env` files.
 
-   ```bash
-   cbk api conversation list
-   ```
+**Example `~/.cbk/env` file:**
+
+```bash
+CHATBOTKIT_API_TOKEN=your_token_here
+```
+
+## Features
+
+### API Commands
+
+Manage ChatBotKit resources directly from the command line:
+
+```bash
+cbk api conversation list
+cbk api bot list
+```
+
+Use `cbk --help` to see all available commands.
+
+### Agent Mode
+
+Run an autonomous AI agent that can execute tasks with local file system and command access, while leveraging the full power of the ChatBotKit platform.
+
+```bash
+cbk agent -p "Create a new file and write hello world to it"
+```
+
+**Local Tools:**
+
+- `read` - Read file contents
+- `write` - Write content to a file
+- `edit` - Replace exact string occurrences (single match only)
+- `find` - Search for files using glob patterns
+- `exec` - Execute shell commands
+
+**Platform Integration:**
+
+The agent runs with complete ChatBotKit platform capabilities, including:
+
+- Access to all configured integrations and 3rd-party services
+- Authenticated sessions with external APIs
+- Dataset connections and skillsets
+- Custom abilities and functions
+
+This means your agent can interact with your local development environment while seamlessly accessing any ChatBotKit resources you've configured.
+
+**Agent Options:**
+
+- `-p, --prompt <text>` - Task to execute
+- `-t, --tools <names>` - Comma-separated list of tools to enable (defaults to all standard tools)
+- `-m, --model <name>` - AI model to use
+
+**Example:**
+
+```bash
+# Run agent with specific tools only
+cbk agent -t read,write -p "Read package.json and create a backup"
+
+# Use custom timeout for long-running commands
+cbk agent -p "Run tests with 60 second timeout" -m gpt-5
+```
 
 ## Documentation
 

package/bin/cbk.js

@@ -4,9 +4,14 @@ import dotenv from 'dotenv'
 import cli from '@chatbotkit/cli'
 import { printError } from '@chatbotkit/cli/output'
 
+import { homedir } from 'os'
+import { join } from 'path'
+
 dotenv.config({
-  // @ts-expect-error arrays are supported
-  path: ['.env.local', '.env'],
+  path: ['.env.local', '.env', join(homedir(), '.cbk', 'env')],
 })
 
+process.on('unhandledRejection', printError)
+process.on('uncaughtException', printError)
+
 cli().catch(printError)

package/dist/cjs/command/agent/index.cjs

@@ -0,0 +1,100 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.command = void 0;
+const env_js_1 = require("../../env.cjs");
+const output_js_1 = require("../../output.cjs");
+const spinner_js_1 = require("../../spinner.cjs");
+const tools_js_1 = require("../../tools.cjs");
+const agent_1 = require("@chatbotkit/agent");
+const sdk_1 = require("@chatbotkit/sdk");
+const commander_1 = require("commander");
+const fs_1 = require("fs");
+const path_1 = require("path");
+function getClient() {
+    return new sdk_1.ChatBotKit({
+        secret: (0, env_js_1.getSECRET)(),
+        runAsUserId: (0, env_js_1.getRUNAS_USERID)(),
+    });
+}
+exports.command = new commander_1.Command()
+    .name('agent')
+    .description('Run an agent as a background worker with a prompt')
+    .addOption(new commander_1.Option('-b, --bot <bot>', 'Bot id'))
+    .addOption(new commander_1.Option('-m, --model <model>', 'Model name'))
+    .addOption(new commander_1.Option('-p, --prompt <prompt>', 'The prompt to execute (or path to a file containing the prompt)').makeOptionMandatory())
+    .addOption(new commander_1.Option('-t, --tools <tools...>', 'Specific tools to enable').choices((0, tools_js_1.getToolNames)()))
+    .addOption(new commander_1.Option('-i, --max-iterations <maxIterations>', 'Maximum number of iterations')
+    .default(50)
+    .argParser((value) => parseInt(value, 10)))
+    .action(async (options) => {
+    const client = getClient();
+    const tools = (0, tools_js_1.getTools)(options.tools);
+    let prompt = options.prompt;
+    {
+        const filePath = (0, path_1.resolve)(process.cwd(), options.prompt);
+        if ((0, fs_1.existsSync)(filePath)) {
+            try {
+                prompt = (0, fs_1.readFileSync)(filePath, 'utf-8');
+            }
+            catch (error) {
+                (0, output_js_1.printError)(error);
+            }
+        }
+    }
+    const isInteractive = process.stdout.isTTY;
+    const spinner = isInteractive ? new spinner_js_1.Spinner() : null;
+    let exitResult = null;
+    let hasOutput = false;
+    for await (const { type, data } of (0, agent_1.execute)({
+        client,
+        botId: options.bot,
+        model: options.model,
+        messages: [{ type: 'user', text: prompt }],
+        tools,
+        maxIterations: options.maxIterations,
+    })) {
+        if (type === 'iteration') {
+            if (spinner) {
+                if (spinner.isSpinning) {
+                    spinner.stop();
+                }
+                const iterationNum = data.iteration - 1;
+                console.log(`\n╭─ Iteration ${iterationNum} ─╮`);
+                spinner.start();
+            }
+            else {
+                (0, output_js_1.print)({ iteration: data.iteration - 1 });
+            }
+            hasOutput = false;
+        }
+        else if (type === 'token') {
+            if (spinner && spinner.isSpinning) {
+                spinner.stop();
+            }
+            if (!hasOutput && isInteractive) {
+                process.stdout.write('> ');
+                hasOutput = true;
+            }
+            process.stdout.write(data.token);
+        }
+        else if (type === 'exit') {
+            exitResult = data;
+        }
+    }
+    if (spinner && spinner.isSpinning) {
+        spinner.stop();
+    }
+    process.stdout.write('\n\n');
+    if (exitResult) {
+        (0, output_js_1.print)({
+            status: exitResult.code === 0 ? 'success' : 'failed',
+            exitCode: exitResult.code,
+            ...(exitResult.message && { message: exitResult.message }),
+        });
+        process.exit(exitResult.code);
+    }
+    else {
+        (0, output_js_1.printError)(new Error('Task ended without exit signal'));
+    }
+});
+exports.default = exports.command;

package/dist/cjs/command/agent/index.d.ts

@@ -0,0 +1,3 @@
+export const command: Command;
+export default command;
+import { Command } from 'commander';

package/dist/cjs/command/api/conversation/index.cjs

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.command = exports.conversationDelete = exports.conversationFetch = exports.conversationList = void 0;
+exports.command = exports.conversationList = void 0;
 const tslib_1 = require("tslib");
 const env_js_1 = require("../../../env.cjs");
 const output_js_1 = require("../../../output.cjs");
@@ -32,7 +32,7 @@ exports.conversationList = new commander_1.Command()
         }
     }
 });
-exports.conversationFetch = new commander_1.Command()
+const conversationFetch = new commander_1.Command()
     .name('fetch')
     .description('Fetch conversation')
     .argument('<conversationId>', 'Conversation ID')
@@ -41,7 +41,7 @@ exports.conversationFetch = new commander_1.Command()
     const conversation = await client.fetch(conversationId);
     (0, output_js_1.print)(conversation);
 });
-exports.conversationDelete = new commander_1.Command()
+const conversationDelete = new commander_1.Command()
     .name('delete')
     .description('Delete conversation')
     .argument('<conversationId>', 'Conversation ID')
@@ -49,11 +49,16 @@ exports.conversationDelete = new commander_1.Command()
     const client = getClient();
     await client.delete(conversationId);
 });
+const commands = {
+    list: exports.conversationList,
+    fetch: conversationFetch,
+    delete: conversationDelete,
+    message: index_js_1.default,
+};
 exports.command = new commander_1.Command()
     .name('conversation')
-    .description('Conversation tools for ChatBotKit')
-    .addCommand(exports.conversationList)
-    .addCommand(exports.conversationFetch)
-    .addCommand(exports.conversationDelete)
-    .addCommand(index_js_1.default);
+    .description('Conversation tools for ChatBotKit');
+for (const cmd of Object.values(commands)) {
+    exports.command.addCommand(cmd);
+}
 exports.default = exports.command;

package/dist/cjs/command/api/conversation/index.d.ts

@@ -1,6 +1,4 @@
 export const conversationList: Command;
-export const conversationFetch: Command;
-export const conversationDelete: Command;
 export const command: Command;
 export default command;
 import { Command } from 'commander';

package/dist/cjs/command/api/conversation/message/index.cjs

@@ -50,10 +50,15 @@ exports.messageDelete = new commander_1.Command()
     const client = getClient();
     await client.delete(conversationId, messageId);
 });
+const commands = {
+    list: exports.messageList,
+    fetch: exports.messageFetch,
+    delete: exports.messageDelete,
+};
 exports.command = new commander_1.Command()
     .name('message')
-    .description('Message tools for ChatBotKit')
-    .addCommand(exports.messageList)
-    .addCommand(exports.messageFetch)
-    .addCommand(exports.messageDelete);
+    .description('Message tools for ChatBotKit');
+for (const cmd of Object.values(commands)) {
+    exports.command.addCommand(cmd);
+}
 exports.default = exports.command;

package/dist/cjs/command/api/dataset/index.cjs

@@ -47,10 +47,15 @@ exports.datasetDelete = new commander_1.Command()
     const client = getClient();
     await client.delete(datasetId);
 });
+const commands = {
+    list: exports.datasetList,
+    fetch: exports.datasetFetch,
+    delete: exports.datasetDelete,
+};
 exports.command = new commander_1.Command()
     .name('dataset')
-    .description('Dataset tools for ChatBotKit')
-    .addCommand(exports.datasetList)
-    .addCommand(exports.datasetFetch)
-    .addCommand(exports.datasetDelete);
+    .description('Dataset tools for ChatBotKit');
+for (const cmd of Object.values(commands)) {
+    exports.command.addCommand(cmd);
+}
 exports.default = exports.command;

package/dist/cjs/command/api/index.cjs

@@ -8,13 +8,18 @@ const index_js_2 = tslib_1.__importDefault(require("./dataset/index.cjs"));
 const index_js_3 = tslib_1.__importDefault(require("./partner/index.cjs"));
 const index_js_4 = tslib_1.__importDefault(require("./skillset/index.cjs"));
 const commander_1 = require("commander");
+const commands = {
+    conversation: index_js_1.default,
+    dataset: index_js_2.default,
+    skillset: index_js_4.default,
+    partner: index_js_3.default,
+};
 exports.command = new commander_1.Command()
     .name('api')
-    .description('API tools for ChatBotKit')
-    .addCommand(index_js_2.default)
-    .addCommand(index_js_4.default)
-    .addCommand(index_js_1.default)
-    .addCommand(index_js_3.default);
+    .description('API tools for ChatBotKit');
+for (const cmd of Object.values(commands)) {
+    exports.command.addCommand(cmd);
+}
 exports.command
     .addOption(new commander_1.Option('-o, --output <format>', 'Output format').choices([
     'yaml',

package/dist/cjs/command/api/index.d.ts

@@ -1,3 +1,4 @@
 export const command: Command;
 export default command;
+export type ChatBotKitSDK = import("@chatbotkit/sdk").ChatBotKit;
 import { Command } from 'commander';

package/dist/cjs/command/api/partner/index.cjs

@@ -4,8 +4,13 @@ exports.command = void 0;
 const tslib_1 = require("tslib");
 const index_js_1 = tslib_1.__importDefault(require("./user/index.cjs"));
 const commander_1 = require("commander");
+const commands = {
+    user: index_js_1.default,
+};
 exports.command = new commander_1.Command()
     .name('partner')
-    .description('Partner tools for ChatBotKit')
-    .addCommand(index_js_1.default);
+    .description('Partner tools for ChatBotKit');
+for (const cmd of Object.values(commands)) {
+    exports.command.addCommand(cmd);
+}
 exports.default = exports.command;

package/dist/cjs/command/api/partner/user/index.cjs

@@ -47,10 +47,15 @@ exports.userDelete = new commander_1.Command()
     const client = getClient();
     await client.delete(userId);
 });
+const commands = {
+    list: exports.userList,
+    fetch: exports.userFetch,
+    delete: exports.userDelete,
+};
 exports.command = new commander_1.Command()
     .name('user')
-    .description('User tools for ChatBotKit')
-    .addCommand(exports.userList)
-    .addCommand(exports.userFetch)
-    .addCommand(exports.userDelete);
+    .description('User tools for ChatBotKit');
+for (const cmd of Object.values(commands)) {
+    exports.command.addCommand(cmd);
+}
 exports.default = exports.command;

package/dist/cjs/command/api/skillset/index.cjs

@@ -47,10 +47,15 @@ exports.skillsetDelete = new commander_1.Command()
     const client = getClient();
     await client.delete(skillsetId);
 });
+const commands = {
+    list: exports.skillsetList,
+    fetch: exports.skillsetFetch,
+    delete: exports.skillsetDelete,
+};
 exports.command = new commander_1.Command()
     .name('skillset')
-    .description('Skillset tools for ChatBotKit')
-    .addCommand(exports.skillsetList)
-    .addCommand(exports.skillsetFetch)
-    .addCommand(exports.skillsetDelete);
+    .description('Skillset tools for ChatBotKit');
+for (const cmd of Object.values(commands)) {
+    exports.command.addCommand(cmd);
+}
 exports.default = exports.command;

package/dist/cjs/command/chat/index.cjs

@@ -3,11 +3,14 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.command = void 0;
 const tslib_1 = require("tslib");
 const env_js_1 = require("../../env.cjs");
-const index_js_1 = require("@chatbotkit/sdk/conversation/index.js");
+const spinner_js_1 = require("../../spinner.cjs");
+const tools_js_1 = require("../../tools.cjs");
+const agent_1 = require("@chatbotkit/agent");
+const sdk_1 = require("@chatbotkit/sdk");
 const commander_1 = require("commander");
 const promises_1 = tslib_1.__importDefault(require("readline/promises"));
 function getClient() {
-    return new index_js_1.ConversationClient({
+    return new sdk_1.ChatBotKit({
         secret: (0, env_js_1.getSECRET)(),
         runAsUserId: (0, env_js_1.getRUNAS_USERID)(),
     });
@@ -15,28 +18,50 @@ function getClient() {
 exports.command = new commander_1.Command()
     .name('chat')
     .description('Start a chat session')
-    .addOption(new commander_1.Option('-m, --model <model>', 'Model name').default('gpt-4'))
-    .action(async (_arg, options) => {
+    .addOption(new commander_1.Option('-b, --bot <bot>', 'Bot id'))
+    .addOption(new commander_1.Option('-m, --model <model>', 'Model name'))
+    .addOption(new commander_1.Option('-t, --tools <tools...>', 'Specific tools to enable').choices((0, tools_js_1.getToolNames)()))
+    .action(async (options) => {
     const client = getClient();
     const rl = promises_1.default.createInterface({
         input: process.stdin,
         output: process.stdout,
     });
     const messages = [];
+    const tools = (0, tools_js_1.getTools)(options.tools);
+    const colors = {
+        reset: '\x1b[0m',
+        bold: '\x1b[1m',
+        cyan: '\x1b[36m',
+        green: '\x1b[32m',
+    };
     for (;;) {
-        const user = await rl.question('user: ');
+        process.stdout.write('\n');
+        const user = await rl.question(`${colors.cyan}●${colors.reset} ${colors.bold}You${colors.reset}\n\n> `);
         messages.push({ type: 'user', text: user });
-        process.stdout.write('bot: ');
-        for await (const { type, data } of client
-            .complete(null, { model: options.model, messages })
-            .stream()) {
+        process.stdout.write(`\n${colors.green}●${colors.reset} ${colors.bold}Assistant${colors.reset}\n\n  `);
+        const spinner = new spinner_js_1.Spinner('');
+        spinner.start();
+        let firstToken = true;
+        for await (const { type, data } of (0, agent_1.complete)({
+            client,
+            botId: options.bot,
+            model: options.model,
+            messages,
+            tools,
+        })) {
             if (type === 'token') {
+                if (firstToken) {
+                    spinner.stop();
+                    firstToken = false;
+                }
                 process.stdout.write(data.token);
             }
             else if (type === 'result') {
                 messages.push({ type: 'bot', text: data.text });
             }
         }
+        spinner.stop();
         process.stdout.write('\n');
     }
 });

package/dist/cjs/index.cjs

@@ -2,15 +2,17 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.default = cbk;
 const tslib_1 = require("tslib");
-const index_js_1 = tslib_1.__importDefault(require("./command/api/index.cjs"));
-const index_js_2 = tslib_1.__importDefault(require("./command/chat/index.cjs"));
-const index_js_3 = tslib_1.__importDefault(require("./command/solution/index.cjs"));
+const index_js_1 = tslib_1.__importDefault(require("./command/agent/index.cjs"));
+const index_js_2 = tslib_1.__importDefault(require("./command/api/index.cjs"));
+const index_js_3 = tslib_1.__importDefault(require("./command/chat/index.cjs"));
+const index_js_4 = tslib_1.__importDefault(require("./command/solution/index.cjs"));
 const commander_1 = require("commander");
 async function cbk(argv = process.argv) {
     const program = new commander_1.Command();
     program.name('cbk').description('Command line tools for ChatBotKit');
-    program.addCommand(index_js_1.default);
     program.addCommand(index_js_2.default);
+    program.addCommand(index_js_1.default);
     program.addCommand(index_js_3.default);
+    program.addCommand(index_js_4.default);
     program.parse(argv);
 }

package/dist/cjs/output.cjs

@@ -33,10 +33,14 @@ function print(input) {
     }
 }
 function printError(error) {
+    if (error?.code === 'ABORT_ERR' || error?.name === 'AbortError') {
+        process.exit(130);
+    }
     if (error instanceof CommandError) {
         console.error(error.message);
     }
     else {
         console.error(error);
     }
+    process.exit(1);
 }

package/dist/cjs/solution/index.cjs

@@ -110,8 +110,8 @@ class Resource {
         return this.config.type;
     }
     get slug() {
-        var _a;
-        return ((_a = this.config.slug) !== null && _a !== void 0 ? _a : this.config.name.toLowerCase().replace(/\W/g, '_').replace(/_+/g, '_'));
+        return (this.config.slug ??
+            this.config.name.toLowerCase().replace(/\W/g, '_').replace(/_+/g, '_'));
     }
     get id() {
         return this.config.id;
@@ -310,7 +310,7 @@ class ArrayBackedObject {
         this.array = array;
         return new Proxy(this, {
             get: (target, property) => {
-                const item = target.array.find((item) => { var _a; return ((_a = (item)) === null || _a === void 0 ? void 0 : _a.slug) === property; });
+                const item = target.array.find((item) => (item)?.slug === property);
                 if (item) {
                     return item;
                 }

package/dist/cjs/spinner.cjs

@@ -0,0 +1,56 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Spinner = void 0;
+class Spinner {
+    constructor(text = '', options = {}) {
+        this.text = text;
+        this.frames = options.frames || [
+            '⠋',
+            '⠙',
+            '⠹',
+            '⠸',
+            '⠼',
+            '⠴',
+            '⠦',
+            '⠧',
+            '⠇',
+            '⠏',
+        ];
+        this.interval = options.interval || 80;
+        this.frameIndex = 0;
+        this.intervalId = null;
+        this.isSpinning = false;
+    }
+    start() {
+        if (this.isSpinning) {
+            return;
+        }
+        this.isSpinning = true;
+        this.frameIndex = 0;
+        this.intervalId = setInterval(() => {
+            const frame = this.frames[this.frameIndex];
+            process.stdout.write(`\r${this.text}${frame} `);
+            this.frameIndex = (this.frameIndex + 1) % this.frames.length;
+        }, this.interval);
+    }
+    stop(keepText = true) {
+        if (!this.isSpinning) {
+            return;
+        }
+        this.isSpinning = false;
+        if (this.intervalId) {
+            clearInterval(this.intervalId);
+            this.intervalId = null;
+        }
+        if (keepText) {
+            process.stdout.write(`\r${this.text}`);
+        }
+        else {
+            process.stdout.write('\r' + ' '.repeat(this.text.length + 2) + '\r');
+        }
+    }
+    setText(text) {
+        this.text = text;
+    }
+}
+exports.Spinner = Spinner;

package/dist/cjs/spinner.d.ts

@@ -0,0 +1,15 @@
+export class Spinner {
+    constructor(text?: string, options?: {
+        frames?: string[];
+        interval?: number;
+    });
+    text: string;
+    frames: string[];
+    interval: number;
+    frameIndex: number;
+    intervalId: NodeJS.Timeout;
+    isSpinning: boolean;
+    start(): void;
+    stop(keepText?: boolean): void;
+    setText(text: string): void;
+}