product-discovery-cli 0.0.1 → 0.0.3

package/README.md

@@ -0,0 +1,236 @@
+# Product Discovery CLI
+
+[![npm version](https://img.shields.io/npm/v/product-discovery-cli.svg)](https://www.npmjs.com/package/product-discovery-cli)
+[![License](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](LICENSE)
+[![Node.js Version](https://img.shields.io/badge/node-%3E%3D20-brightgreen.svg)](https://nodejs.org)
+
+A professional command-line interface to interact with the Product Discovery Agent API. Generate structured product discoveries powered by AI using an intuitive and colorful CLI experience.
+
+## ✨ Features
+
+- 🌐 **Internationalization**: Support for Portuguese (pt-br) and English (en-us)
+- 🎨 **Professional UX**: Colorful output, interactive prompts, and loading spinners
+- 🏗️ **Clean Architecture**: Built with SOLID principles and layered architecture
+- 💾 **Auto-save**: Optional automatic JSON result saving
+- 🔄 **Iterative Improvement**: Refine discoveries with additional context
+- ⚙️ **Configurable**: CLI flags, config files, and environment variables
+- ✅ **Well-tested**: Comprehensive unit tests with 90%+ coverage
+- 📦 **Easy to install**: Available as a global npm package
+
+## 📦 Installation
+
+### Global Installation (Recommended)
+
+```bash
+npm install -g product-discovery-cli
+```
+
+### Local Installation
+
+```bash
+npm install product-discovery-cli
+```
+
+## 🚀 Quick Start
+
+After global installation, simply run:
+
+```bash
+product-discovery
+```
+
+The CLI will guide you through an interactive flow to generate product discoveries.
+
+## 📖 Usage
+
+### Basic Usage
+
+```bash
+# Run with default settings (Portuguese)
+product-discovery
+
+# Run in English
+product-discovery --lang en-us
+
+# Specify API URL
+product-discovery --api-url http://localhost:3000/api/v1/discovery
+
+# Auto-save results without prompting
+product-discovery --save --output ./results
+```
+
+### CLI Options
+
+| Option | Alias | Description | Default |
+|--------|-------|-------------|---------|
+| `--api-url <url>` | `-u` | API endpoint URL | `http://localhost:3000/api/v1/discovery` |
+| `--lang <code>` | `-l` | Language (pt-br, en-us) | `pt-br` |
+| `--config <path>` | `-c` | Path to JSON config file | - |
+| `--save` | `-s` | Auto-save without prompting | `false` |
+| `--output <dir>` | `-o` | Default output directory | - |
+| `--file <name>` | `-f` | Default output filename | - |
+| `--no-save` | - | Disable saving prompt | - |
+
+### Configuration File
+
+Create a JSON configuration file to set default options:
+
+```json
+{
+  "apiUrl": "http://localhost:3000/api/v1/discovery",
+  "lang": "en-us",
+  "autoSave": true,
+  "defaultOutputDir": "./discoveries",
+  "defaultFileName": "discovery.json"
+}
+```
+
+Use it with:
+
+```bash
+product-discovery --config ./config.json
+```
+
+### Environment Variables
+
+Set environment variables for configuration:
+
+```bash
+export PRODUCT_DISCOVERY_API_URL=http://localhost:3000/api/v1/discovery
+product-discovery
+```
+
+## 🌍 Internationalization
+
+The CLI supports multiple languages:
+
+- **Portuguese (pt-br)**: Default language
+- **English (en-us)**: Full translation of all messages
+
+Switch languages using the `--lang` flag:
+
+```bash
+product-discovery --lang en-us
+```
+
+## 🏗️ Architecture
+
+This project follows **Clean Architecture** principles with clear separation of concerns:
+
+```
+src/
+├── application/       # Use cases and business logic
+├── domain/           # Domain entities and utilities
+├── infrastructure/   # External dependencies (API, storage, i18n)
+├── presentation/     # CLI controllers and routes
+└── config/          # Configuration and CLI options
+```
+
+### Key Principles
+
+- **SOLID**: Single Responsibility, Open/Closed, Dependency Inversion
+- **Dependency Injection**: All dependencies injected via constructors
+- **Testability**: Easy to mock and test each layer independently
+
+## 🛠️ Development
+
+### Prerequisites
+
+- Node.js >= 20
+
+### Setup
+
+```bash
+# Clone the repository
+git clone https://github.com/AuronForge/product-discovery-cli.git
+cd product-discovery-cli
+
+# Install dependencies
+npm install
+
+# Run locally
+npm start
+
+# Run tests
+npm test
+
+# Run tests with coverage
+npm run test:coverage
+```
+
+### Testing
+
+The project includes comprehensive unit tests with Jest:
+
+```bash
+# Run all tests
+npm test
+
+# Run with coverage report
+npm run test:coverage
+```
+
+Coverage thresholds are set to 90% for all metrics.
+
+## 📝 Interactive Flow
+
+The CLI guides you through an intuitive workflow:
+
+1. **Welcome**: Display branded banner with metadata
+2. **Input**: Describe your idea/problem/application
+3. **Processing**: Call the Product Discovery API
+4. **Results**: View the generated JSON discovery
+5. **Save**: Optionally save results to a file
+6. **Improve**: Refine with additional context (optional)
+7. **Repeat**: Run discovery for another idea (optional)
+
+## 🎨 Output Example
+
+```
+   ╭────────────────────────────────────────────────────────────────────╮
+   │                                                                    │
+   │    ____                _            _     ____  _                  │
+   │   |  _ \ _ __ ___   __| |_   _  ___| |_  |  _ \(_)___  ___ ___    │
+   │   | |_) | '__/ _ \ / _ | | | |/ __| __| | | | | / __|/ __/ _ \   │
+   │   |  __/| | | (_) | (_| | |_| | (__| |_  | |_| | \__ \ (_| (_) |  │
+   │   |_|   |_|  \___/ \__,_|\__,_|\___|\__| |____/|_|___/\___\___/   │
+   │                                                                    │
+   │   Product Discovery CLI                                            │
+   │   Generate a structured product discovery via the API.             │
+   │                                                                    │
+   │   Author: AuronForge                                               │
+   │   Version: 0.0.2                                                   │
+   │   License: Apache-2.0                                              │
+   │                                                                    │
+   ╰────────────────────────────────────────────────────────────────────╯
+```
+
+## 📄 License
+
+This project is licensed under the Apache-2.0 License.
+
+## 👤 Author
+
+**José Eduardo Trindade E Marques**
+
+- Company: AuronForge 🚀
+- Email: edu.temarques@gmail.com
+- LinkedIn: [linkedin.com/in/edu-marques29](https://linkedin.com/in/edu-marques29)
+
+## 🤝 Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+## 🐛 Issues
+
+Found a bug or have a suggestion? Please open an issue on [GitHub](https://github.com/AuronForge/product-discovery-cli/issues).
+
+## 🔗 Links
+
+- [npm Package](https://www.npmjs.com/package/product-discovery-cli)
+- [GitHub Repository](https://github.com/AuronForge/product-discovery-cli)
+- [Product Discovery Agent API](https://github.com/AuronForge/product-discovery-agent)
+
+---
+
+Made with ❤️ by AuronForge

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "product-discovery-cli",
-  "version": "0.0.1",
+  "version": "0.0.3",
   "description": "CLI to consume the Product Discovery Agent API",
   "license": "Apache-2.0",
   "author": "AuronForge",

package/src/application/RunDiscoveryFlow.js

@@ -8,7 +8,8 @@ class RunDiscoveryFlow {
     this.presenter = presenter;
   }
 
-  async execute({ apiUrl, saveDefaults }) {
+  async execute({ apiUrl, lang, saveDefaults, i18n }) {
+    this.i18n = i18n;
     this.presenter.printHeader();
 
     let continueOuter = true;
@@ -18,22 +19,23 @@ class RunDiscoveryFlow {
       let shouldImprove = true;
 
       while (shouldImprove) {
-        this.presenter.info("What do you want to run discovery for?");
-        const idea = await this.prompt.askInput("Describe your idea/problem/application/pain:", {
-          required: true
+        this.presenter.info(this.i18n.t("askIdea"));
+        const idea = await this.prompt.askInput(this.i18n.t("describeIdea"), {
+          required: true,
+          requiredMessage: this.i18n.t("required")
         });
 
         const attemptText = session.addIdea(idea);
 
-        const spinner = this.presenter.spinner("Calling the discovery API...");
+        const spinner = this.presenter.spinner(this.i18n.t("callingApi"));
         let result;
         try {
-          result = await this.apiClient.runDiscovery(attemptText, apiUrl);
-          spinner.succeed("Discovery completed.");
+          result = await this.apiClient.runDiscovery(attemptText, apiUrl, lang);
+          spinner.succeed(this.i18n.t("discoveryCompleted"));
         } catch (error) {
-          spinner.fail("Discovery failed.");
+          spinner.fail(this.i18n.t("discoveryFailed"));
           this.presenter.error(error.message);
-          const retry = await this.prompt.askYesNo("Do you want to try again?");
+          const retry = await this.prompt.askYesNo(this.i18n.t("askRetry"));
           if (!retry) {
             return;
           }
@@ -43,7 +45,7 @@ class RunDiscoveryFlow {
         this.presenter.json(result);
 
         if (saveDefaults.autoSave === false) {
-          const improve = await this.prompt.askYesNo("Do you want to improve the result?");
+          const improve = await this.prompt.askYesNo(this.i18n.t("askImprove"));
           if (!improve) {
             shouldImprove = false;
             continueOuter = false;
@@ -54,12 +56,12 @@ class RunDiscoveryFlow {
 
         const saveInfo = await this.storage.saveJson(result, saveDefaults);
         if (saveInfo.saved) {
-          this.presenter.success(`Saved to: ${saveInfo.fullPath}`);
+          this.presenter.success(`${this.i18n.t("savedTo")} ${saveInfo.fullPath}`);
           shouldImprove = false;
           continue;
         }
 
-        const improve = await this.prompt.askYesNo("Do you want to improve the result?");
+        const improve = await this.prompt.askYesNo(this.i18n.t("askImprove"));
         if (!improve) {
           shouldImprove = false;
           continueOuter = false;
@@ -71,7 +73,7 @@ class RunDiscoveryFlow {
         break;
       }
 
-      const another = await this.prompt.askYesNo("Do you want to run discovery for another idea?");
+      const another = await this.prompt.askYesNo(this.i18n.t("askAnother"));
       if (!another) {
         continueOuter = false;
       }

package/src/config/cliOptions.js

@@ -1,19 +1,26 @@
 const { Command } = require("commander");
+const { getTranslator } = require("../infrastructure/i18n");
 
 function buildOptions(defaultApiUrl) {
   const program = new Command();
-  program
+  program.parse(process.argv);
+  const preOpts = program.opts();
+  const i18n = getTranslator(preOpts.lang || "pt-br");
+  
+  const programWithDesc = new Command();
+  programWithDesc
     .name("product-discovery")
-    .description("Generate a structured product discovery using the Product Discovery Agent API")
-    .option("-u, --api-url <url>", "API URL", defaultApiUrl)
-    .option("-c, --config <path>", "Path to JSON config file")
-    .option("-s, --save", "Auto-save the JSON result without prompting")
-    .option("-o, --output <dir>", "Default output directory")
-    .option("-f, --file <name>", "Default output filename")
-    .option("--no-save", "Disable saving prompt");
+    .description(i18n.t("cliDescription"))
+    .option("-u, --api-url <url>", i18n.t("optApiUrl"), defaultApiUrl)
+    .option("-l, --lang <language>", i18n.t("optLang"), "pt-br")
+    .option("-c, --config <path>", i18n.t("optConfig"))
+    .option("-s, --save", i18n.t("optSave"))
+    .option("-o, --output <dir>", i18n.t("optOutput"))
+    .option("-f, --file <name>", i18n.t("optFile"))
+    .option("--no-save", i18n.t("optNoSave"));
 
-  program.parse(process.argv);
-  return program.opts();
+  programWithDesc.parse(process.argv);
+  return programWithDesc.opts();
 }
 
 module.exports = { buildOptions };

package/src/infrastructure/ConsolePresenter.js

@@ -2,9 +2,15 @@ const { stdout: output } = require("node:process");
 const chalk = require("chalk");
 const boxen = require("boxen");
 const ora = require("ora");
+const pkg = require("../../package.json");
 
 class ConsolePresenter {
+  constructor(i18n = null) {
+    this.i18n = i18n;
+  }
+
   printHeader() {
+    if (!this.i18n) return;
     const logo = chalk.cyan(
       String.raw`
  ____                _            _     ____  _                               
@@ -14,9 +20,12 @@ class ConsolePresenter {
 |_|   |_|  \___/ \__,_|\__,_|\___|\__| |____/|_|___/\___\___/ \_/ \___|_|   
 `
     );
-    const title = chalk.bold.cyan("Product Discovery CLI");
-    const subtitle = chalk.gray("Generate a structured product discovery via the Product Discovery Agent API.");
-    const banner = `${logo}\n${title}\n${subtitle}`;
+    const title = chalk.bold.cyan(this.i18n.t("headerTitle"));
+    const subtitle = chalk.gray(this.i18n.t("headerSubtitle"));
+    const author = chalk.gray(`${this.i18n.t("headerAuthor")}: ${pkg.author}`);
+    const version = chalk.gray(`${this.i18n.t("headerVersion")}: ${pkg.version}`);
+    const license = chalk.gray(`${this.i18n.t("headerLicense")}: ${pkg.license}`);
+    const banner = `${logo}\n${title}\n${subtitle}\n\n${author}\n${version}\n${license}`;
     output.write(
       boxen(banner, {
         padding: 1,
@@ -37,11 +46,11 @@ class ConsolePresenter {
   }
 
   error(message) {
-    output.write(`${chalk.red("Error:")} ${message}\n\n`);
+    output.write(`${chalk.red(this.i18n.t("error"))} ${message}\n\n`);
   }
 
   json(payload) {
-    output.write(`\n${chalk.bold("Generated discovery JSON:")}\n\n`);
+    output.write(`\n${chalk.bold(this.i18n.t("generatedDiscovery"))}\n\n`);
     output.write(`${chalk.gray(JSON.stringify(payload, null, 2))}\n\n`);
   }
 

package/src/infrastructure/ProductDiscoveryApi.js

@@ -1,9 +1,9 @@
 class ProductDiscoveryApi {
-  async runDiscovery(problemText, apiUrl) {
+  async runDiscovery(problemText, apiUrl, lang = "pt-br") {
     const response = await fetch(apiUrl, {
       method: "POST",
       headers: { "Content-Type": "application/json" },
-      body: JSON.stringify({ problem: problemText })
+      body: JSON.stringify({ problem: problemText, lang })
     });
 
     const text = await response.text();

package/src/infrastructure/PromptService.js

@@ -13,14 +13,14 @@ class PromptService {
     return answer;
   }
 
-  async askInput(message, { required = false } = {}) {
+  async askInput(message, { required = false, requiredMessage = "This field is required." } = {}) {
     const { answer } = await inquirer.prompt([
       {
         type: "input",
         name: "answer",
         message,
         validate: required
-          ? (value) => (value && value.trim() ? true : "This field is required.")
+          ? (value) => (value && value.trim() ? true : requiredMessage)
           : () => true
       }
     ]);

package/src/infrastructure/i18n.js

@@ -0,0 +1,93 @@
+const translations = {
+  "pt-br": {
+    // CLI Options
+    cliDescription: "Gerar uma descoberta de produto estruturada usando a API do Product Discovery Agent",
+    optApiUrl: "URL da API",
+    optLang: "Código do idioma (pt-br, en-us)",
+    optConfig: "Caminho para o arquivo de configuração JSON",
+    optSave: "Salvar automaticamente o resultado JSON sem perguntar",
+    optOutput: "Diretório de saída padrão",
+    optFile: "Nome do arquivo de saída padrão",
+    optNoSave: "Desabilitar prompt de salvamento",
+    
+    // Header
+    headerTitle: "Product Discovery CLI",
+    headerSubtitle: "Gerar uma descoberta de produto estruturada via API do Product Discovery Agent.",
+    headerAuthor: "Autor",
+    headerVersion: "Versão",
+    headerLicense: "Licença",
+    
+    // ConsolePresenter
+    generatedDiscovery: "Discovery JSON gerado:",
+    error: "Erro:",
+    
+    // RunDiscoveryFlow
+    askIdea: "O que você quer descobrir?",
+    describeIdea: "Descreva sua ideia/problema/aplicação/dor:",
+    callingApi: "Chamando a API de discovery...",
+    discoveryCompleted: "Discovery completado.",
+    discoveryFailed: "Discovery falhou.",
+    askRetry: "Você quer tentar novamente?",
+    askImprove: "Você quer melhorar o resultado?",
+    savedTo: "Salvo em:",
+    askAnother: "Você quer rodar discovery para outra ideia?",
+    
+    // CliController
+    configError: "Erro no config:",
+    
+    // Validation
+    required: "Este campo é obrigatório"
+  },
+  
+  "en-us": {
+    // CLI Options
+    cliDescription: "Generate a structured product discovery using the Product Discovery Agent API",
+    optApiUrl: "API URL",
+    optLang: "Language code (pt-br, en-us)",
+    optConfig: "Path to JSON config file",
+    optSave: "Auto-save the JSON result without prompting",
+    optOutput: "Default output directory",
+    optFile: "Default output filename",
+    optNoSave: "Disable saving prompt",
+    
+    // Header
+    headerTitle: "Product Discovery CLI",
+    headerSubtitle: "Generate a structured product discovery via the Product Discovery Agent API.",
+    headerAuthor: "Author",
+    headerVersion: "Version",
+    headerLicense: "License",
+    
+    // ConsolePresenter
+    generatedDiscovery: "Generated discovery JSON:",
+    error: "Error:",
+    
+    // RunDiscoveryFlow
+    askIdea: "What do you want to run discovery for?",
+    describeIdea: "Describe your idea/problem/application/pain:",
+    callingApi: "Calling the discovery API...",
+    discoveryCompleted: "Discovery completed.",
+    discoveryFailed: "Discovery failed.",
+    askRetry: "Do you want to try again?",
+    askImprove: "Do you want to improve the result?",
+    savedTo: "Saved to:",
+    askAnother: "Do you want to run discovery for another idea?",
+    
+    // CliController
+    configError: "Config error:",
+    
+    // Validation
+    required: "This field is required"
+  }
+};
+
+function getTranslator(lang = "pt-br") {
+  const normalizedLang = lang.toLowerCase();
+  const texts = translations[normalizedLang] || translations["pt-br"];
+  
+  return {
+    t: (key) => texts[key] || key,
+    lang: normalizedLang
+  };
+}
+
+module.exports = { getTranslator };

package/src/presentation/CliController.js

@@ -1,5 +1,6 @@
 const { buildOptions } = require("../config/cliOptions");
 const { ConfigLoader } = require("../infrastructure/ConfigLoader");
+const { getTranslator } = require("../infrastructure/i18n");
 
 class CliController {
   constructor({ defaultApiUrl, prompt, presenter, apiClient, storage, useCase }) {
@@ -13,11 +14,17 @@ class CliController {
 
   async start() {
     const cliOptions = buildOptions(this.defaultApiUrl);
+    const lang = cliOptions.lang || "pt-br";
+    const i18n = getTranslator(lang);
+    
+    // Update presenter with i18n
+    this.presenter.i18n = i18n;
+    
     let config = {};
     try {
       config = new ConfigLoader().load(cliOptions.config);
     } catch (error) {
-      this.presenter.error(`Config error: ${error.message}`);
+      this.presenter.error(`${i18n.t("configError")} ${error.message}`);
       return;
     }
 
@@ -31,7 +38,7 @@ class CliController {
       prompt: this.prompt
     };
 
-    await this.useCase.execute({ apiUrl, saveDefaults });
+    await this.useCase.execute({ apiUrl, lang, saveDefaults, i18n });
   }
 }