Tabla de contenidos
1. Introducción
2. ¿Qué es zcli?
3. Instalación de zcli
4. Creación de un perfil
5. Generación de archivos de inicio
6. Prueba de la aplicación localmente
7. Implementación de la aplicación
8. Actualización de la aplicación
9. Temas avanzados y características futuras
10. Conclusión
Introducción
En este artículo, exploraremos la nueva Interfaz de Línea de Comandos de Zendesk (zcli) y sus capacidades. Cubriremos todo, desde la instalación hasta la implementación y actualización de tus aplicaciones de Zendesk. Ya seas un desarrollador o un usuario de Zendesk, esta guía te ayudará a navegar por el proceso paso a paso. ¡Así que sumerjámonos y descubramos el poder de zcli!
¿Qué es zcli?
zcli es una interfaz de línea de comandos que simplifica el proceso de construcción y gestión de aplicaciones de Zendesk. Con zcli, puedes crear nuevas aplicaciones, cargarlas directamente en tu instancia de Zendesk y actualizarlas según sea necesario, todo desde la terminal. Construido con Node.js utilizando el marco opencli, zcli ofrece una experiencia de desarrollo más fluida y soporte nativo para Windows. Di adiós a la molestia de instalar Linux en máquinas con Windows solo para ejecutar herramientas de aplicaciones de Zendesk. Exploraremos las diferencias y mejoras entre las herramientas de aplicaciones de Zendesk y zcli con más detalle más adelante.
Instalación de zcli
Antes de poder comenzar a usar zcli, debemos asegurarnos de tener instalada la versión 12 o superior de Node.js. Puedes verificar la versión de Node.js ejecutando `node -v` en la terminal. Si tu versión es anterior a v12, puedes actualizarla utilizando Node Version Manager o descargando las actualizaciones necesarias desde el sitio web de Node.js. Una vez que Node.js esté actualizado, podemos proceder con la instalación de zcli.
Para instalar zcli, abre la terminal y ejecuta el siguiente comando:
```
npm install @zendesk/zcli -g
```
Después de que la instalación se complete, puedes confirmar la versión ejecutando `zcli -v`. Si todo salió bien, ¡estás listo para comenzar a usar zcli!
Creación de un perfil
Para interactuar con tu instancia de Zendesk utilizando zcli, deberás crear un perfil. Un perfil en zcli corresponde a tus credenciales de inicio de sesión en Zendesk. Cada subdominio requiere un perfil separado. Para crear un perfil, sigue estos pasos:
1. Ejecuta el siguiente comando en la terminal: `zcli login -i`
2. Se te pedirá que ingreses tu subdominio, dirección de correo electrónico y contraseña.
3. Si has desactivado el acceso mediante contraseña, puedes utilizar un token de API en su lugar ingresando tu dirección de correo electrónico seguida de una barra diagonal y el token de API.
zcli guarda de forma segura tus credenciales en el almacén de claves de tu sistema operativo, lo que garantiza la seguridad de tu información de inicio de sesión.
Generación de archivos de inicio
Ahora que zcli está configurado y se ha creado tu perfil, podemos comenzar a generar los archivos de inicio para tu nueva aplicación de Zendesk. Hay varias formas de generar estos archivos, pero por simplicidad, nos centraremos en los archivos básicos de datos de la aplicación.
1. Navega hasta el directorio deseado donde deseas que se encuentren los archivos de tu aplicación.
2. Ejecuta el siguiente comando en la terminal: `zcli apps new`
3. Se te pedirá que ingreses un nombre de directorio para los archivos de la aplicación. Si ya tienes un directorio, ingresa su nombre; de lo contrario, proporciona un nuevo nombre de carpeta y zcli lo creará por ti.
4. A continuación, se te pedirá que ingreses el nombre del autor de la aplicación, su dirección de correo electrónico y un nombre para la aplicación. Estos detalles se pueden actualizar más adelante si es necesario.
Una vez que el proceso esté completo, tendrás los archivos necesarios para poner en marcha tu aplicación en Zendesk.
Prueba de la aplicación localmente
Con los archivos de inicio en su lugar, ahora podemos probar nuestra aplicación localmente utilizando zcli. Esto nos permite realizar cambios y ver los resultados sin necesidad de cargar e instalar paquetes. Para iniciar un servidor web local y ejecutar tu aplicación de Zendesk en tu computadora, sigue estos pasos:
1. Ejecuta el siguiente comando en la terminal: `zcli apps server`
2. Después de unos segundos, el servidor de la aplicación comenzará a ejecutarse en `localhost:4567`.
3. Agrega `zcli_apps=true` al final de la URL de tu instancia de Zendesk.
4. Dirígete a un ticket en Zendesk para ver tu aplicación en la bandeja de aplicaciones de la barra lateral del ticket.
5. Realiza cambios en tu aplicación, actualiza el ticket y observa los cambios actualizados.
Probar tu aplicación localmente con zcli proporciona una experiencia de desarrollo fluida, lo que te permite iterar rápidamente y de manera eficiente.
Implementación de la aplicación
Una vez que tu aplicación haya sido probada y esté lista para ser implementada, puedes validar, empaquetar y cargarla en tu instancia de Zendesk utilizando un solo comando: `zcli apps create`. Este comando inicia el proceso de validación, empaquetado y carga de la aplicación.
Si ocurren errores durante el proceso de instalación, recibirás un mensaje de error con instrucciones sobre cómo resolver el problema. Simplemente actualiza la aplicación según se indica en el mensaje de error y vuelve a ejecutar el comando `zcli apps create`.
Después de una implementación exitosa, puedes confirmar la instalación navegando a la sección "Aplicaciones e integraciones" de tu centro de administración de Zendesk. Tu aplicación debería aparecer en la lista de aplicaciones de Zendesk Support. Para verificar la instalación, dirígete a un ticket y actualiza la barra lateral del ticket.
Actualización de la aplicación
Si has realizado cambios y mejoras en tu aplicación después de haberla instalado en tu instancia de Zendesk, puedes actualizarla fácilmente utilizando zcli. El comando `zcli apps update` te permite llevar los cambios en vivo a tu instancia de Zendesk.
Para actualizar tu aplicación, sigue estos pasos:
1. Realiza los cambios deseados en tu aplicación.
2. Ejecuta el siguiente comando en la terminal: `zcli apps update`.
3. Verifica la actualización actualizando un ticket y observando los cambios.
Actualizar tu aplicación con zcli es un proceso sencillo, lo que garantiza que tus usuarios siempre tengan acceso a la última versión de tu aplicación.
Temas avanzados y características futuras
Si bien este artículo cubre los conceptos básicos de cómo usar zcli, hay temas y comandos más avanzados que exploraremos en futuros videos. Mantente atento a las actualizaciones y nuevas características a medida que zcli continúa evolucionando. Estamos trabajando activamente en agregar más características, como la vista previa del tema de la guía, a zcli. Mantén un ojo en este espacio para emocionantes desarrollos.