plazbot-cli 0.2.25 → 0.3.1

package/src/commands/workers/deploy.ts

@@ -1,18 +1,19 @@
 import { Command } from 'commander';
 import fs from 'fs/promises';
 import path from 'path';
-import { getStoredCredentials } from '../../utils/credentials';
-import { createApiClient } from '../../utils/api';
-import { logger } from '../../utils/logger';
-import { createSpinner, createTable, theme } from '../../utils/ui';
-import { WorkerDeployOptions, WorkerDeployResult } from '../../types/workers';
+import { getStoredCredentials } from '../../utils/credentials.js';
+import { createApiClient } from '../../utils/api.js';
+import { logger } from '../../utils/logger.js';
+import { addExamples } from '../../utils/help.js';
+import { createSpinner, createTable, theme } from '../../utils/ui.js';
+import { WorkerDeployOptions, WorkerDeployResult } from '../../types/workers.js';
 
 export const deployCommand = new Command('deploy')
-  .description('Despliega un worker al workspace de Plazbot')
-  .argument('[file]', 'Archivo TypeScript del worker (ej: ./workers/mi-tool.ts)')
-  .option('-n, --name <name>', 'Nombre del worker (sobreescribe el del archivo)')
-  .option('-d, --description <desc>', 'Descripcion del worker')
-  .option('--dev', 'Usar ambiente de desarrollo', false)
+  .description('Deploy a worker to the Plazbot workspace')
+  .argument('[file]', 'Worker TypeScript file (e.g.: ./workers/my-tool.ts)')
+  .option('-n, --name <name>', 'Worker name (overrides the one in the file)')
+  .option('-d, --description <desc>', 'Worker description')
+  .option('--dev', 'Use development environment', false)
   .action(async (file: string | undefined, options: WorkerDeployOptions) => {
     try {
       const credentials = await getStoredCredentials();
@@ -21,9 +22,9 @@ export const deployCommand = new Command('deploy')
       const files = await resolveWorkerFiles(file);
 
       if (files.length === 0) {
-        logger.error('No se encontraron archivos de workers para desplegar');
-        logger.dim('Uso: plazbot workers deploy ./workers/mi-tool.ts');
-        logger.dim('  o: plazbot workers deploy (busca en ./workers/ automaticamente)');
+        logger.error('No worker files found to deploy');
+        logger.dim('Usage: plazbot workers deploy ./workers/my-tool.ts');
+        logger.dim('   or: plazbot workers deploy (searches ./workers/ automatically)');
         process.exit(1);
       }
 
@@ -34,14 +35,14 @@ export const deployCommand = new Command('deploy')
         dev: options.dev,
       });
 
-      logger.title(`Desplegando ${files.length} worker${files.length > 1 ? 's' : ''}`);
+      logger.title(`Deploying ${files.length} worker${files.length > 1 ? 's' : ''}`);
       console.log();
 
       const results: { file: string; result?: WorkerDeployResult; error?: string }[] = [];
 
       for (const filePath of files) {
         const fileName = path.basename(filePath);
-        const spinner = createSpinner(`Desplegando ${fileName}...`);
+        const spinner = createSpinner(`Deploying ${fileName}...`);
         spinner.start();
 
         try {
@@ -61,7 +62,7 @@ export const deployCommand = new Command('deploy')
           results.push({ file: fileName, result: data });
 
         } catch (error: any) {
-          const msg = error.response?.data?.message || error.message || 'Error desconocido';
+          const msg = error.response?.data?.message || error.message || 'Unknown error';
           spinner.fail(`${fileName}: ${msg}`);
           results.push({ file: fileName, error: msg });
         }
@@ -73,7 +74,7 @@ export const deployCommand = new Command('deploy')
       const failed = results.filter(r => r.error);
 
       if (success.length > 0) {
-        logger.success(`${success.length} worker${success.length > 1 ? 's' : ''} desplegado${success.length > 1 ? 's' : ''}`);
+        logger.success(`${success.length} worker${success.length > 1 ? 's' : ''} deployed`);
 
         const rows = success.map(r => [
           r.result!.name,
@@ -83,13 +84,13 @@ export const deployCommand = new Command('deploy')
         ]);
 
         console.log(createTable(
-          ['Nombre', 'Tipo', 'Estado', 'URL/Cron'],
+          ['Name', 'Type', 'Status', 'URL/Cron'],
           rows,
         ));
       }
 
       if (failed.length > 0) {
-        logger.warning(`${failed.length} worker${failed.length > 1 ? 's' : ''} fallaron`);
+        logger.warning(`${failed.length} worker${failed.length > 1 ? 's' : ''} failed`);
         failed.forEach(f => logger.dim(`  ${f.file}: ${f.error}`));
       }
 
@@ -106,16 +107,27 @@ export const deployCommand = new Command('deploy')
       console.log();
 
       if (options.dev) {
-        logger.warning('Ambiente: desarrollo');
+        logger.warning('Environment: development');
       }
 
     } catch (error) {
-      const message = error instanceof Error ? error.message : 'Error desconocido';
+      const message = error instanceof Error ? error.message : 'Unknown error';
       logger.error(message);
       process.exit(1);
     }
   });
 
