Conversión de CLI Node.js a binarios instalables con npm

Clase 26 de 26 • Curso de Node.js Avanzado

Clase anteriorSiguiente clase

Resumen

Aprender cómo crear comandos CLI con Node.js amplía tus habilidades técnicas y te permite desarrollar herramientas prácticas que puedes usar desde cualquier lugar en tu sistema operativo. Este proceso implica convertir tu código en ejecutables locales instalables, facilitando su uso mediante comandos sencillos desde tu terminal.

¿Cómo convertir tu código a binarios con Node.js?

La creación de un binario ejecutable desde un proyecto de Node se realiza a través del archivo package.json. Para lograr esto, debes añadir una sección adicional llamada bin. Veamos paso a paso:

  1. Dirígete al package.json de tu proyecto.
  2. Crea una nueva propiedad denominada bin justo después del atributo main.
  3. Define tu CLI asignando el nombre del comando que ejecutarás desde la terminal al archivo JavaScript que quieres ejecutar.

Ejemplo:

"bin": {
    "platziasistant": "AI-Assistant.js"
}

Esta definición limita la exposición únicamente al archivo determinado, aunque puedes exponer múltiples scripts si lo deseas.

¿Cómo instalar localmente tu CLI con npm?

Para usar cómodamente tu aplicación directamente desde la terminal, npm ofrece el comando de instalación global local npm link:

  • Dirígete en la línea de comandos al directorio raíz donde está ubicado tu archivo package.json.
  • Ejecuta el siguiente comando:
npm link

Esto habilita al instante tu nuevo comando CLI:

platziasistant

Con esta configuración, tu comando estará disponible globalmente sin importar el lugar en el que te encuentres dentro de tu terminal.

¿Cómo publicar tu paquete en npm?

Una vez tu herramienta está completa y lista, el siguiente paso natural es compartirla a través de npm. Estas son las dos maneras principales de utilizar un paquete público:

  • Realizar una instalación global del paquete: shell npm install -g platziAssistant
  • Ejecutar directamente sin instalación previa: shell npx platziAssistant

Es recomendable profundizar en el proceso eligiendo cursos específicos que expliquen cómo publicar correctamente en npm para garantizar una adecuada distribución de tus proyectos.

¿Qué ideas creativas te gustaría implementar en tus propios CLIs? Cuéntame en los comentarios y comparte cualquier herramienta genial que desarrolles siguiendo este método.