cdd-cli 3.0.1 → 3.1.0

package/docs/en/README.md

@@ -1,167 +0,0 @@
-# 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/src/helpers/dockerActions.js

@@ -1,52 +0,0 @@
-/**
- * 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";
-
-/**
- * Ejecuta una acción de Docker sobre un contenedor y maneja feedback visual.
- * @param {Object} params
- * @param {Array} params.containers - Lista de contenedores.
- * @param {number} params.selected - Índice del contenedor seleccionado.
- * @param {string} params.action - Acción docker (start, stop, restart).
- * @param {string} params.actionLabel - Texto para feedback (Starting, Stopping, etc).
- * @param {Function} params.setMessage - Setter de mensaje visual.
- * @param {Function} params.setMessageColor - Setter de color del mensaje.
- */
-export function handleDockerAction({ containers, selected, action, actionLabel, setMessage, setMessageColor }) {
-  if (containers[selected]) {
-    const c = containers[selected];
-    const id = c.id || c.name;
-    // Validación de estado
-    if (action === "start" && (c.state === "running" || c.status === "running")) {
-      setMessage("Container is already running.");
-      setMessageColor("red");
-      setTimeout(() => setMessage(""), 2000);
-      return;
-    }
-    if (action === "stop" && (c.state === "exited" || c.status === "exited" || c.state === "stopped" || c.status === "stopped")) {
-      setMessage("Container is already stopped.");
-      setMessageColor("red");
-      setTimeout(() => setMessage(""), 2000);
-      return;
-    }
-    setMessage(`${actionLabel} container...`);
-    setMessageColor("green");
-    const child = spawn("docker", [action, id]);
-    child.on("close", () => {
-      setMessage(`${actionLabel} container...`);
-      setMessageColor("green");
-      setTimeout(() => setMessage(""), 3000);
-    });
-  }
-}

package/src/helpers/dockerService.js

@@ -1,100 +0,0 @@
-/**
- * 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" });
-
-export function getLogsStream(containerId, onData, onEnd, onError) {
-  const container = docker.getContainer(containerId);
-  container.logs({
-    follow: true,
-    stdout: true,
-    stderr: true,
-    tail: 100
-  }, (err, stream) => {
-    if (err) {
-      onError?.(err);
-      return;
-    }
-    stream.on('data', chunk => onData?.(chunk.toString()));
-    stream.on('end', () => onEnd?.());
-    stream.on('error', err => onError?.(err));
-  });
-}
-
-export async function startContainer(containerId) {
-  const container = docker.getContainer(containerId);
-  await container.start();
-}
-
-export async function stopContainer(containerId) {
-  const container = docker.getContainer(containerId);
-  await container.stop();
-}
-
-export async function restartContainer(containerId) {
-  const container = docker.getContainer(containerId);
-  await container.restart();
-}
-
-export async function getContainers() {
-  const containers = await docker.listContainers({ all: true });
-  return containers.map((container) => ({
-    id: container.Id,
-    name: container.Names[0].replace("/", ""),
-    image: container.Image,
-    state: container.State,
-    status: container.Status,
-    ports:
-      [
-        ...new Set(
-          container.Ports.filter((port) => port.PublicPort).map(
-            (port) => `${port.PublicPort}:${port.PrivatePort}`
-          )
-        ),
-      ]
-  }));
-}
-
-export async function getStats(containerId) {
-  const container = docker.getContainer(containerId);
-  const stream = await container.stats({ stream: false });
-
-  const cpuDelta =
-    stream.cpu_stats.cpu_usage.total_usage -
-    stream.precpu_stats.cpu_usage.total_usage;
-  const systemDelta =
-    stream.cpu_stats.system_cpu_usage - stream.precpu_stats.system_cpu_usage;
-  const cpuPercent = systemDelta > 0 ? (cpuDelta / systemDelta) * 100 : 0;
-
-  const memUsage = stream.memory_stats.usage || 0;
-  const memLimit = stream.memory_stats.limit || 1;
-  const memPercent = (memUsage / memLimit) * 100;
-
-  const rx = stream.networks
-    ? Object.values(stream.networks)
-        .map((n) => n.rx_bytes)
-        .reduce((a, b) => a + b, 0)
-    : 0;
-  const tx = stream.networks
-    ? Object.values(stream.networks)
-        .map((n) => n.tx_bytes)
-        .reduce((a, b) => a + b, 0)
-    : 0;
-
-  return {
-    cpuPercent: cpuPercent.toFixed(1),
-    memPercent: memPercent.toFixed(1),
-    netIO: { rx, tx },
-  };
-}