+addExamples(deployCommand, [
+  { description: 'Deploy a single worker file',
+    command: 'plazbot workers deploy ./workers/my-tool.ts' },
+  { description: 'Deploy every TypeScript file inside ./workers automatically',
+    command: 'plazbot workers deploy' },
+  { description: 'Deploy with a custom name and description',
+    command: 'plazbot workers deploy ./workers/cron.ts -n "Daily Report" -d "Generates daily KPIs"' },
+  { description: 'Deploy against the local backend',
+    command: 'plazbot workers deploy ./workers/test.ts --dev' },
+]);
+
 // Resuelve los archivos a desplegar
 async function resolveWorkerFiles(file?: string): Promise<string[]> {
   if (file) {
@@ -125,7 +137,7 @@ async function resolveWorkerFiles(file?: string): Promise<string[]> {
       await fs.access(resolved);
       return [resolved];
     } catch {
-      throw new Error(`Archivo no encontrado: ${file}`);
+      throw new Error(`File not found: ${file}`);
     }
   }
 

package/src/commands/workers/index.ts

@@ -1,16 +1,30 @@
 import { Command } from 'commander';
-import { deployCommand } from './deploy';
-import { listCommand } from './list';
-import { logsCommand } from './logs';
-import { removeCommand } from './remove';
-import { secretCommand } from './secret';
-import { testCommand } from './test';
+import { addExamples } from '../../utils/help.js';
+import { deployCommand } from './deploy.js';
+import { listCommand } from './list.js';
+import { logsCommand } from './logs.js';
+import { removeCommand } from './remove.js';
+import { secretCommand } from './secret.js';
+import { testCommand } from './test.js';
 
 export const workersCommands = new Command('workers')
-  .description('Comandos para gestionar workers (tools, syncs, schedules, webhooks)')
+  .description('Commands to manage workers (tools, syncs, schedules, webhooks)')
   .addCommand(deployCommand)
   .addCommand(listCommand)
   .addCommand(logsCommand)
   .addCommand(removeCommand)
   .addCommand(secretCommand)
   .addCommand(testCommand);
+
+addExamples(workersCommands, [
+  { description: 'Deploy every worker file in ./workers automatically',
+    command: 'plazbot workers deploy' },
+  { description: 'List active workers',
+    command: 'plazbot workers list -s active' },
+  { description: 'Run a worker with a JSON payload',
+    command: 'plazbot workers test my-tool -p \'{"product":"iPhone 15"}\'' },
+  { description: 'Save a secret for workers (plz.env.KEY)',
+    command: 'plazbot workers secret set STRIPE_API_KEY sk_live_xxxxx' },
+  { description: 'View the last 100 executions of a worker',
+    command: 'plazbot workers logs my-tool -l 100' },
+]);

package/src/commands/workers/list.ts

@@ -1,15 +1,16 @@
 import { Command } from 'commander';
-import { getStoredCredentials } from '../../utils/credentials';
-import { createApiClient } from '../../utils/api';
-import { logger } from '../../utils/logger';
-import { createSpinner, createTable, theme, statusBadge, formatDate } from '../../utils/ui';
-import { WorkerListOptions, WorkerListItem } from '../../types/workers';
+import { getStoredCredentials } from '../../utils/credentials.js';
+import { createApiClient } from '../../utils/api.js';
+import { logger } from '../../utils/logger.js';
+import { addExamples } from '../../utils/help.js';
+import { createSpinner, createTable, theme, statusBadge, formatDate } from '../../utils/ui.js';
+import { WorkerListOptions, WorkerListItem } from '../../types/workers.js';
 
 export const listCommand = new Command('list')
-  .description('Lista todos los workers del workspace')
-  .option('-t, --type <type>', 'Filtrar por tipo (tool, worker, sync, schedule, webhook)')
-  .option('-s, --status <status>', 'Filtrar por estado (active, inactive, error)')
-  .option('--dev', 'Usar ambiente de desarrollo', false)
+  .description('List all workers in the workspace')
+  .option('-t, --type <type>', 'Filter by type (tool, worker, sync, schedule, webhook)')
+  .option('-s, --status <status>', 'Filter by status (active, inactive, error)')
+  .option('--dev', 'Use development environment', false)
   .action(async (options: WorkerListOptions) => {
     try {
       const credentials = await getStoredCredentials();
@@ -20,7 +21,7 @@ export const listCommand = new Command('list')
         dev: options.dev,
       });
 
-      const spinner = createSpinner('Obteniendo workers...');
+      const spinner = createSpinner('Fetching workers...');
       spinner.start();
 
       const params: Record<string, string> = {};
@@ -33,8 +34,8 @@ export const listCommand = new Command('list')
       spinner.stop();
 
       if (!workers || workers.length === 0) {
-        logger.info('\n  No se encontraron workers en este workspace');
-        logger.dim('  Despliega tu primer worker: plazbot workers deploy ./workers/mi-tool.ts');
+        logger.info('\n  No workers found in this workspace');
+        logger.dim('  Deploy your first worker: plazbot workers deploy ./workers/my-tool.ts');
         console.log();
         return;
       }
@@ -44,9 +45,9 @@ export const listCommand = new Command('list')
       const rows = workers.map(w => [
         w.name,
         typeLabel(w.type),
-        w.status === 'active' ? theme.success('activo')
+        w.status === 'active' ? theme.success('active')
           : w.status === 'error' ? theme.error('error')
-          : theme.muted('inactivo'),
+          : theme.muted('inactive'),
         `${w.executionCount}`,
         w.errorCount > 0 ? theme.error(`${w.errorCount}`) : theme.muted('0'),
         w.avgDurationMs > 0 ? `${w.avgDurationMs}ms` : '—',
@@ -54,7 +55,7 @@ export const listCommand = new Command('list')
       ]);
 
       console.log(createTable(
-        ['Nombre', 'Tipo', 'Estado', 'Ejecuciones', 'Errores', 'Duracion', 'Ultima ejecucion'],
+        ['Name', 'Type', 'Status', 'Executions', 'Errors', 'Duration', 'Last execution'],
         rows,
       ));
 
@@ -62,25 +63,36 @@ export const listCommand = new Command('list')
       const errored = workers.filter(w => w.status === 'error');
       if (errored.length > 0) {
         console.log();
-        logger.warning('Workers con error:');
+        logger.warning('Workers with errors:');
         errored.forEach(w => {
-          logger.dim(`  ${w.name}: ${w.lastError || 'sin detalles'}`);
+          logger.dim(`  ${w.name}: ${w.lastError || 'no details'}`);
         });
       }
 
       console.log();
 
       if (options.dev) {
-        logger.warning('Ambiente: desarrollo');
+        logger.warning('Environment: development');
       }
 
     } catch (error) {
-      const message = error instanceof Error ? error.message : 'Error desconocido';
+      const message = error instanceof Error ? error.message : 'Unknown error';
       logger.error(message);
       process.exit(1);
     }
   });
 
