From 0023aa7022f5a10f71b851f2f8e7a33987616ddd Mon Sep 17 00:00:00 2001 From: Mohamed Marrouchi Date: Wed, 2 Oct 2024 10:06:00 +0100 Subject: [PATCH] feat: add cli project --- cli/.gitignore | 2 + cli/package-lock.json | 295 ++++++++++++++++++++++++++++++++++++++++++ cli/package.json | 33 +++++ cli/src/index.ts | 183 ++++++++++++++++++++++++++ cli/tsconfig.json | 15 +++ 5 files changed, 528 insertions(+) create mode 100644 cli/.gitignore create mode 100644 cli/package-lock.json create mode 100644 cli/package.json create mode 100644 cli/src/index.ts create mode 100644 cli/tsconfig.json diff --git a/cli/.gitignore b/cli/.gitignore new file mode 100644 index 00000000..f06235c4 --- /dev/null +++ b/cli/.gitignore @@ -0,0 +1,2 @@ +node_modules +dist diff --git a/cli/package-lock.json b/cli/package-lock.json new file mode 100644 index 00000000..39a75cea --- /dev/null +++ b/cli/package-lock.json @@ -0,0 +1,295 @@ +{ + "name": "hexabot-cli", + "version": "2.0.0", + "lockfileVersion": 3, + "requires": true, + "packages": { + "": { + "name": "hexabot-cli", + "version": "2.0.0", + "license": "AGPL-3.0-only", + "dependencies": { + "chalk": "^5.3.0", + "commander": "^12.1.0", + "dotenv": "^16.4.5", + "figlet": "^1.7.0" + }, + "bin": { + "hexabot": "dist/index.js" + }, + "devDependencies": { + "@types/chalk": "^2.2.0", + "@types/commander": "^2.12.2", + "@types/figlet": "^1.5.8", + "@types/node": "^22.7.4", + "ts-node": "^10.9.2", + "typescript": "^5.6.2" + } + }, + "node_modules/@cspotcode/source-map-support": { + "version": "0.8.1", + "resolved": "https://registry.npmjs.org/@cspotcode/source-map-support/-/source-map-support-0.8.1.tgz", + "integrity": "sha512-IchNf6dN4tHoMFIn/7OE8LWZ19Y6q/67Bmf6vnGREv8RSbBVb9LPJxEcnwrcwX6ixSvaiGoomAUvu4YSxXrVgw==", + "dev": true, + "dependencies": { + "@jridgewell/trace-mapping": "0.3.9" + }, + "engines": { + "node": ">=12" + } + }, + "node_modules/@jridgewell/resolve-uri": { + "version": "3.1.2", + "resolved": "https://registry.npmjs.org/@jridgewell/resolve-uri/-/resolve-uri-3.1.2.tgz", + "integrity": "sha512-bRISgCIjP20/tbWSPWMEi54QVPRZExkuD9lJL+UIxUKtwVJA8wW1Trb1jMs1RFXo1CBTNZ/5hpC9QvmKWdopKw==", + "dev": true, + "engines": { + "node": ">=6.0.0" + } + }, + "node_modules/@jridgewell/sourcemap-codec": { + "version": "1.5.0", + "resolved": "https://registry.npmjs.org/@jridgewell/sourcemap-codec/-/sourcemap-codec-1.5.0.tgz", + "integrity": "sha512-gv3ZRaISU3fjPAgNsriBRqGWQL6quFx04YMPW/zD8XMLsU32mhCCbfbO6KZFLjvYpCZ8zyDEgqsgf+PwPaM7GQ==", + "dev": true + }, + "node_modules/@jridgewell/trace-mapping": { + "version": "0.3.9", + "resolved": "https://registry.npmjs.org/@jridgewell/trace-mapping/-/trace-mapping-0.3.9.tgz", + "integrity": "sha512-3Belt6tdc8bPgAtbcmdtNJlirVoTmEb5e2gC94PnkwEW9jI6CAHUeoG85tjWP5WquqfavoMtMwiG4P926ZKKuQ==", + "dev": true, + "dependencies": { + "@jridgewell/resolve-uri": "^3.0.3", + "@jridgewell/sourcemap-codec": "^1.4.10" + } + }, + "node_modules/@tsconfig/node10": { + "version": "1.0.11", + "resolved": "https://registry.npmjs.org/@tsconfig/node10/-/node10-1.0.11.tgz", + "integrity": "sha512-DcRjDCujK/kCk/cUe8Xz8ZSpm8mS3mNNpta+jGCA6USEDfktlNvm1+IuZ9eTcDbNk41BHwpHHeW+N1lKCz4zOw==", + "dev": true + }, + "node_modules/@tsconfig/node12": { + "version": "1.0.11", + "resolved": "https://registry.npmjs.org/@tsconfig/node12/-/node12-1.0.11.tgz", + "integrity": "sha512-cqefuRsh12pWyGsIoBKJA9luFu3mRxCA+ORZvA4ktLSzIuCUtWVxGIuXigEwO5/ywWFMZ2QEGKWvkZG1zDMTag==", + "dev": true + }, + "node_modules/@tsconfig/node14": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/@tsconfig/node14/-/node14-1.0.3.tgz", + "integrity": "sha512-ysT8mhdixWK6Hw3i1V2AeRqZ5WfXg1G43mqoYlM2nc6388Fq5jcXyr5mRsqViLx/GJYdoL0bfXD8nmF+Zn/Iow==", + "dev": true + }, + "node_modules/@tsconfig/node16": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/@tsconfig/node16/-/node16-1.0.4.tgz", + "integrity": "sha512-vxhUy4J8lyeyinH7Azl1pdd43GJhZH/tP2weN8TntQblOY+A0XbT8DJk1/oCPuOOyg/Ja757rG0CgHcWC8OfMA==", + "dev": true + }, + "node_modules/@types/chalk": { + "version": "2.2.0", + "resolved": "https://registry.npmjs.org/@types/chalk/-/chalk-2.2.0.tgz", + "integrity": "sha512-1zzPV9FDe1I/WHhRkf9SNgqtRJWZqrBWgu7JGveuHmmyR9CnAPCie2N/x+iHrgnpYBIcCJWHBoMRv2TRWktsvw==", + "deprecated": "This is a stub types definition for chalk (https://github.com/chalk/chalk). chalk provides its own type definitions, so you don't need @types/chalk installed!", + "dev": true, + "dependencies": { + "chalk": "*" + } + }, + "node_modules/@types/commander": { + "version": "2.12.2", + "resolved": "https://registry.npmjs.org/@types/commander/-/commander-2.12.2.tgz", + "integrity": "sha512-0QEFiR8ljcHp9bAbWxecjVRuAMr16ivPiGOw6KFQBVrVd0RQIcM3xKdRisH2EDWgVWujiYtHwhSkSUoAAGzH7Q==", + "deprecated": "This is a stub types definition for commander (https://github.com/tj/commander.js). commander provides its own type definitions, so you don't need @types/commander installed!", + "dev": true, + "dependencies": { + "commander": "*" + } + }, + "node_modules/@types/figlet": { + "version": "1.5.8", + "resolved": "https://registry.npmjs.org/@types/figlet/-/figlet-1.5.8.tgz", + "integrity": "sha512-G22AUvy4Tl95XLE7jmUM8s8mKcoz+Hr+Xm9W90gJsppJq9f9tHvOGkrpn4gRX0q/cLtBdNkWtWCKDg2UDZoZvQ==", + "dev": true + }, + "node_modules/@types/node": { + "version": "22.7.4", + "resolved": "https://registry.npmjs.org/@types/node/-/node-22.7.4.tgz", + "integrity": "sha512-y+NPi1rFzDs1NdQHHToqeiX2TIS79SWEAw9GYhkkx8bD0ChpfqC+n2j5OXOCpzfojBEBt6DnEnnG9MY0zk1XLg==", + "dev": true, + "dependencies": { + "undici-types": "~6.19.2" + } + }, + "node_modules/acorn": { + "version": "8.12.1", + "resolved": "https://registry.npmjs.org/acorn/-/acorn-8.12.1.tgz", + "integrity": "sha512-tcpGyI9zbizT9JbV6oYE477V6mTlXvvi0T0G3SNIYE2apm/G5huBa1+K89VGeovbg+jycCrfhl3ADxErOuO6Jg==", + "dev": true, + "bin": { + "acorn": "bin/acorn" + }, + "engines": { + "node": ">=0.4.0" + } + }, + "node_modules/acorn-walk": { + "version": "8.3.4", + "resolved": "https://registry.npmjs.org/acorn-walk/-/acorn-walk-8.3.4.tgz", + "integrity": "sha512-ueEepnujpqee2o5aIYnvHU6C0A42MNdsIDeqy5BydrkuC5R1ZuUFnm27EeFJGoEHJQgn3uleRvmTXaJgfXbt4g==", + "dev": true, + "dependencies": { + "acorn": "^8.11.0" + }, + "engines": { + "node": ">=0.4.0" + } + }, + "node_modules/arg": { + "version": "4.1.3", + "resolved": "https://registry.npmjs.org/arg/-/arg-4.1.3.tgz", + "integrity": "sha512-58S9QDqG0Xx27YwPSt9fJxivjYl432YCwfDMfZ+71RAqUrZef7LrKQZ3LHLOwCS4FLNBplP533Zx895SeOCHvA==", + "dev": true + }, + "node_modules/chalk": { + "version": "5.3.0", + "resolved": "https://registry.npmjs.org/chalk/-/chalk-5.3.0.tgz", + "integrity": "sha512-dLitG79d+GV1Nb/VYcCDFivJeK1hiukt9QjRNVOsUtTy1rR1YJsmpGGTZ3qJos+uw7WmWF4wUwBd9jxjocFC2w==", + "engines": { + "node": "^12.17.0 || ^14.13 || >=16.0.0" + }, + "funding": { + "url": "https://github.com/chalk/chalk?sponsor=1" + } + }, + "node_modules/commander": { + "version": "12.1.0", + "resolved": "https://registry.npmjs.org/commander/-/commander-12.1.0.tgz", + "integrity": "sha512-Vw8qHK3bZM9y/P10u3Vib8o/DdkvA2OtPtZvD871QKjy74Wj1WSKFILMPRPSdUSx5RFK1arlJzEtA4PkFgnbuA==", + "engines": { + "node": ">=18" + } + }, + "node_modules/create-require": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/create-require/-/create-require-1.1.1.tgz", + "integrity": "sha512-dcKFX3jn0MpIaXjisoRvexIJVEKzaq7z2rZKxf+MSr9TkdmHmsU4m2lcLojrj/FHl8mk5VxMmYA+ftRkP/3oKQ==", + "dev": true + }, + "node_modules/diff": { + "version": "4.0.2", + "resolved": "https://registry.npmjs.org/diff/-/diff-4.0.2.tgz", + "integrity": "sha512-58lmxKSA4BNyLz+HHMUzlOEpg09FV+ev6ZMe3vJihgdxzgcwZ8VoEEPmALCZG9LmqfVoNMMKpttIYTVG6uDY7A==", + "dev": true, + "engines": { + "node": ">=0.3.1" + } + }, + "node_modules/dotenv": { + "version": "16.4.5", + "resolved": "https://registry.npmjs.org/dotenv/-/dotenv-16.4.5.tgz", + "integrity": "sha512-ZmdL2rui+eB2YwhsWzjInR8LldtZHGDoQ1ugH85ppHKwpUHL7j7rN0Ti9NCnGiQbhaZ11FpR+7ao1dNsmduNUg==", + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://dotenvx.com" + } + }, + "node_modules/figlet": { + "version": "1.7.0", + "resolved": "https://registry.npmjs.org/figlet/-/figlet-1.7.0.tgz", + "integrity": "sha512-gO8l3wvqo0V7wEFLXPbkX83b7MVjRrk1oRLfYlZXol8nEpb/ON9pcKLI4qpBv5YtOTfrINtqb7b40iYY2FTWFg==", + "bin": { + "figlet": "bin/index.js" + }, + "engines": { + "node": ">= 0.4.0" + } + }, + "node_modules/make-error": { + "version": "1.3.6", + "resolved": "https://registry.npmjs.org/make-error/-/make-error-1.3.6.tgz", + "integrity": "sha512-s8UhlNe7vPKomQhC1qFelMokr/Sc3AgNbso3n74mVPA5LTZwkB9NlXf4XPamLxJE8h0gh73rM94xvwRT2CVInw==", + "dev": true + }, + "node_modules/ts-node": { + "version": "10.9.2", + "resolved": "https://registry.npmjs.org/ts-node/-/ts-node-10.9.2.tgz", + "integrity": "sha512-f0FFpIdcHgn8zcPSbf1dRevwt047YMnaiJM3u2w2RewrB+fob/zePZcrOyQoLMMO7aBIddLcQIEK5dYjkLnGrQ==", + "dev": true, + "dependencies": { + "@cspotcode/source-map-support": "^0.8.0", + "@tsconfig/node10": "^1.0.7", + "@tsconfig/node12": "^1.0.7", + "@tsconfig/node14": "^1.0.0", + "@tsconfig/node16": "^1.0.2", + "acorn": "^8.4.1", + "acorn-walk": "^8.1.1", + "arg": "^4.1.0", + "create-require": "^1.1.0", + "diff": "^4.0.1", + "make-error": "^1.1.1", + "v8-compile-cache-lib": "^3.0.1", + "yn": "3.1.1" + }, + "bin": { + "ts-node": "dist/bin.js", + "ts-node-cwd": "dist/bin-cwd.js", + "ts-node-esm": "dist/bin-esm.js", + "ts-node-script": "dist/bin-script.js", + "ts-node-transpile-only": "dist/bin-transpile.js", + "ts-script": "dist/bin-script-deprecated.js" + }, + "peerDependencies": { + "@swc/core": ">=1.2.50", + "@swc/wasm": ">=1.2.50", + "@types/node": "*", + "typescript": ">=2.7" + }, + "peerDependenciesMeta": { + "@swc/core": { + "optional": true + }, + "@swc/wasm": { + "optional": true + } + } + }, + "node_modules/typescript": { + "version": "5.6.2", + "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.6.2.tgz", + "integrity": "sha512-NW8ByodCSNCwZeghjN3o+JX5OFH0Ojg6sadjEKY4huZ52TqbJTJnDo5+Tw98lSy63NZvi4n+ez5m2u5d4PkZyw==", + "dev": true, + "bin": { + "tsc": "bin/tsc", + "tsserver": "bin/tsserver" + }, + "engines": { + "node": ">=14.17" + } + }, + "node_modules/undici-types": { + "version": "6.19.8", + "resolved": "https://registry.npmjs.org/undici-types/-/undici-types-6.19.8.tgz", + "integrity": "sha512-ve2KP6f/JnbPBFyobGHuerC9g1FYGn/F8n1LWTwNxCEzd6IfqTwUQcNXgEtmmQ6DlRrC1hrSrBnCZPokRrDHjw==", + "dev": true + }, + "node_modules/v8-compile-cache-lib": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/v8-compile-cache-lib/-/v8-compile-cache-lib-3.0.1.tgz", + "integrity": "sha512-wa7YjyUGfNZngI/vtK0UHAN+lgDCxBPCylVXGp0zu59Fz5aiGtNXaq3DhIov063MorB+VfufLh3JlF2KdTK3xg==", + "dev": true + }, + "node_modules/yn": { + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/yn/-/yn-3.1.1.tgz", + "integrity": "sha512-Ux4ygGWsu2c7isFWe8Yu1YluJmqVhxqK2cLXNQA5AcC3QfbGNpM7fu0Y8b/z16pXLnFxZYvWhd3fhBY9DLmC6Q==", + "dev": true, + "engines": { + "node": ">=6" + } + } + } +} diff --git a/cli/package.json b/cli/package.json new file mode 100644 index 00000000..10086bde --- /dev/null +++ b/cli/package.json @@ -0,0 +1,33 @@ +{ + "name": "hexabot-cli", + "version": "2.0.0", + "description": "Hexabot CLI for creating and managing chatbots built with Hexabot.", + "main": "dist/index.js", + "type": "module", + "bin": { + "hexabot": "dist/index.js" + }, + "scripts": { + "build": "tsc", + "start": "node dist/cli.js", + "dev": "ts-node src/cli.ts", + "prepare": "npm run build" + }, + "keywords": [], + "author": "Hexastack", + "license": "AGPL-3.0-only", + "dependencies": { + "chalk": "^5.3.0", + "commander": "^12.1.0", + "dotenv": "^16.4.5", + "figlet": "^1.7.0" + }, + "devDependencies": { + "@types/chalk": "^2.2.0", + "@types/commander": "^2.12.2", + "@types/figlet": "^1.5.8", + "@types/node": "^22.7.4", + "ts-node": "^10.9.2", + "typescript": "^5.6.2" + } +} diff --git a/cli/src/index.ts b/cli/src/index.ts new file mode 100644 index 00000000..8b84c1fb --- /dev/null +++ b/cli/src/index.ts @@ -0,0 +1,183 @@ +#!/usr/bin/env node + +import figlet from 'figlet'; +import { Command } from 'commander'; +import { execSync } from 'child_process'; +import * as fs from 'fs'; +import * as path from 'path'; +import chalk from 'chalk'; + +console.log(figlet.textSync('Hexabot')); + +// Configuration +const FOLDER = path.resolve(process.cwd(), './docker'); + +/** + * Check if the docker folder exists, otherwise prompt the user to cd into the correct folder. + */ +const checkDockerFolder = (): void => { + if (!fs.existsSync(FOLDER)) { + console.error( + chalk.red( + `Error: The 'docker' folder is not found in the current directory.`, + ), + ); + console.error( + chalk.yellow( + `Please make sure you're in the Hexabot project directory and try again.`, + ), + ); + console.log(chalk.cyan(`Example: cd path/to/hexabot`)); + process.exit(1); // Exit the script if the folder is not found + } +}; + +// Initialize Commander +const program = new Command(); + +// Helper Functions + +/** + * Generate Docker Compose file arguments based on provided services. + * @param services List of services + * @param type Optional type ('dev' | 'prod') + * @returns String of Docker Compose file arguments + */ +const generateComposeFiles = ( + services: string[], + type?: 'dev' | 'prod', +): string => { + let files = [`-f ${path.join(FOLDER, 'docker-compose.yml')}`]; + + services.forEach((service) => { + files.push(`-f ${path.join(FOLDER, `docker-compose.${service}.yml`)}`); + if (type) { + const serviceTypeFile = path.join( + FOLDER, + `docker-compose.${service}.${type}.yml`, + ); + if (fs.existsSync(serviceTypeFile)) { + files.push(`-f ${serviceTypeFile}`); + } + } + }); + + if (type) { + const mainTypeFile = path.join(FOLDER, `docker-compose.${type}.yml`); + if (fs.existsSync(mainTypeFile)) { + files.push(`-f ${mainTypeFile}`); + } + } + + return files.join(' '); +}; + +/** + * Execute a Docker Compose command. + * @param args Additional arguments for the docker compose command + */ +const dockerCompose = (args: string): void => { + try { + execSync(`docker compose ${args}`, { stdio: 'inherit' }); + } catch (error) { + console.error(chalk.red('Error executing Docker Compose command.')); + process.exit(1); + } +}; + +/** + * Parse the comma-separated service list. + * @param serviceString Comma-separated list of services + * @returns Array of services + */ +const parseServices = (serviceString: string): string[] => { + return serviceString.split(',').map((service) => service.trim()); +}; + +// Check if the docker folder exists +checkDockerFolder(); + +// Commands + +program + .name('Hexabot') + .description('A CLI to manage your Hexabot chatbot instance') + .version('1.0.0'); + +program + .command('start') + .description('Start specified services with Docker Compose') + .option( + '--enable ', + 'Comma-separated list of services to enable', + '', + ) + .action((options) => { + const services = parseServices(options.enable); + const composeArgs = generateComposeFiles(services); + dockerCompose(`${composeArgs} up -d`); + }); + +program + .command('dev') + .description( + 'Start specified services in development mode with Docker Compose', + ) + .option( + '--enable ', + 'Comma-separated list of services to enable', + '', + ) + .action((options) => { + const services = parseServices(options.enable); + const composeArgs = generateComposeFiles(services, 'dev'); + dockerCompose(`${composeArgs} up --build -d`); + }); + +program + .command('start-prod') + .description( + 'Start specified services in production mode with Docker Compose', + ) + .option( + '--enable ', + 'Comma-separated list of services to enable', + '', + ) + .action((options) => { + const services = parseServices(options.enable); + const composeArgs = generateComposeFiles(services, 'prod'); + dockerCompose(`${composeArgs} up -d`); + }); + +program + .command('stop') + .description('Stop specified Docker Compose services') + .option('--enable ', 'Comma-separated list of services to stop', '') + .action((options) => { + const services = parseServices(options.enable); + const composeArgs = generateComposeFiles(services); + dockerCompose(`${composeArgs} down`); + }); + +program + .command('destroy') + .description('Destroy specified Docker Compose services and remove volumes') + .option( + '--enable ', + 'Comma-separated list of services to destroy', + '', + ) + .action((options) => { + const services = parseServices(options.enable); + const composeArgs = generateComposeFiles(services); + dockerCompose(`${composeArgs} down -v`); + }); + +// Parse arguments +program.parse(process.argv); + +// If no command is provided, display help +if (!process.argv.slice(2).length) { + program.outputHelp(); +} diff --git a/cli/tsconfig.json b/cli/tsconfig.json new file mode 100644 index 00000000..c1fdad41 --- /dev/null +++ b/cli/tsconfig.json @@ -0,0 +1,15 @@ +{ + "compilerOptions": { + "target": "ES2020", + "module": "ES2020", // Change to ES2020 or ESNext + "moduleResolution": "node", // Ensure module resolution is node + "rootDir": "./src", + "outDir": "./dist", + "strict": true, + "esModuleInterop": true, + "forceConsistentCasingInFileNames": true, + "skipLibCheck": true + }, + "include": ["src"], + "exclude": ["node_modules", "dist"] +}