cdd-cli 3.0.0 → 3.0.1

package/LICENSE

@@ -0,0 +1,23 @@
+MIT License
+
+SPDX-License-Identifier: MIT
+
+Copyright (c) 2025 caertos
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -149,9 +149,18 @@ CDD-CLI es una herramienta de línea de comandos (CLI) multiplataforma que te pe
    ```
 
 ## Uso
-- Al ejecutar `cdd`, verás una tabla con todos tus contenedores Docker.
+- Al ejecutar `cdd`, verás una tabla interactiva con todos tus contenedores Docker.
 - Los contenedores en ejecución muestran estadísticas de CPU y memoria en tiempo real.
-- Usa `Ctrl+C` para salir.
+- Puedes navegar usando las flechas ↑/↓ y controlar los contenedores con atajos de teclado.
+- Usa `Ctrl+C` o la tecla `Q` para salir.
+
+### ⌨️ Atajos de teclado
+
+- ↑ / ↓ : Navegar entre contenedores
+- I : Iniciar el contenedor seleccionado
+- P : Parar el contenedor seleccionado
+- L : Ver logs en tiempo real del contenedor seleccionado
+- Q : Salir del dashboard o de la vista de logs
 
 ## Funcionalidades principales
 - 🐳 Visualización clara y compacta de todos los contenedores.
@@ -200,8 +209,10 @@ CDD-CLI is a cross-platform command-line tool (CLI) to monitor and visualize you
 
 ## Main features
 - 🐳 Clear, compact visualization of all containers.
-- 🔄 Automatic data refresh.
+- 🔄 Automatic data refresh (every 2 seconds).
+- ⌨️ Keyboard shortcuts for fast actions (navigate, start, stop, logs, quit).
 - 📊 Live resource usage stats for running containers.
+- 🪵 Real-time log streaming for selected containers.
 - 🎨 Visual interface with colors and emojis for states.
 - 👤 Author: Carlos Cochero (2025)
 

package/docs/en/README.md

@@ -0,0 +1,167 @@
+# README (ENGLISH)
+*Generated: 2025-10-13*
+
+## Table of Contents
+- [Project Scope](#project-scope)
+- [Objectives & Roadmap](#objectives--roadmap)
+- [Requirements](#requirements)
+- [Installation](#installation)
+- [Quick Start](#quick-start)
+- [Use Cases](#use-cases)
+- [Technical Documentation](#technical-documentation)
+- [API Reference](#api-reference)
+- [License](#license)
+- [Contributing](#contributing)
+- [Code of Conduct](#code-of-conduct)
+- [Changelog](#changelog)
+- [FAQ](#faq)
+- [Publishing & Maintenance](#publishing--maintenance)
+
+---
+
+## Project Scope
+This project is a cross-platform CLI tool for managing Docker containers with real-time log streaming and keyboard shortcuts. It is designed for developers and DevOps engineers who need fast, scriptable, and interactive container management from the terminal.
+
+**What it does:**
+- Lists, starts, stops, and removes Docker containers.
+- Streams logs in real time.
+- Provides keyboard shortcuts for common actions.
+- Offers feedback and stats in the terminal.
+
+**What it does NOT do:**
+- Does not replace Docker Compose or advanced orchestration tools.
+- Does not manage images or networks directly.
+- No GUI; terminal only.
+
+## Objectives & Roadmap
+**Short-term (3 months):**
+- Polish CLI UX and error handling.
+- Add more keyboard shortcuts.
+- Improve documentation and add more use cases.
+
+**Medium-term (6 months):**
+- Add plugin system for custom actions.
+- Support for container stats export (JSON/CSV).
+- Integration with CI/CD pipelines.
+
+**Known limitations:**
+- Requires Docker daemon running locally.
+- Only supports local containers (no remote).
+- Limited to Node.js LTS versions.
+
+## Requirements
+| Requirement         | Minimum         | Recommended      |
+|--------------------|----------------|-----------------|
+| Node.js            | 16.x           | 18.x+           |
+| npm                | 7.x            | 8.x+            |
+| OS                 | Linux, macOS, Windows | Linux, macOS |
+| Docker             | 20.x           | Latest stable   |
+| Permissions        | Docker group or sudo | Docker group |
+
+**Development:**
+- ESLint, Prettier
+- Jest or Mocha for tests
+- GitHub Actions for CI
+
+**Production:**
+- Only Node.js and Docker required
+
+## Installation
+### Global install
+```bash
+npm install -g cdd-cli
+```
+
+### Update
+```bash
+npm update -g cdd-cli
+```
+
+### Uninstall
+```bash
+npm uninstall -g cdd-cli
+```
+
+### Check version
+```bash
+cdd -v
+cdd --version
+```
+
+#### Notes
+- On Linux/macOS, you may need `sudo` for global install.
+- Ensure your global npm bin is in your PATH.
+- On Windows, use an Administrator terminal if needed.
+
+## Quick Start
+```bash
+cdd list
+cdd logs <container>
+cdd start <container>
+cdd stop <container>
+cdd remove <container>
+```
+
+## Use Cases
+1. **List all containers**
+   - `cdd list`
+   - *Shows all containers with status.*
+2. **Start a container**
+   - `cdd start my_container`
+   - *Starts the specified container.*
+3. **Stop a container**
+   - `cdd stop my_container`
+   - *Stops the specified container.*
+4. **Stream logs in real time**
+   - `cdd logs my_container`
+   - *Shows live logs with color highlighting.*
+5. **Remove a container**
+   - `cdd remove my_container`
+   - *Deletes the container after confirmation.*
+6. **Use keyboard shortcuts**
+   - While viewing logs, press `q` to quit, `r` to restart, etc.
+
+## Technical Documentation
+See inline JSDoc comments in source files. Example:
+```js
+/**
+ * Start a Docker container by name.
+ * @param {string} name - Container name
+ * @returns {Promise<boolean>} True if started
+ * @throws {Error} If Docker is not running
+ * @example
+ * await startContainer('my_container');
+ */
+```
+
+## API Reference
+See [API Reference](./api.md) for all exported functions and CLI commands.
+
+## License
+MIT License. See [LICENSE](../../LICENSE).
+
+## Contributing
+See [CONTRIBUTING.md](../../CONTRIBUTING.md).
+
+## Code of Conduct
+See [CODE_OF_CONDUCT.md](../../CODE_OF_CONDUCT.md).
+
+## Changelog
+See [CHANGELOG.md](../../CHANGELOG.md).
+
+## FAQ
+- **Does it work with Docker Desktop?**
+  - Yes, as long as Docker CLI is available.
+- **Can I use it in CI?**
+  - Yes, see examples below.
+- **How do I add my own commands?**
+  - Plugin system coming soon.
+
+## Publishing & Maintenance
+To publish to npm:
+```bash
+npm login
+npm publish --access public
+```
+
+Keep documentation updated with every release. See CONTRIBUTING.md for details.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cdd-cli",
-  "version": "3.0.0",
+  "version": "3.0.1",
   "description": "CLI Docker Dashboard",
   "main": "index.js",
   "scripts": {

package/src/App.jsx

@@ -1,3 +1,14 @@
+/**
+ * Main React component for the CDD CLI UI.
+ * Componente principal de React para la UI del CLI CDD.
+ *
+ * @component
+ * @returns {JSX.Element} The rendered app / La app renderizada
+ * @example
+ * // EN: Render the app
+ * // ES: Renderizar la app
+ * <App />
+ */
 import React from "react";
 import { Box, Text, Spacer } from "ink";
 import { useContainers } from "./hooks/useContainers";

package/src/components/ContainerList.jsx

@@ -1,3 +1,16 @@
+/**
+ * List component for Docker containers.
+ * Componente de lista para contenedores Docker.
+ *
+ * @component
+ * @param {Object} props - Component props / Props del componente
+ * @param {Array} props.containers - Containers to display / Contenedores a mostrar
+ * @returns {JSX.Element} Rendered list / Lista renderizada
+ * @example
+ * // EN: Render with containers
+ * // ES: Renderizar con contenedores
+ * <ContainerList containers={containers} />
+ */
 import React from "react";
 import { Box, Text } from "ink";
 import ContainerRow from "./ContainerRow";

package/src/helpers/dockerActions.js

@@ -1,3 +1,16 @@
+/**
+ * Run a Docker action by name (start, stop, remove).
+ * Ejecuta una acción Docker por nombre (start, stop, remove).
+ *
+ * @param {string} action - Action to perform / Acción a realizar
+ * @param {string} container - Container name / Nombre del contenedor
+ * @returns {Promise<boolean>} True if successful / True si es exitoso
+ * @throws {Error} If Docker is not running / Si Docker no está corriendo
+ * @example
+ * // EN: Start a container
+ * // ES: Iniciar un contenedor
+ * await runDockerAction('start', 'my_container');
+ */
 import { spawn } from "child_process";
 
 /**

package/src/helpers/dockerService.js

@@ -1,3 +1,15 @@
+/**
+ * Utility to interact with Docker CLI.
+ * Utilidad para interactuar con el CLI de Docker.
+ *
+ * @param {string} cmd - Docker command / Comando Docker
+ * @returns {Promise<string>} Output from Docker / Salida de Docker
+ * @throws {Error} If command fails / Si el comando falla
+ * @example
+ * // EN: Run a Docker command
+ * // ES: Ejecutar un comando Docker
+ * await dockerService('ps -a');
+ */
 
 import Docker from "dockerode";
 const docker = new Docker({ socketPath: "/var/run/docker.sock" });

package/src/hooks/useContainers.js

@@ -1,3 +1,13 @@
+/**
+ * React hook to manage Docker containers state.
+ * Hook de React para gestionar el estado de contenedores Docker.
+ *
+ * @returns {[Array, Function]} [containers, refresh] / [contenedores, refrescar]
+ * @example
+ * // EN: Use in a component
+ * // ES: Usar en un componente
+ * const [containers, refresh] = useContainers();
+ */
 import React, { useState, useEffect } from "react";
 import { getContainers } from "../helpers/dockerService";
 

package/src/index.js

@@ -1,4 +1,17 @@
 #!/usr/bin/env node
+
+/**
+ * Entry point for the CDD CLI application.
+ * Punto de entrada para la aplicación CLI de CDD.
+ *
+ * @module index
+ * @example
+ * // EN: Run the CLI
+ * // ES: Ejecutar el CLI
+ * node index.js
+ */
+
+
 import React from "react";
 import { render } from "ink";
 import App from './App';