+addExamples(listCommand, [
+  { description: 'List every worker in the workspace',
+    command: 'plazbot workers list' },
+  { description: 'Only show schedules',
+    command: 'plazbot workers list -t schedule' },
+  { description: 'Show only workers with errors',
+    command: 'plazbot workers list -s error' },
+  { description: 'Filter active webhooks',
+    command: 'plazbot workers list -t webhook -s active' },
+]);
+
 function typeLabel(type: string): string {
   const labels: Record<string, string> = {
     tool: theme.secondary('tool'),

package/src/commands/workers/logs.ts

@@ -1,16 +1,17 @@
 import { Command } from 'commander';
-import { getStoredCredentials } from '../../utils/credentials';
-import { createApiClient } from '../../utils/api';
-import { logger } from '../../utils/logger';
-import { createSpinner, createTable, theme, formatDate } from '../../utils/ui';
-import { WorkerLogsOptions, WorkerLogItem } from '../../types/workers';
+import { getStoredCredentials } from '../../utils/credentials.js';
+import { createApiClient } from '../../utils/api.js';
+import { logger } from '../../utils/logger.js';
+import { addExamples } from '../../utils/help.js';
+import { createSpinner, createTable, theme, formatDate } from '../../utils/ui.js';
+import { WorkerLogsOptions, WorkerLogItem } from '../../types/workers.js';
 
 export const logsCommand = new Command('logs')
-  .description('Ver logs de ejecucion de un worker')
-  .argument('<name>', 'Nombre del worker')
-  .option('-l, --limit <number>', 'Numero de logs a mostrar', '20')
-  .option('-s, --status <status>', 'Filtrar por estado (success, error, timeout)')
-  .option('--dev', 'Usar ambiente de desarrollo', false)
+  .description('View execution logs for a worker')
+  .argument('<name>', 'Worker name')
+  .option('-l, --limit <number>', 'Number of logs to display', '20')
+  .option('-s, --status <status>', 'Filter by status (success, error, timeout)')
+  .option('--dev', 'Use development environment', false)
   .action(async (name: string, options: WorkerLogsOptions) => {
     try {
       const credentials = await getStoredCredentials();
@@ -21,7 +22,7 @@ export const logsCommand = new Command('logs')
         dev: options.dev,
       });
 
-      const spinner = createSpinner(`Obteniendo logs de "${name}"...`);
+      const spinner = createSpinner(`Fetching logs for "${name}"...`);
       spinner.start();
 
       const params: Record<string, string> = {
@@ -35,12 +36,12 @@ export const logsCommand = new Command('logs')
       spinner.stop();
 
       if (!logs || logs.length === 0) {
-        logger.info(`\n  No se encontraron logs para "${name}"`);
+        logger.info(`\n  No logs found for "${name}"`);
         console.log();
         return;
       }
 
-      logger.title(`Logs de "${name}" (${logs.length})`);
+      logger.title(`Logs for "${name}" (${logs.length})`);
 
       const rows = logs.map(log => [
         formatDate(log.createdAt),
@@ -53,7 +54,7 @@ export const logsCommand = new Command('logs')
       ]);
 
       console.log(createTable(
-        ['Fecha', 'Estado', 'Duracion', 'Origen', 'Error'],
+        ['Date', 'Status', 'Duration', 'Source', 'Error'],
         rows,
       ));
 
@@ -63,26 +64,35 @@ export const logsCommand = new Command('logs')
       const avgDuration = Math.round(logs.reduce((sum, l) => sum + l.durationMs, 0) / logs.length);
 
       console.log();
-      logger.label('Exitosos', theme.success(`${successCount}`));
-      logger.label('Errores', errorCount > 0 ? theme.error(`${errorCount}`) : theme.muted('0'));
-      logger.label('Duracion promedio', `${avgDuration}ms`);
+      logger.label('Successful', theme.success(`${successCount}`));
+      logger.label('Errors', errorCount > 0 ? theme.error(`${errorCount}`) : theme.muted('0'));
+      logger.label('Average duration', `${avgDuration}ms`);
       console.log();
 
       if (options.dev) {
-        logger.warning('Ambiente: desarrollo');
+        logger.warning('Environment: development');
       }
 
     } catch (error: any) {
       if (error.response?.status === 404) {
-        logger.error(`Worker "${name}" no encontrado`);
+        logger.error(`Worker "${name}" not found`);
       } else {
-        const message = error instanceof Error ? error.message : 'Error desconocido';
+        const message = error instanceof Error ? error.message : 'Unknown error';
         logger.error(message);
       }
       process.exit(1);
     }
   });
 
+addExamples(logsCommand, [
+  { description: 'Show the last 20 executions of a worker',
+    command: 'plazbot workers logs my-tool' },
+  { description: 'Get the last 100 executions',
+    command: 'plazbot workers logs my-tool -l 100' },
+  { description: 'Only show failed executions',
+    command: 'plazbot workers logs my-tool -s error' },
+]);
+
 function truncate(text: string, max: number): string {
   if (text.length <= max) return text;
   return text.substring(0, max - 3) + '...';

package/src/commands/workers/remove.ts

@@ -1,16 +1,17 @@
 import { Command } from 'commander';
-import { getStoredCredentials } from '../../utils/credentials';
-import { createApiClient } from '../../utils/api';
-import { logger } from '../../utils/logger';
-import { createSpinner } from '../../utils/ui';
-import { WorkerRemoveOptions } from '../../types/workers';
+import { getStoredCredentials } from '../../utils/credentials.js';
+import { createApiClient } from '../../utils/api.js';
+import { logger } from '../../utils/logger.js';
+import { addExamples } from '../../utils/help.js';
+import { createSpinner } from '../../utils/ui.js';
+import { WorkerRemoveOptions } from '../../types/workers.js';
 import readline from 'readline';
 
 export const removeCommand = new Command('remove')
-  .description('Elimina un worker del workspace')
-  .argument('<name>', 'Nombre del worker a eliminar')
-  .option('-f, --force', 'Eliminar sin confirmacion', false)
-  .option('--dev', 'Usar ambiente de desarrollo', false)
+  .description('Delete a worker from the workspace')
+  .argument('<name>', 'Name of the worker to delete')
+  .option('-f, --force', 'Delete without confirmation', false)
+  .option('--dev', 'Use development environment', false)
   .action(async (name: string, options: WorkerRemoveOptions) => {
     try {
       const credentials = await getStoredCredentials();
@@ -22,7 +23,7 @@ export const removeCommand = new Command('remove')
       });
 
       // Verificar que el worker existe
-      const spinner = createSpinner(`Buscando worker "${name}"...`);
+      const spinner = createSpinner(`Looking up worker "${name}"...`);
       spinner.start();
 
       let workerInfo: any;
@@ -33,7 +34,7 @@ export const removeCommand = new Command('remove')
       } catch (error: any) {
         spinner.stop();
         if (error.response?.status === 404) {
-          logger.error(`Worker "${name}" no encontrado`);
+          logger.error(`Worker "${name}" not found`);
         } else {
           logger.error(error.response?.data?.message || error.message);
         }
@@ -41,45 +42,52 @@ export const removeCommand = new Command('remove')
       }
 
       // Mostrar info del worker
-      logger.warning(`\n  Vas a eliminar el siguiente worker:`);
+      logger.warning(`\n  You are about to delete the following worker:`);
       logger.divider();
-      logger.label('Nombre', workerInfo.name);
-      logger.label('Tipo', workerInfo.type);
-      logger.label('Estado', workerInfo.status);
-      logger.label('Ejecuciones', `${workerInfo.executionCount || 0}`);
+      logger.label('Name', workerInfo.name);
+      logger.label('Type', workerInfo.type);
+      logger.label('Status', workerInfo.status);
+      logger.label('Executions', `${workerInfo.executionCount || 0}`);
       logger.divider();
 
       // Confirmacion
       if (!options.force) {
         const confirmed = await askConfirmation(
-          `Eliminar worker "${name}"? Esta accion no se puede deshacer (y/N): `
+          `Delete worker "${name}"? This action cannot be undone (y/N): `
         );
 
         if (!confirmed) {
-          logger.info('\n  Operacion cancelada');
+          logger.info('\n  Operation cancelled');
           process.exit(0);
         }
       }
 
-      const deleteSpinner = createSpinner(`Eliminando "${name}"...`);
+      const deleteSpinner = createSpinner(`Deleting "${name}"...`);
       deleteSpinner.start();
 
       await api.delete(`/api/worker/${encodeURIComponent(name)}`);
 
-      deleteSpinner.succeed(`Worker "${name}" eliminado`);
+      deleteSpinner.succeed(`Worker "${name}" deleted`);
       console.log();
 
       if (options.dev) {
-        logger.warning('Ambiente: desarrollo');
+        logger.warning('Environment: development');
       }
 
     } catch (error) {
-      const message = error instanceof Error ? error.message : 'Error desconocido';
+      const message = error instanceof Error ? error.message : 'Unknown error';
       logger.error(message);
       process.exit(1);
     }
   });
 
+addExamples(removeCommand, [
+  { description: 'Delete a worker with confirmation prompt',
+    command: 'plazbot workers remove my-tool' },
+  { description: 'Delete without confirmation (scripts/CI)',
+    command: 'plazbot workers remove my-tool -f' },
+]);
+
 function askConfirmation(question: string): Promise<boolean> {
   return new Promise((resolve) => {
     const rl = readline.createInterface({