# Documentación del CLI ## v1 -------------------------------------------------------------------------------- title: "Referencia de comandos del CLI" description: "La referencia de comandos del CLI enumera todos los comandos disponibles en Catalyst CLI que puedes ejecutar desde tu terminal." last_updated: "2026-07-02T09:34:15.857Z" source: "https://docs.catalyst.zoho.com/es/cli/v1/cli-command-reference/" service: "All Services" -------------------------------------------------------------------------------- # Referencia de comandos del CLI Debes tener Catalyst CLI instalado en tu sistema para acceder a los comandos de Catalyst. Consulta la página de ayuda para instalar Catalyst CLI para ver los pasos. ### Opciones <table class="content-table"> <thead> <tr> <th>Sintaxis del comando</th> <th>Uso</th> </tr> </thead> <tbody> <tr> <td> <strong>-v</strong> | <strong>--version</strong> </td> <td>Muestra el número de versión del Catalyst CLI</td> </tr> <tr> <td><strong>-p</strong> | <strong>--project &lt;name_or_project_id&gt;</strong></td> <td>Especifica el proyecto de Catalyst que se usará para un comando</td> </tr> <tr> <td><strong>--org &lt;org id&gt;</strong></td> <td>Especifica la organización de Catalyst que se usará para un comando. Se utiliza con la opción -p.</td> </tr> <tr> <td><strong>--token &lt;token&gt;</strong></td> <td>Proporciona un token de autenticación para un comando</td> </tr> <tr> <td><strong>--dc &lt;us|eu|in|jp|sa|au|ca&gt;</strong></td> <td>Proporciona un centro de datos para un comando</td> </tr> <tr> <td><strong>--verbose</strong></td> <td>Cambia el nivel de log a verbose para fines de depuración</td> </tr> <tr> <td><strong>-h</strong> | <strong>--help</strong></td> <td>Muestra la ayuda para un comando de Catalyst</td> </tr> </tbody> </table> <br> ### Comandos <table class="content-table"> <thead> <tr> <th>Sintaxis del comando</th> <th>Uso</th> </tr> </thead> <tbody> <tr> <td><strong>login [options]</strong></td> <td>Inicia sesión en el CLI con tu cuenta de Catalyst</td> </tr> <tr> <td><strong><strong>token:generate [options]</strong></strong></td> <td>Genera un token para autenticar el acceso al CLI desde un sistema remoto</td> </tr> <tr> <td><strong>token:list</strong></td> <td>Lista todos los tokens disponibles generados en este CLI</td> </tr> <tr> <td><strong>token:revoke &lt;id&gt;</strong></td> <td>Revoca un token generado en este CLI</td> </tr> <tr> <td><strong><strong>whoami</strong></strong></td> <td>Muestra la dirección de correo electrónico del usuario actualmente conectado</td> </tr> <tr> <td><strong>init [feature] [options]</strong></td> <td>Inicializa un proyecto de Catalyst, funciones, AppSail y recursos de Client en el directorio local</td> </tr> <tr> <td><strong><strong>project:list</strong></strong></td> <td>Lista todos los proyectos de Catalyst a los que tienes acceso</td> </tr> <tr> <td><strong>project:use [name_or_project_id] </strong></td> <td>Establece un proyecto activo de Catalyst para tu directorio de trabajo</td> </tr> <tr> <td><strong>project:reset</strong></td> <td>Limpia la selección de proyecto activo y restablece al proyecto base</td> </tr> <tr> <td><strong>pull [feature]</strong></td> <td>Descarga recursos de tu proyecto desde la consola remota al directorio local</td> </tr> <tr> <td><strong>iac:export [options]</strong></td> <td>Exporta el código y las configuraciones de un proyecto como un archivo ZIP</td> </tr> <tr> <td><strong>iac:import [options][file_path]</strong></td> <td>Importa el archivo ZIP de un proyecto y crea un nuevo proyecto en la consola</td> </tr> <tr> <td><strong>iac:pack [zip_name]</strong></td> <td>Genera un archivo ZIP listo para importar de un proyecto en el formato estándar</td> </tr> <tr> <td><strong>iac:status [options]&lt;operation&gt;</strong></td> <td>Obtiene el estado actual de un trabajo de importación o exportación programado</td> </tr> <tr> <td><strong>functions:setup</strong></td> <td>Configura el directorio de funciones en tu directorio de proyecto</td> </tr> <tr> <td><strong>functions:add</strong></td> <td>Agrega una función del stack requerido al directorio de funciones</td> </tr> <tr> <td><strong>functions:config [function_name_or_id] [options] </strong></td> <td>Realiza configuraciones avanzadas como la asignación de memoria en una función de tu proyecto</td> </tr> <tr> <td><strong>functions:shell [options]</strong></td> <td>Inicia un shell de Node para probar funciones emuladas de cualquier stack o tipo, excepto funciones Advanced I/O</td> </tr> <tr> <td><strong>functions:delete [function_name_or_id] [options]</strong></td> <td>Elimina una función de la consola remota o del directorio local</td> </tr> <tr> <td><strong>config:set &lt;key=value&gt; </strong></td> <td>Establece la configuración de Catalyst como un par clave-valor</td> </tr> <tr> <td><strong>config:get &lt;key&gt;</strong></td> <td>Obtiene el valor de configuración de Catalyst para la clave especificada</td> </tr> <tr> <td><strong>config:list</strong></td> <td>Lista todas las configuraciones de Catalyst</td> </tr> <tr> <td><strong>config:delete &lt;key&gt; </strong></td> <td>Elimina una clave de la configuración de Catalyst</td> </tr> <tr> <td><strong>appsail:add</strong></td> <td>Asocia un directorio de proyecto de Catalyst existente con un servicio AppSail</td> </tr> <tr> <td><strong>client:setup</strong></td> <td>Configura el directorio de Client en tu directorio de proyecto</td> </tr> <tr> <td><strong>client:delete [client_version] [options]</strong></td> <td>Elimina una versión del Client de la consola remota o del directorio local</td> </tr> <tr> <td><strong>ds:import [~CSV_file_path] [options]</strong></td> <td>Escribe registros de forma masiva en una tabla del Data Store de Catalyst</td> </tr> <tr> <td><strong>ds:export [options]</strong></td> <td>Lee registros de forma masiva desde una tabla del Data Store de Catalyst</td> </tr> <tr> <td><strong>ds:status &lt;operation&gt; [job_id] [options]</strong></td> <td>Muestra el estado del trabajo de una operación de importación o exportación del Data Store</td> </tr> <tr> <td><strong>apig:enable</strong></td> <td>Habilita API Gateway para tu proyecto</td> </tr> <tr> <td><strong>apig:disable</strong></td> <td>Deshabilita API Gateway para tu proyecto</td> </tr> <tr> <td><strong>apig:status [options]</strong></td> <td>Obtiene el estado actual de API Gateway para tu proyecto y el progreso programado</td> </tr> <tr> <td><strong>event:generate</strong> | <strong>generate:event &lt;source&gt; &lt;action&gt; [options]</strong></td> <td>Genera payloads de ejemplo de diferentes componentes o fuentes de eventos personalizados para probar funciones de eventos</td> </tr> <tr> <td><strong>event:generate:integ &lt;service&gt; [options]</strong></td> <td>Genera payloads de ejemplo para el servicio de integración requerido para probar funciones de integración</td> </tr> <tr> <td><strong>event:generate:job</strong></td><td>Genera payloads de ejemplo para probar funciones de trabajo</td> </tr> <tr> <td><strong>run-script</strong> | <strong>run [command]</strong></td> <td>Ejecuta un script de comando específico definido en catalyst.json</td> </tr> <tr> <td><strong>serve [options]</strong></td> <td>Sirve funciones Basic I/O, Advanced I/O, BrowserLogic, AppSail y el Client para probarlos localmente</td> </tr> <tr> <td><strong>deploy [options] [feature] </strong></td> <td>Despliega el proyecto de Catalyst y los recursos del proyecto en la consola remota desde el directorio local</td> </tr> <tr> <td><strong>help [command]</strong></td> <td>Muestra la referencia de comandos o la ayuda para un comando específico</td> </tr> <tr> <td><strong>logout</strong></td> <td>Cierra la sesión del CLI de tu cuenta de Catalyst</td> </tr> <tr> <td><strong>codelib:install</strong></td><td>Instala los componentes preconfigurados de Catalyst CodeLib en tu proyecto</td> </tr> </tbody> </table> Nota: Si eres usuario de Visual Studio Code IDE, puedes instalar la extensión Catalyst Tools y realizar estas operaciones del CLI usando tu IDE en lugar del CLI. Puedes encontrar más detalles sobre la extensión de Catalyst para VS Code en esta sección de ayuda. -------------------------------------------------------------------------------- title: "Opciones del CLI" description: "Catalyst proporciona varias opciones del CLI que puedes usar con cualquiera de los comandos del CLI para diversos propósitos." last_updated: "2026-07-02T09:34:15.860Z" source: "https://docs.catalyst.zoho.com/es/cli/v1/cli-options/" service: "All Services" -------------------------------------------------------------------------------- # Opciones del CLI Catalyst proporciona las siguientes opciones del CLI que puedes usar con cualquiera de los comandos del CLI: ### -v | -\-version Esta opción muestra el número de versión del Catalyst CLI que estás utilizando actualmente. Puedes escribir -v o <br> -\\-version con el comando catalyst de la siguiente manera: catalyst --version <br /> <br /> ### -p | -\-project &lt;name\_or\_project\_id&gt; -\-org &lt;org\_id&gt; La opción \-p o -\\-project se usa para proporcionar el nombre o el ID del proyecto de Catalyst para el cual se debe ejecutar el comando del CLI. Esta opción es muy útil cuando no has inicializado o activado un proyecto para tu directorio de trabajo en el CLI. También puedes usar esta opción si estás ejecutando comandos del Catalyst CLI desde un sistema remoto, como un repositorio de código remoto o un sistema CI, sin una sesión de inicio de sesión activa usando un token. Puedes ejecutar el comando de Catalyst especificando directamente el proyecto para el cual está destinado el comando, sin tener que inicializar o habilitar un proyecto en el CLI. El nombre o el ID del proyecto debe mencionarse con la opción. Por ejemplo, para habilitar API Gateway en un proyecto llamado *ShipmentTracking*, puedes ejecutar el siguiente comando del CLI con esta opción: catalyst apig:enable -p|--project ShipmentTracking También puedes usar opcionalmente la opción -\\-org para proporcionar el ID de la organización de Catalyst a la que pertenece el proyecto y para la cual se debe ejecutar el comando del CLI. Por ejemplo, para desplegar el Client web de un proyecto desde el CLI, ejecutamos el siguiente comando del CLI con ambas opciones: catalyst deploy --only client -p|--project Test --org 72760298 <br> Nota:Si no usas la opción -\\-org después de la opción \-p o -\\-project, se considerará la organización predeterminada para la ejecución del comando. <br /> <br /> ### -\-token &lt;token&gt; La opción -\\-token se usa para autenticar la ejecución de un comando del Catalyst CLI. Los tokens del Catalyst CLI te permiten ejecutar comandos del CLI desde un sistema remoto, como una herramienta CI, sin una sesión de usuario activa conectada. Puedes obtener más información sobre los tokens del Catalyst CLI en la página de ayuda de Trabajar con tokens. Debes generar un token cuando hayas iniciado sesión en una cuenta de usuario desde el CLI. Luego puedes usar ese token desde cualquier sistema remoto para realizar todas las operaciones del CLI sin una sesión de inicio de sesión activa. Esto se hace especificando el token como opción después del comando del CLI. Este token actúa como factor de autenticación para esa cuenta de usuario y continúa asignando tus ejecuciones de comandos al proyecto que especifiques. Por ejemplo, puedes inicializar el componente de funciones de un proyecto de Catalyst desde un sistema remoto a tu directorio de proyecto usando la opción -\\-token de la siguiente manera: catalyst init --only functions --token xxxxxxxxxxxxx Esto hará que Catalyst verifique el token e inicie el proceso de inicialización si el token resulta ser válido. ### -\-dc&lt;us|eu|in|jp|sa|au|ca&gt; La opción -\\-dc<us|eu|in|au|ca> te permite ejecutar un comando desde un inicio de sesión de un DC específico. Catalyst está disponible actualmente en siete centros de datos: US, EU, IN, JP, SA, AU y CA. Generalmente puedes seleccionar el centro de datos desde el cual accederás a Catalyst al iniciar sesión en el CLI. Catalyst te permite mantener diferentes inicios de sesión de cada centro de datos simultáneamente. Es decir, puedes tener un token válido en ambos centros de datos, cada uno para autenticar tus ejecuciones de comandos. Luego puedes elegir ejecutar un comando desde cualquiera de los centros de datos, especificándolo con esta opción. Por ejemplo, si tienes un inicio de sesión válido en los DC de EU y US simultáneamente, puedes inicializar un proyecto y sus recursos en tu directorio para la cuenta de usuario asociada con el centro de datos de US ejecutando el comando de la siguiente manera: catalyst init --dc us Esto permitirá que Catalyst inicialice un proyecto después de verificar las credenciales en el centro de datos que especifiques. <br> Nota: Si tienes diferentes inicios de sesión mantenidos en ambos centros de datos y no usas esta opción para especificar el centro de datos desde el cual ejecutar este comando, se usará el inicio de sesión más reciente por defecto. ### -\-verbose La opción -\\-verbose se usa para mostrar información detallada sobre las acciones que tienen lugar cuando se ejecuta un comando del CLI. Se muestra información que incluye los detalles de la solicitud HTTP enviada al servidor cuando se ejecuta el comando, detalles de las respuestas recibidas, detalles sobre el entorno del CLI, los tokens de autorización usados para contactar al servidor y las cookies establecidas. La opción -\\-verbose te ayuda a depurar y solucionar problemas en las ejecuciones de comandos del CLI y te permite identificar el origen de un error. Puedes ejecutar cualquier comando del CLI con la opción -\\-verbose. Por ejemplo, puedes ejecutar el comando de listar proyectos usando la opción verbose de la siguiente manera: catalyst project:list --verbose ### -h | -\-help La opción -h o -\\-help se usa para obtener ayuda con un comando del CLI. Esto proporciona una breve descripción de la funcionalidad del comando y lista las opciones que están disponibles para el comando y su sintaxis. Por ejemplo, si necesitas ayuda con el comando catalyst functions:shell, puedes ejecutar el siguiente comando: catalyst functions:shell -h|--help <br /> También puedes obtener ayuda para el comando ejecutando catalyst help functions:shell . -------------------------------------------------------------------------------- title: "Identificar al usuario conectado" description: "Puedes encontrar la identificación de la cuenta de usuario que está actualmente conectada al CLI con este comando." last_updated: "2026-07-02T09:34:15.860Z" source: "https://docs.catalyst.zoho.com/es/cli/v1/identify-loggedin-user/" service: "All Services" -------------------------------------------------------------------------------- # Identificar al usuario conectado ### Ejecución del comando Puedes encontrar fácilmente la identificación de la cuenta de usuario que está actualmente conectada al CLI. Para identificar al usuario actualmente conectado al CLI, ejecuta el siguiente comando: catalyst whoami Esto mostrará la dirección de correo electrónico del usuario conectado. <br> ### Ejecutar con la opción -\-dc Si ejecutas este comando con la opción -\\-dc y especificas el centro de datos, el comando devolverá la dirección de correo electrónico del inicio de sesión del usuario de ese centro de datos. Como se explica en la página de ayuda de opciones del CLI, Catalyst te permite mantener tokens de inicio de sesión válidos para múltiples centros de datos simultáneamente. Por lo tanto, si habías iniciado sesión en un centro de datos con una cuenta de usuario y en otro centro de datos con una cuenta de usuario diferente, el comando catalyst whoami mostrará el inicio de sesión del usuario de ese centro de datos cuando se use con la opción -\\-dc. Puedes identificar al usuario actualmente conectado a un centro de datos específico ejecutando el siguiente comando: catalyst whoami --dc &lt;us|eu|in|jp|sa|ca|au&gt; <br /> Nota: Si eres usuario de Visual Studio Code IDE, puedes instalar la extensión Catalyst Tools y realizar operaciones del CLI usando tu IDE en lugar del CLI. Los pasos para realizar la operación whoami en Visual Studio Code IDE se pueden encontrar aquí. -------------------------------------------------------------------------------- title: "Archivo de configuración del CLI" description: "Catalyst te permite establecer y administrar la ubicación de Python descargado en tu sistema local en un archivo de configuración específico." last_updated: "2026-07-02T09:34:15.860Z" source: "https://docs.catalyst.zoho.com/es/cli/v1/cli-config/" service: "All Services" -------------------------------------------------------------------------------- # Archivo de configuración del CLI ### Introducción Los archivos de configuración en general son archivos que definen parámetros y valores para la configuración de cualquier software o base de código. En este caso, Catalyst proporciona comandos del CLI que te permiten establecer y administrar la ubicación de Python y ciertas versiones de Java descargadas en tu sistema local, en un archivo de configuración específico. Este archivo de configuración en particular es un archivo local oculto que se mantiene en tu sistema en ubicaciones variadas, según el sistema operativo instalado. Controla las operaciones de diversas utilidades en tu sistema. También contiene las configuraciones que permiten que el sistema se comunique eficazmente con el CLI. Nota: Actualmente solo puedes establecer la información de la ruta de Python, Java 11, Java 17, Java 21 o Java 25 en este archivo de configuración. Catalyst actualmente no admite agregar otra información en este archivo a través del CLI. ### Establecer un par clave-valor Puedes agregar una entrada al archivo de configuración en tu máquina local especificando la ruta de Python, Java 11, Java 17, Java 21 o Java 25 almacenada en tu sistema, proporcionando las entradas en forma de un par clave-valor. Para hacerlo, ejecuta el comando mencionado a continuación desde la terminal de tu sistema: catalyst config:set &lt;key=value&gt; Puedes establecer la información de la ruta para los stacks de funciones de la siguiente manera: - **Python**: catalyst config:set python3_9.bin=/Users/amelia-426/Downloads/Python-3.9.16 - **Java 8**: catalyst config:set java8.bin=/Library/Java/JavaVirtualMachines/jdk1.8.0_291.jdk/Contents/Home/bin - **Java 11**: catalyst config:set java11.bin=/Library/Java/JavaVirtualMachines/jdk-11.0.17.jdk/Contents/Home/bin - **Java 17**: catalyst config:set java17.bin=/Library/Java/JavaVirtualMachines/jdk-17.jdk/Contents/Home/bin - **Java 21**: catalyst config:set java21.bin=/Library/Java/JavaVirtualMachines/jdk-21.jdk/Contents/Home/bin - **Java 25**: catalyst config:set java25.bin=/Library/Java/JavaVirtualMachines/jdk-25.jdk/Contents/Home/bin <br /> Nota: * Actualmente, solo puedes establecer la clave como python3_9.bin, java8.bin, java11.bin, java17.bin, java21.bin o java25.bin * Reemplaza la ruta listada en los comandos anteriores con tu ruta de JDK o Python * Si tu sistema local ejecuta Windows OS, encierra la ruta entre comillas dobles. Por ejemplo, establecerás la ruta de Java 11 de la siguiente manera:<br /> catalyst config:set java11.bin="/Library/Java/JavaVirtualMachines/jdk-11.0.17.jdk/Contents/Home/bin" <br> ### Obtener el valor de una clave específica Puedes obtener el valor de cualquier clave específica en este archivo de configuración ejecutando el siguiente comando de terminal con la clave: catalyst config:get &lt;key&gt; - **Python**: catalyst config:get python3_9.bin - **Java 8**: catalyst config:get java8.bin - **Java 11**: catalyst config:get java11.bin - **Java 17**: catalyst config:get java17.bin - **Java 21**: catalyst config:get java21.bin - **Java 25**: catalyst config:get java25.bin <br /> Esto devolverá la ruta o el valor de la clave almacenada en el archivo de configuración. Por ejemplo: - **Python**: /Users/amelia-426/Downloads/Python-3.9.16 - **Java 8**: /Library/Java/JavaVirtualMachines/jdk1.8.0_291 - **Java 11**: /Library/Java/JavaVirtualMachines/jdk-11.0.17 - **Java 17**: /Library/Java/JavaVirtualMachines/jdk-17 - **Java 21**: /Library/Java/JavaVirtualMachines/jdk-21 - **Java 25**: /Library/Java/JavaVirtualMachines/jdk-25 Nota: * Actualmente, solo puedes recuperar la información de la ruta de Python, Java 8, Java 11, Java 17, Java 21 o Java 25 de este archivo usando este comando del CLI. * Reemplaza la ruta listada en los comandos anteriores con tu ruta de JDK o Python * Si tu sistema local ejecuta Windows OS, encierra la ruta entre comillas dobles. Por ejemplo, establecerás la ruta de Java 11 de la siguiente manera:<br /> catalyst config:get java11.bin="/Library/Java/JavaVirtualMachines/jdk-11.0.17.jdk/Contents/Home/bin" <br> ### Listar configuraciones Puedes recuperar la lista de todas las configuraciones (pares clave-valor) que están presentes en el archivo de configuración ejecutando el siguiente comando: catalyst config:list <br /> Nota: Actualmente, este comando del CLI solo recupera la información de configuración de la ruta de Python, Java 8, Java 11, Java 17, Java 21 o Java 25 en tu sistema. <br> ### Eliminar clave Puedes eliminar una entrada en el archivo de configuración ejecutando el siguiente comando del CLI: catalyst config:delete &lt;key&gt; <br /> Debes especificar el nombre de la clave de la entrada que deseas eliminar. * **Python**: catalyst config:delete python3_9.bin * **Java 8**: catalyst config:delete java8.bin * **Java 11**: catalyst config:delete java11.bin * **Java 17**: catalyst config:delete java17.bin Esto eliminará el par clave-valor del archivo. <br /> -------------------------------------------------------------------------------- title: "Agregar un servicio AppSail" description: "Agrega un servicio web AppSail de Catalyst en un runtime administrado por Catalyst de Java, Node.js y Python, o en un runtime personalizado como imágenes OCI a tu directorio de proyecto y despliégalo en la nube." last_updated: "2026-07-02T09:34:15.860Z" source: "https://docs.catalyst.zoho.com/es/cli/v1/add-appsail/" service: "All Services" -------------------------------------------------------------------------------- # Agregar un servicio AppSail ### Introducción AppSail es una plataforma serverless de Catalyst que puedes utilizar para desplegar servicios web de cualquier escala en la nube y administrar sus instancias de plataforma. Puedes inicializar un servicio AppSail de dos maneras: * Como un runtime administrado por Catalyst: Inicializa y despliega aplicaciones de runtimes específicos de Java, Node.js y Python compatibles con Catalyst directamente en la consola remota * Como una imagen de contenedor: Inicializa y despliega una imagen OCI de tu aplicación de cualquier runtime o framework desde tu registro local a la consola remota Nota: Catalyst solo admite el despliegue de imágenes compatibles con OCI compiladas para la plataforma Linux AMD64 (x86-64). En ambos casos, puedes inicializar un servicio AppSail para una aplicación que esté lista para ser desplegada y asociarla con un proyecto de Catalyst a través de este comando. Info: Puedes usar este comando para agregar un servicio AppSail en un directorio de proyecto de Catalyst existente. Esto puede utilizarse si no inicializaste AppSail cuando inicializaste el proyecto por primera vez, o para agregar servicios AppSail adicionales después del primero. Si aún no has inicializado un proyecto, primero debes hacerlo. También puedes desplegar directamente una aplicación sin inicialización a través del comando independiente. Puedes agregar un servicio AppSail en un directorio de proyecto de Catalyst existente ejecutando este comando del CLI: catalyst appsail:add <br> ### Agregar AppSail como un runtime administrado por Catalyst Puedes inicializar un servicio AppSail para un runtime administrado por Catalyst directamente en el directorio de tu aplicación, o desde un nuevo directorio. Si seleccionaste AppSail durante la inicialización del proyecto, Catalyst lo configurará después de la inicialización del Client. Catalyst crea un archivo app-config.json cuando se inicializa un servicio AppSail con este método. 1. El CLI te solicitará que selecciones el tipo de runtime como **Catalyst-Managed Runtime** o **Docker Image**. Selecciona la primera opción. 2. Ahora puedes elegir comenzar con un proyecto de ejemplo prediseñado ingresando "Y" y presionando **Enter**, luego seleccionando una aplicación de ejemplo de la lista. La aplicación de ejemplo se descargará en el directorio. Proporciona un nombre cuando se te solicite. Si deseas inicializar tu propia aplicación, ingresa "N" y luego presiona **Enter**. 3. Selecciona si este será tu directorio fuente de tu aplicación ingresando "Y". Si ingresas "N", el CLI te solicitará que escribas la ruta absoluta del fuente de tu aplicación en tu directorio. Presiona **Enter** después de las entradas. 4. Ingresa un nombre para tu aplicación. Puedes nombrar el archivo principal del build de tu aplicación como prefieras. Nota: Cuando compiles tu aplicación como un archivo Java WAR, necesitarás nombrar el archivo principal root.war o agregar controladores específicos de acuerdo con tu código. 5. Ingresa la ruta de compilación absoluta para tu aplicación y luego presiona **Enter**. 6. Selecciona un stack y runtime para tu aplicación y presiona **Enter**. Si seleccionas Java, el CLI te solicitará además que elijas entre **Java SE** o **Java WAR** como formato desplegable de tu aplicación. Puedes obtener más información al respecto aquí. Si seleccionas cualquier otro stack, este paso se omitirá. AppSail se ha agregado en el directorio fuente que seleccionaste, y la aplicación ahora está asociada con el proyecto de Catalyst. Las configuraciones se actualizarán en el archivo catalyst.json de manera correspondiente. Catalyst crea un archivo app-config.json cuando se agrega un servicio AppSail con este método. Este será el único archivo específico de AppSail en el directorio fuente de tu aplicación. Puedes editar los valores como el comando de inicio, las variables de entorno o la memoria en este archivo antes del despliegue. <br> ### Agregar AppSail como un runtime personalizado Puedes inicializar AppSail para una imagen OCI compatible de tu aplicación desde un nuevo directorio. Catalyst admite dos protocolos que puedes utilizar para asociar la imagen de tu aplicación con AppSail. Cada protocolo tiene un esquema distinto para la identificación y el funcionamiento. * Protocolo Docker Image: Úsalo para asociar una imagen preconstruida de tu aplicación presente en el registro local de Docker. La imagen debe estar compilada y etiquetada para apuntar al registro local. Ejemplo: *docker://localhost/expres-hw:latest* * Protocolo Docker Archive: Úsalo para apuntar a un archivo comprimido (.tar o .tar.gz) de una imagen preconstruida de tu aplicación en el directorio de tu sistema. Ejemplo: *docker-archive://test.tar* Nota: El archivo .tar se puede generar típicamente con el comando docker save. No necesitas proporcionar ningún otro detalle excepto el nombre para AppSail en las imágenes de contenedor. No es necesario configurar la ruta fuente o de compilación de la aplicación, el stack ni el comando de inicio para las imágenes OCI, ya que están definidos en las propias imágenes. 1. El CLI te solicitará que selecciones el tipo de runtime como Catalyst-Managed Runtime o **Docker Image**. Selecciona la segunda opción. 2. Selecciona el protocolo como **Docker Image** o **Docker Archive**. 3. Protocolo Docker Image: Si seleccionas **Docker Image**, el CLI listará todas las imágenes disponibles con etiquetas en el registro local de Docker. Selecciona la imagen que necesites. Protocolo Docker Archive: Si seleccionas **Docker Archive**, el CLI te solicitará que ingreses la ruta absoluta al archivo TAR de la imagen de tu aplicación en tu sistema local. Nota: Cuando la configuración de AppSail se almacena en el archivo catalyst.json, la ruta se almacenará de forma relativa a la ubicación de ese archivo. 4. Proporciona un nombre para el servicio AppSail. Puedes nombrarlo como prefieras. AppSail se ha agregado en tu directorio local, y la imagen de la aplicación ahora está asociada con el servicio AppSail. Las configuraciones se actualizarán en el archivo catalyst.json de manera correspondiente. Nota: El archivo app-config.json no se creará cuando agregues AppSail con una imagen de contenedor. Todas las especificaciones de la aplicación se almacenarán en el archivo catalyst.json. Puedes agregar ciertas configuraciones personalizadas de tu aplicación en este archivo. Consulta aquí para más detalles. Ahora puedes programar tu lógica de negocio en tu aplicación, luego servir el servicio AppSail a través de un localhost para depurarlo y probarlo, o desplegarlo directamente en la consola remota. -------------------------------------------------------------------------------- title: "Generar payloads en Catalyst Signals" description: "Catalyst te permite generar payloads de ejemplo de diversas fuentes de eventos compatibles con Catalyst Publishers en Catalyst Signals usando el CLI." last_updated: "2026-07-02T09:34:15.861Z" source: "https://docs.catalyst.zoho.com/es/cli/v1/gen-payload-catalyst-publishers/" service: "All Services" related: - Catalyst Signals (/es/signals/help/events/) -------------------------------------------------------------------------------- # Payload de ejemplo para eventos en Catalyst Publishers Para eventos originados por Catalyst Publishers en el servicio Catalyst Signal, puedes usar el siguiente comando del CLI para generar payloads de ejemplo. catalyst signals:generate &lt;publisher_service&gt; &lt;event_name&gt; El payload de ejemplo generado por este comando del CLI se puede usar para probar la funcionalidad de la función de evento según tus requisitos. Solo se pueden generar payloads de ejemplo para los siguientes componentes de Catalyst CloudScale: * DataStore * Stratus * Cache * Authentication La siguiente tabla detalla los eventos para los cuales se pueden generar payloads de ejemplo usando el comando catalyst signals: generate. <table border="1" cellpadding="8" cellspacing="0"> <thead> <tr> <th class="w25p">Servicio Publisher</th> <th class="w25p">Nombre del evento</th> <th class="w40p">Acción del evento</th> </tr> </thead> <tbody> <tr> <td rowspan="3">DataStore</td> <td>row_inserted</td> <td>Cuando se inserta una fila en la tabla</td> </tr> <tr> <td>row_updated</td> <td>Cuando se actualiza una fila en una tabla</td> </tr> <tr> <td>row_deleted</td> <td>Cuando se elimina una fila de la tabla</td> </tr> <tr> <td rowspan="4">Stratus</td> <td>stratus_object_uploaded</td> <td>Cuando se sube un objeto a un bucket en Stratus</td> </tr> <tr> <td>stratus_object_downloaded</td> <td>Cuando se descarga un objeto de un bucket en Stratus</td> </tr> <tr> <td>stratus_object_updated</td> <td>Cuando se actualiza un objeto en Stratus</td> </tr> <tr> <td>stratus_object_deleted</td> <td>Cuando se elimina un objeto de Stratus</td> </tr> <tr> <td rowspan="2">Cache</td> <td>cache_item_created</td> <td>Cuando se crea un elemento de cache</td> </tr> <tr> <td>cache_item_updates</td> <td>Cuando se actualiza el cache</td> </tr> <tr> <td rowspan="3">Authentication</td> <td>user_signedup</td> <td>Cuando un usuario se registra en una aplicación</td> </tr> <tr> <td>user_confirmed</td> <td>Cuando un usuario completa el proceso de verificación</td> </tr> <tr> <td>user_deleted</td> <td>Cuando se elimina un usuario de la aplicación.</td> </tr> </tbody> </table> Considera este ejemplo: si necesitas generar un payload de ejemplo para probar la funcionalidad de una función de evento que se activa cuando se sube un objeto a un bucket en Stratus, entonces el comando del CLI será: catalyst signals: generate stratus stratus_object_upload **Salida de ejemplo**: El siguiente fragmento JSON muestra un ejemplo de la salida que se puede esperar. { "rule_id": "534143331281450898", "target_id": "33038437", "version": 1, "attempt": 1, "account": { "org_id": "96858155", "project": { "environment": "Development", "name": "Project-Rainfall", "id": "11365000000016052" } }, "events": [ { "data": { "action_time": "7437648374832", "bucket_details": { "bucket_name": "sample-bucket", "project_details": { "id": "11365000000016052", "project_name": "Project-Rainfall", "project_type": "Live" }, "created_by": { "email_id": "emmy@zylker.com", "user_type": "Admin", "user_id": "193334093726081", "is_confirmed": true, "last_name": "66028", "first_name": "97b6bc29b3", "zuid": "2369563417" }, "created_time": "May 23, 2025 06:21 PM", "modified_by": { "email_id": "emmy@zylker.com", "user_type": "Admin", "user_id": "193334093726081", "is_confirmed": true, "last_name": "66028", "first_name": "97b6bc29b3", "zuid": "2369563417" }, "modified_time": "May 23, 2025 06:21 PM", "bucket_meta": { "versioning": false, "caching": { "status": "Disabled" }, "encryption": false, "audit_consent": false } }, "object_key": "path1/path2/myfile.png" }, "id": "7a66cb17-967b-5ccd-dad0-34c34e63e5a", "time_in_ms": "1748004702399", "source": "publisher_id:51607702502369250/service:cloudscalestratus/account:41005674", "event_config": { "api_name": "stratus_object_uploaded", "id": "57515236254614294" } } ] } ### Payload de ejemplo para eventos personalizados Para generar payloads de ejemplo para eventos originados por aplicaciones o componentes personalizados, puedes usar el comando del CLI catalyst signals:generate de la siguiente manera: catalyst signals:generate custom &lt;custom_event&gt; Para generar payloads de eventos personalizados, necesitas definir los eventos personalizados. Es decir, necesitas haber definido y configurado la clave de API REST para el evento requerido dentro de tu publisher personalizado. Más información:<br /> * Custom Events * Custom Publishers * Add schema to custom events Considera el siguiente ejemplo: tienes otra aplicación que rastrea la dieta de los usuarios finales y les proporciona recomendaciones nutricionales. Tienes un requisito donde, en caso de que un usuario final registre su plan de dieta, hay una lógica apropiada que necesita activarse. En este caso, siempre que hayas definido y configurado el esquema del evento y la clave de API REST requerida, puedes generar un payload de ejemplo para este evento usando el Catalyst CLI de la siguiente manera: catalyst signals:generate custom diet_profile_registered **Salida de ejemplo**: El siguiente fragmento JSON muestra un ejemplo de la salida que se puede esperar. { "rule_id": "382913648739323890", "target_id": "70141764", "version": 1, "attempt": 1, "account": { "org_id": "60047207190", "project": { "environment": "Development", "name": "Project-Rainfall", "id": "21256000000010040" } }, "events": [ { "data": {}, "id": "53aea689-77ac-fd4b-560d-82fd532bd1a", "time_in_ms": "1760089550627", "source": "publisher_id:90216327659515060/service:custom", "event_config": { "api_name": "diet_profile_registered", "id": "97690672393764451" } } ] } -------------------------------------------------------------------------------- title: "Cerrar sesión del CLI" description: "Puedes cerrar sesión de tu cuenta activa en el CLI ejecutando el comando logout." last_updated: "2026-07-02T09:34:15.862Z" source: "https://docs.catalyst.zoho.com/es/cli/v1/logout/" service: "All Services" -------------------------------------------------------------------------------- # Cerrar sesión del CLI ### Ejecución del comando Puedes cerrar sesión del CLI antes de finalizar la ejecución de la terminal. El token de autenticación que contiene tus credenciales de la cuenta de usuario conectada se revocará cuando cierres sesión. Cuando vuelvas a iniciar sesión, se generará un nuevo token para la sesión. Para cerrar sesión del CLI, ejecuta el siguiente comando: catalyst logout <br> El CLI te solicitará una confirmación. Presiona Y y presiona Enter. <br> Tu cuenta de usuario se desconectará del CLI. El CLI mostrará un mensaje confirmando que has cerrado sesión. Puedes volver a iniciar sesión en el CLI usando el comando catalyst login . Nota: Si eres usuario de Visual Studio Code IDE, puedes instalar la extensión Catalyst Tools y realizar operaciones del CLI usando tu IDE en lugar del CLI. Los pasos para cerrar sesión de Catalyst usando Visual Studio Code IDE se pueden encontrar aquí. ### Ayuda contextual -------------------------------------------------------------------------------- title: "Introducción" description: "Catalyst proporciona ayuda contextual cuando encuentras un error durante la ejecución de un comando del CLI." last_updated: "2026-07-02T09:34:15.862Z" source: "https://docs.catalyst.zoho.com/es/cli/v1/context-sensitive-help/introduction/" service: "All Services" -------------------------------------------------------------------------------- # Ayuda contextual del CLI ### Introducción Catalyst proporciona ayuda contextual cuando encuentras un error durante la ejecución de un comando del CLI. Por ejemplo, si hay un error inesperado en el uso de un comando o al obtener un recurso durante la ejecución de un comando, Catalyst te proporcionará ayuda para el contexto particular del error. La ayuda contextual implica comprender el propósito o uso de un comando por parte del usuario y la razón de la ocurrencia del error. Catalyst analizará la situación de forma dinámica para determinar la razón por la cual no se obtuvo el resultado esperado y te proporcionará ayuda personalizada en consecuencia. Cuando encuentres un error inesperado durante la ejecución de un comando, Catalyst no solo especificará la razón detrás del error, sino que también te proporcionará ayuda con las acciones que puedes tomar para rectificar o prevenir el error. Catalyst también mostrará un enlace de ayuda a la documentación del comando o acción en particular. Simplemente puedes abrir la URL del enlace de ayuda en un navegador y acceder a la documentación de ayuda. <br> #### Ejemplos de ayuda contextual * Si ejecutas el comando catalyst client:delete \[options\] \[client\_version\] para eliminar una versión en producción del Client, el CLI te informará que un Client actualmente en producción no se puede eliminar. También te sugerirá que podrías hacer que una versión diferente esté en producción o desplegar una nueva versión del Client antes de intentar la operación de eliminación nuevamente. También te proporcionará un enlace de ayuda a la sección específica en la documentación del CLI que contiene una explicación detallada.<br /> <br> * Si ejecutas un comando del CLI mientras has cerrado sesión de tu cuenta remota de Catalyst, el CLI te informará que no pudo autenticar la ejecución de tu comando. Te sugerirá que inicies sesión en tu cuenta o ejecutes el comando con un token de autenticación válido, y proporcionará un enlace de ayuda.<br /> <br> * Si despliegas un recurso con un archivo de configuración requerido faltante, el CLI te informará sobre el archivo ausente en particular y te sugerirá incluirlo en el directorio. Puedes aprender sobre la estructura del directorio del proyecto desde el enlace de ayuda proporcionado y rectificar los errores.<br /> -------------------------------------------------------------------------------- title: "Posibles errores en las ejecuciones de comandos" description: "Catalyst proporciona ayuda contextual cuando encuentras un error durante la ejecución de un comando del CLI." last_updated: "2026-07-02T09:34:15.862Z" source: "https://docs.catalyst.zoho.com/es/cli/v1/context-sensitive-help/possible-errors/" service: "All Services" -------------------------------------------------------------------------------- # Lista de posibles errores en las ejecuciones de comandos A continuación se presentan algunos posibles errores comunes que podrías encontrar en tu CLI durante las ejecuciones de comandos, y las acciones que puedes tomar para resolverlos: <br> <div class="mobile-h-scroll"> <table class="content-table"> <thead> <tr> <th class="right">Comando/Componente</th> <th class="middle-right">Errores</th> <th class="middle-right">Soluciones</th> </tr> </thead> <tbody> <tr> <td rowspan="7" class="left pos-re">Autenticación</td> <td class="middle-right">Contenedor de tokens vacío</td> <td class="middle-right">Genera un nuevo token</td> </tr> <tr> <td class="middle-right">Error al recuperar el token</td> <td class="middle-right">Usa un token válido de la lista</td> </tr> <tr> <td class="middle-right">Sesión cerrada del CLI</td> <td class="middle-right">Inicia sesión en el CLI</td> </tr> <tr> <td class="middle-right">Error al recuperar el Refresh Token o Access Token</td> <td class="middle-right">Inicia sesión en el CLI usando --no-localhost</td> </tr> <tr> <td class="middle-right">Error al generar el token</td> <td class="middle-right">Genera un nuevo token</td> </tr> <tr> <td class="middle-right">Token inválido proporcionado con la opción --token</td> <td class="middle-right">Proporciona un token válido con la opción</td> </tr> <tr> <td class="middle-right">Error de autenticación</td> <td class="middle-right">Vuelve a iniciar sesión con la opción --force</td> </tr> <tr> <td class="left pos-re">Centro de datos</td> <td class="middle-right">Entrada inválida para la opción --dc</td> <td class="middle-right">Especifica una entrada válida e intenta de nuevo</td> </tr> <tr> <td rowspan="7" class="left pos-re">Proyecto</td> <td class="middle-right">Primer proyecto de Catalyst no creado</td> <td class="middle-right">Crea un nuevo proyecto</td> </tr> <tr> <td class="middle-right">Proyecto proporcionado con la opción -p no encontrado</td> <td class="middle-right">Selecciona un proyecto existente de la lista</td> </tr> <tr> <td class="middle-right">Archivo faltante en el directorio del proyecto</td> <td class="middle-right">Inicializa el proyecto o configura el componente faltante </td> </tr> <tr> <td class="middle-right">Recurso no encontrado en el directorio del proyecto</td> <td class="middle-right">Inicializa el proyecto o configura el componente faltante</td> </tr> <tr> <td class="middle-right">Proyecto no encontrado en la consola remota</td> <td class="middle-right">Usa un proyecto disponible de la lista</td> </tr> <tr> <td class="middle-right">Archivo corrupto en el directorio del proyecto</td> <td class="middle-right">Elimina el archivo corrupto e inicializa el proyecto de nuevo</td> </tr> <tr> <td class="middle-right">Proyecto activo no encontrado en la consola remota</td> <td class="middle-right">Cambia el proyecto activo existente a uno disponible</td> </tr> <tr> <td rowspan="14" class="left pos-re">API Gateway</td> <td class="middle-right">Error al habilitar APIG: Programador de APIG en progreso</td> <td class="middle-right">Verifica el estado del trabajo programado e intenta de nuevo después de un momento</td> </tr> <tr> <td class="middle-right">Informes de APIG no encontrados</td> <td class="middle-right">Despliega las reglas de APIG desde el CLI</td> </tr> <tr> <td class="middle-right">Error al deshabilitar APIG: Programador de APIG en progreso</td> <td class="middle-right">Verifica el estado del trabajo programado e intenta de nuevo después de un momento</td> </tr> <tr> <td class="middle-right">No se puede leer el archivo de reglas de APIG</td> <td class="middle-right">Rectifica los errores especificados e intenta de nuevo</td> </tr> <tr> <td class="middle-right">Archivo de reglas de APIG faltante</td> <td class="middle-right">Crea el archivo faltante o especifica un nombre de archivo válido</td> </tr> <tr> <td class="middle-right">Nombre faltante en la regla de APIG</td> <td class="middle-right">Proporciona un nombre para la regla de APIG</td> </tr> <tr> <td class="middle-right">Nombre duplicado en la regla de APIG</td> <td class="middle-right">Cambia el nombre o elimina la regla de APIG</td> </tr> <tr> <td class="middle-right">Valores obligatorios faltantes en la regla de APIG</td> <td class="middle-right">Agrega los valores obligatorios especificados a la regla de APIG</td> </tr> <tr> <td class="middle-right">Valores duplicados en la regla de APIG</td> <td class="middle-right">Modifica la regla de APIG y resuelve el conflicto</td> </tr> <tr> <td class="middle-right">Client inválido especificado en la regla de APIG</td> <td class="middle-right">Rectifica los errores especificados en el Client e intenta de nuevo</td> </tr> <tr> <td class="middle-right">No se puede autenticar la regla de APIG con destino Client</td> <td class="middle-right">Elimina la clave especificada de la regla de APIG</td> </tr> <tr> <td class="middle-right">RegEx inválida en la regla de APIG</td> <td class="middle-right">Rectifica el error de RegEx especificado</td> </tr> <tr> <td class="middle-right">Parámetros inválidos en la regla de APIG</td> <td class="middle-right">Rectifica el error especificado para continuar</td> </tr> <tr> <td class="middle-right">URL de solicitud o destino inválida en la regla de APIG</td> <td class="middle-right">Proporciona una URL de destino válida en la regla de APIG</td> </tr> <tr> <td rowspan="3" class="left pos-re">Data Store</td> <td class="middle-right">Identificador de tabla faltante en la operación de exportación/importación</td> <td class="middle-right">Proporciona el identificador de tabla en el comando o archivo de configuración</td> </tr> <tr> <td class="middle-right">Archivo fuente faltante en la operación de importación</td> <td class="middle-right">Proporciona la ruta del archivo CSV en la máquina local con el comando, o el File ID del archivo subido en File Store en el JSON de configuración</td> </tr> <tr> <td class="middle-right">No hay carpetas en File Store para subir el archivo CSV para importación</td> <td class="middle-right">Crea al menos una carpeta en File Store</td> </tr> <tr> <td rowspan="8" class="left pos-re">Client</td> <td class="middle-right">Client web no encontrado en la máquina local</td> <td class="middle-right">Crea un nuevo Client web</td> </tr> <tr> <td class="middle-right">Client web no encontrado en la consola remota</td> <td class="middle-right">Despliega un Client web desde el CLI</td> </tr> <tr> <td class="middle-right">Versión del Client web no encontrada en la máquina local/consola remota para eliminar</td> <td class="middle-right">Elimina una versión de la lista de versiones disponibles </td> </tr> <tr> <td class="middle-right">La versión del Client web está en producción y no se puede eliminar</td> <td class="middle-right">Cambia la versión en producción a una diferente o despliega una nueva versión del Client web</td> </tr> <tr> <td class="middle-right">No se pueden usar las opciones --local y --remote simultáneamente para eliminar</td> <td class="middle-right">Usa solo una de las opciones a la vez</td> </tr> <tr> <td class="middle-right">No se puede analizar el archivo del Client</td> <td class="middle-right">Rectifica el error especificado e intenta de nuevo</td> </tr> <tr> <td class="middle-right">Archivo faltante en el directorio del Client</td> <td class="middle-right">Crea el archivo especificado en el directorio fuente del Client</td> </tr> <tr> <td class="middle-right">Archivo corrupto en el directorio del Client</td> <td class="middle-right">Rectifica el error especificado o proporciona destinos válidos</td> </tr> <tr> <td rowspan="8" class="left pos-re">Functions</td> <td class="middle-right">No hay Functions en la consola remota para configurar o usar la funcionalidad</td> <td class="middle-right">Crea una nueva función en la consola o despliega una función en la consola</td> </tr> <tr> <td class="middle-right">Valor inválido con la opción --memory al configurar</td> <td class="middle-right">Proporciona un número válido con la opción</td> </tr> <tr> <td class="middle-right">Función no encontrada en la máquina local para eliminar</td> <td class="middle-right">Selecciona una función disponible de la lista para eliminar</td> </tr> <tr> <td class="middle-right">No hay Functions en la máquina local para eliminar</td> <td class="middle-right">Crea una nueva función en el directorio del proyecto</td> </tr> <tr> <td class="middle-right">Función no encontrada en la consola remota para eliminar</td> <td class="middle-right">Selecciona una función disponible de la lista para eliminar</td> </tr> <tr> <td class="middle-right">No hay Functions en la consola remota para eliminar</td> <td class="middle-right">Crea una nueva función en la consola o despliega una función en la consola</td> </tr> <tr> <td class="middle-right">No se puede usar el ID de función en la máquina local para eliminar</td> <td class="middle-right">Usa el nombre de la función o ejecuta el comando sin especificar identificadores de función</td> </tr> <tr> <td class="middle-right">No se pueden usar las opciones --local y --remote simultáneamente para eliminar</td> <td class="middle-right">Usa solo una de las opciones a la vez</td> </tr> <tr> <td rowspan="5" class="left pos-re">Archivos de configuración</td> <td class="middle-right">Functions especificadas en el archivo de configuración no encontradas</td> <td class="middle-right">Especifica nombres de función válidos bajo la clave functions</td> </tr> <tr> <td class="middle-right">Client especificado en el archivo de configuración no encontrado</td> <td class="middle-right">Especifica un directorio fuente de Client válido bajo la clave client</td> </tr> <tr> <td class="middle-right">Directorio especificado en el archivo de configuración no encontrado</td> <td class="middle-right">Especifica un nombre de directorio válido que esté disponible en el directorio del proyecto</td> </tr> <tr> <td class="middle-right">Destinos inválidos en el archivo de configuración</td> <td class="middle-right">Especifica valores válidos como targets en el archivo de configuración</td> </tr> <tr> <td class="middle-right">Archivo faltante en el directorio raíz del proyecto</td> <td class="middle-right">Inicializa el proyecto de nuevo</td> </tr> <tr> <td rowspan="4" class="left pos-re">Scripts</td> <td class="middle-right">Comando de script inválido</td> <td class="middle-right">Especifica el comando en un formato válido</td> </tr> <tr> <td class="middle-right">Funcionalidad especificada inválida</td> <td class="middle-right">Especifica una funcionalidad válida para ejecutar el script</td> </tr> <tr> <td class="middle-right">Script no disponible en el archivo</td> <td class="middle-right">Ejecuta un script disponible</td> </tr> <tr> <td class="middle-right">El script finalizó con error</td> <td class="middle-right">Rectifica el error e intenta de nuevo</td> </tr> <tr> <td rowspan="8" class="left pos-re">Generación de eventos</td> <td class="middle-right">Opciones proporcionadas no están en pares</td> <td class="middle-right">Proporciona las opciones como pares en el formato correcto</td> </tr> <tr> <td class="middle-right">Fuente inválida</td> <td class="middle-right">Proporciona una fuente disponible<br></td> </tr> <tr> <td class="middle-right">Opciones en formato inválido</td> <td class="middle-right">Proporciona las opciones en un formato válido</td> </tr> <tr> <td class="middle-right">Nombre del Event Bus faltante en evento personalizado</td> <td class="middle-right">Proporciona el nombre del Event Bus</td> </tr> <tr> <td class="middle-right">Identificador de regla faltante en evento personalizado</td> <td class="middle-right">Proporciona el identificador de regla</td> </tr> <tr> <td class="middle-right">Event Bus no encontrado en la consola remota</td> <td class="middle-right">Proporciona un nombre de Event Bus disponible</td> </tr> <tr> <td class="middle-right">Acción no compatible con la fuente</td> <td class="middle-right">Proporciona una acción compatible con la fuente</td> </tr> <tr> <td class="middle-right">Identificador de segmento/tabla/carpeta incorrecto</td> <td class="middle-right">Proporciona un identificador válido con la opción</td> </tr> <tr> <td rowspan="3" class="left pos-re">Generación de eventos: funciones de integración</td> <td class="middle-right">Valor de entrada incorrecto para evento de integración con Cliq</td> <td class="middle-right">Proporciona la entrada en el formato correcto</td> </tr> <tr> <td class="middle-right">Combinación desconocida de componente Cliq</td> <td class="middle-right">Elige la combinación apropiada de componentes Cliq de la lista</td> </tr> <tr> <td class="middle-right">Servicio de integración no disponible</td> <td class="middle-right">Proporciona un servicio de integración disponible</td> </tr> <tr> <td class="left pos-re">Pull</td> <td class="middle-right">Valor inválido con el comando</td> <td class="middle-right">Proporciona los valores client, functions o apig con el comando</td> </tr> <tr> <td rowspan="2" class="left pos-re">Serve</td> <td class="middle-right">No hay componentes válidos para servir</td> <td class="middle-right">Rectifica los errores e intenta de nuevo</td> </tr> <tr> <td class="middle-right">Puertos en el rango indicado no disponibles</td> <td class="middle-right">Especifica un puerto fuera del rango indicado</td> </tr> <tr> <td class="left pos-re">Shell</td> <td class="middle-right">No hay funciones válidas para servir</td> <td class="middle-right">Rectifica los errores e intenta de nuevo</td> </tr> <tr> <td rowspan="2" class="left pos-re">Deploy</td> <td class="middle-right">No hay Functions listas para desplegar</td> <td class="middle-right">Ejecuta el comando deploy con una opción apropiada</td> </tr> <tr> <td class="middle-right">Despliegue de APIG omitido</td> <td class="middle-right">Habilita API Gateway localmente y despliégalo una vez más</td> </tr> <tr> <td rowspan="7" class="left pos-re">Configuración de Functions Java</td> <td class="middle-right">Archivo JAR faltante en la ruta especificada en el archivo de configuración</td> <td class="middle-right">Especifica una ruta válida al archivo JAR</td> </tr> <tr> <td class="middle-right">Archivo corrupto en el directorio de Functions</td> <td class="middle-right">Elimina el archivo corrupto y ejecuta el comando de nuevo</td> </tr> <tr> <td class="middle-right">Nombre de proyecto no coincide en el archivo de configuración</td> <td class="middle-right">Cambia el nombre del proyecto a un valor apropiado</td> </tr> <tr> <td class="middle-right">Error en la verificación de la versión del compilador Java</td> <td class="middle-right">Asegúrate de que el compilador Java esté instalado y ejecuta el comando de nuevo</td> </tr> <tr> <td class="middle-right">Compilador Java por encima de la versión compatible</td> <td class="middle-right">Degrada el compilador Java a una versión compatible</td> </tr> <tr> <td class="middle-right">Archivo principal faltante en el directorio de Functions</td> <td class="middle-right">Especifica un archivo principal válido en el archivo de configuración</td> </tr> <tr> <td class="middle-right">Error de compilación Java</td> <td class="middle-right">Rectifica los errores especificados para continuar</td> </tr> <tr> <td class="left pos-re">Configuración de Functions Node.js</td> <td class="middle-right">Archivo principal faltante en el directorio de Functions</td> <td class="middle-right">Especifica un archivo principal válido en el archivo de configuración</td> </tr> <tr> <td rowspan="8" class="left pos-re">Uso de opciones</td> <td class="middle-right">Destinos duplicados especificados para la opción</td> <td class="middle-right">Elimina el valor duplicado e intenta de nuevo</td> </tr> <tr> <td class="middle-right">Destino inválido especificado con la opción</td> <td class="middle-right">Proporciona un destino válido según lo especificado</td> </tr> <tr> <td class="middle-right">Destino especificado con y sin filtro</td> <td class="middle-right">Proporciona el destino en un formato válido</td> </tr> <tr> <td class="middle-right">No se puede depurar el destino Client</td> <td class="middle-right">Elimina el Client como destino en -\-debug e intenta de nuevo</td> </tr> <tr> <td class="middle-right">Conflicto en el uso de opciones</td> <td class="middle-right">Usa solo una de las opciones a la vez</td> </tr> <tr> <td class="middle-right">Entrada inválida para la opción</td> <td class="middle-right">Proporciona una entrada válida según lo especificado e intenta de nuevo</td> </tr> <tr> <td class="middle-right">APIG no se puede servir por separado</td> <td class="middle-right">Incluye al menos otro componente como Functions o Client</td> </tr> <tr> <td class="middle-right">La opción Org es necesaria cuando se proporciona la opción Project</td> <td class="middle-right">Proporciona el ID de la organización a la que pertenece el proyecto usando -\-org cuando te refieras a un proyecto específico usando -\-project o -p</td> </tr> <tr> <td rowspan="4" class="left pos-re">General</td> <td class="middle-right">No se está en el directorio de la aplicación Catalyst durante la ejecución del comando</td> <td class="middle-right">Ejecuta el comando desde un directorio válido de Catalyst o inicializa un proyecto para hacer de este un directorio de aplicación Catalyst</td> </tr> <tr> <td class="middle-right">Uso incorrecto del comando</td> <td class="middle-right">Usa catalyst help o ejecuta el comando con la opción --help para obtener instrucciones de uso</td> </tr> <tr> <td class="middle-right">No se puede cargar el archivo</td> <td class="middle-right">Rectifica los errores especificados para continuar</td> </tr> <tr> <td class="middle-right">Puerto solicitado no disponible</td> <td class="middle-right">Proporciona un puerto diferente con el comando</td> </tr> </tbody> </table> </div> ### Ayuda del CLI -------------------------------------------------------------------------------- title: "Ayuda de referencia de comandos" description: "Catalyst proporciona diversas opciones de ayuda para las ejecuciones de comandos del CLI, como la referencia de comandos, la ayuda de sintaxis de comandos, la opción de ayuda y la ayuda contextual." last_updated: "2026-07-02T09:34:15.863Z" source: "https://docs.catalyst.zoho.com/es/cli/v1/cli-help/command-reference-help/" service: "All Services" -------------------------------------------------------------------------------- # Ayuda de referencia de comandos ### Ver la referencia de comandos Catalyst proporciona diversas opciones de ayuda para las ejecuciones de comandos del CLI. Puedes usar estas opciones en cualquier momento que necesites ayuda con tus operaciones del CLI, como para obtener la referencia de comandos o la lista de opciones disponibles para un comando en particular. Puedes obtener fácilmente la referencia de comandos que lista todos los comandos del CLI disponibles con su sintaxis, junto con descripciones breves de los comandos y las acciones que realizan. Esto también listará las opciones generales del CLI que se pueden usar con cualquier comando del CLI, con sus descripciones. <br> Para ver la referencia de comandos, puedes ejecutar el siguiente comando desde cualquier directorio: catalyst help <br> Esto mostrará todos los comandos y opciones disponibles en la versión del CLI que tienes instalada. -------------------------------------------------------------------------------- title: "Ayuda de sintaxis y opciones de comandos" description: "Catalyst proporciona diversas opciones de ayuda para las ejecuciones de comandos del CLI, como la referencia de comandos, la ayuda de sintaxis de comandos, la opción de ayuda y la ayuda contextual." last_updated: "2026-07-02T09:34:15.863Z" source: "https://docs.catalyst.zoho.com/es/cli/v1/cli-help/command-syntax-and-options-help/" service: "All Services" -------------------------------------------------------------------------------- # Ayuda de sintaxis y opciones de comandos También puedes obtener ayuda con un comando específico. Esto proporciona una breve descripción del propósito del comando y lista las opciones disponibles para el comando y sus sintaxis. Puedes acceder a esta ayuda especificando el comando después de catalyst help. <br> Por ejemplo, si necesitas ayuda con catalyst serve, puedes ejecutar el siguiente comando: catalyst help serve <br> Esto proporcionará una breve descripción del comando y listará las opciones que admite. -------------------------------------------------------------------------------- title: "La opción de ayuda" description: "Catalyst proporciona diversas opciones de ayuda para las ejecuciones de comandos del CLI, como la referencia de comandos, la ayuda de sintaxis de comandos, la opción de ayuda y la ayuda contextual." last_updated: "2026-07-02T09:34:15.863Z" source: "https://docs.catalyst.zoho.com/es/cli/v1/cli-help/help-option/" service: "All Services" -------------------------------------------------------------------------------- # La opción de ayuda También puedes obtener ayuda para un comando específico escribiendo el comando y agregando la opción -h o <br> -\\-help. Esto realiza la misma funcionalidad que la ayuda de sintaxis y opciones de comandos mencionada en la sección anterior. Por ejemplo, si necesitas ayuda con el comando catalyst functions:shell, puedes ejecutar el siguiente comando: catalyst functions:shell --help|-h Esto se discute en detalle en el documento de opciones del CLI. -------------------------------------------------------------------------------- title: "Ayuda contextual" description: "Catalyst proporciona diversas opciones de ayuda para las ejecuciones de comandos del CLI, como la referencia de comandos, la ayuda de sintaxis de comandos, la opción de ayuda y la ayuda contextual." last_updated: "2026-07-02T09:34:15.863Z" source: "https://docs.catalyst.zoho.com/es/cli/v1/cli-help/context-sensitive-help/" service: "All Services" -------------------------------------------------------------------------------- # Ayuda contextual Catalyst también proporciona ayuda contextual cuando encuentras un error durante la ejecución de un comando del CLI. Catalyst no solo especificará la razón detrás del error, sino que también te proporcionará ayuda con las acciones que puedes tomar para rectificar o prevenir el error, así como un enlace de ayuda a la documentación de la acción en particular. Esto se discute en detalle en la página de ayuda contextual del CLI, que también incluye una lista de posibles errores que podrías encontrar durante cada una de tus ejecuciones de comandos. ### Desplegar recursos -------------------------------------------------------------------------------- title: "Introducción" description: "Catalyst te permite desplegar fácilmente tu proyecto y sus recursos como Functions, Client web, AppSail, API Gateway y aplicaciones Slate en la nube usando el CLI." last_updated: "2026-07-02T09:34:15.863Z" source: "https://docs.catalyst.zoho.com/es/cli/v1/deploy-resources/introduction/" service: "All Services" -------------------------------------------------------------------------------- # Desplegar recursos ### Introducción Puedes desplegar los recursos de tu proyecto desde el CLI a la consola remota, después de haberlos desarrollado y probado. Esto actualizará el proyecto en la consola con el código más reciente. Los componentes que puedes desplegar desde el CLI son: Client, Functions, AppSail, reglas de API Gateway y aplicaciones Slate que desarrollaste en tu directorio local del proyecto de Catalyst. Puedes desplegar aplicaciones de Client web de los tres tipos: aplicaciones web básicas, aplicaciones Angular y aplicaciones React. Cuando despliegas recursos desde el CLI, solo estarán disponibles en el entorno de desarrollo de tu proyecto de Catalyst. No afectarán el entorno de producción de tu aplicación. Para que los recursos estén disponibles en el entorno de producción, debes desplegar el proyecto a producción desde la consola. También puedes alojar tu aplicación de Client web directamente desde la consola de Catalyst y crear o subir funciones directamente en la consola. También puedes configurar APIs en API Gateway directamente en la consola. Catalyst también admite una opción de despliegue independiente para desplegar tu recurso AppSail sin inicializarlo previamente, además del despliegue regular. Nota: No puedes desplegar recursos de tus aplicaciones móviles usando Catalyst CLI. Puedes alojar aplicaciones móviles usando Mobile Device Management. <br> ### Ejecución del comando deploy Para desplegar tu proyecto de Catalyst y todos sus recursos desde el CLI a la consola remota, ejecuta el siguiente comando en tu terminal desde el directorio de tu proyecto: catalyst deploy Cuando ejecutes este comando, desplegará todos los recursos desplegables en tu directorio de proyecto por defecto. El CLI considerará el proyecto que está activo en tu directorio de trabajo. Si algún proyecto diferente al proyecto base del directorio está activo en él, el CLI mostrará una advertencia informándote al respecto. Después de que se complete el despliegue, tu proyecto se sincronizará con tu proyecto en la consola en la nube. Podrás acceder a las funciones, Client web, AppSail, aplicaciones Slate y las definiciones actualizadas de API Gateway que se desplegaron desde la consola. Nota: Si eres usuario de Visual Studio Code IDE, puedes instalar la extensión Catalyst Tools y realizar operaciones del CLI usando tu IDE en lugar del CLI. Los pasos para desplegar tus recursos de Catalyst usando Visual Studio Code IDE se pueden encontrar aquí. <br> ### Puntos a recordar: * Un proyecto solo se puede desplegar exitosamente si su directorio incluye los paquetes de Client y Functions en la estructura estándar. Los directorios de Functions y Client deben contener los archivos de configuración requeridos en el formato estándar. Para más información, consulta la ayuda de estructura del directorio de proyecto. * El archivo catalyst.json debe estar presente en el directorio del proyecto cuando el proyecto se despliega usando el CLI. No es necesario incluir este archivo cuando alojas directamente el Client web desde la consola. * El archivo catalyst-user-rules.json que contiene las definiciones de las reglas de API Gateway debe estar presente en el directorio raíz del proyecto, si necesitas que se despliegue. Nota: Si eres usuario de Visual Studio Code IDE, puedes instalar la extensión Catalyst Tools y realizar operaciones del CLI usando tu IDE en lugar del CLI. Los pasos para desplegar tus recursos de Catalyst usando Visual Studio Code IDE se pueden encontrar aquí. -------------------------------------------------------------------------------- title: "Desplegar Functions" description: "Catalyst te permite desplegar fácilmente tu proyecto y sus recursos como Functions, Client web, AppSail, API Gateway y aplicaciones Slate en la nube usando el CLI." last_updated: "2026-07-02T09:34:15.864Z" source: "https://docs.catalyst.zoho.com/es/cli/v1/deploy-resources/deploy-functions/" service: "All Services" -------------------------------------------------------------------------------- # Desplegar Functions El CLI compilará todas las funciones Java en tu directorio de proyecto antes de desplegarlas. Los archivos de clase Java compilados estarán disponibles en sus respectivos directorios. Las funciones de Node.js y Python se despliegan directamente. El CLI despliega cada función individualmente. El CLI mostrará el estado del despliegue de cada recurso individualmente, indicando si fue exitoso o falló. Las funciones Basic I/O y Advanced I/O se despliegan en las URLs mostradas en la terminal, y puedes acceder a sus endpoints desde sus URLs. Los endpoints de las funciones Cron, Event, Browser Logic e Integration no son accesibles a través de URLs, ya que están asociadas con cron jobs, event listeners o integraciones externas respectivamente. El CLI solo mostrará su estado de despliegue. <br> Nota: La parte /server/ en la URL de una aplicación de Catalyst indica una función. La URL de una función Basic I/O contiene un /execute después del nombre de la función, mientras que la URL de una función Advanced I/O no contiene esa palabra clave. <br> -------------------------------------------------------------------------------- title: "Desplegar Client" description: "Catalyst te permite desplegar fácilmente tu proyecto y sus recursos como Functions, Client web, AppSail, API Gateway y aplicaciones Slate en la nube usando el CLI." last_updated: "2026-07-02T09:34:15.864Z" source: "https://docs.catalyst.zoho.com/es/cli/v1/deploy-resources/deploy-client/" service: "All Services" -------------------------------------------------------------------------------- # Desplegar Client El despliegue de un Client web generará la URL del endpoint del Client web alojado, donde puedes acceder a la aplicación. ### Desplegar aplicaciones básicas de Client El Client web básico se desplegará directamente. <br> ### Desplegar aplicaciones Angular Cuando despliegas una aplicación Angular, el plugin de Catalyst para tu aplicación Angular, zcatalyst-cli-plugin-angular , que se instala cuando la aplicación Angular se inicializa, gestionará el despliegue. Se generan los archivos chunk que representan tus componentes y servicios Angular, como los archivos de polyfills y runtime. El build se genera después de que se crean los archivos chunk. Las aplicaciones Angular se compilan y se construyen en un directorio de salida dist/. Esta carpeta contendrá todos los archivos compilados de tu aplicación, como el archivo de punto de entrada, hojas de estilo y plantillas de los tipos HTML, CSS, JS o TS en la carpeta fuente de tu aplicación, src. Los detalles del despliegue se actualizarán en el archivo de configuración del workspace angular.json. Estos se enmarcan dentro del procedimiento estándar de despliegue de las aplicaciones Angular. El CLI mostrará los detalles del despliegue de tu aplicación Angular. La URL del endpoint del Client web desplegado se generará y mostrará. Puedes abrir la aplicación con esta URL. <br> ### Desplegar aplicaciones React Cuando despliegas una aplicación React, el plugin de Catalyst para tu aplicación React, zcatalyst-cli-plugin-react , que se instala cuando la aplicación React se inicializa, gestionará el despliegue. El plugin habilitará la compilación de la aplicación React. Las aplicaciones React se compilan y se construyen en un directorio de salida build/. Esta carpeta contendrá todos los archivos compilados de tu aplicación, como los archivos HTML, hojas de estilo, JS y otros archivos en la carpeta fuente de tu aplicación src. El build listo para producción se genera después de la compilación. Si habías desarrollado tu aplicación React en TypeScript, el código se transpilará a JavaScript durante la compilación. Estos se enmarcan dentro del procedimiento estándar de despliegue de las aplicaciones React. El CLI mostrará los detalles del despliegue de tu aplicación React. La URL del endpoint del Client web desplegado se generará y mostrará. Puedes abrir la aplicación con esta URL. <br> Nota: * La parte /app/ en la URL de una aplicación de Catalyst indica el componente Client. Puedes ver las URLs de tu aplicación de ambos entornos desde la sección de configuración de entornos. * Si ingresas la URL de la aplicación en este formato: https://_nombre\_de\_dominio\_del\_proyecto_.development.catalystserverless.com, te redirigirá automáticamente a la página de inicio de la aplicación que hayas configurado en el archivo client-package.json , en el entorno de desarrollo. <br> -------------------------------------------------------------------------------- title: "Desplegar AppSail" description: "Catalyst te permite desplegar fácilmente tu proyecto y sus recursos como Functions, cliente web, AppSail, API Gateway y aplicaciones Slate en la nube usando el CLI." last_updated: "2026-07-02T09:34:15.864Z" source: "https://docs.catalyst.zoho.com/es/cli/v1/deploy-resources/deploy-appsail/" service: "All Services" -------------------------------------------------------------------------------- # Desplegar AppSail ### Introducción Catalyst te permite desplegar los servicios de AppSail de dos formas diferentes: * Despliegue regular: El despliegue regular se aplica cuando ya has inicializado un recurso AppSail ya sea durante la inicialización del proyecto o al agregarlo en un directorio de proyecto existente. * Despliegue independiente: Puedes hacer un despliegue independiente de una aplicación directamente sin inicializarla como un servicio AppSail previamente. Puedes desplegar las aplicaciones inicializadas como runtimes administrados por Catalyst o runtimes personalizados a través de ambos métodos de despliegue. A continuación se presentan algunos puntos importantes para AppSail inicializado o agregado de dos formas diferentes: * Runtimes administrados por Catalyst: Catalyst despliega todos los archivos ejecutables de tu aplicación presentes en la ruta de compilación que especificaste durante la inicialización de la aplicación, en este caso junto con las configuraciones del proyecto. Nota: No necesitas empaquetar ni comprimir todos los archivos de compilación juntos, ya que AppSail los empaquetará automáticamente durante el servicio o despliegue de la aplicación desde la ruta de compilación especificada. * Imágenes de contenedor: La imagen OCI de tu aplicación asociada con AppSail se despliega, junto con el archivo de configuración de tu proyecto. Nota: Catalyst solo admite el despliegue de imágenes compatibles con OCI compiladas para la plataforma Linux AMD64 (x86-64). <br> ### Despliegue regular Si la aplicación AppSail ya está inicializada en el directorio del proyecto, el CLI desplegará automáticamente la aplicación junto con el resto de los recursos del proyecto cuando ejecutes el comando catalyst deploy. El CLI mostrará la URL del endpoint de la aplicación después de que se despliegue, con la que puedes abrirla. <br> Si tienes múltiples aplicaciones AppSail en tu directorio de proyecto, puedes acceder a todas sus URLs de endpoint desde el CLI. También puedes ejecutar el siguiente comando para desplegar únicamente el servicio AppSail desde el directorio fuente de tu aplicación. catalyst deploy appsail El proceso de despliegue es el mismo. <br> <br> ### Despliegue independiente Debes ejecutar el comando de despliegue independiente desde la raíz del directorio de un proyecto Catalyst. Es decir, catalyst.json y otros archivos de dependencia del proyecto deben estar presentes en el directorio. Nota: Si ejecutas el comando de despliegue independiente sin ninguna de las [opciones específicas para desplegar imágenes de contenedor](#standalone-deploy-appsail-options), el CLI te solicitará entradas relacionadas únicamente con aplicaciones de runtime administrado por Catalyst de forma predeterminada. Debes recordar los siguientes puntos sobre el despliegue independiente. Aplicaciones de runtime administrado por Catalyst: * Debes asegurarte de que los archivos de compilación desplegables de tu aplicación estén presentes en el directorio desde el que ejecutas el comando. Esto se debe a que ese directorio se considerará como el directorio de compilación automáticamente. * El archivo app-config.json no se crea cuando haces un despliegue independiente para desplegar una aplicación sin inicializarla. La información que contiene este archivo se obtiene como entrada tuya en el CLI durante el despliegue. Imágenes de contenedor: * Puedes usar el comando de despliegue independiente con estas opciones para desplegar aplicaciones como imágenes de contenedor: --name &lt;name&gt;, --source &lt;image&gt;, --command &lt;command&gt;, --port &lt;port&gt;. Las dos primeras son obligatorias, mientras que las dos últimas son opcionales y se pueden usar para anular cualquier comando de inicio o puertos ya configurados en la definición de la imagen de contenedor. Las opciones se explican en detalle a continuación. <br> Puedes hacer el despliegue independiente de una aplicación AppSail de la siguiente manera: 1. Navega al directorio donde están presentes los archivos desplegables de la aplicación y ejecuta el siguiente comando: catalyst deploy appsail 2. Ingresa un nombre para tu aplicación. Puedes nombrar el archivo principal de la compilación de tu aplicación como prefieras. <br> Nota: Sin embargo, cuando compilas tu aplicación como un archivo Java WAR, necesitarás nombrar el archivo principal root.war o agregar controladores específicos según tu código. 3. Selecciona la ruta de compilación para tu aplicación de la lista y presiona **Enter**. <br> 4. Selecciona un stack para tu aplicación y presiona **Enter**. <br> Si seleccionas Java, el CLI te solicitará adicionalmente que elijas entre Java SE o Java WAR como formato desplegable de tu aplicación. <br> Si seleccionas cualquier otro stack, esto se omitirá. 5. Adicionalmente debes especificar el comando de inicio para tu aplicación según el stack, framework y servidor web utilizado. Esta información se desplegará directamente y estará disponible en la sección Configurations de tu consola después del despliegue de la aplicación. <br> Tu aplicación ahora está desplegada directamente en el proyecto remoto asociado sin necesidad de inicializarla como un recurso AppSail. Ahora puedes acceder a ella con su URL de endpoint que se muestra en el CLI. <br> <br> ### Opciones de despliegue independiente de AppSail El comando de despliegue independiente catalyst deploy appsail admite las siguientes opciones. Algunas de estas son aplicables tanto a aplicaciones de runtime administrado por Catalyst como a imágenes de contenedor, mientras que algunas son específicas solo para uno de ellos. --name &lt;name&gt; Usa esto para especificar el nombre de tu aplicación. Esto es aplicable tanto a aplicaciones de runtime administrado por Catalyst como a imágenes de contenedor. Ejemplo: --name DemoApp --build-path &lt;path&gt; Usa esto para especificar la ruta de compilación de tu aplicación. Proporciona un valor de ruta absoluta. Esto es aplicable solo a aplicaciones de runtime administrado por Catalyst. Ejemplo: --build-path /users/amelia/catalystapp/demoapp/ --stack &lt;stack&gt; Usa esto para especificar el stack o runtime de tu aplicación. Solo debes especificar los runtimes que son soportados por Catalyst. Esto es aplicable solo a aplicaciones de runtime administrado por Catalyst. Ejemplo: --stack NodeJS 20 --platform &lt;javase|war&gt; Usa esto para especificar la plataforma del stack Java únicamente que son soportadas en Catalyst: javase o war. Esto es aplicable solo a aplicaciones de runtime administrado por Catalyst. Ejemplo: --platform javase --command &lt;command&gt; Usa esto para especificar el comando de inicio para tu aplicación. Esto es aplicable tanto a aplicaciones de runtime administrado por Catalyst como a imágenes de contenedor. Esto anulará cualquier valor ya configurado en la definición de la imagen de contenedor. Ejemplo: --command npm start --source &lt;image&gt; Usa esto para especificar la fuente de la imagen docker a desplegar. Esto es aplicable solo a aplicaciones de imagen de contenedor. Debes comenzar con '*docker://*' para el protocolo de imagen Docker y '*docker-archive://*' para el protocolo de archivo Docker. Consulta aquí para más detalles. Ejemplo: --source docker://example-voting-app-worker:latest --port &lt;port&gt; Usa esto para especificar el puerto para AppSail. Esto es aplicable solo a aplicaciones de imagen de contenedor. Esto anulará cualquier valor ya configurado en la definición de la imagen de contenedor. Ejemplo: --port 8000 -------------------------------------------------------------------------------- title: "Desplegar API Gateway" description: "Catalyst te permite desplegar fácilmente tu proyecto y sus recursos como Functions, Client web, AppSail, API Gateway y aplicaciones Slate en la nube usando el CLI." last_updated: "2026-07-02T09:34:15.864Z" source: "https://docs.catalyst.zoho.com/es/cli/v1/deploy-resources/deploy-api-gateway/" service: "All Services" -------------------------------------------------------------------------------- # Desplegar API Gateway Puedes desplegar el archivo JSON de API Gateway de tu proyecto en la nube. Esto actualizará las definiciones de API locales en la consola remota. Nota: Si API Gateway está deshabilitado para tu proyecto, el despliegue de las reglas de API Gateway se omitirá. -------------------------------------------------------------------------------- title: "Desplegar en Slate" description: "Catalyst te permite desplegar fácilmente tu proyecto y sus recursos como Functions, Client web, AppSail, API Gateway y aplicaciones Slate en la nube usando el CLI." last_updated: "2026-07-02T09:34:15.864Z" source: "https://docs.catalyst.zoho.com/es/cli/v1/deploy-resources/deploy-to-slate/" service: "All Services" -------------------------------------------------------------------------------- # Desplegar en Slate Puedes desplegar tu aplicación web frontend en Catalyst Slate siguiendo los pasos que se indican a continuación. Antes de desplegar cualquier aplicación en Slate, asegúrate de que el directorio del proyecto esté vinculado al servicio Slate. Para esto, puedes usar el comando catalyst slate:link. Ejecuta el siguiente comando en tu terminal desde el directorio del proyecto del servicio Slate: catalyst deploy slate Esto despliega todos los componentes de Slate presentes en tu directorio de proyecto en el entorno de desarrollo de Catalyst. Puedes usar la siguiente opción para proporcionar un mensaje de despliegue para el despliegue en Slate. catalyst deploy slate -m "deployment message" Para desplegar solo una aplicación específica desde el directorio del proyecto a Slate, puedes usar directamente el siguiente comando: catalyst deploy --only slate:appname Si deseas desplegar la aplicación en el entorno de producción, usa el siguiente comando. Asegúrate de haber accedido al entorno de producción en la consola antes de iniciar un despliegue a producción. catalyst deploy slate --production -------------------------------------------------------------------------------- title: "Opciones de despliegue" description: "Catalyst te permite desplegar fácilmente tu proyecto y sus recursos en la consola remota usando el CLI." last_updated: "2026-07-02T09:34:15.864Z" source: "https://docs.catalyst.zoho.com/es/cli/v1/deploy-resources/deploy-options/" service: "All Services" -------------------------------------------------------------------------------- # Opciones de despliegue Catalyst CLI te permite desplegar solo recursos específicos, como solo el paquete del cliente, funciones específicas o un servicio AppSail, usando dos opciones de despliegue. Las siguientes opciones están disponibles para el comando catalyst deploy. Nota: Además de estas opciones de despliegue, también puedes desplegar recursos específicos de tu proyecto navegando a la carpeta de destino donde se encuentran los recursos y ejecutando el comando catalyst deploy desde esa carpeta. Esto se puede usar cuando los recursos desplegables están todos ubicados en el mismo directorio. Por ejemplo, si deseas desplegar una función particular sola, puedes navegar a la carpeta de la función en el CLI y ejecutar el comando catalyst deploy. ### \--only &lt;targets&gt; La opción -\\-only te permite definir los recursos específicos a desplegar. Puedes usar esto con las palabras clave client, functions, appsail, slate o apig. Puedes especificar múltiples recursos separados por comas sin caracteres de espacio en blanco entre ellos. Por ejemplo, para desplegar solo el directorio del cliente, ejecuta el siguiente comando en tu terminal: catalyst deploy --only client Esto inicia el despliegue únicamente del directorio del cliente. El proceso de despliegue es el mismo que se discutió en la sección anterior. <br> También puedes desplegar funciones específicas o servicios AppSail usando la opción -\\-only. Debes especificar los nombres de las funciones objetivo o los servicios AppSail en el comando separados por comas como se muestra a continuación: catalyst deploy --only functions:InvoiceFetch,functions:CostAccounting <br> También puedes desplegar el cliente y ciertas funciones, o un servicio AppSail y ciertas funciones, solos como se muestra a continuación: catalyst deploy --only functions:InvoiceSync,functions:CostAccounting,functions:FreightTracking <br> Esto desplegará solo los recursos especificados del directorio del proyecto. <br > ### \--except &lt;targets&gt; La opción -\\-except te permite definir los recursos a excluir del despliegue. Desplegará todos los recursos excepto los que especifiques. Por ejemplo, si usas la opción -\\-except con client, excluirá el paquete del cliente y desplegará todo lo demás. Puedes ejecutar este comando de la siguiente manera: catalyst deploy --except client También puedes usar esta opción para excluir funciones o servicios AppSail específicos. Por ejemplo: $ catalyst deploy --except appsail:customerapp,functions:CostAccounting Esto desplegará todos los demás recursos del proyecto. <br> ### \--ignore-scripts Catalyst te permite automatizar las ejecuciones de comandos del CLI y del terminal definiendo scripts en el archivo catalyst.json en tu directorio de proyecto. Puedes definir dos scripts de ciclo de vida para ejecutar antes y después del comando catalyst deploy respectivamente: predeploy, postdeploy. Puedes aprender más sobre los scripts de ciclo de vida y personalizados en la página de ayuda de Scripts. Si usas la opción -\\-ignore-scripts al ejecutar el comando catalyst deploy, el CLI ignorará las acciones configuradas para los scripts predeploy y postdeploy en el archivo catalyst.json de tu directorio de proyecto. El proceso de despliegue continuará sin la ejecución de estos scripts de ciclo de vida. Puedes usar la opción -\\-ignore-scripts de la siguiente manera: catalyst deploy --ignore-scripts El proceso de despliegue será el mismo que se discutió anteriormente. Nota: Si eres usuario de Visual Studio Code IDE, puedes instalar la extensión Catalyst Tools y realizar operaciones del CLI usando tu IDE en lugar del CLI. Los pasos para desplegar individualmente funciones de Catalyst usando Visual Studio Code IDE se pueden encontrar aquí, y los pasos para desplegar recursos del cliente se pueden encontrar aquí. ### Estructura del directorio del proyecto -------------------------------------------------------------------------------- title: "Introducción" description: "La estructura del directorio del proyecto se refiere a la estructura de directorio predeterminada en la que se crea un proyecto de Catalyst cuando lo inicializas desde el CLI." last_updated: "2026-07-02T09:34:15.864Z" source: "https://docs.catalyst.zoho.com/es/cli/v1/project-directory-structure/introduction/" service: "All Services" -------------------------------------------------------------------------------- # Estructura del Directorio del Proyecto ### Introducción Cuando creas o inicializas un nuevo proyecto desde el Catalyst CLI, se crea con una estructura específica junto con los archivos de configuración necesarios. Este proyecto se almacena en el directorio donde lo creas, que se considerará como el directorio principal del proyecto. El código base del proyecto se genera en el directorio principal del proyecto durante la creación. Para aprender sobre la inicialización de un proyecto de Catalyst o cualquiera de sus componentes específicos desde el CLI, consulta la página de ayuda Inicializar Recursos. Antes de alojar un client web en Catalyst, debes asegurarte de que contenga todos los recursos en la estructura estándar del directorio del proyecto como se describe en esta página de ayuda. Cualquier discrepancia podría causar errores en la producción de tu aplicación. Cuando inicializas un proyecto de Catalyst desde el CLI, se te pedirá que elijas los componentes a inicializar. Los dos componentes fundamentales de un proyecto de Catalyst que puedes inicializar son: el Client y las Functions Si inicializas todos los componentes, se crean los siguientes directorios de recursos en el directorio de tu proyecto: 1. Client 2. Functions 3. catalyst.json Veamos estos recursos en detalle. -------------------------------------------------------------------------------- title: "Directorio de Functions" description: "La estructura del directorio del proyecto se refiere a la estructura de directorio predeterminada en la que se crea un proyecto de Catalyst cuando lo inicializas desde el CLI." last_updated: "2026-07-02T09:34:15.864Z" source: "https://docs.catalyst.zoho.com/es/cli/v1/project-directory-structure/functions-directory/" service: "All Services" -------------------------------------------------------------------------------- # Directorio de Functions ### Introducción Como se discutió anteriormente, Catalyst soporta Functions escritas en entornos de programación Java, Node.js y Python. La carpeta functions en el directorio del proyecto contiene todas las funciones del lado del servidor de tu microservicio o aplicación en carpetas individuales. La carpeta de una función individual en el directorio de Functions contiene el archivo principal de la función (el archivo de clase .java o el archivo .js o el archivo .py), y todas las demás dependencias necesarias y archivos de configuración de la función. También puedes crear funciones secundarias adicionales en la carpeta de la función que trabajen estrechamente con la función principal. Sin embargo, no puedes crear funciones secundarias en una carpeta de función desde el CLI. Puedes importar manualmente los archivos en la carpeta desde un entorno de desarrollo externo, o crearlos en la consola de Catalyst y descargarlos (pull) al directorio usando el CLI. Nota: Puedes agregar cualquier cantidad de Functions de stacks Java, Node.js o Python en el directorio de Functions usando el CLI o configurar el componente de Functions en cualquier momento usando el CLI. Para aprender más, consulta la página de ayuda Trabajar con Functions. Cuando inicializas Functions desde el CLI en el directorio del proyecto, se creará una carpeta llamada 'functions' dentro del directorio del proyecto, junto con las dependencias necesarias según el entorno de programación que selecciones. <br> La carpeta de una función **Java** se configura con los siguientes componentes cuando se crea: 1. El archivo de clase .java principal 2. catalyst-config.json 3. Los archivos de biblioteca .jar La carpeta de una función **Node.js** se configura con los siguientes componentes cuando se crea: 1. El archivo de función principal (index.js) 2. catalyst-config.json 3. Módulos de Node y dependencias de función Node.js La carpeta de una función **Python** se configura con los siguientes componentes cuando se crea: 1. El archivo main.py 2. catalyst-config.json 3. El archivo requirements.txt Primero discutamos sobre el archivo de función principal y el archivo catalyst-config.json que son comunes en los entornos de programación Java, Node.js y Python. ### El Archivo de Función Principal El archivo de función principal es el archivo de tipo .java o .js o .py, dependiendo del lenguaje que selecciones al inicializar la función. El archivo de función principal se crea con una estructura de código de ejemplo para Java, Node.js y Python. Para una función Java, necesitarás proporcionar el nombre de clase de la función principal y el nombre de referencia del grupo de funciones al inicializarla desde el CLI. El nombre de la carpeta de la función será el mismo que el nombre de referencia de la función. Para una función Node.js y Python, necesitarás proporcionar el nombre del paquete de la función. También necesitarás proporcionar el nombre del archivo de punto de entrada o el archivo de función principal, que será index.js y main.py por defecto, respectivamente. El archivo catalyst.json especificará los nombres de referencia o de paquete de todas las Functions. <br> ### Archivo catalyst-config json El archivo catalyst-config.json especifica la configuración de la función, como sus especificaciones de despliegue y ejecución. { "deployment":{ "name": "fn", "stack": "node16", "type": "advancedio", "env_variables": {} }, "execution": { "main": "index.js" } } La información de deployment incluye los siguientes parámetros: * name: El nombre de referencia del grupo de funciones que proporcionaste al inicializarlo.<br /> Si modificas el nombre de referencia de la función, asegúrate de actualizar los cambios en _catalyst-config.json_ y renombrar la carpeta de la función con el mismo nombre. También debes reflejar los cambios en catalyst.json. * stack: Indica si es una función Java, Node.js o Python y la información de versión. Cambiar este valor resultará en errores. * type: Indica el tipo de función. Para aprender más sobre los tipos de funciones, consulta la página de ayuda de Functions. Cambiar este valor resultará en errores. execution se refiere al archivo de función principal que es el punto de entrada, es decir, el nombre del archivo de función principal .java, .js o .py. Debes asegurarte de que el archivo catalyst-config.json esté presente en la raíz de la carpeta de la función y contenga las configuraciones correctas cuando despliegues la función. Ahora veamos en detalle los archivos de biblioteca Java, las dependencias de funciones Node y Python: <br> ### La Carpeta de Biblioteca Java La carpeta de biblioteca llamada lib contiene los archivos JAR dependientes para la función. La carpeta lib se agrega al directorio de la función automáticamente cuando inicializas la función para el entorno Java desde el CLI. Estos archivos JAR son parte del paquete Java SDK. Durante el tiempo de ejecución, la función Java llama a estos archivos de biblioteca ya que contienen paquetes y características que la función requiere para ejecutarse. <br> ### Módulos de Node y Dependencias de Funciones Node JS La carpeta de una función Node.js esencialmente incluye lo siguiente: 1. El archivo de función principal 2. catalyst-config.json 3. package-lock.json 4. package.json 5. La carpeta de módulos de Node Previamente hemos discutido el archivo de función principal y el archivo catalyst-config.json. Los módulos de Node y las dependencias de funciones Node se instalan en tu sistema cuando instalas el paquete Node.js SDK. <br> Los archivos package.json y package-lock.json son archivos de dependencia que contienen la configuración de la función. El archivo package.json especifica información como el nombre de la función, archivo de función principal, versión, autor y más, mientras que el package-lock.json especifica otra información de dependencias en detalle. Nota: Si renombras la función, debes actualizar los cambios en estos archivos de configuración. La carpeta de módulos de Node contiene las subcarpetas de los módulos. Cada módulo contiene archivos de biblioteca individuales, archivos de licencia, archivos de configuración, archivos index y más, que son esenciales para la ejecución de tus funciones Node.js. Uno de los módulos de Node, zcatalyst-sdk-node, contiene las definiciones del Node.js SDK de todos los componentes de Catalyst agrupados en una carpeta llamada src, y otros archivos de dependencia. Nota: * Cuando creas una función desde la consola, el grupo de funciones no contendrá todas las dependencias requeridas. Por ejemplo, los módulos de Node no se agregarán a un grupo de funciones Node.js, aunque se creará una carpeta para ellos. En tales casos, puedes descargar (pull) las Functions desde la consola al directorio del proyecto usando el CLI. Esto creará un directorio para esas funciones en la estructura requerida. Si el grupo de funciones creado en la consola contiene funciones secundarias, se incluirán en la carpeta de la función cuando las descargues desde la consola. * Cuando creas una función desde un editor externo y la importas a Catalyst, debes asegurarte de que todas las dependencias estén incluidas y todos los archivos de configuración estén creados en el formato especificado. Si hay alguna discrepancia, podría resultar en errores cuando la función se ejecute. ### Módulos de Python y Dependencias de Funciones La carpeta de una función Python esencialmente incluye lo siguiente: 1. El archivo main.py 2. catalyst-config.json 3. El archivo requirements.txt Ya hemos discutido sobre el archivo de función principal y el archivo catalyst-config.json en las secciones anteriores. #### Archivo requirements.txt Este archivo requirements.txt contiene la lista de dependencias instaladas que se necesitan para implementar la función Python. Por defecto, contiene la entrada para el paquete Python SDK de Catalyst (zcatalyst-sdk), cuando creas la función Python desde el CLI. Cuando instalas dependencias externas o bibliotecas para tu función, tendrás que configurar los nombres y valores de las dependencias en forma de pares clave-valor manualmente en el archivo requirements.txt y guardarlo. También puedes actualizar la versión del paquete Python SDK o cualquiera de las dependencias externas simplemente configurando los valores de versión apropiados en el archivo requirements.txt y guardándolo. Cuando sirvas o despliegues tu función Python desde el CLI, las configuraciones actualizadas se reflejarán. Nota: Debes configurar todas las dependencias externas que agregues en el directorio de la función en el archivo requirements.txt de manera obligatoria. La estructura del directorio de funciones Python es la siguiente: -------------------------------------------------------------------------------- title: "Directorio del Client" description: "La estructura del directorio del proyecto se refiere a la estructura de directorio predeterminada en la que se crea un proyecto de Catalyst cuando lo inicializas desde el CLI." last_updated: "2026-07-02T09:34:15.865Z" source: "https://docs.catalyst.zoho.com/es/cli/v1/project-directory-structure/client-directory/" service: "All Services" -------------------------------------------------------------------------------- # Directorio del Client La carpeta client en el directorio del proyecto contiene todos los componentes del front-end de tu aplicación. Estos incluyen los archivos HTML de las páginas web, los archivos CSS, los archivos JavaScript que habilitan los elementos accionables en tu página web y otros archivos requeridos. ### Archivos del Directorio del Client Por defecto, la carpeta del Client se configura con los siguientes archivos: <br> index.html: El archivo index.html es el nombre de archivo predeterminado para la página de inicio de tu aplicación web. Se crea con una estructura de código de ejemplo. main.css: El archivo main.css contiene los estilos de las páginas de tu aplicación web. Se crea como un archivo vacío. main.js: El archivo main.js define la funcionalidad de la página de inicio de la aplicación web. Se crea como un archivo vacío. <br> ### Archivo client-package json El client-package.json es el archivo de configuración de tu recurso Client. Contiene las siguientes especificaciones de tu aplicación por defecto: { "name":"shipmentTracking", "version":"0.0.2", "homepage":"index.html", "login_redirect":"home.html", "404":"custom404.html" } * name: El nombre del web Client. Una vez que establezcas un nombre y alojes la aplicación, no debes cambiarlo. Cambiar el nombre de la aplicación web después de haberla alojado resultará en un error. * version: La versión de la aplicación web que se aloja, en formato decimal. Con cada actualización posterior de tu aplicación, puedes modificar el número de versión de manera incremental. No puedes decrementar el número de versión. * homepage: La URL de la página de inicio de la aplicación web. Si modificas el nombre del archivo index.html, debes cambiar el valor correspondiente en este archivo también. <br> Aparte de estas especificaciones obligatorias, también puedes incluir estas propiedades: * description: La descripción de la aplicación web. Esta se puede modificar durante las actualizaciones de versión. * login\_redirect: La página a la que el usuario debe ser redirigido después de un inicio de sesión exitoso en la aplicación web. * 404: Una página 404 personalizada que puedes crear para tu aplicación. Cada vez que los usuarios de tu aplicación intenten acceder a una página inexistente que resulte en un error 404, serán redirigidos a esta página personalizada. Nota: * Si proporcionas una ruta a una página 404 personalizada usando la clave 404, puedes nombrar ese archivo como desees. Si no configuras una clave 404 en el archivo client-package.json, aún puedes incluir una página con el nombre exacto 404.html en el directorio. * Catalyst buscará la clave 404 en el archivo clientpackage.json. Si existe, Catalyst renderizará ese archivo en caso de que ocurra un error 404 en la aplicación. Si no se proporciona una ruta para una página 404 personalizada en tu aplicación, Catalyst buscará cualquier archivo llamado _404.html_ en el directorio del Client. Si ninguno existe, los usuarios serán redirigidos a una página 404 predeterminada proporcionada por Catalyst. <br> Puedes agregar más archivos del Client de tu aplicación web y crear subcarpetas dentro de la carpeta del Client según lo necesites. Sin embargo, el archivo client-package.json debe estar presente obligatoriamente solo en la raíz de tu recurso Client y no en ninguna subcarpeta. Nota: * Una página de inicio para tu aplicación web y el archivo client-package.json deben estar presentes obligatoriamente en el directorio del Client. Los archivos CSS y JS son opcionales, según la funcionalidad de tu aplicación. Puedes eliminar los archivos main.css y main.js si no los necesitas. * Al alojar una aplicación web, debes asegurarte de que las especificaciones mencionadas en el archivo client-package.json sean precisas y que hayas seguido todas las directrices mencionadas anteriormente. Para aprender más sobre el alojamiento de una aplicación web, consulta Web Client Hosting. * Puedes configurar el componente Client en cualquier momento usando el CLI mientras trabajas con el proyecto. Para aprender más, consulta Trabajar con el Client. -------------------------------------------------------------------------------- title: "catalyst.json" description: "La estructura del directorio del proyecto se refiere a la estructura de directorio predeterminada en la que se crea un proyecto de Catalyst cuando lo inicializas desde el CLI." last_updated: "2026-07-02T09:34:15.865Z" source: "https://docs.catalyst.zoho.com/es/cli/v1/project-directory-structure/catalyst-json/" service: "All Services" -------------------------------------------------------------------------------- # El archivo de configuración catalyst json El archivo catalyst.json contiene la configuración del directorio completo del proyecto, es decir, los directorios de Functions y del Client. A continuación se muestra un fragmento de ejemplo: { "functions": { "targets": [ "fn", "sendemail", "jaavafn", "mynode", "cert_gen_function" ], "ignore":[ ".output", ], "source":"functions" }, "client":{ "source":"client" } } ### Parámetros Contiene las siguientes especificaciones de los directorios de Functions y del Client: * source: El source especifica los nombres de las carpetas destino de los directorios de Functions y del Client. No debes modificar estos valores. * targets: Los targets especifican los nombres de directorio de cada función individual en el proyecto. * ignore: Este campo especifica los archivos en el directorio del componente, o en uno de sus subdirectorios, que deben ignorarse al desplegar el código a producción. Puedes mencionar los archivos a ignorar dentro de los corchetes. Puedes listar los archivos directamente o usar patrones glob para especificar los archivos. Por ejemplo, si especificas _\*.css_, todos los archivos CSS en el directorio particular serán ignorados durante el despliegue. ### Puntos a Recordar * El archivo catalyst.json se crea en el directorio del proyecto independientemente de qué componentes inicialices durante la creación del proyecto desde el CLI. Incluso si no seleccionas ningún componente para inicializar, se creará el archivo catalyst.json. Por lo tanto, cuando crees un proyecto desde la consola UI de Catalyst, debes inicializarlo desde el CLI para que catalyst.json se cree con la información de configuración de los recursos del proyecto. * El archivo catalyst.json no es obligatorio si alojas tu aplicación web desde la consola de Catalyst, es decir, cuando alojas el recurso Client y despliegas las Functions individualmente desde la consola. Sin embargo, si despliegas tu aplicación como un todo desde el CLI, o desde una fuente externa como GitHub, el archivo catalyst.json debe estar presente obligatoriamente en la carpeta raíz de tu aplicación. * Si renombras los directorios de Functions o del Client, debes actualizar los cambios en catalyst.json. * Si cambias los nombres de cualquiera de las Functions, debes actualizar los cambios en catalyst.json. * Si ejecutas los comandos catalyst functions:setup , catalyst functions:add , catalyst client:setup o catalyst pull desde el CLI, la información de configuración de la función o del Client se actualiza automáticamente en el archivo catalyst.json. * Si importas manualmente archivos de componentes desde un entorno de desarrollo externo, debes crear los archivos de configuración en el formato mencionado en esta página de ayuda. Nota: Si eres usuario de Visual Studio Code IDE, puedes instalar la extensión Catalyst Tools y realizar operaciones del CLI usando tu IDE en lugar del CLI. Los pasos para servir y desplegar tus recursos de Catalyst usando el catalyst.json mediante Visual Studio Code IDE se pueden encontrar aquí. ### Exportar e importar proyectos -------------------------------------------------------------------------------- title: "Introducción" description: "Catalyst te permite exportar un proyecto incluyendo sus configuraciones y código como un archivo ZIP, e importar el archivo ZIP en cualquier proyecto nuevo." last_updated: "2026-07-02T09:34:15.868Z" source: "https://docs.catalyst.zoho.com/es/cli/v1/export-and-import-projects/introduction/" service: "All Services" -------------------------------------------------------------------------------- # Exportar e importar proyectos ### Introducción Catalyst CLI proporciona la capacidad de realizar operaciones de exportación e importación de proyectos IaC desde el entorno local. Puedes exportar un proyecto de Catalyst, incluyendo las configuraciones de sus componentes y su código, como un archivo ZIP externo. Luego puedes importar el archivo ZIP como un nuevo proyecto en cualquier cuenta de Catalyst. La exportación de un proyecto se realiza desde su directorio de proyecto activo en el entorno local. Cuando exportas un proyecto, el archivo ZIP de exportación se crea en un formato específico en el mismo directorio. Solo puedes importar un proyecto si este archivo ZIP está en este formato estándar. El CLI también te permite importar directamente cualquier proyecto desde un directorio local sin tener que exportarlo primero, a través de un comando pack que genera un archivo ZIP listo para importar. La función de exportación e importación de proyectos permite transferencias fáciles de proyectos entre centros de datos o entre cuentas de Catalyst. También permite acceso y pruebas fáciles de un proyecto desde un entorno externo, como un repositorio de GitHub. Puedes simplemente clonar un repositorio Git que contenga los componentes de un proyecto de Catalyst, generar su archivo ZIP para importarlo y probar el proyecto fácilmente. También puedes realizar estas acciones fácilmente a través de un sistema remoto, como un sistema CI, o escribir scripts para automatizar estas tareas. Catalyst también te proporciona la opción de importar un proyecto solo a la consola remota de Catalyst, o tanto a la consola remota como al entorno local. Nota: También puedes realizar las operaciones de exportación e importación de proyectos IaC desde General Settings en la consola remota. Puedes aprender sobre esto en la página de ayuda de IaC Settings . -------------------------------------------------------------------------------- title: "Formato del archivo ZIP de exportación/importación" description: "Catalyst te permite exportar un proyecto incluyendo sus configuraciones y código como un archivo ZIP, e importar el archivo ZIP en cualquier proyecto nuevo." last_updated: "2026-07-02T09:34:15.868Z" source: "https://docs.catalyst.zoho.com/es/cli/v1/export-and-import-projects/export-import-zip-file/" service: "All Services" -------------------------------------------------------------------------------- # Formato del archivo ZIP de exportación/importación ### Componentes del archivo ZIP Catalyst te permite exportar o importar los esquemas y configuraciones de un proyecto, junto con su código de funciones y cliente, sin los datos. Los datos, como los registros en las tablas de Data Store, la lista de usuarios de la aplicación o los archivos de File Store, no se incluirán en el archivo ZIP. El archivo ZIP que se crea cuando se exporta un proyecto desde su directorio local contiene los siguientes componentes. * Archivo ZIP del directorio de Functions: El ZIP de exportación contendrá el directorio de funciones del proyecto en su estructura estándar. Todas las funciones que fueron inicializadas en el directorio del proyecto estarán presentes como archivos ZIP individuales, con sus archivos de configuración y componentes del SDK. * Archivo ZIP del directorio del Client: El ZIP de exportación también incluirá el directorio del cliente del proyecto. El cliente web que fue inicializado en el proyecto, con todos los archivos del cliente, estará presente como un archivo ZIP en la carpeta webclient. * Archivo JSON project-template: Las configuraciones de los componentes del proyecto estarán presentes en un único archivo JSON en el archivo ZIP de exportación. El archivo JSON contiene las definiciones del proyecto y la configuración de los componentes. Estas configuraciones incluyen esquemas y metadatos de Data Store y File Store, segmentos de Cache, trabajos Cron, configuraciones de Circuits, Security Rules, dominios y direcciones de correo electrónico, Event Listeners y reglas, APIs en API Gateway, plantillas de correo electrónico, perfiles de usuario y más.<br /> <br /> A continuación se muestra un extracto de un JSON project-template de ejemplo: { "name" : "project-template", "version" : "1.0.0", "parameters" : { }, "components" : { "Circuits" : [ { "type" : "circuit", "name" : "InvoiceGen", "properties" : { "name" : "InvoiceGen", "states" : { "State1" : { "next" : "End", "start" : true, "type" : "pass" } } }, "dependsOn" : [ ] } ], "Functions" : [ { "type" : "function", "name" : "warehouseportal", "properties" : { "stack" : "node14", "code" : { "path" : "functions/warehouseportal.zip" }, "configuration" : { "memory" : 256 }, "type" : "basicio", "name" : "warehouseportal" }, "dependsOn" : [ ] } ], "WebClient" : [ { "type" : "client", "name" : "warehousePortal", "properties" : { "app_name" : "warehousePortal", "code" : { "path" : "webclient/warehousePortal.zip" } }, "dependsOn" : [ ] } ], "Cron" : [ { "type" : "cron", "name" : "dailyBackup", "properties" : { "cron_url_details" : { "headers" : { }, "request_body" : "", "request_method" : "POST", "params" : { }, "url" : "https://catalyst.zoho.com/help/index.html" }, "end_time" : -1, "description" : "", "cron_name" : "dailyBackup", "job_detail" : { "hour" : 1, "timezone" : "America/Los_Angeles", "minute" : 0, "second" : 0, "repetition_type" : "Daily" }, "cron_type" : "Calendar", "status" : true }, "dependsOn" : [ ] } ], "Datastore" : [ { "type" : "table", "name" : "InventoryDB", "properties" : { "table_name" : "InventoryDB" }, "dependsOn" : [ ] }, { "type" : "column", "name" : "InventoryDB-ProductID", "properties" : { "decimal_digits" : 2, "column_name" : "ProductID", "data_type" : "int", "is_unique" : false, "is_mandatory" : false, "search_index_enabled" : false, "table_id" : "InventoryDB", "table_name" : "InventoryDB", "max_length" : 10 }, "dependsOn" : [ "Datastore.table.InventoryDB" ] }, { "type" : "tableScope", "name" : "InventoryDB-App Administrator", "properties" : { "role_name" : "App Administrator", "table_scope" : "GLOBAL", "type" : "App Administrator", "table_name" : "InventoryDB" }, "dependsOn" : [ "Datastore.table.InventoryDB" ] }, { "type" : "tableScope", "name" : "InventoryDB-App User", "properties" : { "role_name" : "App User", "table_scope" : "GLOBAL", "type" : "App User", "table_name" : "InventoryDB" }, "dependsOn" : [ "Datastore.table.InventoryDB" ] }, { "type" : "tablePermission", "name" : "InventoryDB-App Administrator", "properties" : { "role_name" : "App Administrator", "type" : "App Administrator", "table_permissions" : [ "SELECT", "UPDATE", "INSERT", "DELETE" ], "table_name" : "InventoryDB" }, "dependsOn" : [ "Datastore.table.InventoryDB" ] }, { "type" : "tablePermission", "name" : "InventoryDB-App User", "properties" : { "role_name" : "App User", "type" : "App User", "table_permissions" : [ "SELECT" ], "table_name" : "InventoryDB" }, "dependsOn" : [ "Datastore.table.InventoryDB" ] }] } } Nota: * Catalyst no podrá importar un proyecto si el archivo ZIP no contiene el archivo JSON project-template. Este es un archivo obligatorio que define las configuraciones del proyecto. * Actualmente, la única forma de generar el archivo JSON de un proyecto de Catalyst es exportándolo. No podrás generarlo manualmente. La actualización para generar directamente el JSON de un proyecto se implementará pronto. -------------------------------------------------------------------------------- title: "Exportar proyecto" description: "Catalyst te permite exportar un proyecto incluyendo sus configuraciones y código como un archivo ZIP, e importar el archivo ZIP en cualquier proyecto nuevo." last_updated: "2026-07-02T09:34:15.868Z" source: "https://docs.catalyst.zoho.com/es/cli/v1/export-and-import-projects/export-project/" service: "All Services" -------------------------------------------------------------------------------- # Exportar proyecto ### Ejecución del comando Cuando exportas un proyecto presente en el directorio local, el CLI obtendrá las configuraciones de los componentes del proyecto desde la consola remota. Si no se han configurado componentes, las configuraciones predeterminadas se escribirán en el archivo JSON project-template. Nota: * El proyecto debe estar disponible obligatoriamente en la consola remota para ser exportado. * Si la consola contiene código de funciones o cliente actualizado que no está presente en el directorio local, se obtendrá automáticamente. <br> 1. Para exportar un proyecto asociado con un directorio de proyecto de Catalyst en tu sistema local, ejecuta el siguiente comando desde el directorio en tu terminal: catalyst iac:export Esto iniciará el trabajo de exportación. Catalyst asignará un Job ID único a la operación de exportación. Puedes usar este Job ID para verificar el estado del trabajo en cualquier momento. <br> 2. Después de que el trabajo de exportación se complete, el CLI te solicitará la descarga del archivo ZIP de exportación. Presiona Y, luego presiona Enter para descargar el ZIP en tu directorio de proyecto. El archivo ZIP estará disponible en el directorio principal de tu directorio de proyecto en el formato estándar como se discutió en la sección anterior, junto con los directorios functions y client, y el archivo catalyst.json . Nota: Puedes exportar un proyecto que no esté asociado con el directorio actual desde el que se ejecuta el comando, usando la opción \--project <name\_or\_project\_id>. <br> ### Opciones de exportar proyecto #### \--production Puedes exportar el entorno de producción de un proyecto directamente, en lugar de su entorno de desarrollo que es el predeterminado para todas las acciones del CLI. Esto se puede hacer apuntando al entorno de producción usando la opción \--production al ejecutar el comando desde el directorio del proyecto de esta manera: catalyst iac:export --production Esto exportará las configuraciones del proyecto desde su entorno de producción de la misma manera que se discutió en la sección anterior. -------------------------------------------------------------------------------- title: "Importar proyecto" description: "Catalyst te permite exportar un proyecto incluyendo sus configuraciones y código como un archivo ZIP, e importar el archivo ZIP en cualquier proyecto nuevo." last_updated: "2026-07-02T09:34:15.869Z" source: "https://docs.catalyst.zoho.com/es/cli/v1/export-and-import-projects/import-project/" service: "All Services" -------------------------------------------------------------------------------- # Importar proyecto ### Introducción La opción de importar proyecto te permite importar un nuevo proyecto de Catalyst. Catalyst creará y configurará el proyecto basándose en el archivo ZIP fuente. Configurará cada componente según las definiciones especificadas en el JSON project-template, y el código de funciones y cliente se poblará en el proyecto. Como se mencionó en la Introducción, puedes importar un proyecto de dos formas diferentes: * Importación IaC: Ejecutar el comando de importación IaC solo importará el proyecto en la consola remota. Se creará y configurará un nuevo proyecto en la consola basándose en el archivo ZIP fuente. No podrás encontrar este proyecto en el directorio local. * Importación a través de inicialización: También puedes importar un proyecto mientras inicializas un nuevo proyecto desde el CLI. Esto realizará las mismas acciones que una inicialización de proyecto, es decir, el proyecto será importado tanto en la consola remota de Catalyst como en el entorno local. Encontrarás un nuevo proyecto creado y configurado en la consola basándose en el archivo ZIP. El archivo JSON project-template, y el código de funciones y cliente también estarán disponibles en el directorio local. Cualquier otra característica de la operación de importación será la misma en ambos casos. <br> Algunos puntos importantes a recordar: * El archivo ZIP fuente que contiene las definiciones del proyecto, y el código de funciones y cliente debe estar en el formato estándar para ser importado, como se discutió anteriormente. * El archivo JSON project-template debe estar presente en la raíz del archivo ZIP. Un proyecto no puede ser importado sin este archivo. Los directorios functions o client, o el archivo de configuración catalyst.json no son obligatorios. * Siempre puedes empaquetar cualquier directorio de proyecto de Catalyst existente y generar un archivo ZIP listo para importar usando el comando catalyst iac:pack . Nota: No podrás importar un proyecto directamente al entorno de producción. <br> ### Importación IaC 1. Para importar un nuevo proyecto a través del método de importación IaC, crea y navega a un nuevo directorio para el proyecto de Catalyst en tu terminal, luego ejecuta este comando desde el directorio: catalyst iac:import <br> 2. Proporciona un nombre para el nuevo proyecto, luego presiona Enter.<br /> <br> 3. Catalyst verificará el directorio desde el que ejecutaste el comando en busca de archivos ZIP, y te pedirá que selecciones un archivo ZIP de los disponibles como fuente del proyecto.<br /> Si no hay archivos ZIP presentes en el directorio, puedes proporcionar la ruta al archivo ZIP fuente a importar. <br> 4. El CLI te redirigirá a una ventana del navegador para confirmar la sesión de inicio de sesión del usuario brevemente, y el trabajo de importación se iniciará. Puedes cerrar la ventana del navegador y regresar al terminal.<br /> <br> Catalyst asignará un Job ID único a la operación de importación. Puedes usar este Job ID para verificar el estado del trabajo en cualquier momento. <br> Después de que el trabajo de importación se complete, el CLI mostrará su estado. Si la importación es exitosa, encontrarás un nuevo proyecto creado en tu consola remota de Catalyst con los componentes, funciones y cliente configurados basándose en el archivo ZIP. Siempre puedes traer los recursos al entorno local desde la consola, para obtener el proyecto en el entorno local. Traer el proyecto solo obtendrá las funciones, el cliente y las reglas de API Gateway. No obtendrá ninguna configuración de componentes. <br> ### Opciones de importar proyecto #### \--name Puedes proporcionar directamente un nombre para el proyecto al importar un proyecto, usando la opción -\\-name con el comando de importación de la siguiente manera: catalyst iac:import --name &lt;project_name&gt; Proporciona un nombre para el proyecto a crear por el trabajo de importación con la opción -\\-name. El CLI luego te pedirá que elijas un archivo ZIP en el directorio o proporciones una ruta al archivo fuente, como se discutió anteriormente. <br> ### Importación a través de inicialización 1. Para importar un proyecto durante la inicialización del proyecto, ejecuta el comando de inicialización de proyecto desde un nuevo directorio creado para el proyecto: catalyst init <br> 2. Selecciona "Import an existing project" de la lista de proyectos para asociar el directorio.<br /> <br> 3. Proporciona un nombre para el proyecto, luego selecciona un archivo ZIP fuente o proporciona una ruta para importarlo, como se discutió en la sección de importación de proyecto IaC. El proceso será el mismo.<br /> Catalyst asignará un Job ID único a la operación de importación después de que se inicie. Después de que el trabajo de importación se complete, puedes encontrar el proyecto creado y configurado en la consola remota, así como en el directorio local. <br> Dado que esto importa el proyecto en el directorio local, los archivos de configuración catalyst.json y .catalystrc se crearán con los detalles del proyecto. El directorio del proyecto también contendrá los directorios functions y client, si estaban presentes en el archivo ZIP, y el archivo JSON project-template. -------------------------------------------------------------------------------- title: "Generar un archivo ZIP listo para importar" description: "Catalyst te permite exportar un proyecto incluyendo sus configuraciones y código como un archivo ZIP, e importar el archivo ZIP en cualquier proyecto nuevo." last_updated: "2026-07-02T09:34:15.869Z" source: "https://docs.catalyst.zoho.com/es/cli/v1/export-and-import-projects/generate-zip-file/" service: "All Services" -------------------------------------------------------------------------------- # Generar un archivo ZIP listo para importar ### Introducción Catalyst te permite importar directamente cualquier proyecto desde un directorio local sin tener que exportarlo primero. Esto significa que no necesitas tener un archivo ZIP listo para importar ya presente en tu sistema local para importar un proyecto. Puedes generar un archivo ZIP listo para importar en el formato estándar en un directorio de proyecto de Catalyst existente automáticamente, ejecutando este comando. Luego puedes proporcionar la ruta a este archivo ZIP al importar el proyecto. Esto te ahorra el esfuerzo de verificar si todos los archivos y subdirectorios están presentes en el formato requerido, y comprimir cada carpeta de función o el directorio del cliente manualmente para preparar un archivo ZIP fuente para importar. Nota: Como la operación de importación requiere el archivo JSON project-template, debe estar presente obligatoriamente en el directorio desde el que se ejecuta el comando pack. Los directorios de funciones o cliente, o el archivo de configuración catalyst.json no son obligatorios. <br> ### IaC Pack Puedes empaquetar un proyecto de Catalyst y generar su archivo ZIP en el formato estándar, ejecutando el siguiente comando desde el directorio del proyecto: catalyst iac:pack Esto creará el archivo ZIP en el mismo directorio. También puedes proporcionar un nombre de tu elección al archivo ZIP especificando el nombre después del comando como se muestra a continuación. <br /> -------------------------------------------------------------------------------- title: "Obtener el estado de un trabajo de exportación o importación" description: "Catalyst te permite exportar un proyecto incluyendo sus configuraciones y código como un archivo ZIP, e importar el archivo ZIP en cualquier proyecto nuevo." last_updated: "2026-07-02T09:34:15.869Z" source: "https://docs.catalyst.zoho.com/es/cli/v1/export-and-import-projects/export-import-job-status/" service: "All Services" -------------------------------------------------------------------------------- # Obtener el estado de un trabajo de exportación o importación ### Obtener estado Si un trabajo de exportación o importación se está procesando, o fue procesado recientemente, en un directorio de proyecto, puedes obtener el estado del trabajo. Para obtener el estado de un trabajo de exportación o importación, ejecuta el siguiente comando desde ese directorio: catalyst iac:status export|import El CLI mostrará el estado del trabajo de exportación o importación procesado en ese directorio. <br> ### Opciones de estado del trabajo #### \--id &lt;id&gt; Puedes obtener el estado de un trabajo de importación o exportación específico ejecutado en cualquier directorio, especificando el Job ID único que se generó automáticamente cuando se inició el trabajo. Tanto las operaciones de exportación como de importación generan Job IDs. Para obtener el estado de cualquier trabajo de exportación o importación, especifica el Job ID con el comando de la siguiente manera: catalyst iac:status export|import --id &lt;id&gt; El CLI mostrará el estado del trabajo. ### Generar eventos -------------------------------------------------------------------------------- title: "Introducción" description: "Catalyst te permite generar payloads de ejemplo de varias fuentes de eventos soportadas por Catalyst Event Listeners usando el CLI." last_updated: "2026-07-02T09:34:15.869Z" source: "https://docs.catalyst.zoho.com/es/cli/v1/event-generate/introduction/" service: "All Services" -------------------------------------------------------------------------------- # Event Generate ### Introducción Catalyst te permite generar payloads de ejemplo para eventos asociados con Catalyst Publishers en Catalyst Signals usando el CLI. El comando catalyst event:generate genera payloads de ejemplo para Catalyst Publishers en el CLI. Puedes especificar el publisher particular y la acción para la que necesitas el payload. Puedes usar el payload generado para probar las funciones Event en tu proyecto desde el entorno local. Además de las funciones Event, también puedes generar payloads de ejemplo y probar las funciones Integration en tu proyecto. El comando catalyst event:generate:integ te permite seleccionar el servicio de integración, la fuente del componente y el handler para generar el payload. Luego puedes iniciar un shell de Node desde el CLI para probar y depurar la función Event o Integration, pasando los datos del payload de ejemplo generado a la función. Nota: * Ambos comandos de generación de eventos en el CLI solo generan payloads de ejemplo para ayudarte a probar funciones en el entorno local. Estas acciones no se reflejarán en Signals, Functions, ni en ningún componente que hayas configurado en tu proyecto o en la consola remota. Permanecerán sin cambios. * Cliq Integration Functions actualmente no está disponible para usuarios de Catalyst que acceden desde los centros de datos EU, AU, IN o CA. ConvoKraft Integration Functions están disponibles para usuarios que acceden desde todos los DC. * Si eres usuario de Visual Studio Code IDE, puedes instalar la extensión Catalyst Tools y realizar operaciones del CLI usando tu IDE en lugar del CLI. Los pasos para depurar funciones Event, Cron e Integration usando Visual Studio Code IDE se pueden encontrar aquí. -------------------------------------------------------------------------------- title: "Payload de ejemplo para eventos de componentes" description: "Catalyst te permite generar payloads de ejemplo de varias fuentes de eventos soportadas por Catalyst Event Listeners usando el CLI." last_updated: "2026-07-02T09:34:15.870Z" source: "https://docs.catalyst.zoho.com/es/cli/v1/event-generate/sample-payload-component-event/" service: "All Services" -------------------------------------------------------------------------------- # Generar payload de ejemplo para una fuente de evento de componente Notas: * El componente Event Listeners está actualmente siendo descontinuado. Te recomendamos encarecidamente migrar a nuestro servicio de bus de eventos más nuevo y robusto, Catalyst Signals. Aprende más sobre Catalyst Signals. * Aprende sobre la generación de payloads para eventos originados por Catalyst Publishers. ### Generación de payload Un component event listener escucha un evento específico que ocurre en uno de los componentes de Catalyst, luego activa la función objetivo asociada y le pasa los datos del componente. Ya está creado por defecto en un proyecto. Puedes obtener datos de ejemplo del mismo patrón en el CLI, para la fuente y la acción que necesites. El comando general para generar un payload de ejemplo de un evento en el CLI es: catalyst event:generate|generate:event [options] &lt;source&gt; &lt;action&gt; <br> Puedes proporcionar cualquiera de las fuentes y acciones asociadas de un evento de componente de Catalyst, en el comando que se muestra en la tabla a continuación: <table class="content-table"> <thead> <tr> <th class="w30p"><strong>Fuente</strong></th> <th class="w30p"><strong>Acción</strong></th> <th class="w40p"><strong>Entradas opcionales</strong></th> </tr> </thead> <tbody> <tr> <td><span class="badge">datastore</span></td> <td><span class="badge">Insert</span> <span class="badge">Update</span> <span class="badge">Delete</span></td> <td><span class="badge">--table &lt;table_name_or_id&gt;</span></td> </tr> <tr> <td><span class="badge">cache</span></td> <td><span class="badge">Put</span></td> <td><span class="badge">--segment &lt;segment_name_or_id&gt;</span></td> </tr> <tr> <td><span class="badge">user</span></td> <td><span class="badge">SignUp</span> <span class="badge">Delete</span></td> <td>NA</td> </tr> <tr> <td><span class="badge">filestore</span></td> <td><span class="badge">Upload</span></td> <td><span class="badge">--folder &lt;folder_name_or_id&gt;</span></td> </tr> <tr> <td><span class="badge">webapp</span></td> <td><span class="badge">Success</span></td> <td>NA</td> </tr> <tr> <td><span class="badge">github</span></td> <td><span class="badge">Success</span> <span class="badge">Failure</span></td> <td>NA</td> </tr> </tbody> </table> <br> Por ejemplo, para generar un payload de ejemplo para un evento de inserción en Data Store, ejecuta el siguiente comando: catalyst event:generate|generate:event datastore Insert <br> Esto generará el siguiente payload JSON para esta fuente y acción. El payload contendrá los detalles reales de tu proyecto, los detalles del event bus predeterminado y detalles de entidad de ejemplo. Puedes pasar estos datos a una función Event a través del shell de funciones y probarla según tus necesidades. <br> También puedes guardar directamente el payload JSON en un archivo en lugar de mostrarlo en el CLI, creando un archivo en la ruta que necesites de la siguiente manera: catalyst event:generate|generate:event user Signup>>payload.json <br> ### Entradas opcionales Además del par obligatorio de fuente y acción, también puedes proporcionar entradas opcionales sobre la fuente de la entidad, como se muestra en la tabla. Por ejemplo, si especificas el nombre o ID de la tabla al generar el payload de ejemplo para una operación de inserción en Data Store, Catalyst verificará en tu proyecto remoto si existe una tabla con ese nombre o ID. Si la entidad existe, el CLI mostrará los datos de esa tabla en el payload JSON. Si no proporcionas entradas opcionales, o si no hay entidades que coincidan con tus entradas, el CLI generará el payload JSON con datos de ejemplo aleatorios. <br> Por ejemplo, para generar un payload de ejemplo para un evento de put en caché en un segmento existente configurado en la consola remota, se ejecuta el siguiente comando: catalyst event:generate|generate:event cache Put --segment &lt;segment_name_or_id&gt; <br> Catalyst busca un segmento con ese nombre o ID. Si existe, generará el payload incluyendo los datos de ese segmento. El ID del segmento que se pasó se especifica como el valor para source\_entity\_id en el ejemplo que se muestra a continuación. <br /> ### Opciones de generación de eventos de componentes El comando catalyst event:generate admite dos opciones que puedes usar con él. Sin embargo, solo una de esas opciones es aplicable cuando generas un payload de ejemplo de una fuente de evento de componente. <br> #### -e | -\-event-bus <event\_bus\_name> La opción -\\-event-bus o \-e te permite especificar el nombre del event bus que debe usarse en el payload de ejemplo. Puedes usar esto al generar el payload de cualquier fuente o acción. El JSON event\_bus\_details contendrá el nombre que pases como nombre del bus. Si no especificas el nombre del event bus, el nombre del bus será 'Default' en el payload de un evento de componente. <br> Por ejemplo, para generar el payload de un evento de put en caché y especificar el nombre del event bus con él, ejecuta el siguiente comando: catalyst event:generate|generate:event cache Put --event-bus TrackerRequests <br> Esto generará el payload e incluirá el nombre del event bus en event\_bus\_details. Discutiremos las opciones disponibles en el contexto de una fuente de evento personalizado en la siguiente sección. Nota: Si eres usuario de Visual Studio Code IDE, puedes instalar la extensión Catalyst Tools y realizar operaciones del CLI usando tu IDE en lugar del CLI. Los pasos para depurar tus funciones Event usando Visual Studio Code IDE se pueden encontrar aquí. -------------------------------------------------------------------------------- title: "Payload de ejemplo para eventos personalizados" description: "Catalyst te permite generar payloads de ejemplo de varias fuentes de eventos soportadas por Catalyst Event Listeners usando el CLI." last_updated: "2026-07-02T09:34:15.870Z" source: "https://docs.catalyst.zoho.com/es/cli/v1/event-generate/sample-payload-custom-event/" service: "All Services" -------------------------------------------------------------------------------- # Generar payload de ejemplo para una fuente de evento personalizado Notas: * El componente Event Listeners está actualmente siendo descontinuado. Te recomendamos encarecidamente migrar a nuestro servicio de bus de eventos más nuevo y robusto, Catalyst Signals. Aprende más sobre Catalyst Signals. * Aprende sobre la generación de payloads para eventos originados por Catalyst Publishers. ### Generación de payload Un custom event listener se usa para pasar datos a una función objetivo cada vez que su URL es invocada por el usuario final. Los custom event listeners pueden contener múltiples reglas, que pueden estar asociadas con diferentes funciones objetivo. Todas las reglas de un custom event listener tienen el mismo endpoint URL, pero cada regla contendrá una variable de identificador de regla única que puedes configurar al crearla. Esto te permite indicar la regla específica a invocar. Nota: Los custom event listeners no existen en un proyecto por defecto. Por lo tanto, primero debes crear un custom event listener en tu proyecto desde la consola remota, para generar un payload de ejemplo para él. Sin embargo, no necesitas crear ninguna regla en él para este propósito. Puedes crear una regla en el CLI con fines de prueba al generar el payload de ejemplo. Esto no se reflejará en el custom event listener configurado en la consola. <br> Puedes generar un payload de ejemplo para un evento personalizado ejecutando este mismo comando: catalyst event:generate|generate:event [options] &lt;source&gt; &lt;action&gt; <br> Sin embargo, Catalyst solo acepta los siguientes valores para fuente y acción para una fuente de evento personalizado: <table class="content-table"> <thead> <tr> <th><strong>Fuente</strong></th> <th><strong>Acción</strong></th> </tr> </thead> <tbody> <tr> <td><span class="badge">custom</span></td> <td><span class="badge">Produce</span></td> </tr> </tbody> </table> <br> ### Opciones de comando obligatorias También debes usar estas opciones de forma obligatoria al generar un payload de ejemplo para un evento personalizado: <br> #### -e | -\-event-bus <event\_bus\_name> La opción \--event-bus realiza la misma acción que se discutió en la sección anterior. Te permite especificar el nombre del event bus que debe usarse en el payload de ejemplo. El JSON event\_bus\_details contendrá el nombre que pases como nombre del bus. <br> #### -rid | -\-rule-id <rule\_identifier> La opción \--rule-id te permite especificar el identificador de regla que debe usarse en el payload de evento personalizado. Como se mencionó anteriormente, un identificador de regla identifica de forma única una regla en un event bus personalizado. El campo data en el JSON contendrá el identificador de regla. Puedes generar un payload de ejemplo para un evento personalizado y pasar el nombre del event bus y el identificador de regla ejecutando el siguiente comando: catalyst event:generate|generate:event custom Produce --event-bus TrackerRequests --rule-id DomesticTracking <br> Esto generará el siguiente payload JSON. El payload contendrá los detalles de tu proyecto, los detalles del event bus y del identificador de regla que proporcionaste, así como otros datos de ejemplo. <br /> Nota: Si eres usuario de Visual Studio Code IDE, puedes instalar la extensión Catalyst Tools y realizar operaciones del CLI usando tu IDE en lugar del CLI. Los pasos para depurar tus funciones Event usando Visual Studio Code IDE se pueden encontrar aquí. -------------------------------------------------------------------------------- title: "Payload de ejemplo para funciones Integration" description: "Catalyst te permite generar payloads de ejemplo de varias fuentes de eventos soportadas por Catalyst Event Listeners usando el CLI." last_updated: "2026-07-02T09:34:15.870Z" source: "https://docs.catalyst.zoho.com/es/cli/v1/event-generate/sample-payload-integration-functions/" service: "All Services" -------------------------------------------------------------------------------- # Generar payload de ejemplo para probar funciones Integration ### Generación de payload Las funciones Integration te permiten codificar y usar una función de Catalyst como backend de otros servicios de Zoho, y establecer una integración con ellos. Catalyst actualmente soporta la integración con Zoho Cliq y ConvoKraft Bot Logic a través de funciones Integration. Puedes desarrollar el backend de extensiones de Cliq que agrupan bots, comandos, acciones de mensaje, widgets y funciones a través de funciones Integration. El CLI te permite generar payloads de ejemplo para varios handlers en cada una de estas herramientas. Nota: Cliq Integration Functions actualmente no está disponible para usuarios de Catalyst que acceden desde los centros de datos EU, AU, IN o CA. ConvoKraft Integration Functions están disponibles para usuarios que acceden desde todos los DC. <br> El comando general para generar un payload de ejemplo para probar una función Integration en el CLI es: catalyst event:generate:integ [options] &lt;service&gt; Dado que Catalyst actualmente solo soporta integraciones con Cliq, debes proporcionar el siguiente valor como servicio: ZohoCliq . <br> Catalyst soporta los siguientes componentes de Cliq y clases de handler para los que puedes generar un payload de ejemplo en el CLI. <table class="content-table"> <thead> <tr> <th>Componente</th> <th>Clases de handler</th> </tr> </thead> <tbody> <tr> <td><span class="badge">bot</span></td> <td><span class="badge">welcome_handler</span><br><span class="badge">message_handler</span> <br><span class="badge">context_handler</span> <br><span class="badge">mention_handler</span><br><span class="badge">action_handler</span><br> <span class="badge">incomingwebhook_handler</span><br> <span class="badge">participation_handler</span></td> </tr> <tr> <td><span class="badge">command</span></td> <td><span class="badge">execution_handler</span> <br><span class="badge">suggestion_handler</span></td> </tr> <tr> <td><span class="badge">messageaction</span></td> <td><span class="badge">execution_handler</span></td> </tr> <tr> <td><span class="badge">widget</span></td> <td><span class="badge">view_handler</span></td> </tr> <tr> <td><span class="badge">function</span></td> <td><span class="badge">button_handler</span> <br><span class="badge">form_handler</span> <br><span class="badge">form_change_handler</span> <br><span class="badge">form_values_handler</span> <br><span class="badge">widget_button_handler</span></td> </tr> <tr> <td><span class="badge">installation</span></td> <td><span class="badge">installation_handler installation_validator</span></td> </tr> </tbody> </table> <br> 1. Ejecuta el siguiente comando para seleccionar el componente y una clase de handler para generar el payload: catalyst event:generate:integ ZohoCliq <br> 2. Selecciona un componente de la lista y presiona Enter.<br /> <br> 3. Selecciona una clase de handler de la lista y presiona Enter.<br /> <br> El CLI generará un payload JSON de ejemplo para ese componente y fuente de handler. Dependiendo del componente, el payload contendrá datos relevantes. También puedes guardar directamente el payload JSON en un archivo en lugar de mostrarlo en el CLI. <br> ### Opciones de generación de eventos para funciones Integration <br> #### \--inputs &lt;inputs&gt; Puedes generar un payload de ejemplo para probar funciones Integration especificando directamente el componente y el handler para el que necesitas los datos. Las entradas deben especificarse en el siguiente formato: catalyst event:generate:integ ZohoCliq --inputs component,handler <br> Por ejemplo, para generar un payload de ejemplo para una clase form\_handler del componente function, ejecuta el siguiente comando: catalyst event:generate:integ ZohoCliq --inputs function,form_handler <br> Esto generará el siguiente payload JSON. Consulta la tabla mostrada anteriormente para ver la lista de componentes de Cliq y clases de handler soportadas por Catalyst.<br /> Nota: Si eres usuario de Visual Studio Code IDE, puedes instalar la extensión Catalyst Tools y realizar operaciones del CLI usando tu IDE en lugar del CLI. Los pasos para depurar tus funciones Event usando Visual Studio Code IDE se pueden encontrar aquí. ### Importación y exportación de Data Store -------------------------------------------------------------------------------- title: "Introducción" description: "Catalyst te permite realizar operaciones de lectura y escritura masiva en las tablas del Data Store usando el CLI." last_updated: "2026-07-02T09:34:15.870Z" source: "https://docs.catalyst.zoho.com/es/cli/v1/data-store-import-and-export/introduction/" service: "All Services" -------------------------------------------------------------------------------- # Importación y exportación de Data Store ### Introducción Catalyst te permite realizar operaciones de lectura y escritura masiva en las tablas del Data Store de Catalyst usando el CLI. * Importación de Data Store: La operación de importación puede obtener miles de registros de un archivo CSV subido en un Bucket en Stratus y escribirlos de forma masiva en una tabla específica del Data Store. Después de que la operación de importación se haya ejecutado exitosamente, se generará un archivo CSV de reporte con los detalles de la ejecución del trabajo en una URL de descarga. * Exportación de Data Store: La operación de exportación puede leer de forma masiva miles de registros de una tabla específica del Data Store y generar un archivo CSV con los resultados de la operación de lectura si el trabajo es exitoso. Los requisitos específicos para ambas operaciones de importación y exportación se pueden definir en un archivo JSON de configuración de entrada opcional, que puedes pasar junto con tus comandos del CLI. Si no pasas un archivo de configuración, debes especificar la información obligatoria en las opciones de la ejecución del comando. Puedes configurar una URL de callback en ambas operaciones para habilitar la publicación automática de las respuestas de estado del trabajo. También puedes verificar manualmente el estado de ejecución del trabajo cuando lo necesites. Nota: Catalyst también proporciona APIs para las operaciones de importación y exportación del Data Store. Puedes crear los trabajos, verificar sus estados y descargar los resultados usando APIs individuales para ambas operaciones. Consulta las documentaciones de API de lectura masiva y API de escritura masiva para más información. -------------------------------------------------------------------------------- title: "Operación de importación" description: "Catalyst te permite realizar operaciones de lectura y escritura masiva en las tablas del Data Store usando el CLI." last_updated: "2026-07-02T09:34:15.870Z" source: "https://docs.catalyst.zoho.com/es/cli/v1/data-store-import-and-export/import-operation/" service: "All Services" -------------------------------------------------------------------------------- # Importación de Data Store La sintaxis general del comando de importación de Data Store es: catalyst ds:import [CSV_file_path] [options] Antes de discutir la ejecución del comando, veamos las operaciones y configuraciones disponibles para este comando en detalle. ### Operaciones Hay tres operaciones que se pueden realizar usando el comando de importación de Data Store: * Insert: Inserta nuevas filas de datos en la tabla desde el archivo CSV * Update: Actualiza filas de datos existentes en la tabla * Upsert: Habilita las operaciones de inserción y actualización al mismo tiempo. Si el registro ya existe, la fila se actualiza. Si el registro no existe, se inserta una nueva fila con los datos. Puedes especificar la operación a ejecutar en el archivo JSON de configuración de entrada. ### Archivo CSV de entrada Como se mencionó anteriormente, la operación de importación escribe registros de forma masiva desde un archivo CSV a una tabla. Puedes proporcionar el archivo CSV de dos maneras: 1. Puedes subir el archivo CSV que contiene los registros a un Bucket en Stratus antes de comenzar a ejecutar esta operación. En este caso, debes especificar la Object URL única generada para el archivo en Stratus, en el archivo JSON de configuración que pasas durante la ejecución del comando. 2. Si no pasas ningún archivo JSON de configuración con el comando, debes especificar la ruta del archivo CSV en tu sistema durante la ejecución del comando, como se muestra en la sintaxis general anterior. Catalyst entonces subirá el archivo CSV que proporcionas al Bucket de tu proyecto y obtendrá automáticamente su Object URL para la ejecución. Puedes seleccionar la ruta para guardar el archivo en Stratus. Catalyst considerará el archivo CSV especificado con el comando como la prioridad más alta, sobre la Object URL especificada en el archivo JSON. Si el archivo CSV no se especifica en ninguno de los dos lugares, el CLI mostrará un mensaje de error durante la ejecución del comando. Nota: 1. La primera fila del archivo CSV debe ser la fila de encabezado. En otras palabras, los nombres de las columnas deben estar presentes como fila de encabezado. 2. El archivo CSV debe contener datos en el formato que cumple con los estándares de archivos CSV. Si el archivo no está en el formato estándar, los datos escritos en la tabla pueden corromperse. 3. Podrás insertar 5000 registros en cada tabla por proyecto en el entorno de desarrollo. Si el archivo CSV contiene más registros que eso, los primeros 5000 registros se escribirán en la tabla. Los demás se omitirán en el entorno de desarrollo. No hay límites superiores para la inserción de datos en el entorno de producción. <br> ### Estructura del archivo JSON de configuración A continuación se muestra un archivo JSON de configuración de ejemplo que especifica los requisitos de la operación de importación, que puedes pasar opcionalmente durante la ejecución del comando: { "table_identifier" : "ZylkerEmpDatabase", "operation" : "upsert", "object_url" : "https://bucket-name-development.zohostratus.com/object-name", "callback" : { "url" : "https://hr.zylker.com/es/EmpRecords/_callback.php.com", "headers" : { "src" : "ZCatalyst", "operation" : "bulkwriteAPI" } }, "find_by" : "EmpID", "fk_mapping" : [ { "local_column" : "EmpID", "reference_column" : "EmployeeID" }, { "local_column" : "DeptID", "reference_column" : "DepartmentID" } ] } Los parámetros admitidos por el archivo JSON de configuración se definen a continuación: <table class="content-table"> <thead> <tr> <th class="w30p">Atributos</th> <th class="w70p">Descripción</th> </tr> </thead> <tbody> <tr> <td><strong>table_identifier</strong> <br> (String, Obligatorio) </td> <td>El ID único de la tabla o el nombre de la tabla donde se deben importar los datos. También puedes pasar el identificador de tabla usando la opción -\-table.</td> </tr> <tr> <td><strong>operation</strong><br> (String, Opcional)</td> <td>Especifica la operación a ejecutar.<br /> <br /> <strong>Valores permitidos:</strong>insert, update, upsert<br /> <br /> <strong>Operación predeterminada:</strong> insert</td> </tr> <tr> <td><strong>object_url</strong><br> (String, Obligatorio)</td> <td>La Object URL única del archivo CSV en Stratus. <br> También puedes especificar la ruta del archivo CSV con el comando.</td> </tr> <tr> <td><strong>find_by</strong><br><br> (String, Obligatorio para operaciones update y upsert. No obligatorio para la operación insert)</td> <td>La columna única mediante la cual se identifican los registros.<br /> <br /> Por ejemplo, si especificas una columna única llamada 'EmployeeID' como el valor de find_by, Catalyst buscará los registros en la tabla de Data Store usando el valor de <em>EmployeeID</em>. Para la operación de actualización, Catalyst actualizará las filas que coincidan con el valor de <em>EmployeeID</em> del archivo CSV. Para la operación upsert, Catalyst actualizará las filas existentes e insertará nuevas filas si no hay registros con valores de EmployeeID coincidentes.<br /> <br /> <strong>Update:</strong> Puede ser una columna con valores únicos configurados en el Data Store, o el ROWID generado por Catalyst para los registros.<br /> <br /> <strong>Upsert:</strong> Solo puedes especificar una columna con valores únicos configurados en el Data Store. No podrás especificar el ROWID como valor de find_by. Esto se debe a que upsert insertará nuevas filas si no se encuentran coincidencias, y los valores de ROWID no estarán disponibles para filas que no existan en el Data Store.<br /> <br /> <strong>Insert:</strong> Si especificas una columna find_by para una operación de inserción, los registros que coincidan con los valores de la columna del archivo CSV se omitirán y no se insertarán en la tabla de Data Store. Esto se debe a que insert no puede actualizar si un registro dado ya existe.</td> </tr> <tr> <td><strong>fk_mapping</strong><br> (JSON, Opcional)</td> <td>Mapeo de claves foráneas para las columnas que son claves primarias en otras tablas. Se especifica si alguna columna importada del archivo CSV debe configurarse como clave foránea.<br /> <br /> Debes mapear las claves foráneas en el siguiente formato:<br> {<br> "local_column" :<br> "local_column_name_1",<br> "reference_column" : "reference_column_name_1"<br> }<br> <br> donde local_column es el nombre de la columna en la tabla donde se procesa la operación de escritura masiva, y reference_column es el nombre de la columna en la tabla en la que es clave primaria.<br /> </td> </tr> <tr> <td><strong>callback</strong><br> (JSON, Opcional)</td> <td>La sección donde puedes definir las propiedades de la URL de callback, donde se enviarán las respuestas JSON automáticas de los estados del trabajo. Las propiedades que se deben incluir en esta sección se indican en la tabla a continuación. </td> </tr> </tbody> </table> #### Propiedades del callback <table class="content-table"> <thead> <tr> <th class="w30p">Atributo</th> <th class="w70p">Descripción</th> </tr> </thead> <tbody> <tr> <td><strong>url</strong><br><br> (String, Obligatorio si deseas especificar la URL de callback)</td> <td>La URL donde se enviarán las respuestas automáticas usando el método HTTP POST, cada vez que cambie el estado del trabajo. La información sobre los detalles del trabajo estará contenida en el cuerpo de la respuesta JSON.<br /><br /> El CLI también mostrará una transmisión en tiempo real de la ejecución y el estado final del trabajo.</td> </tr> <tr> <td><strong>headers</strong><br> (String, Opcional) <td>Encabezados que necesitas que se pasen en la respuesta JSON a la URL de callback<br /> <br /> Debes especificar los encabezados como:<br> {<br> "{header_name_1}" : "{header_value_1}",<br> "{header_name_2}" : "{header_value_2}"<br> }<br> <br> y así sucesivamente.</td> </tr> <tr> <td><strong>params</strong><br> (String, Opcional)</td> <td>Parámetros que necesitas que se agreguen a la URL de callback<br /> <br /> Debes especificar los parámetros como:<br /> {<br> "{param_name_1}" : "{param_value_1}",<br> "{param_name_2}" : "{param_value_2}"<br> }<br> <br> y así sucesivamente.</td> </tr> </tbody> </table> Nota: Si no especificas los parámetros obligatorios del archivo CSV y el identificador de tabla en el archivo JSON, o si no pasas un archivo JSON durante la ejecución del comando, debes especificar la ruta del archivo CSV y el identificador de tabla como opciones de importación. <br> ### Estados de procesamiento del trabajo de importación Hay tres estados de procesamiento del trabajo para la operación de importación: * In-Progress: El trabajo entra en este estado tan pronto como ejecutas el comando de importación. El CLI mostrará un parámetro job\_id que puedes usar para verificar el estado de la ejecución del trabajo para respuestas posteriores de forma manual, si no has configurado una URL de callback en el JSON.<br /> <br /> Si has configurado una URL de callback, también se publicará una respuesta de estado con el job\_id en la URL en el formato que definiste. * Success: Si la operación de importación es exitosa, Catalyst proporcionará una URL de descarga donde puedes descargar un archivo CSV de reporte que contiene los detalles de la ejecución del trabajo. Catalyst también te permite descargar el archivo de reporte directamente a tu sistema a través del CLI. Si has configurado una URL de callback, esta respuesta también se publicará en ella. * Failed: Si la operación de importación falla, el CLI mostrará los detalles de los errores que ocurrieron. Si has configurado una URL de callback, esta respuesta también se publicará en ella. <br> ### Opciones de importación El proceso de ejecución del comando de importación se describe en detalle en esta sección, para cada opción. El comando de importación de Data Store admite las siguientes opciones: <br> #### -\-config &lt;path&gt; La opción config te permite definir la ruta del archivo JSON de configuración en tu sistema.<br /> <br /> Por ejemplo, puedes ejecutar la operación de importación y pasar la ruta del archivo JSON como se muestra a continuación:<br /> <br /> El CLI entonces programará automáticamente la ejecución del trabajo y lo marcará como "in-progress". Mostrará una transmisión en tiempo real del proceso de ejecución, junto con el job_id .<br /> <br /> Si el trabajo se ejecuta exitosamente, el CLI te solicitará que descargues el archivo de reporte a tu sistema. Escribe 'y', luego presiona Enter para descargar.<br /> <br /> El archivo ZIP que contiene el archivo de reporte se descargará en tu directorio de proyecto.<br /> <br /> Puedes usar la URL de descarga proporcionada por Catalyst para descargar el reporte incluso cuando no estés trabajando en tu CLI. Debes ejecutarlo como un comando de API.<br /> Nota: La URL de descarga será válida por 1 día desde su generación. El archivo CSV de reporte listará todos los registros que se omitieron de la escritura, junto con las razones correspondientes.<br /> <br> <br> #### -\-table &lt;name|id&gt; <br /> La opción -\\-table te permite especificar el nombre de la tabla o el Table ID de la tabla, en la cual se deben escribir los registros.<br /> <br /> Como se mencionó anteriormente, si no especificas el identificador de tabla en el archivo JSON, o si no pasas un archivo JSON durante la ejecución del comando, debes especificarlo usando esta opción.<br /> <br /> Catalyst considerará la tabla especificada en la opción como la prioridad más alta, sobre la especificada en el archivo JSON. Si la tabla no se especifica en ninguno de los dos lugares, el CLI mostrará un mensaje de error durante la ejecución del comando.<br /> <br /> Por ejemplo, puedes especificar el identificador de tabla junto con la ruta del archivo CSV de la siguiente manera:<br /> <br /> Si especificas la ruta del archivo CSV, el CLI entonces ejecutará la operación de importación, escribirá los registros de forma masiva en la tabla especificada y proporcionará el archivo de reporte de la misma manera.<br /> Nota: La ruta de tu bucket no puede estar vacía. #### -\-production <br /> La opción \--production te permite ejecutar directamente la operación de importación en el entorno de producción de tu proyecto de Catalyst. Si usas esta opción, los registros del archivo CSV de entrada se escribirán de forma masiva en la tabla especificada directamente en producción.<br /> Nota: Solo puedes usar esta opción si el entorno de producción ya está habilitado para tu proyecto. -------------------------------------------------------------------------------- title: "Operación de exportación" description: "Catalyst te permite realizar operaciones de lectura y escritura masiva en las tablas del Data Store usando el CLI." last_updated: "2026-07-02T09:34:15.871Z" source: "https://docs.catalyst.zoho.com/es/cli/v1/data-store-import-and-export/export-operation/" service: "All Services" -------------------------------------------------------------------------------- # Exportación de Data Store ### Introducción La sintaxis general del comando de exportación de Data Store es: catalyst ds:export [options] ### Estructura del archivo JSON de configuración El comando de exportación de Data Store obtendrá los registros de la tabla que especifiques, que coincidan con los criterios que definas en el archivo JSON de configuración de entrada. Si no pasas el archivo JSON con el comando, o si no especificas ningún criterio, todos los registros de la tabla se leerán por defecto. A continuación se muestra un archivo JSON de configuración de ejemplo que especifica los requisitos de la operación de exportación, que puedes pasar opcionalmente durante la ejecución del comando: Los parámetros admitidos por el archivo JSON de configuración se definen a continuación: <table class="content-table"> <thead> <tr> <th class="w30p">Atributos</th> <th class="w70p">Descripción</th> </tr> </thead> <tbody> <tr> <td><strong>table_identifier</strong><br> (String, Obligatorio)</td> <td>El ID único de la tabla o el nombre de la tabla de donde se deben exportar los datos. También puedes pasar el identificador de tabla usando la opción --table.</td> </tr> <tr> <th><strong>query</strong><br> (JSON, Opcional)</th> <th>La sección donde puedes definir las condiciones y criterios para el trabajo de exportación</th> </tr> <tr> <td><strong>page</strong><br> (Numérico, Opcional)</td> <td>El archivo CSV generado como resultado del proceso de lectura masiva contiene doscientos mil registros en una página.<br /> <br /> El valor de página '1' indica que se exportarán los primeros doscientos mil registros que coincidan con tu consulta. Puedes obtener registros posteriores aumentando el valor de página.<br /> <br /> Por ejemplo, si deseas obtener registros del rango 200,001 a 400,000, debes especificar el valor de página como '2'.<br /> <br /> Valor predeterminado: 1<br><br> También puedes especificar el valor de página usando la<br> opción --page.</td> </tr> <tr> <td><strong>select_columns</strong><br> (Array, Opcional)</td> <td>Columnas específicas en los registros que necesitan obtenerse de la tabla. Si no especificas las columnas, se seleccionarán y obtendrán todas las columnas.<br /> <br /> Puedes incluir múltiples columnas en un array.</td> </tr> <tr> <th><strong>callback</strong><br> (JSON, Opcional)</th> <th>La sección donde puedes definir las propiedades de la URL de callback, donde se enviarán las respuestas JSON automáticas de los estados del trabajo</th> </tr> <tr> <td><strong>url</strong><br> (String, Obligatorio si deseas especificar la URL de callback</td> <td>La URL donde se enviarán las respuestas automáticas usando el método HTTP POST, cada vez que cambie el estado del trabajo. La información sobre los detalles del trabajo estará contenida en el cuerpo de la respuesta JSON.<br /> <br /> El CLI también mostrará una transmisión en tiempo real de la ejecución y el estado final del trabajo.</td> </tr> <tr> <td><strong>headers</strong><br> (String, Opcional)</td> <td>Encabezados que necesitas que se pasen en la respuesta JSON a la URL de callback<br /> <br /> Debes especificar los encabezados como:<br> {<br> "{header_name_1}" : "{header_value_1}",<br> "{header_name_2}" : "{header_value_2}"<br> }<br> <br /> y así sucesivamente.</td> </tr> <tr> <td><strong>params</strong><br> (String, Opcional)</td> <td>Parámetros que necesitas que se agreguen a la URL de callback<br /> <br /> Debes especificar los parámetros como:<br> {<br> "{param_name_1}" : "{param_value_1}",<br> "{param_name_2}" : "{param_value_2}"<br> }<br> <br /> y así sucesivamente.</td> </tr> <tr> <th><strong>criteria</strong><br> (JSON, Opcional)</th> <th>Un conjunto de condiciones basadas en las cuales se obtendrán los registros. Las propiedades que se deben incluir en esta sección se indican en la tabla a continuación.</th> </tr> </tbody> </table> <br> #### Propiedades de criterios <table class="content-table"> <thead> <tr> <th class="w30p">Atributos</th> <th class="w70p">Descripción</th> </tr> </thead> <tbody> <tr> <td><strong>group_operator</strong><br> (String, Obligatorio si deseas especificar los criterios</td> <td>El operador que vinculará los grupos de criterios entre sí.<br /> <br /> Operadores admitidos: AND, OR<br /> <br /> Si defines dos o más grupos de criterios, puedes usar el operador AND o OR. Por ejemplo, puedes especificar un criterio como "column1 equal value 1 AND column2 contains value 2" en el formato especificado en la sección anterior.<br /> <br /> Nota: No podrás usar combinaciones de ambos operadores. Puedes usar AND o OR en una sola ejecución de comando.</td> </tr> <tr> <td><strong>group</strong><br> (JSON, Obligatorio si deseas especificar los criterios)</td> <td>Puedes incluir hasta 25 conjuntos de criterios en esta sección. El archivo JSON de ejemplo muestra 2 conjuntos de criterios.<br /> <br /> <strong>Nota:</strong> Solo puedes incluir un grupo general con un operador de grupo en una sola ejecución.</td> </tr> <tr> <td><strong>column_name</strong><br> (String, Obligatorio si deseas especificar los criterios)</td> <td>Nombre de la columna específica de la tabla para la cual se deben definir los criterios</td> </tr> <tr> <td><strong>comparator</strong><br> (String, Obligatorio si deseas especificar los criterios)</td> <td>El operador de comparación que coincide el nombre de la columna con el valor del criterio<br /> <br /> <strong>Comparadores admitidos:</strong> equal, not_equal, greater_than, greater_equal, less_than, less_equal, starts_with, ends_with, contains, not_contains, in, not_in, between, not_between<br /> <br /> Nota:<br> * Puedes especificar múltiples valores para los comparadores in y not_in, separados por comas. * Catalyst solo admite el comparador equal para una columna encriptada. No podrás usar otros comparadores como criterio para una columna encriptada.</td> </tr> <tr> <td><strong>value</strong><br> (String, Obligatorio si deseas especificar los criterios)</td> <td>El valor para la columna específica en el registro que deseas definir como criterio</td> </tr> </tbody> </table> Nota: Si no especificas el parámetro obligatorio del identificador de tabla en el archivo JSON, o si no pasas un archivo JSON durante la ejecución del comando, debes especificarlo a través de la opción de exportación. ### Estados de procesamiento del trabajo de exportación Hay tres estados de procesamiento del trabajo para la operación de exportación: * In-Progress: El trabajo entra en este estado tan pronto como ejecutas el comando de importación. El CLI mostrará un parámetro job_id que puedes usar para verificar el estado de la ejecución del trabajo para respuestas posteriores de forma manual, si no has configurado una URL de callback en el JSON.<br /> <br /> Si has configurado una URL de callback, también se publicará una respuesta de estado con el job_id en la URL en el formato que definiste. * Success: Si la operación de exportación es exitosa, Catalyst proporcionará una URL de descarga donde puedes descargar el archivo CSV que contiene los registros que coinciden con tu consulta. Catalyst también te permite descargar el archivo de resultados directamente a tu sistema a través del CLI. Si has configurado una URL de callback, esta respuesta también se publicará en ella. * Failed: Si la operación de exportación falla, el CLI mostrará los detalles de los errores que ocurrieron. Si has configurado una URL de callback, esta respuesta también se publicará en ella. ### Opciones de exportación El proceso de ejecución del comando de exportación se describe en detalle en esta sección, para cada opción. El comando de exportación de Data Store admite las siguientes opciones: <br> #### -\-config &lt;path&gt; La opción \--config te permite definir la ruta del archivo JSON de configuración en tu sistema. Por ejemplo, puedes ejecutar la operación de exportación y pasar la ruta del archivo JSON como se muestra a continuación: El CLI entonces programará automáticamente la ejecución del trabajo y lo marcará como "in-progress". Mostrará una transmisión en tiempo real del proceso de ejecución, junto con el job_id. <br> Si el trabajo se ejecuta exitosamente, el CLI te solicitará que descargues el archivo de resultados a tu sistema. Escribe 'y', luego presiona Enter para descargar. <br> El archivo ZIP que contiene el archivo de resultados se descargará en tu directorio de proyecto. <br> Puedes usar la URL de descarga proporcionada por Catalyst para descargar el archivo de resultados incluso cuando no estés trabajando en tu CLI. Debes ejecutarlo como un comando de API. Nota: La URL de descarga será válida por 1 día después de su generación. <br> El archivo CSV de resultados contendrá una lista de todos los registros que coinciden con tu consulta del trabajo de exportación. <br> <br> #### -\-table &lt;name|id&gt; <br /> La opción -\\-table te permite especificar el nombre de la tabla o el Table ID de la tabla, de donde se deben leer los registros. Como se mencionó anteriormente, si no especificas el identificador de tabla en el archivo JSON, o si no pasas un archivo JSON durante la ejecución del comando, debes especificarlo usando esta opción. Catalyst considerará la tabla especificada en la opción como la prioridad más alta, sobre la especificada en el archivo JSON. Si la tabla no se especifica en ninguno de los dos lugares, el CLI mostrará un mensaje de error durante la ejecución del comando. Por ejemplo, puedes especificar el identificador de tabla de la siguiente manera: catalyst ds:export --table EmpDetails El CLI entonces ejecutará la operación de exportación, leerá de forma masiva los registros de la tabla especificada y proporcionará los resultados de la misma manera. <br> <br> #### -\-page &lt;page&gt; Como se discutió en la sección de parámetros JSON, puedes especificar un valor de página para indicar el rango de registros a obtener de la tabla. Por ejemplo, puedes obtener registros del rango 200,001 a 400,000 ejecutando el siguiente comando: catalyst ds:export --page 2 <br> <br> #### -\-production La opción -\\-production te permite ejecutar directamente la operación de exportación en el entorno de producción de tu proyecto de Catalyst. Si usas esta opción, los registros de la tabla en el entorno de producción se leerán de forma masiva. Nota: Solo puedes usar esta opción si el entorno de producción ya está habilitado para tu proyecto. -------------------------------------------------------------------------------- title: "Verificar el estado de importación/exportación" description: "Catalyst te permite realizar operaciones de lectura y escritura masiva en las tablas del Data Store usando el CLI." last_updated: "2026-07-02T09:34:15.880Z" source: "https://docs.catalyst.zoho.com/es/cli/v1/data-store-import-and-export/check-import-export-status/" service: "All Services" -------------------------------------------------------------------------------- # Verificar el estado de una operación de importación o exportación ### Introducción Puedes verificar manualmente el estado de una operación de importación o exportación de Data Store que iniciaste previamente en cualquier momento que lo necesites. Si no configuraste una URL de callback en tu archivo JSON, o si terminaste la ejecución del comando de importación o exportación del CLI, puedes verificar el estado del trabajo usando este comando. El CLI te informará si el trabajo de importación o exportación está en progreso, se ejecutó exitosamente o falló. Debes usar el job_id que se asignó al trabajo de importación o exportación cuando iniciaste la operación, en este comando. <br> ### Comando de verificación de estado La sintaxis general del comando de verificación de estado del trabajo de importación o exportación es: ds:status [options] &lt;operation&gt; [job_id] El valor de &lt;operation&gt; debe ser import o export, y debes especificarlo obligatoriamente. El job\_id es opcional. Si no especificas el job\_id, se listarán todos los trabajos de la operación especificada ejecutados en las últimas 24 horas. Por ejemplo, si especificas la operación de exportación sin proporcionar un job\_id, el CLI mostrará una lista de todos los trabajos de exportación ejecutados como se muestra a continuación. Luego puedes seleccionar un ID de trabajo específico de la lista y presionar Enter, para ver su estado detallado. El CLI seguirá el mismo proceso de proporcionar una URL de descarga y permitirte descargar el archivo de respuesta si el trabajo se ejecutó exitosamente, como se discutió en las secciones anteriores. Si proporcionas el job\_id con el comando, el CLI obtendrá directamente y mostrará el estado de ese trabajo en particular. <br> ### La opción -\-production El comando de verificación de estado de importación/exportación admite una opción: -\\-production Esta opción te permite verificar el estado de una operación que se ejecutó en el entorno de producción de tu proyecto de Catalyst. Si usaste la opción -\\-production en la ejecución de un comando de importación o exportación, también debes usar la opción para verificar su estado. Nota: Solo puedes usar esta opción si el entorno de producción ya está habilitado para tu proyecto. ### Inicializar recursos -------------------------------------------------------------------------------- title: "Introducción" description: "Puedes inicializar un proyecto de Catalyst y recursos del proyecto como Functions, Client y AppSail desde el CLI" last_updated: "2026-07-02T09:34:15.880Z" source: "https://docs.catalyst.zoho.com/es/cli/v1/initialize-resources/introduction/" service: "All Services" -------------------------------------------------------------------------------- # Inicializar recursos ### Introducción El primer paso para trabajar con el Catalyst CLI es inicializar un proyecto de Catalyst en un directorio de tu sistema local y asociar ese directorio con ese proyecto. No puedes realizar ninguna operación relacionada con el proyecto en el CLI hasta que hayas inicializado un proyecto de Catalyst. El directorio en el que inicializas un proyecto se conoce como el directorio del proyecto. Los archivos de configuración requeridos para tu proyecto se crean automáticamente cuando se inicializa el proyecto. Puedes inicializar cuatro componentes básicos de un proyecto de Catalyst: Functions, Client, AppSail y Slate. Los directorios de los componentes que inicializas se crean automáticamente, junto con los archivos de configuración y dependencias requeridos. Para información detallada sobre la estructura del directorio del proyecto y las estructuras de código de los archivos de configuración, consulta la **página de ayuda de Estructura del Directorio del Proyecto** . Nota: También puedes obtener un archivo JSON que contiene las definiciones de APIs de API Gateway desde la consola remota, a tu directorio del proyecto. Consulta la página de ayuda de Trabajar con API Gateway para más información. <br> Después de que el proceso de inicialización se complete, este directorio quedará permanentemente vinculado a ese proyecto. Aunque puedes usar el directorio para trabajar con otros proyectos usando el comando catalyst project:use , esta asociación solo será temporal. El proyecto que originalmente inicialices en un directorio se considerará el proyecto base de ese directorio. Nota: * No podrás inicializar un proyecto en un directorio cuya raíz ya esté vinculada a otro proyecto. Cuando un proyecto se inicializa en un directorio, el CLI realiza una verificación de componentes de Catalyst comenzando desde la raíz del directorio. Si se encuentran componentes en la raíz, el CLI no inicializará un nuevo proyecto en él. * La mejor manera de inicializar un nuevo proyecto es crear una carpeta individual para él en tu sistema local, navegar hasta ella y ejecutar el comando de inicialización desde ese directorio. * Si eres usuario de Visual Studio Code IDE, puedes instalar la extensión Catalyst Tools y realizar operaciones del CLI usando tu IDE en lugar del CLI. Los pasos para inicializar tu proyecto de Catalyst usando Visual Studio Code IDE se pueden encontrar aquí -------------------------------------------------------------------------------- title: "Inicializar un nuevo proyecto" description: "Puedes inicializar un proyecto de Catalyst y recursos del proyecto como Functions, Client y AppSail desde el CLI" last_updated: "2026-07-02T09:34:15.880Z" source: "https://docs.catalyst.zoho.com/es/cli/v1/initialize-resources/initialize-new-project/" service: "All Services" -------------------------------------------------------------------------------- # Inicializar un nuevo proyecto Puedes inicializar un proyecto, y luego las Functions, Client y una aplicación AppSail como se explica en estas secciones. Para inicializar un nuevo proyecto desde el CLI: 1. Crea una carpeta para el proyecto en tu máquina local y navega hasta ella desde la terminal. Inicializa un proyecto ejecutando el siguiente comando desde ese directorio: catalyst init 2. Selecciona una organización en la que crear el proyecto. Puedes crear y trabajar con múltiples organizaciones en Catalyst, y crear proyectos en cada una. 3. Puedes asociar el directorio del proyecto actual con un proyecto de Catalyst existente en esta organización. También puedes crear tu propio proyecto nuevo directamente desde el CLI o importar un proyecto existente en esta organización. <br /> * Para seleccionar un proyecto de Catalyst existente de esta organización, selecciona de la lista de tus proyectos usando las flechas. Presiona Enter para confirmar. Nota: Puedes ejecutar el comando catalyst project:use para asociar un proyecto existente, que haya sido previamente inicializado en el CLI, con el directorio de trabajo. * Para crear un nuevo proyecto, navega a la opción Create a new project y presiona Enter. Serás redirigido a la consola de Catalyst para crear un nuevo proyecto. Puedes proporcionar un nombre para el proyecto y hacer clic en **Create**. * Para importar un proyecto existente, debes seleccionar Import an existing project , luego seleccionar el archivo ZIP fuente del proyecto. Puedes aprender más sobre estos pasos en la página de ayuda de Exportar e Importar Proyecto. Nota: * No puedes crear tu primer proyecto de Catalyst desde el CLI. Puedes crear el primer proyecto solo usando la consola web de Catalyst. Puedes crear proyectos posteriores desde el CLI. * Puedes crear hasta 50 proyectos en tu cuenta. Puedes solicitar a Catalyst un aumento en este límite contactando a nuestro soporte en support@zohocatalyst.com. Abordaremos cada solicitud caso por caso. <br> 4. Ahora, selecciona los componentes que necesitas configurar para tu aplicación de Catalyst presionando Space para seleccionar las funcionalidades. Presiona Enter para confirmar tus elecciones. Puedes inicializar cualquiera de estos componentes: Functions, Client, AppSail. <br /> <br> Nota: * También puedes inicializar un proyecto sin seleccionar ningún componente. Dado que el propósito principal de una inicialización de proyecto es vincular el directorio a un proyecto particular, no es obligatorio inicializar ninguno de sus componentes. En este caso, se creará una carpeta de proyecto con solo los archivos catalyst.json y .catalystrc. * Si no inicializas un componente particular durante la inicialización del proyecto, siempre puedes configurarlo más tarde en cualquier momento después de que el proyecto esté inicializado. Para más información, consulta las secciones de ayuda de configuración de Client, configuración de Functions y agregar AppSail. <br> El proyecto se creará con un ID de proyecto único. El archivo catalyst.json y el archivo oculto .catalystrc que contiene los detalles de tu proyecto se crearán en el directorio del proyecto. El directorio del proyecto de Catalyst incluirá directorios, archivos y dependencias basados en todos los componentes que inicializaste. La imagen a continuación muestra un directorio de proyecto de ejemplo si se inicializaron una función Java y un componente Client básico en el proyecto. Nota: * Si estás inicializando recursos en un directorio de proyecto existente, el CLI omitirá los pasos para asociar un proyecto con el directorio. * Si estás inicializando un componente que ya está presente en el directorio del proyecto, el CLI mostrará un mensaje preguntando si la carpeta debe ser sobrescrita. Puedes presionar Y para sobrescribir el directorio existente o N para omitir la creación del directorio y luego presionar Enter. * Puedes autocompletar las consultas con los valores predeterminados si presionas Enter. * Si eres usuario de Visual Studio Code IDE, puedes instalar la extensión Catalyst Tools y realizar operaciones del CLI usando tu IDE en lugar del CLI. Los pasos para inicializar tu proyecto de Catalyst usando Visual Studio Code IDE se pueden encontrar aquí. -------------------------------------------------------------------------------- title: "Inicializar Functions" description: "Puedes inicializar un proyecto de Catalyst y recursos del proyecto como Functions, Client y AppSail desde el CLI" last_updated: "2026-07-02T09:34:15.880Z" source: "https://docs.catalyst.zoho.com/es/cli/v1/initialize-resources/initialize-functions/" service: "All Services" -------------------------------------------------------------------------------- # Inicializar Functions ### Configurar el tipo de función Si eliges inicializar el directorio de Functions para tu proyecto, Catalyst iniciará su proceso de configuración. 1. Selecciona el tipo de función que deseas desarrollar. Haz tu selección y presiona Enter .<br /> Los seis tipos de funciones que puedes desarrollar en Catalyst son: Basic I/O, Advanced I/O, Event, Cron, Browser Logic, Integration y Browser Logic. Para obtener más información sobre los tipos de funciones y sus propósitos, consulta la **página de ayuda de Functions.** <br> **Integration Functions:** <br> El proceso de inicialización del CLI es el mismo para todos los demás tipos de funciones, excepto las Integration Functions. Si seleccionas _Integration_ de la lista, debes realizar estos dos pasos adicionales antes de pasar al siguiente paso:<br /> **i.** Selecciona el servicio con el que deseas integrar. Actualmente solo puedes seleccionar la integración con Cliq. **ii.** Selecciona los handlers que necesites. Puedes aprender más sobre esto en la página de ayuda de Integration Functions .<br /> El resto del proceso de configuración es el mismo para todos los tipos de funciones. El proceso solo varía con el stack de la función. Nota: Cliq Integration Functions no está disponible actualmente para los usuarios de Catalyst que acceden desde los centros de datos de EU, AU, IN o CA. ConvoKraft Integration Functions están disponibles para todos los DCs. <br> 2. Selecciona un stack para desarrollar las funciones del lado del servidor y presiona Enter . La lista muestra todos los runtimes soportados. Puedes seleccionar la última versión soportada de Java, Node.js o Python de la lista. Nota: Puedes crear múltiples funciones de Java, Node.js o Python dentro de un solo directorio de Functions usando el comando catalyst functions:add . <br> ### Inicializar una función Java de cualquier tipo 1. Si inicializas una función Java, selecciona el runtime requerido de los runtimes soportados: **Java 8**, **Java 11**, **Java 17**, **Java 21**, **Java 25**. <br> Nota: Antes de elegir tu versión del stack de función Java, asegúrate de tener el JDK relevante instalado en tu sistema. También puedes instalar los JDKs relevantes desde los siguientes enlaces: * Java 8 * Java 11 * Java 17 * Java 21 * Java 25 2. Ingresa el nombre de referencia de la función Java cuando se te solicite y presiona Enter . Este también será el nombre de la carpeta de la función.<br /> 3. Proporciona el nombre de la clase principal de la función Java y presiona Enter . El CLI descargará el paquete del Java SDK y completará el proceso de configuración de la función. <br> 4. Si es la primera vez que inicializas una función de **Java 11**, **Java 17**, **Java 21** o **Java 25**, necesitarás configurar adicionalmente la información de ruta de los JDKs instalados en tu sistema. Puedes establecer esta información en un archivo de configuración específico que está presente en tu sistema local como un archivo oculto. La ruta de los JDKs instalados deberá configurarse usando el comando CLI config:set &lt;key=value&gt;. Puedes encontrar más información sobre este comando en este documento de ayuda. Establece la información de ruta en el archivo de configuración como se muestra en el ejemplo a continuación: **Java 11**: catalyst config:set java11.bin=/Library/Java/JavaVirtualMachines/jdk-11.0.17.jdk/Contents/Home/bin <br /> **Java 17**: catalyst config:set java17.bin=/Library/Java/JavaVirtualMachines/jdk-17.jdk/Contents/Home/bin <br /> **Java 21**: catalyst config:set java21.bin=/Library/Java/JavaVirtualMachines/jdk-21.jdk/Contents/Home/bin <br /> **Java 25**: catalyst config:set java25.bin=/Library/Java/JavaVirtualMachines/jdk-25.jdk/Contents/Home/bin <br /> Nota: * Reemplaza la ruta indicada en los comandos anteriores con tu ruta de JDK. * Si tu sistema local ejecuta Windows OS, encierra la ruta entre comillas dobles. Por ejemplo, establecerás la ruta de Java 11 de la siguiente manera:<br /> catalyst config:set java11.bin="/Library/Java/JavaVirtualMachines/jdk-11.0.17.jdk/Contents/Home/bin" <br /> La carpeta de la función Java se creará con el archivo de clase .java principal, los archivos JAR de biblioteca, catalyst-config.json , y otros archivos de configuración. Estos valores se actualizarán en el archivo de configuración catalyst.json .<br /> Puedes aprender sobre la estructura del directorio de funciones Java en detalle en la página de ayuda de Estructura del Directorio del Proyecto. <br> ### Inicializar una función Node JS de cualquier tipo 1. Si inicializas una función Node.js, selecciona el runtime requerido de los runtimes soportados: **Node 24**, **Node 22**, **Node 20**, **Node 18**, **Node 16**, **Node 14**. <br> 2. Proporciona un nombre de paquete para tu función Node cuando se te solicite y presiona Enter .<br /> 3. Proporciona el nombre del archivo de punto de entrada y presiona Enter . 4. Proporciona un nombre para el author de la función y presiona Enter . 5. El CLI te solicitará permitir la instalación de dependencias de Node. Presiona Y para confirmar la instalación, y presiona Enter para confirmar tu elección. Si no instalas todas las dependencias requeridas, podría causar errores durante la ejecución de la función.<br /> El CLI descargará el paquete del Node.js SDK y completará el proceso de configuración de la función. <br> Nota: Catalyst te permite crear una función Advanced I/O en la plantilla Express, que instala los módulos de Express.js. Sin embargo, no podrás crear la plantilla Express desde el CLI. Pero puedes instalar Express en tu sistema de forma independiente ejecutando npm install express --save desde el directorio de una función particular para usar los módulos de Express en ella. Puedes aprender más sobre la plantilla Express en la página de ayuda de Advanced I/O Function . <br> El directorio de la función Node está ahora configurado con el archivo principal de función .js, catalyst-config.json , y los módulos de Node necesarios y archivos de configuración si instalaste las dependencias. Estos valores se actualizarán en el archivo de configuración catalyst.json . Puedes aprender sobre la estructura del directorio de funciones Node.js en detalle en la página de ayuda de Estructura del Directorio del Proyecto . Nota: * Puedes agregar cualquier número de subcarpetas y archivos en el directorio de una función Java o Node.js. Además del archivo principal de función, la carpeta de una función puede contener otras subfunciones. Sin embargo, los archivos de configuración y dependencias deben estar en la raíz del directorio de la función. * Puedes crear subfunciones a través de la consola de Catalyst , o usando editores externos. También puedes obtener un directorio de función existente desde la consola a tu sistema local usando el comando catalyst pull. * Si necesitas inicializar más de una función, puedes hacerlo usando el comando catalyst functions:add . <br> ### Inicializar una función Python de cualquier tipo 1. Si inicializas una función Python, selecciona el runtime requerido de los runtimes soportados: **Python 3.9**, **Python 3.10**, **Python 3.11**, **Python 3.12** o **Python 3.13**. 2. Proporciona un nombre de paquete para tu función Python cuando se te solicite y presiona Enter .<br /> 3. Proporciona el nombre del archivo de punto de entrada y presiona Enter. Tras la inicialización exitosa de la función Python, el paquete del Catalyst Python SDK se instalará automáticamente para tu proyecto y se realizará una entrada en el archivo requirements.txt. Nota: Si es la primera vez que inicializas una función Python, necesitarás configurar adicionalmente la información de ruta de Python instalado en tu sistema. Puedes establecer esta información en un archivo de configuración específico que está presente en tu sistema local como un archivo oculto. La ruta deberá configurarse usando el comando CLI config:set &lt;key=value&gt;. Puedes encontrar más información sobre este comando en este documento de ayuda. El directorio de la función Python está ahora configurado con el archivo principal de función .py, catalyst-config.json y el archivo de configuración requirements.txt. Estos valores se actualizarán en el archivo de configuración catalyst.json. Puedes aprender sobre la estructura del directorio de funciones Python en detalle en la página de ayuda de Estructura del Directorio del Proyecto . Puedes codificar las funciones que inicializaste en tu entorno local y desplegarlas a la consola. Puedes usar el shell de Functions para probarlas y depurarlas antes de desplegar. De manera similar, puedes servirlas a través de un localhost también. Nota: * Puedes agregar cualquier número de subcarpetas y archivos en el directorio de una función Java, Node.js o Python. Además del archivo principal de función, la carpeta de una función puede contener otras subfunciones. Sin embargo, los archivos de configuración y dependencias deben estar en la raíz del directorio de la función. * Puedes crear subfunciones para funciones Node.js a través de la consola de Catalyst. Sin embargo, las funciones Java y Python solo se pueden crear y actualizar desde el CLI y usando editores externos. * Puedes obtener un directorio de función existente desde la consola a tu sistema local usando el comando catalyst pull . * Si necesitas inicializar más de una función, puedes hacerlo usando el comando catalyst functions:add . -------------------------------------------------------------------------------- title: "Inicializar el Client" description: "Puedes inicializar un proyecto de Catalyst y recursos del proyecto como Functions, Client y AppSail desde el CLI" last_updated: "2026-07-02T09:34:15.881Z" source: "https://docs.catalyst.zoho.com/es/cli/v1/initialize-resources/initialize-client/" service: "All Services" -------------------------------------------------------------------------------- # Inicializar el Client ### Introducción Catalyst te permite desarrollar tres tipos de aplicaciones Client nativas que se pueden alojar en Web Client Hosting: * Aplicaciones Angular * Aplicaciones React * Aplicaciones Client básicas Catalyst proporciona plantillas listas para usar para aplicaciones Client Angular y React. Cuando inicializas estas aplicaciones, Catalyst manejará todo el procedimiento de configuración y te solicitará instalar las dependencias requeridas. Las aplicaciones Angular y React se crearán en el directorio de tu proyecto en su estructura boilerplate. La aplicación Client básica es una versión simple del Client de Catalyst que se creará en su propia estructura estándar. Los procedimientos de instalación diferirán para los tres tipos de aplicaciones Client. Nota: * Puedes agregar cualquier número de subcarpetas y archivos en el directorio del Client como archivos HTML, archivos JavaScript, imágenes de logo y más. Sin embargo, los archivos de configuración y dependencias deben estar en la raíz del directorio del Client. * También puedes obtener un web Client alojado desde la consola a tu sistema local usando el comando catalyst pull . * Web Client Hosting es adecuado para aplicaciones web básicas y simples. Puedes explorar nuestro robusto servicio de desarrollo frontend, Slate, que te permite desplegar aplicaciones web sin problemas en una variedad de frameworks JavaScript populares como Next.js, Angular, React, Vue y más. Slate también proporciona despliegues automatizados desde GitHub, GitLab o Bitbucket, y ofrece una serie de otras funcionalidades avanzadas. Si inicializas el directorio del Client para tu proyecto, Catalyst iniciará su proceso de configuración después de la inicialización de Functions. Selecciona uno de los tipos de Client para inicializar para tu proyecto de las opciones, luego presiona Enter. <br> ### Aplicaciones Angular Angular es un framework de diseño de aplicaciones frontend y plataforma de desarrollo para crear aplicaciones de página única eficientes y sofisticadas. Angular sigue una arquitectura basada en componentes donde la aplicación se desacopla en entidades funcionales y lógicas individuales y reutilizables. Los bloques de construcción de Angular como los componentes, plantillas, directivas e inyecciones de dependencia se combinan en módulos, que juntos forman una aplicación Angular. Puedes aprender más en la documentación oficial de Angular . Se recomienda que tengas Angular CLI instalado en tu máquina local para desarrollar aplicaciones Client Angular. Este CLI maneja la instalación y configuración de las dependencias requeridas automáticamente, y permite un desarrollo y prueba fácil de aplicaciones Client. Catalyst iniciará automáticamente su instalación durante el proceso de inicialización del Client. Catalyst también proporciona un plugin para la aplicación Angular, zcatalyst-cli-plugin-angular , que se instala cuando se inicializa la aplicación Angular. Este plugin, compatible con la última versión LTS de Angular, maneja internamente varias operaciones involucradas en el desarrollo y prueba de la aplicación Angular. Esto facilita y agiliza tu tarea de construcción de aplicaciones, y te permite enfocarte en la funcionalidad de la aplicación en lugar de su configuración y mantenimiento. Nota: El plugin de Catalyst debe instalarse en el directorio específico de la aplicación. El archivo de configuración catalyst.json especificará la ruta del plugin. Catalyst ha descontinuado el soporte para la instalación global del plugin de Angular. Por favor, actualiza el código de tus aplicaciones Angular existentes de acuerdo a esto. <br> Si seleccionas Angular Web App de las opciones mientras inicializas el Client, Catalyst iniciará el procedimiento de configuración estándar para aplicaciones Angular. La aplicación se creará en la última versión LTS. Nota: La versión LTS de Angular actualmente soportada por Catalyst es v12. 1. El CLI te solicitará que proporciones un nombre para el componente Client de tu proyecto. Proporciona un nombre para el Client y presiona Enter .<br /> <br> 2. Si Angular CLI no está ya instalado en tu sistema, Catalyst iniciará automáticamente una instalación temporal de su versión LTS. También instalará un paquete de schematics específico de Catalyst que es necesario para generar una aplicación Angular.<br /> <br /> Ingresa "Y" para confirmar la instalación de los paquetes requeridos cuando se te solicite, luego presiona Enter .<br /> Si los paquetes requeridos ya existen en tu sistema local, la configuración saltará al siguiente paso. Nota: Si tienes una versión antigua o no soportada de Angular instalada en tu sistema, Catalyst te solicitará actualizar la versión a la última versión soportada. <br> 3. Puedes habilitar el enrutamiento de Angular para manejar la navegación entre las diferentes vistas que crees. Ingresa "Y", luego presiona Enter cuando se te solicite.<br /> <br> 4. Puedes dar estilo a los componentes Angular con cualquiera de los formatos de hoja de estilos soportados como se muestra a continuación. Selecciona un formato de hoja de estilos para tu aplicación, luego presiona Enter .<br /> Las solicitudes de enrutamiento y hoja de estilos caen bajo los procedimientos de configuración predeterminados de las aplicaciones Angular.<br /> Catalyst luego iniciará la instalación de los archivos de aplicación Angular, archivos de configuración y dependencias en sus estructuras boilerplate. Los módulos de Node requeridos para el desarrollo de la aplicación también se instalan a través de NPM.<br /> <br> El directorio del Client Angular está ahora configurado con los archivos de aplicación estándar, archivos de entorno, el archivo del plugin, hojas de estilo, index.html y clases TypeScript como se muestra a continuación. Los módulos de Node requeridos, archivos de configuración JSON y dependencias, incluyendo client-package.json específico de Catalyst, también estarán presentes en el directorio. Después de que estos paquetes se instalen, el archivo de configuración catalyst.json se actualizará con los detalles del paquete del Client, incluyendo la ruta al archivo del plugin especificado anteriormente. Puedes aprender más sobre los archivos de configuración de Catalyst y el directorio del Client en la página de ayuda de Estructura del Directorio del Proyecto . Puedes aprender sobre probar y desplegar una aplicación Angular desde el Catalyst CLI en las páginas de ayuda de Servir Recursos y Desplegar Recursos. <br> ### Aplicaciones React React es una biblioteca JavaScript frontend que te permite construir aplicaciones interactivas e interfaces de usuario. Su arquitectura basada en componentes gestiona y renderiza eficientemente los estados en tu aplicación durante la construcción. React proporciona facilidad y flexibilidad en el desarrollo de aplicaciones Client de página única, y ofrece reutilización de sus componentes. Puedes aprender más en la documentación oficial de React . Catalyst proporciona un plugin para la aplicación React, zcatalyst-cli-plugin-react , que se instala cuando se inicializa la aplicación React. Este plugin contiene ciertos módulos de Node y archivos de biblioteca que manejan internamente varias operaciones involucradas en el desarrollo y prueba de la aplicación React. Esto permite un proceso de construcción de aplicaciones más rápido y eficiente. Nota: El plugin de Catalyst debe instalarse en el directorio específico de la aplicación. El archivo de configuración catalyst.json especificará la ruta del plugin. Catalyst ha descontinuado el soporte para la instalación global del plugin de React. Por favor, actualiza el código de tus aplicaciones React existentes de acuerdo a esto. Cuando inicializas una aplicación React, Catalyst facilitará automáticamente su creación y configuración a través del gestor de paquetes Yarn por defecto. Si no tienes Yarn instalado en tu máquina local, la aplicación React se configurará usando NPM. Catalyst permite el manejo de todas las tareas de configuración como vincular y resolver paquetes, e instalar dependencias, a través del gestor de paquetes automáticamente. Si seleccionas React Web App de las opciones mientras inicializas el Client, Catalyst iniciará el procedimiento de configuración estándar para aplicaciones React. 1. Puedes crear la aplicación React con la plantilla estándar de JavaScript o una plantilla de TypeScript. TypeScript es un superconjunto tipado de JavaScript que se transpila a JavaScript plano durante la compilación. Catalyst te proporciona estas opciones durante la inicialización para hacer el procedimiento de configuración más fácil y rápido.<br /> <br /> Selecciona JavaScript o TypeScript de las opciones.<br /> 2. El CLI te solicitará que proporciones un nombre para el componente Client de tu proyecto. Proporciona un nombre para el Client y presiona Enter. Nota: El directorio del Client en tu proyecto se llama client en el caso de aplicaciones Angular y web Client básicas. Sin embargo, para aplicaciones React, el nombre del directorio del Client es el mismo nombre que asignas al web Client aquí durante su inicialización o configuración. Por ejemplo, si nombras tu web Client como "vendorApp", el directorio del Client también se llamará vendorApp . Este valor se actualizará de acuerdo a esto en el archivo de configuración catalyst.json. Esto iniciará la instalación de los paquetes React necesarios como react , react-dom y react-scripts a través de una plantilla CRA específica de Catalyst. Esta plantilla base ejecutará el comando create-react-app .<br /> El gestor de paquetes luego inicializará un repositorio git para la aplicación React e instalará las dependencias de la plantilla.<br /> Después de que la inicialización se complete, puedes encontrar los archivos de la aplicación React creados en sus estructuras boilerplate en el directorio de tu proyecto.<br /> <br> La estructura del directorio de la aplicación React contendrá los archivos fuente de la aplicación, archivos públicos, archivos de configuración, módulos de Node y otras dependencias incluyendo client-package.json específico de Catalyst como se muestra a continuación. Después de que estos paquetes se instalen, el archivo de configuración catalyst.json se actualizará con los detalles del paquete del Client, incluyendo la ruta al archivo del plugin especificado anteriormente. Puedes aprender más sobre los archivos de configuración de Catalyst y el directorio del Client en la página de ayuda de Estructura del Directorio del Proyecto . Cuando sirvas o despliegues la aplicación React, se creará una carpeta build en este directorio que contendrá todos los archivos compilados según los estándares de React.js. <br> ### Aplicaciones Client básicas La aplicación Client básica es una versión simple del Client de Catalyst que se crea sin ningún framework o biblioteca externa. Puedes crear aplicaciones web Client simples y funcionales eligiendo la opción Basic Web App durante la inicialización del Client. El CLI te solicitará que proporciones un nombre para el componente Client de tu proyecto. Proporciona un nombre para el Client y presiona Enter . <br> El directorio del Client se creará ahora en el directorio del proyecto y el archivo catalyst.json se actualizará con su información. <br> El directorio del Client básico se configurará con el archivo principal index.html, main.css, main.js y la configuración client-package.json. Puedes aprender sobre la estructura del directorio del Client en detalle en la página de ayuda de Estructura del Directorio del Proyecto. Puedes servir el Client a través de un localhost para probarlo, y luego desplegarlo a la nube, o alojarlo desde la consola directamente. -------------------------------------------------------------------------------- title: "Inicializar un servicio AppSail" description: "Inicializa un servicio web AppSail de Catalyst en un runtime gestionado por Catalyst de Java, Node.js y Python, o en un runtime personalizado como una imagen OCI en el directorio de tu proyecto para desplegarlo en la nube." last_updated: "2026-07-02T09:34:15.881Z" source: "https://docs.catalyst.zoho.com/es/cli/v1/initialize-resources/initialize-appsail/" service: "All Services" -------------------------------------------------------------------------------- # Inicializar AppSail ### Introducción AppSail es una plataforma serverless de Catalyst que puedes usar para desplegar servicios web de cualquier escala en la nube y gestionar sus instancias de plataforma. Puedes inicializar un servicio AppSail de dos formas: * Como un runtime gestionado por Catalyst: Inicializa y despliega aplicaciones de runtimes específicos de Java, Node.js y Python soportados por Catalyst directamente en la consola remota * Como una imagen de contenedor: Inicializa y despliega una imagen OCI de tu aplicación de cualquier runtime o framework desde tu registro local a la consola remota Nota: Catalyst solo soporta el despliegue de imágenes compatibles con OCI construidas para la plataforma Linux AMD64 (x86-64). ** Consulta aquí para más detalles.** En ambos casos, puedes inicializar un servicio AppSail para una aplicación lista para ser desplegada y asociarla con un proyecto de Catalyst mediante este comando. Info: Puedes asociar un directorio de proyecto Catalyst existente con una aplicación AppSail usando el comando appsail:add. También puedes desplegar directamente una aplicación sin inicialización a través del comando independiente. <br> ### Inicializar AppSail como un Runtime Gestionado por Catalyst Puedes inicializar un servicio AppSail para un runtime gestionado por Catalyst directamente en el directorio de tu aplicación, o desde un nuevo directorio. Si seleccionaste AppSail durante la inicialización del proyecto, Catalyst lo configurará después de la inicialización del Client. Catalyst crea un archivo app-config.json cuando se inicializa un servicio AppSail con este método. 1. El CLI te pedirá que selecciones el tipo de runtime como **Catalyst-Managed Runtime** o **Docker Image** cuando se inicialice AppSail. Selecciona la primera opción. 2. Ahora puedes elegir comenzar con un proyecto de ejemplo listo usando ingresando "Y" y presionando **Enter**, luego seleccionando una aplicación de ejemplo de la lista. La aplicación de ejemplo se descargará en el directorio. Proporciona un nombre para ella cuando se te solicite. Si deseas inicializar tu propia aplicación, ingresa "N", luego presiona **Enter**. 3. Selecciona si este será tu directorio fuente de tu aplicación ingresando "Y". Si ingresas "N", el CLI te pedirá que escribas la ruta absoluta del código fuente de tu aplicación en tu directorio. Presiona **Enter** después de las entradas. 4. Ingresa un nombre para tu aplicación. Puedes nombrar el archivo principal del build de tu aplicación como prefieras. Nota: Cuando construyas tu aplicación como un archivo Java WAR, necesitarás nombrar el archivo principal root.war o agregar controladores específicos según tu código. 5. Ingresa la ruta de build absoluta para tu aplicación, luego presiona **Enter**. 6. Selecciona un stack y runtime para tu aplicación y presiona **Enter**. Si seleccionas Java, el CLI te pedirá además que elijas entre **Java SE** o **Java WAR** como el formato desplegable de tu aplicación. Puedes aprender más sobre esto aquí. Si seleccionas cualquier otro stack, esto se omitirá. AppSail ahora está inicializado en el directorio fuente que seleccionaste, y la aplicación está ahora asociada con el proyecto de Catalyst. Las configuraciones se actualizarán en el archivo catalyst.json de manera correspondiente. Esta inicialización solo creará el archivo de configuración app-config.json específico de AppSail en el directorio fuente de tu aplicación. Puedes editar los valores como el comando de inicio, variables de entorno o memoria en este archivo antes de desplegar. <br> ### Inicializar AppSail como un Runtime Personalizado Puedes inicializar AppSail para una imagen OCI compatible de tu aplicación desde un nuevo directorio. Catalyst soporta dos protocolos que puedes usar para asociar la imagen de tu aplicación con AppSail. Cada protocolo tiene un esquema distinto para identificación y funcionamiento. * Protocolo Docker Image: Usa esto para asociar una imagen preconstruida de tu aplicación presente en el registro local de Docker. La imagen debe estar construida y etiquetada para apuntar al registro local. Ejemplo: *docker://localhost/expres-hw:latest* * Protocolo Docker Archive: Usa esto para apuntar a un archivo de respaldo (.tar o .tar.gz) de una imagen preconstruida de tu aplicación en el directorio de tu sistema. Ejemplo: *docker-archive://test.tar* Nota: El archivo .tar se puede generar típicamente con el comando docker save. No necesitas proporcionar ningún otro detalle excepto el nombre del AppSail para imágenes de contenedor. No es necesario configurar la ruta fuente o de build de la aplicación, el stack ni el comando de inicio para imágenes OCI, ya que están definidos en las imágenes. 1. El CLI te pedirá que selecciones el tipo de runtime como Catalyst-Managed Runtime o **Docker Image** cuando se inicialice AppSail. Selecciona la segunda opción. 2. Selecciona el protocolo como **Docker Image** o **Docker Archive**. 3. Protocolo Docker Image: Si seleccionas **Docker Image**, el CLI listará todas las imágenes disponibles con etiquetas en el registro local de Docker. Selecciona la imagen que necesitas. Protocolo Docker Archive: Si seleccionas **Docker Archive**, el CLI te pedirá que ingreses la ruta absoluta al archivo TAR de la imagen de tu aplicación en tu sistema local. Nota: Cuando la configuración de AppSail se almacena en el archivo catalyst.json, la ruta se almacenará de forma relativa a la ubicación de ese archivo. 4. Proporciona un nombre para el servicio AppSail. Puedes nombrarlo como prefieras. AppSail ahora está inicializado en tu directorio local, y la imagen de la aplicación está ahora asociada con el servicio AppSail. Las configuraciones se actualizarán en el archivo catalyst.json de manera correspondiente. Nota: El archivo app-config.json no se creará cuando inicialices AppSail con una imagen de contenedor. Todas las especificaciones de la aplicación se almacenarán en el archivo catalyst.json. Puedes agregar ciertas configuraciones personalizadas de tu aplicación en este archivo. Consulta aquí para más detalles. Ahora puedes codificar tu lógica de negocio en tu aplicación, luego servir el servicio AppSail a través de un localhost para depurar y probar, o desplegarlo directamente en la consola remota. -------------------------------------------------------------------------------- title: "Inicializar un recurso específico" description: "Puedes inicializar un proyecto de Catalyst y recursos del proyecto como Functions, Client y AppSail desde el CLI" last_updated: "2026-07-02T09:34:15.881Z" source: "https://docs.catalyst.zoho.com/es/cli/v1/initialize-resources/initialize-specific-resource/" service: "All Services" -------------------------------------------------------------------------------- # Inicializar un recurso específico Puedes inicializar un recurso específico de la siguiente manera: catalyst init [feature] Debes ingresar la palabra clave client, appsail o functions . Por ejemplo, para inicializar solo el directorio de Functions para tu proyecto, ejecuta el siguiente comando desde el directorio de tu proyecto: catalyst init functions -------------------------------------------------------------------------------- title: "Opciones de inicialización" description: "Puedes inicializar un proyecto de Catalyst y recursos del proyecto como Functions, Client y AppSail desde el CLI" last_updated: "2026-07-02T09:34:15.881Z" source: "https://docs.catalyst.zoho.com/es/cli/v1/initialize-resources/initialize-options/" -------------------------------------------------------------------------------- # Opciones de inicialización ### -\-force Catalyst te permite forzar la inicialización de un proyecto o sus recursos en un directorio. Si encuentras algún problema al inicializar un proyecto, puedes usar esta opción. Para realizar una inicialización forzada de un proyecto, ejecuta el siguiente comando: catalyst init --force Puedes seguir los mismos pasos para inicializar recursos, como se mencionó anteriormente. -------------------------------------------------------------------------------- title: "Inicializar Slate" description: "Inicializa un servicio Catalyst Slate al inicializar los recursos del proyecto desde el CLI." last_updated: "2026-07-02T09:34:15.881Z" source: "https://docs.catalyst.zoho.com/es/cli/v1/initialize-resources/initialize-slate/" -------------------------------------------------------------------------------- # Inicializar Slate # Introducción Slate es un servicio de desarrollo front-end ofrecido por Catalyst que te permite desplegar, previsualizar y lanzar tus aplicaciones web de manera fluida. Puedes desplegar aplicaciones construidas con cualquier framework front-end, con soporte nativo para frameworks populares de JavaScript como Next.js, React, Angular, Astro, Vue, SolidJS, Svelte y Vite. Consulta la lista completa de frameworks soportados. Puedes inicializar un servicio Slate en el directorio de tu proyecto siguiendo los pasos descritos en la próxima sección. Si deseas desplegar cualquier directorio de proyecto existente en Catalyst Slate, primero debes vincular el directorio con el servicio Slate, usando el comando catalyst slate:link. También puedes desvincularlo si es necesario usando el comando catalyst slate:unlink. Además, puedes agregar múltiples aplicaciones Slate a un directorio de proyecto donde ya se haya inicializado un servicio Slate usando el comando catalyst slate:create. Aprende cómo desplegar una aplicación Slate. ### Inicializar Slate Puedes inicializar un servicio Slate directamente en el directorio de tu aplicación, o desde un nuevo directorio. Si seleccionaste Slate durante la inicialización del proyecto, puedes seguir los pasos que se listan a continuación: También puedes usar el siguiente comando para inicializar el servicio Slate directamente: catalyst init slate 1. Selecciona el framework del client de la aplicación que deseas desplegar en Slate. Presiona Enter para confirmar. Nota: Este proceso descarga automáticamente una plantilla base según el framework elegido en el directorio de tu proyecto, permitiéndote personalizarla y desplegarla en Slate. 2. El CLI establecerá la configuración predeterminada para tu aplicación Slate basándose en el framework elegido. Proporciona un nombre para tu aplicación y presiona **Enter**. Esta configuración incluye los comandos de instalación y build, así como la ruta de build del framework respectivo. Si deseas continuar con la configuración predeterminada, ingresa N. De lo contrario, ingresa Y para realizar las actualizaciones necesarias. Nota: 1. El comando de instalación instala las dependencias requeridas, típicamente usando un gestor de paquetes. 2. El comando de build es el script que transforma tu código de desarrollo en código de producción. 3. La ruta de build es el directorio donde se generan los archivos optimizados listos para producción después de ejecutar el proceso de build. Por defecto, el comando de instalación se detecta automáticamente como **npm install** y el comando de build como **npm run build**. Si deseas cambiar estos, puedes hacerlo ingresando N y proporcionando el comando de paquete requerido. Una vez que confirmes la configuración, el código de plantilla Slate del framework elegido se descargará en el directorio del proyecto, y se agregará una entrada al archivo catalyst.json, que sirve como conexión entre el directorio de tu proyecto y el servicio Catalyst Slate. ### Inicio de sesión del CLI -------------------------------------------------------------------------------- title: "Iniciar sesión desde Catalyst CLI" description: "Aprende a iniciar sesión en Catalyst CLI antes de ejecutar un comando del CLI desde tu terminal." last_updated: "2026-07-02T09:34:15.882Z" source: "https://docs.catalyst.zoho.com/es/cli/v1/login/login-from-cli/" service: "All Services" -------------------------------------------------------------------------------- # Iniciar sesión desde Catalyst CLI ### Introducción Antes de comenzar a usar Catalyst CLI, necesitas iniciar sesión en tu cuenta de Catalyst desde el CLI. Esto conectará tu CLI con tu cuenta en línea de Zoho. Una vez que hayas iniciado sesión desde tu CLI, puedes trabajar en tu proyecto de Catalyst directamente desde la terminal de tu sistema. Los cambios que realices en el CLI se reflejarán y sincronizarán en tu cuenta en línea de Catalyst cuando los despliegues. ### Pasos para iniciar sesión Para iniciar sesión en tu cuenta en línea de Zoho desde el CLI: 1. Ejecuta el siguiente comando en tu terminal: catalyst login 2. Se te solicitará permitir que Catalyst recopile información de reportes de errores del CLI. Presiona Y para permitir que Catalyst recopile información de reportes de errores del CLI y presiona Enter. Para denegar el permiso, presiona N y luego presiona Enter. 3. El CLI te solicitará que selecciones el centro de datos desde el cual accederás a Catalyst. Selecciona el DC US, EU, IN, JP, SA, AU o CA según el DC al que pertenece tu cuenta, y luego presiona Enter. Serás redirigido automáticamente a la ventana de tu navegador, donde se abrirá la página de inicio de sesión de Zoho Accounts. Si no eres redirigido automáticamente, visita la URL que se muestra bajo 'Visit this URL on this device to login'.<br /> Nota: Además de la información de reportes de errores, Catalyst también recopila información sobre el rendimiento y comportamiento del CLI, registros de comandos y otros elementos esenciales. Estos son beneficiosos durante correcciones de errores, si te comunicas con el soporte de Catalyst para solucionar problemas. Si deniegas el permiso ahora, tendrás que cerrar sesión e iniciar sesión de nuevo, o realizar un inicio de sesión forzado, para permitir este permiso nuevamente. Los datos se envían al servidor de Catalyst solo después de que hayas autenticado tu CLI. 4. Si no has iniciado sesión en tu cuenta de Zoho, inicia sesión usando tus credenciales en la página de inicio de sesión de Zoho Accounts. 5. Serás redirigido a una página donde Catalyst CLI solicita permiso para acceder a los datos de tu cuenta de Zoho. Haz clic en Accept para proporcionar estos permisos a Catalyst CLI.<br /> <br> 6. Si tu intento de inicio de sesión es exitoso, serás redirigido a una pantalla que muestra un mensaje de inicio de sesión exitoso de Catalyst CLI.<br /> 7. Cierra la ventana y continúa usando el CLI en tu terminal. El CLI también muestra un mensaje de inicio de sesión exitoso.<br /> Nota: Si eres usuario de Visual Studio Code IDE, puedes instalar la extensión Catalyst Tools y realizar estas operaciones del CLI usando tu IDE en lugar del CLI. Los pasos para iniciar sesión en Catalyst a través de tu Visual Studio Code IDE se pueden encontrar aquí. -------------------------------------------------------------------------------- title: "Opciones de inicio de sesión" description: "Aprende a iniciar sesión en Catalyst CLI antes de ejecutar un comando del CLI desde tu terminal." last_updated: "2026-07-02T09:34:15.882Z" source: "https://docs.catalyst.zoho.com/es/cli/v1/login/options/" service: "All Services" -------------------------------------------------------------------------------- # Opciones de inicio de sesión Catalyst CLI te permite usar las siguientes opciones con el comando catalyst login. ### -\-no-localhost Catalyst te ofrece la conveniencia de usar un dispositivo diferente para iniciar sesión en el CLI. Después de proporcionar tus credenciales e iniciar sesión desde otro dispositivo, puedes continuar usando el CLI en tu dispositivo actual. Esto es muy útil cuando no puedes acceder a tu servidor o usar un navegador en tu dispositivo actual. También puedes usar esta opción cuando necesites proporcionar acceso al CLI de tu cuenta de usuario a otro colaborador. Para iniciar sesión en tu CLI sin usar un navegador, ejecuta el comando catalyst login con la opción -\\-no-localhost de la siguiente manera: catalyst login --no-localhost Cuando ejecutes este comando, se te solicitará permitir que Catalyst recopile información de reportes de errores del CLI. Presiona Y para permitir que Catalyst recopile información de reportes de errores del CLI y presiona Enter. Para denegar el permiso, presiona N y presiona Enter. <br> El CLI te solicitará que selecciones el centro de datos desde el cual accederás a Catalyst. Selecciona el centro de datos US, EU, AU, JP, SA, IN o CA según tu ubicación, y luego presiona Enter. Catalyst entonces te proporcionará una URL y un código de verificación para tu dispositivo. Puedes visitar la URL desde cualquier dispositivo que pueda conectarse a la página de Zoho Accounts. <br> Ingresa el código de verificación proporcionado por Catalyst en esa página y haz clic en Verify. <br> Luego serás redirigido a una página de inicio de sesión, donde puedes iniciar sesión usando las credenciales de tu cuenta. Si tu cuenta ya tiene sesión iniciada, tu CLI se asociará con esa cuenta automáticamente. Se te pedirá que proporciones permisos a Catalyst CLI para acceder a los datos de tu cuenta de Zoho. Después de proporcionar los permisos, la ventana del navegador mostrará un mensaje confirmando que tu dispositivo ha sido aprobado. <br> Ahora puedes comenzar a usar el CLI desde el dispositivo actual. <br> ### -\-force Si encuentras problemas con la autenticación de usuario y la terminal te solicita reautenticación, puedes usar la opción de inicio de sesión forzado en lugar de cerrar sesión e iniciar sesión de nuevo. El inicio de sesión forzado descarta las credenciales de autenticación actuales para ese centro de datos, como el grant token y el access token, e inicia sesión del usuario en la cuenta de Catalyst completamente de nuevo. También puedes usar esta opción para mantener diferentes inicios de sesión de diferentes centros de datos simultáneamente. Es decir, puedes tener un token válido en un solo centro de datos para autenticar tus ejecuciones de comandos. Si ya has iniciado sesión en un centro de datos con una cuenta, y realizas un inicio de sesión forzado en otro centro de datos, ambos tokens de autenticación serán válidos. Luego puedes elegir ejecutar un comando desde cualquiera de los centros de datos, especificándolo como una opción con el comando. Nota: * Solo puedes tener una cuenta con sesión iniciada por centro de datos. No podrás mantener múltiples inicios de sesión desde el mismo centro de datos. * Si tienes diferentes inicios de sesión mantenidos en diferentes centros de datos y no usas esta opción para especificar el centro de datos desde el cual ejecutar este comando, se usará el inicio de sesión más reciente por defecto. Para realizar un inicio de sesión forzado en tu CLI, ejecuta el comando catalyst login con la opción \--force de la siguiente manera: catalyst login --force Después de ejecutar el comando, sigue los mismos pasos que para catalyst login para iniciar sesión en tu cuenta en línea de Zoho desde el CLI. ### Scripts -------------------------------------------------------------------------------- title: "Introducción" description: "Catalyst proporciona la funcionalidad para automatizar las ejecuciones de comandos del CLI y la terminal durante el proceso de pruebas o despliegue en forma de scripts." last_updated: "2026-07-02T09:34:15.882Z" source: "https://docs.catalyst.zoho.com/es/cli/v1/scripts/introduction/" service: "All Services" -------------------------------------------------------------------------------- # Scripts ### Introducción Catalyst proporciona la funcionalidad para automatizar las ejecuciones de comandos del CLI y la terminal durante el proceso de pruebas o despliegue en forma de scripts. Puedes definir scripts de Catalyst en el archivo catalyst.json del directorio de tu proyecto de Catalyst. Los scripts permiten la abstracción de los detalles de los procesos detrás de un ejecutor de tareas. Esto te ayuda a evitar realizar tareas iterativas manualmente y automatiza la lógica que necesita ejecutarse durante las diversas etapas del proceso de pruebas o despliegue. Catalyst soporta dos tipos de scripts: 1. Lifecycle Scripts: Scripts que se ejecutan durante varios eventos del ciclo de vida 2. Custom Scripts: Scripts que puedes definir para ejecutarse cuando los necesites También puedes ejecutar un script manualmente y probarlo cuando lo necesites, usando el CLI. -------------------------------------------------------------------------------- title: "Scripts de ciclo de vida y personalizados" description: "Catalyst proporciona la funcionalidad para automatizar las ejecuciones de comandos del CLI y la terminal durante el proceso de pruebas o despliegue en forma de scripts." last_updated: "2026-07-02T09:34:15.882Z" source: "https://docs.catalyst.zoho.com/es/cli/v1/scripts/lifecycle-and-custom-scripts/" service: "All Services" -------------------------------------------------------------------------------- # Scripts de ciclo de vida y personalizados Antes de aprender sobre cómo escribir un script, discutamos los dos tipos de scripts soportados en Catalyst. Catalyst soporta los siguientes lifecycle scripts: 1. preserve: El script se ejecuta automáticamente antes de que se ejecute el comando catalyst serve . 2. postserve: El script se ejecuta automáticamente después de que se ejecute el comando catalyst serve. 3. predeploy: El script se ejecuta automáticamente antes de que se ejecute el comando catalyst deploy . 4. postdeploy: El script se ejecuta automáticamente después de que se ejecute el comando catalyst deploy. Puedes configurar scripts personalizados para que se ejecuten automáticamente en cualquier momento que los necesites, en el orden que necesites, llamándolos dentro de los lifecycle scripts. Nota: 1. Todos los scripts mencionados anteriormente se ejecutarán en el directorio fuente del componente de Catalyst actual. 2. Puedes elegir omitir las ejecuciones de los lifecycle scripts configurados en el archivo catalyst.json mientras pruebas o despliegas los componentes. Para hacerlo, debes ejecutar catalyst serve o catalyst deploy con la opción -\\-ignore-scripts. Consulta sus respectivas páginas de ayuda para más detalles. -------------------------------------------------------------------------------- title: "Escribir un script" description: "Catalyst proporciona la funcionalidad para automatizar las ejecuciones de comandos del CLI y la terminal durante el proceso de pruebas o despliegue en forma de scripts." last_updated: "2026-07-02T09:34:15.882Z" source: "https://docs.catalyst.zoho.com/es/cli/v1/scripts/write-script/" service: "All Services" -------------------------------------------------------------------------------- # Escribir un script ### Introducción Puedes definir y ejecutar scripts para el Client y las Functions de tu proyecto. Puedes ejecutar comandos del Catalyst CLI y comandos de terminal de tu entorno local a través de scripts. Debes escribir los scripts en el campo scripts del ámbito de functions o client en el archivo catalyst.json presente en la raíz del directorio de tu proyecto. Este archivo contiene la configuración e información de destino de los componentes del directorio de tu proyecto. A continuación se muestra una estructura de código de ejemplo del archivo de configuración catalyst.json. <br> ### Script de ejemplo Discutamos el script mostrado en la imagen anterior. El código de este archivo catalyst.json define dos lifecycle scripts y dos custom scripts. La ejecución de los lifecycle scripts ejecutará los custom scripts. Los scripts aquí están incluidos dentro del ámbito del Client, porque están definidos para el componente Client del proyecto. El código se muestra a continuación: { "functions": { "targets": [ "catly" ], "ignore": [], "source": "functions" }, "client": { "source": "client/app/build", "ignore": [], "scripts": { "packageJson": "cd client && cp client-package.json app/build/", "build": "cd client/app && yarn install && yarn build", "preserve": "catalyst run client:build && catalyst run client:packageJson", "predeploy": "catalyst run client:build && catalyst run client:packageJson" } } } Cuando ejecutas un custom script dentro de un lifecycle script usando el comando catalyst run como se muestra en el ejemplo anterior, debes especificar el componente para el cual se está ejecutando. Esto es necesario si, por ejemplo, hay un comando de terminal cd (cambiar directorio) que debe ejecutarse. La raíz del directorio de ese componente se considerará como el directorio desde el cual se ejecuta el comando de cambio de directorio. <br> El flujo lógico de los scripts escritos anteriormente es el siguiente: 1. Cuando ejecutas el comando catalyst serve o catalyst deploy para el componente Client, los scripts preserve o predeploy se inician respectivamente, antes de ejecutar el comando. 2. Ambos scripts preserve y predeploy contienen las mismas ejecuciones de comandos. La primera acción es el comando catalyst run client:build, que ejecuta el custom script build para el componente Client. La segunda acción es catalyst run client:packageJson , que ejecuta el script packageJson para el componente Client. 3. El custom script build realiza las siguientes acciones en secuencia: * La terminal navega al directorio client/app. * Se ejecuta el comando yarn install para instalar las dependencias de Node.js usando el gestor de paquetes Yarn. * Se ejecuta el comando yarn build para construir la aplicación Client. 4. El custom script packageJson realiza las siguientes acciones una tras otra: * La terminal navega al directorio client. * El archivo client-package.json se copia del directorio client y se pega en el directorio app/build. Después de que estos scripts se ejecutan, los componentes se sirven o despliegan. -------------------------------------------------------------------------------- title: "Ejecutar un script" description: "Catalyst proporciona la funcionalidad para automatizar las ejecuciones de comandos del CLI y la terminal durante el proceso de pruebas o despliegue en forma de scripts." last_updated: "2026-07-02T09:34:15.882Z" source: "https://docs.catalyst.zoho.com/es/cli/v1/scripts/run-script/" service: "All Services" -------------------------------------------------------------------------------- # Ejecutar un script También puedes ejecutar manualmente un script cuando lo necesites usando el CLI, para probar su ejecución. Puedes listar los scripts disponibles en el directorio del proyecto navegando al directorio y ejecutando cualquiera de los siguientes comandos del CLI: catalyst run-script | run <br> El CLI mostrará los lifecycle scripts y custom scripts que están configurados y disponibles para cada componente en el archivo catalyst.json . <br> Puedes ejecutar directamente un script ejecutando el comando run con el nombre del script como se muestra a continuación: catalyst run-script | run [command] Por ejemplo, para ejecutar el custom script packageJson , ejecuta el siguiente comando desde el directorio del proyecto: catalyst run client:packageJson <br> Esto ejecutará el script packageJson definido en el ejemplo. ### Servir recursos -------------------------------------------------------------------------------- title: "Introducción" description: "Catalyst te permite probar los recursos de tu proyecto localmente usando el CLI antes de desplegarlos a la consola remota." last_updated: "2026-07-02T09:34:15.882Z" source: "https://docs.catalyst.zoho.com/es/cli/v1/serve-resources/introduction/" service: "All Services" -------------------------------------------------------------------------------- # Servir recursos ### Introducción Catalyst CLI te permite la conveniencia de probar los recursos de tu proyecto localmente antes de desplegarlos a la nube. Puedes servir los recursos a través de un localhost en tu sistema para pruebas sin afectar la versión en producción de tu aplicación. Puedes servir estos componentes de tu proyecto a través del servidor local: **funciones Basic I/O**, **funciones Advanced I/O**, **Browser Logic Functions**, **aplicaciones AppSail**, **aplicaciones web Angular**, **aplicaciones web React** y **aplicaciones web básicas**. Nota: Catalyst no podrá servir funciones de los otros tipos, es decir, funciones Cron, Event e Integration, ya que sus endpoints no son directamente accesibles a través de URLs. El comando serve también te permite iniciar un servidor local desde cualquier puerto, o iniciar el servidor en modo debug para analizar la ejecución de tu código en detalle. Puedes probar objetivos específicos de tu proyecto, redirigir solicitudes desconocidas a la URL del host local, o ignorar scripts. Todas estas acciones se pueden realizar usando las diversas opciones disponibles para el comando serve. Nota: * También puedes iniciar un shell de Node exclusivamente para probar y depurar funciones de todos los tipos excepto las funciones Advanced I/O. Para obtener más información, consulta la página de ayuda de Trabajar con Functions. * Los paquetes de Functions, Client y AppSail solo se pueden servir exitosamente si sus directorios están en las estructuras estándar. Los directorios deben contener los archivos de configuración requeridos en el formato estándar. Para más información, consulta la página de ayuda de Estructura del Directorio del Proyecto. * Para servir una aplicación AppSail, necesitarás haber inicializado un recurso AppSail ya sea durante la inicialización del proyecto o agregándolo en un directorio de proyecto existente. * Si eres usuario de Visual Studio Code IDE, puedes instalar la extensión Catalyst Tools y realizar operaciones del CLI usando tu IDE en lugar del CLI. Los pasos para servir tus recursos de Catalyst usando Visual Studio Code IDE se pueden encontrar aquí. -------------------------------------------------------------------------------- title: "Servir todos los recursos" description: "Catalyst te permite probar los recursos de tu proyecto localmente usando el CLI antes de desplegarlos a la consola remota." last_updated: "2026-07-02T09:34:15.883Z" source: "https://docs.catalyst.zoho.com/es/cli/v1/serve-resources/serve-all-resources/" service: "All Services" -------------------------------------------------------------------------------- # Servir todos los recursos ### Ejecución del comando serve Puedes alojar las funciones Basic I/O, Advanced I/O y Browser Logic; aplicaciones AppSail; componentes web Client Angular, React y básicos de tu proyecto de Catalyst localmente navegando al directorio de tu proyecto y ejecutando el siguiente comando: catalyst serve Esto iniciará un servidor local en un puerto predeterminado y servirá tus recursos en el endpoint. El CLI mostrará las URLs de los endpoints locales de tu Client, AppSail y endpoints de funciones que se están sirviendo. Como se mencionó anteriormente, Catalyst solo puede servir funciones Basic I/O, Advanced I/O y Browser Logic. Por lo tanto, si hay funciones Cron, Event o Integration en el directorio de tu proyecto, se omitirán del servicio. De manera similar, el archivo JSON de reglas de API Gateway también se omitirá del servicio. <br> ### Servir Functions y aplicaciones web básicas Puedes probar las funciones Basic I/O, Advanced I/O y Browser Logic que están alojadas a través del servidor local accediendo a sus endpoints URL. Estos endpoints se pueden acceder desde un entorno IDE o en tu navegador. El web Client se abrirá en tu navegador predeterminado automáticamente, después de que se aloje a través del servidor local. Nota: Puedes deshabilitar la apertura automática de la URL del web Client en tu navegador usando la opción \--no-open . <br> Cuando accedes a la página principal o a cualquiera de las subpáginas de tu Client, o a los endpoints de tus funciones después de que se sirven, el CLI mostrará un log en vivo de los endpoints accedidos junto con los métodos de solicitud que se usan para acceder a ellos. La información de invocación de la función también incluye niveles de log y otras entradas de log como se muestra a continuación. <br> ### Servir aplicaciones Angular Las aplicaciones Angular en tu proyecto se servirán de manera similar. El plugin de Catalyst para tu aplicación Angular, zcatalyst-cli-plugin-angular , que se instala cuando se inicializa la aplicación Angular, gestionará la sesión de serve. Angular implementa Hot Module Replacement (HMR). El HMR es una funcionalidad de Webpack que actualiza y recarga módulos específicos, sin recompilar y recargar todo el proyecto, cuando se realizan cambios durante una sesión de serve. El HMR está habilitado cuando sirves la aplicación a través del Catalyst CLI por defecto. Nota: Puedes deshabilitar la observación en vivo usando la opción \--no-watch mientras sirves un componente. <br> Cuando la aplicación Angular se sirve, los módulos en la aplicación, como /router , /common etc., se compilan inicialmente. El CLI muestra los detalles de la compilación y la generación del build. También puedes ver los detalles de los archivos individuales en la aplicación, como los archivos chunk iniciales y sus tamaños. Estos caen bajo las normas predeterminadas de los procesos de build y serve de aplicaciones Angular. <br> El CLI redirigirá al navegador predeterminado para abrir el web Client automáticamente después de que la compilación se complete. Puedes deshabilitar esto usando la opción \--no-open , similar a las aplicaciones web básicas. También puedes ver el log en vivo de los endpoints accedidos junto con los métodos de solicitud, en la sesión de serve de una aplicación Angular. <br> Si el HMR no ha sido deshabilitado, los cambios que hagas en tu aplicación Angular se reflejarán en vivo en la sesión de serve sin una recompilación y recarga de todo el componente. El CLI mostrará los logs en vivo de los módulos actualizados, como los detalles de los archivos chunk modificados. <br> ### Servir aplicaciones React Una aplicación React de Catalyst se servirá de manera similar a una aplicación Angular. El plugin de Catalyst para tu aplicación React, zcatalyst-cli-plugin-react , que se instala cuando se inicializa la aplicación React, gestionará la sesión de serve. Las aplicaciones React implementan Hot Module Replacement (HMR) de manera similar a las aplicaciones Angular. El HMR es una funcionalidad de Webpack que actualiza y recarga módulos específicos, sin recompilar y recargar todo el proyecto, cuando se realizan cambios durante una sesión de serve. El HMR está habilitado cuando sirves la aplicación a través del Catalyst CLI por defecto. Nota: Puedes deshabilitar la observación en vivo usando la opción -\-no-watch mientras sirves un componente. <br> Cuando la aplicación React se sirve, el plugin compila en un build de desarrollo. El CLI muestra los detalles de la compilación y el endpoint local para acceder a la aplicación. <br> El CLI redirigirá al navegador predeterminado para abrir el web Client automáticamente después de que la compilación se complete. Puedes deshabilitar esto usando la opción -\\-no-open , similar a las aplicaciones web básicas. También puedes ver el log en vivo de los endpoints accedidos junto con los métodos de solicitud, en la sesión de serve de una aplicación React. Si el HMR no ha sido deshabilitado, los cambios que hagas en tu aplicación React se reflejarán en vivo en la sesión de serve sin una recompilación y recarga de todo el componente. El CLI mostrará los logs en vivo de los módulos actualizados. <br> ### Servir aplicaciones AppSail El proceso de serve para una aplicación AppSail se iniciará dependiendo del stack, runtime y framework de la aplicación, así como de cualquier servidor web embebido utilizado. Basándose en estos factores, tu código compilado podría estar en cualquier formato y estructura. Consulta la sección de ayuda Common Build Files de AppSail para más detalles. Nota: Catalyst sirve todos los archivos ejecutables de tu aplicación AppSail presentes en la ruta de build que especificaste durante la inicialización de la aplicación. No necesitas empaquetar o comprimir todos los archivos de build juntos, ya que AppSail los empaquetará automáticamente durante el serve de la aplicación. <br> También necesitarás tener los comandos de inicio, las variables de entorno, así como la asignación de memoria requerida configurados para tus aplicaciones. Nota: <br> * No necesitas configurar puertos o comandos de inicio particulares para servir una aplicación AppSail específicamente. Simplemente puedes servir una aplicación desplegable, y Catalyst manejará todos los procesos requeridos internamente. * Catalyst CLI proporciona un modo de observación en vivo por defecto, que te permite realizar una recarga en caliente de los recursos que se están sirviendo. Sin embargo, esto actualmente no está disponible para las aplicaciones AppSail de Catalyst y se servirán sin un modo de observación en vivo. <br> Después de probar los recursos del proyecto, puedes salir de la sesión de serve en tu terminal matando el comando en ejecución según tu entorno local. Esto apagará el servidor local. ### Servir una aplicación Slate Puedes alojar la aplicación Slate en tu proyecto de Catalyst localmente navegando al directorio de tu proyecto en local y ejecutando el siguiente comando: catalyst serve --only slate Este comando catalyst serve inicia tu aplicación Slate localmente ejecutando el dev_command definido en tu archivo cli-config.json. Este dev_command se configurará en el archivo cuando vincules o crees una aplicación Slate. Antes de ejecutar el comando catalyst serve, debes asegurarte de que el dev_command incluya el comando de inicio de tu aplicación con el ZC_SLATE_PORT. Por ejemplo, si estás trabajando con una aplicación React, actualiza el comando a: PORT=$ZC_SLATE_PORT npm start Tendrás que configurar tu comando de inicio aquí basándote en el framework de tu aplicación. Puedes consultar la tabla a continuación para los comandos de inicio predeterminados de los frameworks soportados por Catalyst Slate. Puedes modificar el comando de inicio según las necesidades de tu aplicación, si es necesario. <table class="content-table"> <thead> <tr> <th class="w25p">Framework</th> <th class="w75p">Comando de inicio predeterminado</th> </tr> </thead> <tbody> <tr> <td>Create React App</td> <td>PORT=$ZC_SLATE_PORT npm start</td> </tr> <tr> <td>Solid JS(Vite)</td> <td>npm run dev -\- -\-port $ZC_SLATE_PORT</td> </tr> <tr> <td>React + Vite</td> <td>npm run dev -\- -\-port $ZC_SLATE_PORT</td> </tr> <tr> <td>Next.js</td> <td>npm run dev -\- -\-port $ZC_SLATE_PORT</td> </tr> <tr> <td>Astro</td> <td>npm run dev -\- -\-port $ZC_SLATE_PORT</td> </tr> <tr> <td>Angular</td> <td>npm start -\- -\-port $ZC_SLATE_PORT</td> </tr> <tr> <td>Vue (Vite)</td> <td>npm run dev -\- -\-port $ZC_SLATE_PORT</td> </tr> <tr> <td>Preact</td> <td>npm run dev -\- -\-port $ZC_SLATE_PORT</td> </tr> <tr> <td>Svelte</td> <td>npm run dev -\- -\-port $ZC_SLATE_PORT</td> </tr> </tbody> </table> Cuando sirves la aplicación Slate, el comando de inicio mencionado en el archivo cli-config.json ejecuta la aplicación en un servidor local y el CLI mostrará la URL desde la cual puedes acceder a tu aplicación Slate. Después de que hayas terminado de probar tu aplicación localmente, puedes proceder a desplegarla a la consola remota. Discutiremos los comandos de despliegue en la siguiente sección. -------------------------------------------------------------------------------- title: "Opciones de serve" description: "Catalyst te permite probar los recursos de tu proyecto localmente usando el CLI antes de desplegarlos a la consola remota." last_updated: "2026-07-02T09:34:15.883Z" source: "https://docs.catalyst.zoho.com/es/cli/v1/serve-resources/serve-options/" service: "All Services" -------------------------------------------------------------------------------- # Opciones de Catalyst Serve Catalyst CLI habilita una variedad de opciones que puedes usar con el comando catalyst serve. ### \--http &lt;port&gt; Puedes servir los recursos localmente en cualquier puerto que necesites, diferente al puerto predeterminado 3000\. Puedes hacer esto usando la opción -\\-http e incluyendo el número de puerto desde donde necesitas que los recursos sean servidos. Por ejemplo, para servir tus recursos desde el puerto 2000, ejecuta el siguiente comando desde el directorio de tu proyecto: catalyst serve --http 2000 <br> ### \--debug &lt;type:port&gt; Catalyst te permite iniciar el servidor local en modo debug y adjuntar un depurador al servidor en vivo. Puedes depurar el código de tus funciones Basic I/O y Advanced I/O de tu proyecto. Puedes asociar el servidor a una instancia de depurador de tu IDE que usas para desarrollar el código. Esto te permite depurar la ejecución de tus funciones e identificar los errores y problemas en el código. Nota: El comando catalyst serve --debug solo está disponible para funciones Java y Node.js, y no es compatible con funciones Python. Puedes usar un IDE de Python para este propósito y adjuntar un depurador local. Luego puedes servir la función Python y probarla localmente. Consulta esta página de ayuda para pasos detallados sobre cómo depurar y servir funciones Python. También puedes elegir iniciar el servidor en un puerto de tu elección, similar a la opción \--http&lt;port&gt; . El puerto predeterminado donde las funciones Basic I/O se adjuntan al depurador es 8010 y para las funciones Advanced I/O es 8000. <br> Puedes iniciar el servidor local en modo debug ejecutando el siguiente comando desde el directorio del proyecto: catalyst serve --debug &lt;advancedio:name:port,basicio:port&gt; Debes especificar el nombre de las funciones Advanced I/O mientras usas esta opción. No necesitas especificar los nombres de las funciones Basic I/O. Por ejemplo: catalyst serve --debug advancedio:InvoiceFetch:2000,basicio:4000 <br> Esto iniciará el servidor local en el puerto predeterminado 3000\. Los recursos se servirán y los endpoints locales se mostrarán. Luego puedes adjuntar el depurador en el puerto 2000 para la función Advanced I/O y el puerto 4000 para las funciones Basic I/O. El servidor estará escuchando en estos puertos para el depurador. <br> Después de ver este mensaje, abre tu IDE y adjunta el depurador a los puertos que especificaste para las funciones. El CLI mostrará un mensaje de confirmación después de que se adjunte. Ahora puedes probar tus recursos y depurarlos. El CLI mostrará los errores capturados por el depurador, junto con sus detalles. <br> ### \--proxy&lt;url&gt; Catalyst te permite redirigir una solicitud desconocida a la URL del localhost generada por el servidor en el CLI. Esto te permite redirigir las solicitudes que se encuentran durante el serve de funciones. Dichas solicitudes se redirigirán a la consola de Catalyst por defecto. Puedes especificar la URL a la que redirigir las solicitudes desconocidas, mientras ejecutas el comando serve de la siguiente manera: catalyst serve --proxy &lt;url&gt; <br> ### \--only&lt;targets&gt; Puedes servir objetivos específicos en lugar de todos los recursos usando esta opción. Por ejemplo, puedes servir funciones específicas, o el paquete Client solamente. Para servir objetivos específicos, ejecuta el comando catalyst serve con la opción -\\-only seguida de los objetivos a servir como se muestra a continuación: catalyst serve --only client <br /> <br /> ### \--no-watch Catalyst CLI proporciona un modo de observación en vivo por defecto, que te permite realizar una recarga en caliente de los recursos que se están sirviendo. Esto te permite ver las actualizaciones de los cambios que realizas instantáneamente, sin tener que recompilar o re-servir el código. Sin embargo, si necesitas que el modo de observación en vivo se deshabilite, puedes hacerlo usando esta opción. Puedes usar esta opción si no necesitas hacer cambios en el código, como cuando sirves un build listo para producción, o si no necesitas que las actualizaciones se reflejen en vivo. Puedes servir recursos con la observación en vivo predeterminada deshabilitada como se muestra a continuación: catalyst serve --no-watch Esto hará que el servidor compile el código solo cuando el código se sirve inicialmente. El servidor no observará cambios después de que el código se sirva. Las actualizaciones no se reflejarán en vivo cuando pruebes los recursos. Si necesitas que el modo de observación en vivo predeterminado se habilite de nuevo, debes salir de la sesión de serve y re-servir el código sin usar esta opción. <br> ### \--except&lt;targets&gt; Puedes elegir excluir recursos específicos de ser servidos usando esta opción. Por ejemplo, puedes excluir funciones específicas o el paquete Client. Para excluir una función específica, ejecuta el comando catalyst serve con la opción \--except seguida del nombre del objetivo como se muestra a continuación: catalyst serve -- except functions:InvoiceGeneration <br> ### \--ignore-scripts Catalyst te permite automatizar las ejecuciones de comandos del CLI y la terminal definiendo scripts en el archivo catalyst.json en el directorio de tu proyecto. Puedes definir dos lifecycle scripts para ejecutar antes y después del comando catalyst serve respectivamente: preserve, postserve . Puedes aprender más sobre los lifecycle scripts y custom scripts en la página de ayuda de Scripts . Si usas la opción \--ignore-scripts mientras ejecutas el comando catalyst serve, el CLI ignorará las acciones configuradas para los scripts preserve y postserve en el archivo catalyst.json del directorio de tu proyecto. El proceso de despliegue continuará sin la ejecución de estos lifecycle scripts. Puedes usar la opción \--ignore-scripts de la siguiente manera: catalyst serve --ignore-scripts El proceso de serve será el mismo que se discutió anteriormente. <br> ### \--no-open Cuando ejecutas el comando serve y el servidor aloja el código, el CLI te redirigirá a tu navegador predeterminado automáticamente para abrir el componente Client en tu proyecto. Si necesitas que esta redirección automática se deshabilite, puedes ejecutar el comando serve con esta opción como se muestra a continuación: catalyst serve --no-open El CLI mostrará la URL del localhost de todos los componentes servidos como de costumbre. Aún puedes abrir el web Client manualmente accediendo a la URL, si lo necesitas. Puedes usar esta opción cuando no necesites probar el componente Client, o mientras realizas una ejecución de prueba de un build listo para producción. ### Trabajar con API Gateway -------------------------------------------------------------------------------- title: "Introducción" description: "Catalyst CLI proporciona opciones para habilitar o deshabilitar API Gateway y obtener el estado de la creación de APIs en tu entorno local." last_updated: "2026-07-02T09:34:15.884Z" source: "https://docs.catalyst.zoho.com/es/cli/v1/working-with-api-gateway/introduction/" service: "All Services" -------------------------------------------------------------------------------- # Trabajar con API Gateway ### Introducción Catalyst proporciona API Gateway como una herramienta avanzada de gestión de APIs que te permite crear, mantener y monitorear solicitudes HTTP generadas desde aplicaciones Client y microservicios. Catalyst API Gateway actúa como un punto de entrada para acceder a las funciones Basic I/O y Advanced I/O, así como a los componentes web Client de tu aplicación. Para obtener más información sobre este componente en detalle, consulta la **documentación de ayuda de API Gateway** . El CLI proporciona opciones para realizar las siguientes acciones en el API Gateway de tu aplicación: * Habilitar el API Gateway * Obtener el estado del API Gateway y el progreso de la programación * Deshabilitar el API Gateway Después de habilitar el API Gateway para tu proyecto, podrás configurar un archivo JSON en el directorio de tu proyecto que contiene las definiciones de cada API que crees en tu aplicación. Discutiremos esto en detalle en este documento de ayuda. Puedes trabajar en este JSON desde el entorno local y desplegarlo a la consola remota , de manera similar a las funciones o el componente Client. También puedes obtener las últimas definiciones de APIs creadas en tu consola remota a tu directorio local del proyecto, y actualizar el archivo JSON de API Gateway. Puedes aprender sobre esto en la página de ayuda de Pull Resources. Nota: Si eres usuario de Visual Studio Code IDE, puedes instalar la extensión Catalyst Tools y realizar operaciones del CLI usando tu IDE en lugar del CLI. Los pasos para trabajar con API Gateway usando Visual Studio Code IDE se pueden encontrar aquí. -------------------------------------------------------------------------------- title: "Habilitar API Gateway" description: "Catalyst CLI proporciona opciones para habilitar o deshabilitar API Gateway y obtener el estado de la creación de APIs en tu entorno local." last_updated: "2026-07-02T09:34:15.884Z" source: "https://docs.catalyst.zoho.com/es/cli/v1/working-with-api-gateway/enable-api-gateway/" service: "All Services" -------------------------------------------------------------------------------- # Habilitar API Gateway Puedes habilitar API Gateway desde el CLI para tu proyecto si está deshabilitado. Debes habilitarlo antes de acceder a él por primera vez. Nota: Cuando habilitas el API Gateway para tu aplicación de Catalyst, las configuraciones en Security Rules se deshabilitan automáticamente. Las funciones y el web Client alojado en tu proyecto de Catalyst se volverán inmediatamente inaccesibles hasta que crees APIs para ellos. Por lo tanto, debes proceder con precaución. Asegúrate de crear APIs para todas tus funciones y web Client inmediatamente después de habilitar API Gateway. También debes asegurarte de que los usuarios finales no accedan a ellos mientras tanto. <br> Para habilitar API Gateway para tu proyecto, ejecuta el siguiente comando desde el directorio de tu proyecto: catalyst apig:enable <br> El CLI habilitará el componente y actualizará los archivos de configuración con el estado del API Gateway. Esto también habilitará el API Gateway en la consola remota. <br> Siempre puedes verificar el estado del API Gateway de tu proyecto en el archivo catalyst.json en el directorio de tu proyecto. El parámetro enabled para la configuración de apig se actualizará a true . <br /> Nota: Si eres usuario de Visual Studio Code IDE, puedes instalar la extensión Catalyst Tools y realizar operaciones del CLI usando tu IDE en lugar del CLI. Los pasos para trabajar con API Gateway usando Visual Studio Code IDE se pueden encontrar aquí. -------------------------------------------------------------------------------- title: "Obtener el estado de API Gateway" description: "Catalyst CLI proporciona opciones para habilitar o deshabilitar API Gateway y obtener el estado de la creación de APIs en tu entorno local." last_updated: "2026-07-02T09:34:15.884Z" source: "https://docs.catalyst.zoho.com/es/cli/v1/working-with-api-gateway/obtain-api-gateway-status/" service: "All Services" -------------------------------------------------------------------------------- # Obtener el estado de API Gateway ### Ejecución del comando Puedes obtener el estado actual del API Gateway de tu proyecto para verificar si está habilitado o deshabilitado. Si la creación de APIs está en progreso en API Gateway, por ejemplo un proceso de creación automática está en progreso, esto también mostrará el estado del progreso de la programación y te informará de su estado actual. Para obtener el estado del API Gateway de tu proyecto y su progreso de programación, ejecuta el siguiente comando desde el directorio de tu proyecto: catalyst apig:status Se mostrará el estado actual. <br /> ### Opciones de estado de API Gateway También puedes obtener el estado de programación anterior del API Gateway de tu proyecto, en lugar del estado actual, ejecutando $ catalyst apig:status con la siguiente opción: catalyst apig:status --previous Esto mostrará el estado registrado anterior del componente API Gateway. Si el componente fue previamente deshabilitado o habilitado, el CLI te informará de esto. <br /> Nota: Si eres usuario de Visual Studio Code IDE, puedes instalar la extensión Catalyst Tools y realizar operaciones del CLI usando tu IDE en lugar del CLI. Los pasos para trabajar con API Gateway usando Visual Studio Code IDE se pueden encontrar aquí. -------------------------------------------------------------------------------- title: "Archivo JSON de API Gateway" description: "Catalyst CLI proporciona opciones para habilitar o deshabilitar API Gateway y obtener el estado de la creación de APIs en tu entorno local." last_updated: "2026-07-02T09:34:15.884Z" source: "https://docs.catalyst.zoho.com/es/cli/v1/working-with-api-gateway/api-gateway-json-file/" service: "All Services" -------------------------------------------------------------------------------- # Archivo JSON de API Gateway Como se mencionó en la introducción, puedes incluir un archivo JSON en el directorio de tu proyecto que contendrá las definiciones de cada API creada en el componente API Gateway para tu aplicación. Este archivo catalyst-user-rules.json se crea en el directorio principal del proyecto. Si no has creado ninguna API en tu proyecto, aún puedes obtener el archivo catalyst-user-rules.json con definiciones de APIs de ejemplo usando el comando catalyst pull . Este archivo incluirá las definiciones para la API por defecto llamada Login Redirect incluso si no se han creado APIs personalizadas. También se incluirán definiciones de ejemplo para una función Basic I/O y una Advanced I/O. Si se han creado APIs personalizadas en la consola remota, sus últimas definiciones se obtendrán en el directorio de tu proyecto. El archivo JSON contendrá las definiciones del origen, destino, el método de solicitud, y los detalles de los límites de throttling y el procesador de solicitudes de una API, si están configurados. Puedes definir nuevas APIs o modificar las definiciones de APIs existentes en el entorno local, y actualizarlas en la consola remota desplegando las reglas de API Gateway usando el comando catalyst deploy. Nota: Si eres usuario de Visual Studio Code IDE, puedes instalar la extensión Catalyst Tools y realizar operaciones del CLI usando tu IDE en lugar del CLI. Los pasos para trabajar con API Gateway usando Visual Studio Code IDE se pueden encontrar aquí. -------------------------------------------------------------------------------- title: "Deshabilitar API Gateway" description: "Catalyst CLI proporciona opciones para habilitar o deshabilitar API Gateway y obtener el estado de la creación de APIs en tu entorno local." last_updated: "2026-07-02T09:34:15.884Z" source: "https://docs.catalyst.zoho.com/es/cli/v1/working-with-api-gateway/disable-api-gateway/" service: "All Services" -------------------------------------------------------------------------------- # Deshabilitar API Gateway Puedes deshabilitar el API Gateway en tu proyecto en cualquier momento desde el CLI. Esto volverá a habilitar inmediatamente las definiciones configuradas en Security Rules . Nota: Si vuelves a habilitar API Gateway después de deshabilitarlo, todas las APIs que habías creado seguirán disponibles y se volverán a habilitar inmediatamente cuando API Gateway se reactive. No tendrás que crear las mismas APIs de nuevo. <br> Para deshabilitar API Gateway para tu proyecto, ejecuta el siguiente comando desde el directorio de tu proyecto: catalyst apig:disable <br> El CLI deshabilitará el componente y actualizará el archivo catalyst.json con el estado del API Gateway. El parámetro enabled para la configuración de apig se actualizará a false. Esto también deshabilitará el API Gateway en la consola remota. <br /> Nota: Si eres usuario de Visual Studio Code IDE, puedes instalar la extensión Catalyst Tools y realizar operaciones del CLI usando tu IDE en lugar del CLI. Los pasos para trabajar con API Gateway usando Visual Studio Code IDE se pueden encontrar aquí. ### Trabajar con el Client -------------------------------------------------------------------------------- title: "Introducción" description: "Catalyst CLI te permite configurar el componente del cliente como una aplicación Basic, React o Angular, incluso después de inicializar el proyecto." last_updated: "2026-07-02T09:34:15.884Z" source: "https://docs.catalyst.zoho.com/es/cli/v1/working-with-the-client/introduction/" service: "All Services" -------------------------------------------------------------------------------- # Trabajar con el Client ### Introducción Catalyst CLI te permite configurar y trabajar con los componentes del proyecto que no inicializaste durante la inicialización del proyecto. Puedes configurar los directorios del cliente y las funciones desde el CLI en cualquier momento mientras trabajas con el proyecto. También puedes agregar un nuevo servicio AppSail en cualquier momento. Esta funcionalidad es muy conveniente si no inicializaste el paquete del cliente durante la inicialización del proyecto para alojarlo a través de web client hosting, o si inicializaste un proyecto vacío y luego necesitas que se agregue el componente del cliente a tu aplicación. En tales casos, puedes configurar rápidamente el cliente en su estructura de directorio estándar en tu directorio de proyecto. El CLI se asegurará de que todos los archivos de configuración requeridos del cliente se inicialicen en sus estructuras de plantilla. La información actualizada sobre el componente del cliente recién creado también se agregará automáticamente al archivo catalyst.json cuando lo configures. También puedes realizar una operación de eliminación remota en el componente del cliente y eliminar cualquiera de sus versiones previamente alojadas desde el CLI. Nota: * Si eres usuario de Visual Studio Code IDE, puedes instalar la extensión Catalyst Tools y realizar operaciones del CLI usando tu IDE en lugar del CLI. Los pasos para trabajar con componentes Client de Catalyst usando Visual Studio Code IDE se pueden encontrar aquí * El alojamiento de cliente web es adecuado para aplicaciones web básicas y simples. Puedes explorar nuestro robusto servicio de desarrollo frontend, Slate, que te permite desplegar aplicaciones web sin problemas en una variedad de frameworks JavaScript populares como Next.js, Angular, React, Vue y más. Slate también proporciona despliegues automatizados desde GitHub, GitLab o Bitbucket, y ofrece una gran cantidad de otras funciones avanzadas. -------------------------------------------------------------------------------- title: "Configurar Client" description: "Catalyst CLI te permite configurar el componente del cliente como una aplicación Basic, React o Angular, incluso después de inicializar el proyecto." last_updated: "2026-07-02T09:34:15.885Z" source: "https://docs.catalyst.zoho.com/es/cli/v1/working-with-the-client/set-up-client/" service: "All Services" -------------------------------------------------------------------------------- # Configurar Client Puedes configurar el componente del cliente desde el CLI navegando a tu directorio de proyecto y ejecutando el siguiente comando: catalyst client:setup <br> El procedimiento es el mismo que inicializar el directorio del cliente durante la inicialización del proyecto. El CLI te solicitará que proporciones un nombre para el componente del cliente de tu proyecto. Ingresa un nombre y presiona Enter. <br> El directorio del cliente ahora se creará en el directorio del proyecto y el archivo catalyst.json se actualizará con su información. <br> El directorio del cliente se configurará con un archivo index.html, un main.css y un archivo main.js, junto con el archivo de configuración client-package.json. Puedes aprender sobre la estructura del directorio del cliente en detalle en la página de ayuda de Estructura del directorio del proyecto. <br> Nota: * Puedes agregar cualquier número de subcarpetas y archivos en el directorio del cliente como archivos HTML, archivos JavaScript, imágenes de logo y más. Sin embargo, los archivos de configuración y dependencias deben estar en la raíz del directorio del cliente. * También puedes traer un cliente web alojado desde la consola a tu sistema local usando el comando catalyst pull . Después de compilar y probar el componente del cliente, puedes alojarlo a través de _Web Client Hosting_ en la consola de Catalyst o desplegar el cliente desde el CLI a la consola remota. Nota: Si eres usuario de Visual Studio Code IDE, puedes instalar la extensión Catalyst Tools y realizar operaciones del CLI usando tu IDE en lugar del CLI. Los pasos para configurar tus componentes Client usando Visual Studio Code IDE se pueden encontrar aquí -------------------------------------------------------------------------------- title: "Eliminar Client" description: "Catalyst CLI te permite configurar el componente Client como una aplicación Basic, React o Angular, incluso después de que el proyecto esté inicializado." last_updated: "2026-07-02T09:34:15.885Z" source: "https://docs.catalyst.zoho.com/es/cli/v1/working-with-the-client/delete-client/" service: "All Services" -------------------------------------------------------------------------------- # Eliminar Client ### Ejecución del comando Puedes eliminar permanentemente cualquier versión anterior del componente Client en tu proyecto de Catalyst usando el CLI. Puedes elegir eliminar el Client desde la consola remota o desde el directorio local de tu proyecto mientras ejecutas este comando. También puedes eliminar una versión del Client desde la consola a través de Web Client Hosting. Nota: * No podrás eliminar la versión del Client que está actualmente en producción. Solo puedes eliminar una versión que no esté actualmente alojada en producción. * Si una versión del Client existe en ambas ubicaciones, solo se eliminará de la ubicación que elijas. Por ejemplo, incluso si eliminas la versión del Client de la consola remota, seguirá presente en el directorio local de tu proyecto hasta que la elimines de la máquina local por separado. 1. Para eliminar una versión anterior de tu componente Client desde el CLI, ejecuta el siguiente comando desde la estructura del directorio del proyecto: catalyst client:delete <br> 2. El CLI te pedirá que elijas entre el Client en la consola remota o el Client en el directorio local de tu proyecto. Selecciona una opción y presiona Enter .<br /> <br> 3. El CLI mostrará todas las versiones de tu aplicación web que se han alojado previamente. Selecciona cualquier versión de la lista, que no sea la versión en producción, y presiona Enter .<br /> La versión seleccionada se eliminará de tu proyecto de Catalyst desde la ubicación elegida. <br> Nota: Puedes usar el comando catalyst pull para obtener recursos de la consola remota al directorio local, o catalyst deploy para desplegar recursos a la consola remota desde el directorio local si necesitas sincronización. <br> También puedes especificar directamente la versión del Client a eliminar de la siguiente manera: catalyst client:delete [client_version] Por ejemplo: catalyst client:delete 1.0.0 El CLI te pedirá que selecciones entre la consola remota o el directorio local, y luego te solicitará la confirmación de eliminación de la misma manera. <br> ### Opciones de eliminación de Client Puedes elegir directamente listar las versiones del Client en la consola remota o en el directorio local de tu proyecto para eliminarlas usando las opciones respectivas. Para listar las versiones del Client disponibles en el directorio local de tu proyecto, ejecuta el comando catalyst client:delete de la siguiente manera: catalyst client:delete --local Para listar las versiones del Client disponibles en la consola remota de tu proyecto, ejecuta el comando catalyst client:delete de la siguiente manera: catalyst client:delete --remote El CLI listará las versiones del Client de acuerdo a la opción elegida, y podrás eliminar la versión requerida como se explicó anteriormente. También puedes eliminar directamente una versión desde la consola remota o el directorio local como se muestra a continuación: catalyst client:delete 1.0.0 --remote <br /> Nota: Si eres usuario de Visual Studio Code IDE, puedes instalar la extensión Catalyst Tools y realizar operaciones del CLI usando tu IDE en lugar del CLI. Los pasos para configurar tus componentes Client usando Visual Studio Code IDE se pueden encontrar aquí ### Trabajar con Functions -------------------------------------------------------------------------------- title: "Introducción" description: "Catalyst CLI te permite configurar el componente Functions incluso después de que el proyecto esté inicializado, agregar múltiples funciones en tu proyecto, configurar su memoria, probar funciones en un shell de Node, y eliminarlas." last_updated: "2026-07-02T09:34:15.888Z" source: "https://docs.catalyst.zoho.com/es/cli/v1/working-with-functions/introduction/" service: "All Services" -------------------------------------------------------------------------------- # Trabajar con Functions ### Introducción Catalyst CLI te permite configurar y trabajar con los componentes del proyecto que no inicializaste durante la inicialización del proyecto. Puedes configurar los directorios de Client y Functions desde el CLI en cualquier momento mientras trabajas con el proyecto. Esta funcionalidad es muy conveniente si no inicializaste el paquete de Functions durante la inicialización del proyecto, o si inicializaste un proyecto vacío, y luego necesitas que el componente Functions se agregue a tu aplicación. Puedes configurar el directorio de Functions con una función, y luego agregar más funciones según sea necesario. Puedes aprender más sobre las funciones de Catalyst en la página de ayuda de Functions. Cuando una función de Java, Node.js o Python se inicializa o configura, los archivos dependientes y los archivos de configuración se agregan automáticamente a la carpeta de la función por Catalyst. Por lo tanto, se recomienda crear funciones de Catalyst usando el CLI o la consola de Catalyst. Esto permite que el código boilerplate de los archivos de dependencia se agregue correctamente en la estructura estándar del directorio del proyecto . La información actualizada sobre el componente de función también se agregará al archivo catalyst.json cuando lo configures. También puedes iniciar un shell de Node para probar, ejecutar y depurar funciones de Catalyst localmente desde el CLI después de codificarlas. El CLI también te permite eliminar las funciones desplegadas. Discutiremos cada uno de estos comandos del CLI en este documento de ayuda. Nota: Si eres usuario de Visual Studio Code IDE, puedes instalar la extensión Catalyst Tools y realizar operaciones del CLI usando tu IDE en lugar del CLI. Los pasos para trabajar con funciones de Catalyst usando Visual Studio Code IDE se pueden encontrar aquí -------------------------------------------------------------------------------- title: "Configurar Functions" description: "Catalyst CLI te permite configurar el componente Functions incluso después de que el proyecto esté inicializado, agregar múltiples funciones en tu proyecto, configurar su memoria, probar funciones en un shell de Node, y eliminarlas." last_updated: "2026-07-02T09:34:15.888Z" source: "https://docs.catalyst.zoho.com/es/cli/v1/working-with-functions/set-up-functions/" service: "All Services" -------------------------------------------------------------------------------- # Configurar Functions ### Configurar el tipo de función 1. Puedes configurar el directorio de Functions en tu proyecto navegando al directorio de tu proyecto y ejecutando el siguiente comando en tu CLI: catalyst functions:setup <br /> El procedimiento es el mismo que inicializar el directorio de Functions durante la inicialización del proyecto. 2. Selecciona el tipo de función que deseas desarrollar y presiona Enter .<br /> <br /> Los seis tipos de funciones que puedes desarrollar en Catalyst son: Basic I/O, Advanced I/O, Event, Cron, Browser Logic, Integration y Browser Logic. Para obtener más información sobre los tipos de funciones y sus propósitos, consulta la **página de ayuda de Functions.** <br> **Integration Functions:** <br> El proceso de inicialización del CLI es el mismo para todos los demás tipos de funciones, excepto las Integration Functions. Si seleccionas _Integration_ de la lista, debes realizar estos dos pasos adicionales antes de pasar al siguiente paso:<br><br> i. Selecciona el servicio con el que deseas integrar. Actualmente solo puedes seleccionar la integración con Cliq .<br /> ii. Selecciona los handlers que necesites. Puedes aprender más sobre esto en la página de ayuda de Integration Functions .<br /> El resto del proceso de configuración es el mismo para todos los tipos de funciones. El proceso solo varía con el stack de la función. Nota: Cliq Integration Functions no está disponible actualmente para los usuarios de Catalyst que acceden desde los centros de datos de EU, AU, IN o CA. ConvoKraft Integration Functions están disponibles para los usuarios que acceden desde todos los DCs. <br> 3. Selecciona un stack para desarrollar las funciones del lado del servidor y presiona Enter . La lista muestra todos los runtimes soportados. Puedes seleccionar el último runtime soportado de Java, Node.js , o Python de la lista.<br /> Nota: Puedes incluir funciones de Java, Node.js o Python en un solo directorio de Functions usando el comando catalyst functions:add . <br> ### Configurar una función Java de cualquier tipo 1. Si configuras una función Java, selecciona el runtime requerido de los runtimes soportados: **Java 8**, **Java 11**, **Java 17**, **Java 21**, **Java 25**. <br> Nota: Antes de elegir tu versión del stack de función Java, asegúrate de tener el JDK relevante instalado en tu sistema. También puedes instalar los JDKs relevantes desde los siguientes enlaces: * Java 8 * Java 11 * Java 17 * Java 21 * Java 25 2. Ingresa el nombre de referencia de la función Java cuando se te solicite y presiona **Enter**, e ingresa el nombre de la clase principal de la función Java y presiona **Enter**. El CLI descargará el paquete del Java SDK y completará el proceso de configuración de Functions. <br> 3. Si es la primera vez que inicializas o configuras una función de **Java 11**, **Java 17**, **Java 21** o **Java 25**, necesitarás configurar adicionalmente la información de ruta de los JDKs instalados en tu sistema. Puedes establecer esta información en un archivo de configuración específico que está presente en tu sistema local como un archivo oculto. La ruta de los JDKs instalados deberá configurarse usando el comando CLI config:set &lt;key=value&gt;. Puedes encontrar más información sobre este comando en este documento de ayuda. Establece la información de ruta en el archivo de configuración como se muestra en el ejemplo a continuación: **Java 11**: catalyst config:set java11.bin=/Library/Java/JavaVirtualMachines/jdk-11.0.17.jdk/Contents/Home/bin <br /> **Java 17**: catalyst config:set java17.bin=/Library/Java/JavaVirtualMachines/jdk-17.jdk/Contents/Home/bin <br /> **Java 21**: catalyst config:set java21.bin=/Library/Java/JavaVirtualMachines/jdk-21.jdk/Contents/Home/bin <br /> **Java 25**: catalyst config:set java25.bin=/Library/Java/JavaVirtualMachines/jdk-25.jdk/Contents/Home/bin <br /> Nota: * Reemplaza la ruta indicada en los comandos anteriores con tu ruta de JDK. * Si tu sistema local ejecuta Windows OS, encierra la ruta entre comillas dobles. Por ejemplo, establecerás la ruta de Java 11 de la siguiente manera:<br /> catalyst config:set java11.bin="/Library/Java/JavaVirtualMachines/jdk-11.0.17.jdk/Contents/Home/bin" <br /> La carpeta de la función Java se creará con el archivo de clase .java principal, los archivos JAR de biblioteca, catalyst-config.json , y otros archivos de configuración. Estos valores se actualizarán en el archivo de configuración catalyst.json. <br> <br /> Puedes aprender sobre la estructura del directorio de funciones Java en detalle en la página de ayuda de Estructura del Directorio del Proyecto .<br /> ### Configurar una función Node.js de cualquier tipo 1. Si configuras una función Node.js, selecciona el runtime requerido de los runtimes soportados: **Node 24**, **Node 22**, **Node 20**, **Node 18**, **Node 16**, **Node 14**, **Node 12**. <br> 2. Proporciona un nombre de paquete para tu función Node cuando se te solicite y presiona Enter .<br /> 3. Ingresa el nombre del archivo de punto de entrada y presiona Enter .<br /> 4. Ingresa un nombre para el autor de la función y presiona Enter .<br /> 5. El CLI te solicitará permitir la instalación de dependencias de Node. Presiona Y para confirmar la instalación, y presiona Enter para confirmar tu elección. Si no instalas todas las dependencias requeridas, podría causar errores durante la ejecución de la función.<br /> <br /> El CLI descargará el paquete del Node.js SDK y completará el proceso de configuración de la función.<br /> Nota: Catalyst te permite crear una función Advanced I/O de Node.js en la plantilla Express, que instala los módulos de Express.js. Sin embargo, no podrás crear la plantilla Express desde el CLI. Pero puedes instalar Express en tu sistema de forma independiente ejecutando npm install express --save desde el directorio de una función particular para usar los módulos de Express en ella. Puedes aprender más sobre la plantilla Express en la página de ayuda de Advanced I/O Function. <br> El directorio de la función Node está ahora configurado con el archivo principal de función .js, catalyst-config.json, y los módulos de Node necesarios y archivos de configuración si instalaste las dependencias. Estos valores se actualizarán en el archivo de configuración catalyst.json.<br /> <br /> Puedes aprender sobre la estructura del directorio de funciones Node.js en detalle en la página de ayuda de Estructura del Directorio del Proyecto . ### Configurar una función Python de cualquier tipo 1. Si configuras una función Python, selecciona el runtime requerido de los runtimes soportados: **Python 3.9**, **Python 3.10**, **Python 3.11**, **Python 3.12** o **Python 3.13**. 2. Proporciona un nombre de paquete para tu función Python cuando se te solicite y presiona Enter . 3. Ingresa el nombre del archivo de punto de entrada y presiona Enter . Tras la inicialización exitosa de la función Python, el paquete del Catalyst Python SDK se instalará automáticamente para tu proyecto y se realizará una entrada en el archivo requirements.txt. Nota: Si es la primera vez que inicializas una función Python, necesitarás configurar adicionalmente la información de ruta de Python instalado en tu sistema. Puedes establecer esta información en un archivo de configuración específico que está presente en tu sistema local como un archivo oculto. La ruta deberá configurarse usando el comando CLI config:set &lt;key=value&gt;. Puedes encontrar más información sobre este comando en este documento de ayuda. El directorio de la función Python está ahora configurado con el archivo principal de función .py, catalyst-config.json, y el archivo de configuración requirements.txt. Estos valores se actualizarán en el archivo de configuración catalyst.json. <br /> Puedes aprender sobre la estructura del directorio de funciones Python en detalle en la página de ayuda de Estructura del Directorio del Proyecto . Nota: * Puedes agregar cualquier número de subcarpetas y archivos en el directorio de una función Java, Node.js o Python. Además del archivo principal de función, la carpeta de una función puede contener otras subfunciones. Sin embargo, los archivos de configuración y dependencias deben estar en la raíz del directorio de la función. * Puedes crear subfunciones para funciones Node.js a través de la consola de Catalyst , o usando editores externos. Sin embargo, las funciones Java y Python solo se pueden crear y actualizar desde el CLI. * También puedes obtener un directorio de función existente desde la consola a tu sistema local usando el comando catalyst pull. Ahora puedes trabajar en la función que configuraste. Puedes codificar la función subiendo el paquete a la consola de Catalyst, y trabajar en ella usando el editor en línea de la consola o con otro editor de tu elección. También puedes usar el shell de Functions para probar y ejecutar el código de la función, y luego desplegarlo a la consola. -------------------------------------------------------------------------------- title: "Agregar Functions" description: "Catalyst CLI te permite configurar el componente Functions incluso después de que el proyecto esté inicializado, agregar múltiples funciones en tu proyecto, configurar su memoria, probar funciones en un shell de Node, y eliminarlas." last_updated: "2026-07-02T09:34:15.889Z" source: "https://docs.catalyst.zoho.com/es/cli/v1/working-with-functions/add-functions/" service: "All Services" -------------------------------------------------------------------------------- # Agregar Functions Puedes agregar cualquier número de funciones nuevas de los stacks Java, Node.js y Python en el directorio de Functions, después de haber inicializado o configurado la primera función para tu proyecto. Cada nueva función se creará en su propio directorio dentro del directorio de Functions. Nota: Este comando se usa para agregar funciones adicionales en un proyecto después de que se crea la primera función. Por lo tanto, el directorio de Functions ya debe estar presente en el directorio de tu proyecto antes de ejecutar este comando. <br> Puedes agregar una nueva función en tu directorio de Functions ejecutando el siguiente comando desde el directorio de tu proyecto: catalyst functions:add <br> El procedimiento es el mismo que inicializar o configurar una función. Consulta la sección anterior para más detalles. Después de agregar la función, se creará una carpeta individual para ella en el directorio de Functions junto con sus dependencias y archivos de configuración, como se mencionó en la sección anterior. <br /> Nota: Si eres usuario de Visual Studio Code IDE, puedes instalar la extensión Catalyst Tools y realizar operaciones del CLI usando tu IDE en lugar del CLI. Los pasos para agregar funciones de Catalyst usando Visual Studio Code IDE se pueden encontrar aquí -------------------------------------------------------------------------------- title: "Configurar la memoria de Functions" description: "Catalyst CLI te permite configurar el componente Functions incluso después de que el proyecto esté inicializado, agregar múltiples funciones en tu proyecto, configurar su memoria, probar funciones en un shell de Node, y eliminarlas." last_updated: "2026-07-02T09:34:15.889Z" source: "https://docs.catalyst.zoho.com/es/cli/v1/working-with-functions/configure-function-memory/" service: "All Services" -------------------------------------------------------------------------------- # Configurar la memoria de Functions ### Comando de configuración Catalyst te permite configurar la memoria para cada una de tus funciones. Esta memoria se asignará cuando la función se ejecute. Puedes elegir una memoria entre 128 MB y 512 MB para cualquier función. La memoria predeterminada asignada a una función es de 256 MB. Es decir, si no configuras la memoria, o si habías creado una función antes de que esta funcionalidad estuviera disponible, la memoria se establecerá automáticamente en 256 MB. Nota: La CPU se asigna automáticamente basándose en la memoria que configures para tu función. No podrás ver ni configurar este valor. Puedes modificar este valor para cualquiera de tus funciones existentes según tus requisitos de la siguiente manera: 1. Ejecuta el siguiente comando desde el directorio del proyecto de tu función. catalyst functions:config El CLI listará todas las funciones que has creado en tu proyecto, junto con información sobre su asignación de memoria actual. 2. Selecciona una de las funciones para configurar y presiona Enter .<br /> 3. Selecciona la memoria a asignar a la función de las opciones disponibles y presiona Enter .<br /> La configuración de memoria de la función se actualizará.<br /> <br> También puedes configurar directamente la memoria de una función especificando el nombre o ID de la función junto con el comando como: catalyst functions:config[function_name_or_id] Por ejemplo: catalyst functions:config Generate_Invoice El CLI te pedirá que selecciones una configuración de memoria de la misma manera. ### Opciones de configuración de memoria de Functions También puedes especificar directamente la memoria que deseas asignar para una función específica usando la opción <br> -\\-memory &lt;value&gt; para el comando catalyst functions:config, seguida del nombre o ID de la función. Esto se puede hacer de la siguiente manera: catalyst functions:config [--memory &lt;value&gt;] [function_name_or_id] <br> Por ejemplo, si deseas asignar 128 MB de memoria para una función llamada _MailOrder_ , ejecuta el siguiente comando: catalyst functions:config --memory 128MB MailOrder El CLI te pedirá confirmación. Ingresa Y y presiona Enter . La configuración de memoria de la función se actualizará. -------------------------------------------------------------------------------- title: "Iniciar un shell para Functions" description: "Catalyst CLI te permite configurar el componente Functions incluso después de que el proyecto esté inicializado, agregar múltiples funciones en tu proyecto, configurar su memoria, probar funciones en un shell de Node, y eliminarlas." last_updated: "2026-07-02T09:34:15.889Z" source: "https://docs.catalyst.zoho.com/es/cli/v1/working-with-functions/functions-shell/" service: "All Services" -------------------------------------------------------------------------------- # Iniciar un shell para Functions ### Introducción El shell de Functions te ofrece las capacidades de una consola de shell de Node combinadas con la eficiencia del Catalyst CLI, para probar y depurar tus funciones. Usando el shell de Functions del Catalyst CLI, puedes probar y depurar los siguientes tipos de funciones de las plataformas Java, Node.js o Python en tu proyecto: Basic I/O, Cron, Event e Integration. Nota: No podrás probar funciones Advanced I/O usando el shell de Node. Sin embargo, puedes servir funciones Advanced I/O, e incluso funciones Basic I/O y el Client, desde un host local y probar su rendimiento usando el comando catalyst serve. La salida de la ejecución de una función se obtiene y muestra en el CLI en formato JSON. Para una función Basic I/O, la salida String se genera en el CLI, y para los otros tipos de funciones, se obtienen las respuestas apropiadas. Mientras pruebas una función Basic I/O de los stacks Java o Node.js, también puedes adjuntar un depurador al endpoint de la función y probar su código a través de un servidor local, o habilitar el modo HTTP para ella en el shell. Esto no es compatible con funciones Python, pero puedes depurar una función Python de forma independiente. Catalyst CLI también proporciona varias otras opciones para el shell de Functions que discutiremos más adelante en esta sección. <br> ### Ejecución del comando del shell de Functions Para iniciar un shell para probar una función, navega al directorio del proyecto de la función y ejecuta el siguiente comando: catalyst functions:shell Esto abre el shell en el CLI. Puedes probar cualquier función en tu proyecto que no sea Advanced I/O, pasar entradas y ejecutarla en el caso de una función Basic I/O, y realizar otras operaciones de shell de Node sobre ella. Puedes pasar entradas a una función Basic I/O en el shell de dos maneras: * Pasar valores a las variables de la función y ejecutar la función. * Declarar una variable en el CLI, asignarla a una variable de la función, y pasar los valores de entrada a través de la variable declarada. Luego puedes vincular la variable declarada a esa función y ejecutarla. #### Ejemplo para pasar entrada directa Probemos una función simple llamada _EMI_ , que te permite pasar un valor de entrada para una variable llamada _principal_ . Esta función luego calcula el monto de EMI para un servicio de envío, basándose en algunos valores constantes predefinidos. Pasamos un valor para la variable de entrada y ejecutamos la función _EMI_ en el shell ingresando la siguiente declaración: EMI({"principal":"10000"}) Esto invoca la función _EMI_ y pasa la entrada a su variable. Una vez que la ejecución de la función se completa, la salida se obtiene del servidor como una respuesta JSON. El CLI muestra la salida de la función junto con el código de estado HTTP enviado por el servidor. #### Ejemplo para declarar una variable y vincularla También puedes declarar una variable en el CLI y asignarla a la variable en la función. Esto te permitirá usar la variable declarada en lugar de la variable de la función y pasar valores de entrada fácilmente. Declaremos una variable 'P', asignémosla a la variable _principal_ en la función _EMI_ , y pasemos un valor de entrada. Esto se puede hacer ejecutando el siguiente comando en el shell: var P={"principal":"3000"} Esto asigna _P_ a _principal_ y pasa el valor de entrada de 3000 a P. Puedes verificar si la variable fue asignada imprimiendo el valor de P en la consola. Esto se puede hacer usando la función de Node.js console.log() de la siguiente manera: console.log(P) Si la variable fue asignada y el valor fue pasado exitosamente, el shell imprimirá el valor de _principal_ que fue pasado. Ahora puedes vincular la variable declarada a la función y ejecutarla de la siguiente manera: EMI(P) Esto invoca la función y pasa la entrada a su variable a través de _P_ . Una vez que la ejecución de la función se completa, el CLI mostrará la salida junto con el código de estado HTTP enviado por el servidor. El CLI devolverá los códigos de respuesta HTTP apropiados del servidor si ocurren errores en tiempo de ejecución. #### Salir del shell Puedes salir del shell de Functions matando el comando de terminal según tu entorno local o ejecutando el siguiente comando: .exit Una vez que tu función ha sido probada exhaustivamente, puedes desplegar la función desde el entorno local a la consola remota. ### Opciones del shell de Functions Hay cuatro opciones que puedes usar con el comando de inicio del shell de Functions. #### \--http \[port\] La opción -\\-http invoca tu función Basic I/O en el modo HTTP. El CLI sirve tu función a través de un host local, y te proporciona acceso a su endpoint local. El servidor estará escuchando en el puerto donde la función se aloja localmente, y el CLI mostrará un log en vivo de las actividades en el puerto. El CLI luego abrirá el shell de Functions donde puedes probar tu función. Nota: La opción -\\-http solo es aplicable a funciones Basic I/O, ya que los endpoints de las funciones Cron, Event e Integration no se pueden acceder directamente. Esta opción es similar a la funcionalidad del comando catalyst serve que sirve funciones Basic I/O, funciones Advanced I/O y los componentes Client localmente. Puedes iniciar un shell de Functions en modo HTTP y probar todas las funciones Basic I/O en un proyecto, ejecutando el siguiente comando desde el directorio del proyecto: catalyst functions:shell --http Esto alojará todas las funciones Basic I/O en el directorio de Functions del proyecto localmente, en el puerto predeterminado 8080 . El CLI mostrará las URLs de los endpoints de todas las funciones. Puedes acceder a estas funciones abriendo las URLs en tu navegador en cualquier momento mientras realizas las operaciones del shell. Ahora puedes probar y ejecutar tus funciones como se discutió en la sección anterior usando el shell, y verlas en modo HTTP accediendo a sus URLs. También puedes iniciar el servidor en un puerto diferente, si lo necesitas, mientras ejecutas este comando y anular el puerto predeterminado 8080. Esto se puede hacer especificando el número de puerto con la opción -\\-http. Por ejemplo, si prefieres usar el puerto 7000, ejecuta este comando desde el directorio del proyecto: catalyst serve --http 7000 #### \--debug \[port\] Catalyst te permite probar tus funciones Java y Node.js localmente con un depurador remoto adjunto al servidor localhost en vivo. Nota: El comando catalyst functions:shell --debug no es compatible con funciones Python. Para conocer los pasos para depurar una función Python, consulta esta sección. Cuando usas la opción -\\-debug e inicias el shell de Functions, Catalyst escuchará el transporte dt\_socket en el puerto predeterminado o personalizado y esperará la conexión del depurador después de invocar la función. Una vez que la conexión se establece, el depurador adjunto depurará la ejecución de tu función e identificará cualquier error y problema en su código. Puedes iniciar tu shell de Functions e iniciar la conexión al depurador ejecutando el siguiente comando desde el directorio del proyecto: catalyst functions:shell --debug Esto abrirá el shell de Functions de la misma manera que antes. Cuando invoques la función en el shell, Catalyst establecerá la conexión con el depurador. Catalyst CLI asignará el puerto 8000 para el depurador por defecto. Una vez que el depurador esté adjunto, el CLI mostrará un mensaje para indicar este hecho. Catalyst luego ejecutará tu función en el modo de depuración y mostrará la respuesta del servidor. Puedes anular el puerto predeterminado 8000 e iniciar el depurador en un puerto diferente, si es necesario. Esto se puede hacer especificando el número de puerto con la opción -\\-debug. Por ejemplo, si prefieres usar el puerto 7000, ejecuta el siguiente comando desde el directorio del proyecto: catalyst serve --debug 7000 #### \--ignore-scripts Esta opción te permite indicar a Catalyst que ignore los scripts de ciclo de vida pre y post escritos en el archivo catalyst.json para una función particular. Dado que puedes alojar y acceder a los endpoints de funciones Basic I/O usando la opción -\\-http en el shell de Functions, los scripts preserve y postserve se ejecutan automáticamente cuando se alojan. El script preserve se ejecuta antes de que la función sea servida, y el script postserve se ejecuta después de que salgas del serve local, si están disponibles. Puedes indicar a Catalyst que ignore estos scripts de ciclo de vida pre y post cuando las funciones son servidas usando la opción -\\-ignore-scripts. Por ejemplo, configuremos el archivo catalyst.json de un proyecto para incluir los siguientes scripts preserve y postserve para una función. Si inicias el shell de Functions sin usar la opción \--ignore-scripts, los scripts se ejecutarán antes de que el shell se abra y después de que salgas del shell respectivamente, como se muestra a continuación. Para ignorar los scripts preserve y postserve, inicia el shell de Functions ejecutando el siguiente comando desde el directorio de tu proyecto: catalyst functions:shell --ignore-scripts Esto ignorará los scripts y ejecutará el shell de la manera estándar. #### \--no-watch Catalyst CLI habilita un modo de observación en vivo en el shell de Functions por defecto. Este modo observa activamente los cambios realizados en el archivo de la función o en el directorio de la función después de que el shell se abra. Cuando detecta cambios confirmados en el archivo de la función o el directorio de la función, habilita una recarga en caliente del shell de Functions para reflejar las actualizaciones en vivo. Por lo tanto, podrás acceder a la versión actualizada de la función en el shell en vivo inmediatamente después de que los cambios se guarden, sin tener que recompilar o re-servir el código. Puedes deshabilitar este modo de observación predeterminado iniciando el shell de Functions usando la opción -\\-no-watch, como se muestra a continuación: catalyst functions:shell --no-watch Ahora, si haces algún cambio en el archivo de la función después de haberlo iniciado en el shell, las actualizaciones no se reflejarán en la función compilada abierta en el shell. Puedes trabajar con la versión actualizada de la función ya sea reinvocando la función después de que se hayan hecho los cambios, o saliendo del shell y reabriéndolo. Por ejemplo, consideremos una función que contiene el código de ejemplo predeterminado de una función Basic I/O de Node.js. Imprime el mensaje "Hello from index.js" cuando se invoca en el shell de Functions. Si haces cambios en el código de la función como se muestra a continuación, estas actualizaciones no se reflejan en vivo en el CLI mientras la función aún está abierta en el shell. Necesitarás invocar la función de nuevo para obtener la salida del código actualizado. Sin embargo, si no usas la opción -\\-no-watch e inicias el shell de Functions con el modo de observación predeterminado habilitado, el shell detectará los cambios realizados en el código en vivo y realizará una recarga en caliente de la función automáticamente, como se muestra a continuación. <br> ### Depuración de funciones Python Para depurar una función Python, necesitarás usar un IDE de Python de forma independiente, ya que Catalyst actualmente no ofrece soporte del CLI para depurarlas. Puedes adjuntar un depurador local con un IDE de tu elección, como Visual Studio Code o PyCharm. El depurador escuchará en el puerto donde la función se aloja localmente y el IDE mostrará un log en vivo de las actividades en el puerto. Los pasos para depurar una función Python usando VS Code se indican a continuación: 1. Para depurar una función Python particular alojada en un servidor local desde un IDE directamente, necesitarás un paquete de depuración para establecer la conexión entre el servidor local y el IDE. En este caso, usaremos el paquete de Python debugpy. Abre el directorio de tu proyecto de Catalyst en VS Code. En el archivo main.py, incluye las líneas de código indicadas a continuación. import debugpy debugpy.listen(<<"Enter port number here">>) debugpy.wait_for_client() Nota: El puerto predeterminado para adjuntar en las configuraciones de debug de VS Code es 5678. Este es el puerto donde la función Python será servida. Puedes anular el puerto predeterminado y cambiarlo mientras ejecutas el comando serve, si es necesario, usando la opción especificada a continuación: catalyst serve --http &lt;Port number&gt; 2. Navega a tu directorio de Functions y, para instalar el paquete debugpy, ejecuta este comando en la terminal de tu IDE: python -m pip install --upgrade debugpy 3. Crea un archivo launch.json en el directorio raíz de tu proyecto de Catalyst, si no existe uno ya. Puedes consultar esta página de ayuda para los pasos para crear un archivo launch.json. Agrega el siguiente código en el archivo y guárdalo. { "version": "0.2.0", "configurations": [ { "name": "Python: Remote Attach", "type": "python", "request": "attach", "connect": { "host": "localhost", "port": <<Enter port number here>> }, "pathMappings": [ { "localRoot": "${workspaceFolder}", "remoteRoot": "${workspaceFolder}/.build/" } ], "justMyCode": true } ] } 4. Ahora, cambia a la vista Run and Debug en VS Code e inicia el depurador. Ahora puedes ejecutar el comando CLI serve para ver los detalles de ejecución de la función en la terminal de tu IDE. Nota: Debes asegurarte de especificar el mismo número de puerto mencionado en los archivos de configuración mientras ejecutas el comando. Puedes consultar esta página de ayuda para pasos más detallados sobre la depuración de scripts locales de funciones Python en VS Code. Nota: Si eres usuario de Visual Studio Code IDE, puedes instalar la extensión Catalyst Tools y realizar operaciones del CLI usando tu IDE en lugar del CLI. Los pasos para ejecutar y depurar funciones de Catalyst usando Visual Studio Code IDE se pueden encontrar aquí -------------------------------------------------------------------------------- title: "Eliminar Functions" description: "Catalyst CLI te permite configurar el componente Functions incluso después de que el proyecto esté inicializado, agregar múltiples funciones en tu proyecto, configurar su memoria, probar funciones en un shell de Node, y eliminarlas." last_updated: "2026-07-02T09:34:15.890Z" source: "https://docs.catalyst.zoho.com/es/cli/v1/working-with-functions/delete-functions/" service: "All Services" -------------------------------------------------------------------------------- # Eliminar Functions ### Ejecución del comando de eliminación Puedes eliminar permanentemente funciones de tu proyecto de Catalyst usando el CLI. Puedes elegir eliminar funciones de la consola remota o del directorio local de tu proyecto mientras ejecutas este comando. Nota: Si una función existe en ambas ubicaciones, solo se eliminará de la ubicación que elijas. Por ejemplo, incluso si eliminas una función de la consola remota, seguirá presente en el directorio local de tu proyecto hasta que la elimines de la máquina local por separado. <br> 1. Para eliminar funciones en tu proyecto, ejecuta el siguiente comando desde el directorio de tu proyecto: catalyst functions:delete <br> 2. El CLI te pedirá que elijas entre las funciones en la consola remota o las funciones en el directorio local de tu proyecto. Selecciona una opción y presiona Enter .<br /> <br> 3. El CLI listará todas las funciones en tu consola remota o en tu directorio local, según la opción que elegiste. Selecciona las funciones que necesitas eliminar y presiona Enter .<br /> <br> 4. El CLI te pedirá una confirmación. Ingresa "Y " y presiona Enter para confirmar. Las funciones seleccionadas se eliminarán de la ubicación elegida.<br /> <br> Nota: Puedes usar el comando catalyst pull para obtener recursos de la consola remota al directorio local, o catalyst deploy para desplegar recursos a la consola remota desde el directorio local si necesitas sincronización. <br> También puedes especificar directamente la función a eliminar incluyendo el nombre o ID de la función junto con el comando como: catalyst functions:delete [function_name_or_id] Por ejemplo: catalyst functions:delete InvoiceFetch El CLI te pedirá que selecciones entre la consola remota o el directorio local, y luego te solicitará la confirmación de eliminación de la misma manera. Nota: Puedes especificar el nombre o ID de la función directamente para eliminar una función de la consola remota. Sin embargo, para eliminar una función del directorio local, solo debes proporcionar el nombre de la función y no el ID. <br> ### Opciones de eliminación de Functions Puedes elegir directamente listar las funciones en la consola remota o en el directorio local de tu proyecto para eliminarlas usando las opciones respectivas. Para listar las funciones disponibles en el directorio local de tu proyecto, ejecuta el comando catalyst functions:delete de la siguiente manera: catalyst functions:delete --local Para listar las funciones disponibles en la consola remota de tu proyecto, ejecuta el comando catalyst functions:delete de la siguiente manera: catalyst functions:delete --remote El CLI listará las funciones de acuerdo a la opción elegida, y podrás eliminar las funciones requeridas como se explicó anteriormente. También puedes eliminar directamente una función de la consola remota o el directorio local como se muestra a continuación: catalyst functions:delete InvoiceFetch --remote <br /> Nota: Si eres usuario de Visual Studio Code IDE, puedes instalar la extensión Catalyst Tools y realizar operaciones del CLI usando tu IDE en lugar del CLI. Los pasos para eliminar funciones de Catalyst usando Visual Studio Code IDE se pueden encontrar aquí ### Trabajar con proyectos -------------------------------------------------------------------------------- title: "Listar proyectos de Catalyst" description: "Catalyst CLI te permite ver una lista de tus proyectos de Catalyst, asociar un proyecto con tu directorio de trabajo y restablecer el proyecto activo." last_updated: "2026-07-02T09:34:15.890Z" source: "https://docs.catalyst.zoho.com/es/cli/v1/working-with-projects/list-catalyst-projects/" service: "All Services" -------------------------------------------------------------------------------- # Trabajar con proyectos ### Listar proyectos de Catalyst Puedes ver una lista de los proyectos de Catalyst en las organizaciones a las que tienes acceso en tu cuenta de usuario de Catalyst, desde el CLI. Para ver una lista de todos tus proyectos de Catalyst existentes en la organización que está configurada como predeterminada, ejecuta el siguiente comando: catalyst project:list <br> Si necesitas que se listen los proyectos de una organización diferente que no es la predeterminada, debes ejecutar el mismo comando con la opción --org y especificar el ID único de organización de esa organización de esta manera: catalyst project:list --org&lt;org_id&gt; Esto mostrará una tabla con los nombres y los Project IDs de tus proyectos de Catalyst existentes en la organización. <br> El proyecto base del directorio desde el que ejecutaste el comando también se especifica en la lista de proyectos. Este es el proyecto que originalmente inicializaste en ese directorio. La lista también indica el proyecto que está activo en ese directorio. Si el proyecto activo no es el proyecto base del directorio, el CLI mostrará una alerta sobre esto. Nota: Si eres usuario de Visual Studio Code IDE, puedes instalar la extensión Catalyst Tools y realizar la operación del CLI mencionada anteriormente usando tu IDE en lugar del CLI. Los pasos para ver una lista de todos tus proyectos de Catalyst usando Visual Studio Code IDE se pueden encontrar aquí -------------------------------------------------------------------------------- title: "Usar un proyecto de Catalyst" description: "Catalyst CLI te permite ver una lista de tus proyectos de Catalyst, asociar un proyecto con tu directorio de trabajo y restablecer el proyecto activo." last_updated: "2026-07-02T09:34:15.890Z" source: "https://docs.catalyst.zoho.com/es/cli/v1/working-with-projects/use-catalyst-project/" service: "All Services" -------------------------------------------------------------------------------- # Usar un proyecto de Catalyst Usando Catalyst CLI, puedes asociar un proyecto de Catalyst para tu directorio de trabajo. Puedes agregar un proyecto de Catalyst existente y vincularlo con tu directorio. Sin embargo, tu directorio solo puede estar vinculado y asociado permanentemente con su proyecto base, que es el proyecto que inicializaste en ese directorio. Por lo tanto, cuando uses otro proyecto en el directorio, la asociación con ese proyecto será solo temporal. Nota: Este comando solo se puede ejecutar desde un directorio de proyecto de Catalyst activo. Por lo tanto, si tu selección de directorio actual no es un directorio de proyecto activo, puedes inicializar el proyecto, o traer sus componentes al directorio, en su lugar. ### Ejecución del comando 1. Para usar un proyecto de Catalyst en tu directorio de trabajo, ejecuta el siguiente comando desde el directorio requerido: catalyst project:use El CLI mostrará una lista de tus proyectos existentes de tu organización predeterminada. 2. Selecciona el proyecto que necesitas, usando las teclas de flecha. Presiona Enter para confirmar tu elección. Tu proyecto ahora se agregará a tu directorio de trabajo y el CLI mostrará un mensaje de confirmación. <br> También puedes ejecutar el comando catalyst project:use con el nombre o el Project ID de ese proyecto para usarlo en el directorio de trabajo de la siguiente manera: catalyst project:use [name_or_project_id] Nota: Si deseas usar un proyecto que pertenece a una organización que no es la predeterminada, asegúrate de incluir la opción --org y ejecutar el siguiente comando para usar el proyecto: catalyst project:use [name_or_project_id] --org&lt;org_id&gt; <br /> Nota: Si eres usuario de Visual Studio Code IDE, puedes instalar la extensión Catalyst Tools y realizar la operación del CLI mencionada anteriormente usando tu IDE en lugar del CLI. Los pasos para agregar un proyecto de Catalyst a tu directorio de trabajo existente usando Visual Studio Code IDE se pueden encontrar aquí -------------------------------------------------------------------------------- title: "Restablecer el proyecto activo" description: "La estructura del directorio del proyecto se refiere a la estructura de directorios predeterminada en la que se crea un proyecto de Catalyst cuando lo inicializas desde el CLI." last_updated: "2026-07-02T09:34:15.890Z" source: "https://docs.catalyst.zoho.com/es/cli/v1/working-with-projects/reset-active-project/" service: "All Services" -------------------------------------------------------------------------------- # Restablecer el proyecto activo Puedes borrar el proyecto activo temporal de tu directorio de trabajo y restablecerlo al proyecto base con el que se inicializó el directorio. Restablecer el proyecto te ayuda a deshacer el comando catalyst project:use. Para borrar el proyecto activo en tu directorio de trabajo y restablecerlo a su proyecto base, navega al directorio y ejecuta el siguiente comando: catalyst project:reset Nota: Si eres usuario de Visual Studio Code IDE, puedes instalar la extensión Catalyst Tools y realizar la operación del CLI mencionada anteriormente usando tu IDE en lugar del CLI. Los pasos para restablecer tu proyecto de Catalyst usando Visual Studio Code IDE se pueden encontrar aquí ### Trabajar con Slate -------------------------------------------------------------------------------- title: "Crear aplicación Slate" description: "Catalyst CLI te permite crear una configuración de aplicación Slate para la aplicación en tu directorio de proyecto." last_updated: "2026-07-02T09:34:15.891Z" source: "https://docs.catalyst.zoho.com/es/cli/v1/working-with-slate/create-slate-app/" service: "All Services" -------------------------------------------------------------------------------- # Trabajar con Slate # Crear una aplicación Slate adicional Si tu directorio de proyecto ya está vinculado a un proyecto de Catalyst y Slate está inicializado, puedes agregar una nueva aplicación Slate a tu directorio de proyecto directamente usando los pasos a continuación. Esta operación agregará automáticamente el código de plantilla de Slate basado en el framework front-end elegido a tu directorio de proyecto. 1. Ejecuta el siguiente comando en la terminal desde el directorio de proyecto del servicio Slate: catalyst slate:create 2. Selecciona el framework requerido para tu aplicación Slate y proporciona un nombre para tu aplicación. 3. Según el framework elegido, los comandos de **install** y **build**, y la **build path** del framework se detectarán automáticamente. Si deseas continuar con la configuración predeterminada, ingresa **N**. De lo contrario, ingresa **Y** para realizar las actualizaciones necesarias. Después de que se realicen todos los cambios, la aplicación Slate se creará en tu directorio de proyecto. El archivo **catalyst.json** se actualizará con los detalles de la aplicación Slate recién creada. También puedes crear una aplicación Slate proporcionando directamente un nombre para tu aplicación y el framework requerido. Ejecuta el siguiente comando en tu terminal: catalyst slate:create --name &lt;name&gt; --framework &lt;framework_name&gt; -------------------------------------------------------------------------------- title: "Vincular aplicación Slate" description: "Catalyst CLI te permite vincular una configuración de Slate a una aplicación existente para desplegarlas en Slate." last_updated: "2026-07-02T09:34:15.891Z" source: "https://docs.catalyst.zoho.com/es/cli/v1/working-with-slate/link-slate-app/" service: "All Services" -------------------------------------------------------------------------------- # Vincular una aplicación Slate Para desplegar un proyecto existente en Slate, debes vincular obligatoriamente la ruta raíz del proyecto con el servicio Slate. Para esto tendrás que inicializar el servicio Slate primero. Esta vinculación establece una conexión entre tu directorio de proyecto y el servicio Slate localmente y para desplegar a la consola, debes usar el comando deploy. Esta opción se puede usar cuando una aplicación de un framework soportado por Slate no fue inicializada originalmente como un servicio Slate, pero luego prefieres desplegarla como un servicio Slate. Para vincular el directorio con Slate, sigue los pasos listados a continuación. 1. Ejecuta el siguiente comando en la terminal desde el directorio de proyecto de la aplicación: catalyst slate:link Selecciona la ruta fuente que debe vincularse al servicio Slate y presiona **Enter**. 2. Proporciona un nombre para tu aplicación según sea necesario y presiona **Enter**. 3. El framework de la aplicación se detectará automáticamente y se listará junto con sus comandos de **install**, **build** y la **build path**. De lo contrario, podrás seleccionar el framework manualmente desde la terminal. Si deseas continuar con la configuración predeterminada, ingresa **N**. De lo contrario, ingresa **Y** para realizar las actualizaciones necesarias. Después de que se establezcan las configuraciones, se creará una entrada en el archivo catalyst.json para establecer una conexión entre la ruta del directorio del proyecto y el servicio Slate. -------------------------------------------------------------------------------- title: "Desvincular aplicación Slate" description: "Catalyst CLI te permite desvincular una configuración de Slate de una aplicación existente si ya no es necesaria." last_updated: "2026-07-02T09:34:15.891Z" source: "https://docs.catalyst.zoho.com/es/cli/v1/working-with-slate/unlink-slate-app/" service: "All Services" -------------------------------------------------------------------------------- # Desvincular una aplicación Slate Puedes eliminar la conexión entre tu directorio de proyecto y el servicio Slate usando los pasos listados a continuación. Esta operación solo eliminará la configuración de Slate en tu directorio de proyecto y no en la consola de Catalyst, si ya has desplegado la aplicación. 1. Ejecuta el siguiente comando desde la terminal desde el directorio de proyecto de la aplicación: catalyst slate:unlink 2. Navega usando las teclas de flecha para elegir la aplicación y haz clic en **Enter** para confirmar. 3. Ingresa **Yes** para eliminar la configuración de Slate de tu aplicación, su entrada en el archivo catalyst.json y el código fuente de la aplicación. Ingresa **No** para eliminar solo la entrada en el archivo catalyst.json mientras conservas el código fuente de tu aplicación. Para la misma operación, también puedes usar el siguiente comando proporcionando directamente el nombre de la aplicación: catalyst slate:unlink --name &lt;&lt;app_name&gt;&gt; ### Trabajar con tokens -------------------------------------------------------------------------------- title: "Introducción" description: "Catalyst proporciona tokens que puedes usar para autenticar tus ejecuciones de comandos del CLI cuando no tienes una sesión activa." last_updated: "2026-07-02T09:34:15.891Z" source: "https://docs.catalyst.zoho.com/es/cli/v1/working-with-tokens/introduction/" service: "All Services" -------------------------------------------------------------------------------- # Trabajar con tokens ### Introducción Catalyst CLI proporciona tokens que validan tus sesiones del CLI asociándolas con una cuenta de usuario particular. Cuando estás conectado a tu CLI, los comandos que ejecutas se autentican internamente mediante un token. Sin embargo, también puedes generar un token manualmente y usarlo para realizar todas las actividades del CLI sin una sesión de inicio de sesión activa. Los tokens son muy útiles cuando accedes a Catalyst CLI desde un sistema remoto, como un sistema de Integración Continua, donde no necesitas iniciar sesión en el CLI de forma exclusiva. Puedes proporcionar autenticación al sistema CI para acceder a Catalyst y ejecutar comandos del CLI de forma remota usando un token del CLI que generes. Un token del CLI solo se puede generar cuando estás conectado a una cuenta de usuario desde el CLI. Una vez generado, puedes usar ese token en cualquier lugar desde cualquier dispositivo para realizar operaciones del CLI de forma remota, incluso sin sesiones de inicio de sesión activas. Este token actúa como factor de autenticación para esa cuenta de usuario y continúa mapeando tus ejecuciones de comandos a un proyecto que especifiques. También puedes proporcionar tokens de una cuenta de usuario particular a los colaboradores de tu proyecto de Catalyst y permitirles realizar operaciones del CLI, sin tener que proporcionarles las credenciales de inicio de sesión del usuario. Cuando se genera un token, se crea un ID único para identificar ese token. Debes usar este token ID al revocar un token. Debes tener en cuenta los siguientes puntos importantes al usar tokens: * Un token solo se puede generar desde un CLI y solo se puede usar en una terminal de CLI. No podrás trabajar con tokens fuera de un entorno CLI. * Cuando generas un token en la terminal de un dispositivo particular, solo podrás revocar ese token desde la misma terminal. No podrás revocarlo desde la terminal de otro dispositivo. Sin embargo, puedes usar ese token para realizar operaciones del CLI desde cualquier dispositivo o entorno. * Un token está asociado con el centro de datos de la cuenta de usuario con la que fue generado. Por lo tanto, se accederá a Catalyst desde el mismo centro de datos cuando uses un token con tus ejecuciones de comandos. * Un token generado en Catalyst CLI es válido para siempre. No caducará a menos que lo revoques personalmente. * Puedes crear múltiples tokens para una cuenta de usuario y usar cualquiera de esos tokens en cualquier momento desde cualquier dispositivo. Nota: Si eres usuario de Visual Studio Code IDE, puedes instalar la extensión Catalyst Tools y realizar operaciones del CLI usando tu IDE en lugar del CLI. Los pasos para gestionar tus tokens de autenticación en Visual Studio Code IDE se pueden encontrar aquí. -------------------------------------------------------------------------------- title: "Generar un token" description: "Catalyst proporciona tokens que puedes usar para autenticar tus ejecuciones de comandos del CLI cuando no tienes una sesión activa." last_updated: "2026-07-02T09:34:15.891Z" source: "https://docs.catalyst.zoho.com/es/cli/v1/working-with-tokens/generate-token/" service: "All Services" -------------------------------------------------------------------------------- # Generar un token ### Ejecución del comando <br> 1. Puedes generar un token para tu cuenta de usuario desde Catalyst CLI ejecutando el siguiente comando: catalyst token:generate Esto iniciará el proceso de generación de tokens. El CLI mostrará una URL que puedes visitar desde cualquier dispositivo. También generará un código de verificación de dispositivo, que debes ingresar en la página web de la URL. <br> 2. Navega a la URL que se muestra en el CLI e ingresa el código de verificación. Haz clic en Verify. El código solo será válido durante cinco minutos. <br> Una vez que el CLI de tu dispositivo sea verificado, el token se generará y se mostrará en tu CLI. <br> Ahora puedes usar este token para realizar cualquier operación del CLI desde cualquier dispositivo remoto, incluso cuando estés desconectado, especificándolo como una opción con el comando del CLI de la siguiente manera: catalyst command --token [token] Para aprender más, consulta la página de ayuda de opciones del CLI La operación del CLI se mapeará a la cuenta de usuario para la que generaste el token, y el comando se ejecutará para el proyecto de la cuenta que esté activo en ese directorio. <br> ### Opciones de generar token También puedes usar el comando catalyst token:generate para verificar el token que está actualmente activo en tu sesión con inicio de sesión. Para hacerlo, ejecuta el comando con la opción -\\-current de la siguiente manera: catalyst token:generate --current Esto mostrará el token que está actualmente activo y autenticado en el CLI. Nota: El comando catalyst token:generate --current solo se puede usar cuando estás conectado a una cuenta de usuario en el CLI. -------------------------------------------------------------------------------- title: "Listar tokens" description: "Catalyst proporciona tokens que puedes usar para autenticar tus ejecuciones de comandos del CLI cuando no tienes una sesión activa." last_updated: "2026-07-02T09:34:15.891Z" source: "https://docs.catalyst.zoho.com/es/cli/v1/working-with-tokens/list-tokens/" service: "All Services" -------------------------------------------------------------------------------- # Listar tokens Para ver una lista de los tokens disponibles para tu cuenta de usuario, ejecuta el siguiente comando en el CLI: catalyst token:list <br> Esto mostrará una lista de tokens que habías generado para esa cuenta, junto con detalles como Token ID, fecha y hora de creación. -------------------------------------------------------------------------------- title: "Revocar un token" description: "Catalyst proporciona tokens que puedes usar para autenticar tus ejecuciones de comandos del CLI cuando no tienes una sesión activa." last_updated: "2026-07-02T09:34:15.891Z" source: "https://docs.catalyst.zoho.com/es/cli/v1/working-with-tokens/revoke-token/" service: "All Services" -------------------------------------------------------------------------------- # Revocar un token Puedes revocar un token que fue generado previamente en el mismo CLI. Esto eliminará el token de forma permanente y ya no podrás usarlo para autenticar tus operaciones del CLI. Para revocar un token, ejecuta el siguiente comando en la terminal del mismo dispositivo que se usó para generar el token: catalyst token:revoke &lt;token ID&gt; Debes especificar el token ID del token a revocar. Puedes encontrar el ID de un token usando el comando mencionado en la sección anterior. ### Traer recursos -------------------------------------------------------------------------------- title: "Introducción" description: "Catalyst te permite traer recursos desde un proyecto de Catalyst en la consola remota al mismo proyecto en tu directorio de proyecto local a través del CLI." last_updated: "2026-07-02T09:34:15.891Z" source: "https://docs.catalyst.zoho.com/es/cli/v1/pull-resources/introduction/" service: "All Services" -------------------------------------------------------------------------------- # Traer recursos ### Introducción Puedes traer las funcionalidades de un proyecto de Catalyst que fue creado en la consola UI al CLI fácilmente. Esto te permite descargar los componentes de un proyecto desde la consola, al mismo proyecto que está activo en tu directorio de trabajo en el CLI. Puedes usar esta funcionalidad para actualizar tu directorio de proyecto con los cambios que se realizaron en la consola. Puedes traer los tres componentes de un proyecto de Catalyst: **Client**, **Functions**, **API Gateway Rules**. Cuando traes los componentes de cliente y funciones, sus respectivos directorios principales se crean dentro de tu directorio de proyecto de trabajo. Cuando traes las reglas de API Gateway, un archivo JSON que contiene las definiciones de las últimas reglas de APIG se traerá a tu directorio principal del proyecto. Puedes aprender sobre la estructura de directorios en detalle en la página de ayuda de Estructura del directorio del proyecto. Nota: * Si tu directorio de trabajo no tiene un proyecto de Catalyst activo asociado, no podrás traer ningún recurso. Asegúrate de haber inicializado y asociado el directorio con un proyecto de Catalyst antes de traer recursos a él. * Si eres usuario de Visual Studio Code IDE, puedes instalar la extensión Catalyst Tools y realizar las operaciones del CLI mencionadas anteriormente usando tu IDE en lugar del CLI. Los pasos para realizar operaciones de Pull en tus proyectos de Catalyst usando Visual Studio Code IDE se pueden encontrar aquí -------------------------------------------------------------------------------- title: "Traer todos los recursos" description: "Catalyst te permite traer recursos desde un proyecto de Catalyst en la consola remota al mismo proyecto en tu directorio de proyecto local a través del CLI." last_updated: "2026-07-02T09:34:15.891Z" source: "https://docs.catalyst.zoho.com/es/cli/v1/pull-resources/pull-all-resources/" service: "All Services" -------------------------------------------------------------------------------- # Traer todos los recursos ### Ejecución del comando Para traer funcionalidades de un proyecto de Catalyst a tu CLI, navega al directorio del proyecto donde deseas traer los recursos y ejecuta el siguiente comando: catalyst pull Esto iniciará el proceso de pull. Selecciona los recursos que deseas traer. Puedes traer los tres recursos o elegir recursos específicos. Presiona Enter después de seleccionar los recursos. <br /> ### Traer Functions Si seleccionaste Functions, selecciona todas las funciones que deseas traer de tu consola al directorio del proyecto de la lista. Presiona Enter después de hacer la selección. Esto traerá cada función disponible en la consola a su propio directorio en el directorio de funciones de tu proyecto, en tu máquina local. <br> ### Traer el Client Si seleccionaste _client_, elige la versión de la aplicación cliente que deseas traer de la lista. El CLI muestra todas las versiones de tu aplicación cliente alojadas en la consola remota. Haz la selección y presiona Enter. Los archivos del cliente de la versión que selecciones se traerán al directorio del cliente de tu proyecto, en tu máquina local. <br> ### Traer reglas de API Gateway Si seleccionaste API Gateway Rules, se creará un archivo catalyst-user-rules.json en el directorio principal de tu proyecto. Las últimas definiciones creadas para todas tus APIs en la consola remota se escribirán en este archivo. Puedes aprender sobre este archivo en la página de ayuda de Trabajar con API Gateway del CLI. Si API Gateway está deshabilitado para tu proyecto en la consola remota, Catalyst te pedirá que lo habilites desde el CLI antes de traer las definiciones de API. Escribe Y y presiona Enter para habilitar API Gateway. Si API Gateway está habilitado, las definiciones de API se traerán automáticamente y se agregarán al archivo catalyst-user-rules.json. Catalyst también actualizará el archivo catalyst.json para incluir la información sobre el archivo JSON de reglas de API Gateway. Nota: Si seleccionaste un recurso para traer y no existe en la consola remota, el CLI arrojará un error. Por ejemplo, si no se crearon APIs en la consola remota, no se traerán reglas de API Gateway. <br> ### Sobrescribir recursos existentes Si el directorio de funciones o del cliente, o el archivo catalyst-user-rules.json, no existe en la carpeta raíz de tu proyecto, se crearán automáticamente antes de que se traigan los recursos. Sin embargo, si un recurso ya está presente en tu carpeta de proyecto, el CLI te pedirá confirmación para sobrescribir el archivo existente. Escribe Y para sobrescribir los archivos existentes, o N para rechazar, y presiona Enter. Si confirmas la sobrescritura, el proceso de pull se iniciará. Si rechazas, el proceso de pull se abortará. <br /> -------------------------------------------------------------------------------- title: "Traer un recurso específico" description: "Catalyst te permite traer recursos desde un proyecto de Catalyst en la consola remota al mismo proyecto en tu directorio de proyecto local a través del CLI." last_updated: "2026-07-02T09:34:15.891Z" source: "https://docs.catalyst.zoho.com/es/cli/v1/pull-resources/pull-specific-resource/" service: "All Services" -------------------------------------------------------------------------------- # Traer un recurso específico Puedes traer un recurso específico de tu proyecto de la siguiente manera: catalyst pull [feature] Debes especificar la palabra clave client, functions o apig. Por ejemplo, para traer solo funciones, ejecuta el siguiente comando desde tu directorio de proyecto: catalyst pull functions Esto listará todas las funciones que puedes traer a tu directorio. Puedes seleccionar y traer los recursos requeridos como se discutió en la sección anterior. --- ## FAQ — Catalyst CLI # General Puedes consultar la **página de ayuda de instalación de Catalyst CLI** para obtener ayuda con la instalación del Catalyst CLI. Una vez que hayas instalado Catalyst CLI usando el comando npm, puedes trabajar con el CLI desde tu terminal. Los comandos de Catalyst comienzan con la palabra clave catalyst. Puedes consultar la **documentación del CLI** para obtener ayuda detallada con todos los comandos del CLI. Cuando una versión más reciente del Catalyst CLI esté disponible, tu terminal mostrará un mensaje alertándote después de ejecutar un comando del CLI exitosamente. Para actualizar tu CLI, ejecuta el siguiente comando: $ npm install -g zcatalyst-cli Nota: - En casos raros, los valores del registro de tu sistema podrían no reflejar la última versión del Catalyst CLI. Esto podría causar que tu sistema conserve la versión anterior del CLI. Para evitar esto, menciona el número de versión al ejecutar el comando. Por ejemplo, para actualizar a la versión 1.14.1, ejecuta $ npm install -g zcatalyst-cli @1.14.1 - Si no puedes actualizar el Catalyst CLI, ejecuta el comando usando sudo. Alternativamente, puedes visitar el sitio web de NPM para verificar si estás usando la última versión. Si se detectan problemas o comportamientos anormales en el CLI, Catalyst creará automáticamente un archivo <strong>catalyst-debug.log</strong> en el directorio desde el que se ejecutó el comando. Luego puedes contactar al equipo de Catalyst a través de nuestra dirección de correo de soporte: support@zohocatalyst.com. Proporciona una breve descripción del problema y adjunta el archivo catalyst-debug.log en el correo. El equipo de Catalyst te contactará en menos de 24 horas con una solución para el problema. Puedes encontrar este error si el Catalyst CLI no está correctamente instalado en tu sistema local. Puedes intentar los siguientes pasos para corregir este error: 1. Necesitarás verificar si instalaste la última versión estable de Node, y si es mayor que v12, ejecutando el comando node -v en tu terminal. 2. También debes verificar si la versión de NPM es mayor que v12 ejecutando el comando npm -v en tu terminal. 3. Desinstala y reinstala el Catalyst CLI con el comando sudo en MacOS o en el símbolo del sistema de Windows en modo administrador. El Catalyst CLI solo admite **Node.js v12 o posterior**. Si encuentras este error, podría significar que tienes una versión inferior de Node.js instalada en tu sistema. Puedes actualizar la versión de Node.js para resolver este error descargando Node.js v12 o superior para tu plataforma desde su sitio web oficial, o usar un gestor de versiones de Node como NVM para instalar Node.js y NPM. NPM viene incluido con Node.js cuando lo instalas. Para verificar si Node.js se ha actualizado correctamente, ejecuta el siguiente comando en tu terminal para comprobar la versión: $ node -v Encontrarás este error si la autorización TLS estricta ha sido habilitada en tu sistema. Puedes resolver este error ejecutando el siguiente comando en tu terminal: $ set NODE_TLS_REJECT_UNAUTHORIZED=0 Ahora puedes reintentar ejecutar el comando de Catalyst. Si el problema aún no se resuelve, contacta al soporte de Catalyst en support@zohocatalyst.com para obtener asistencia adicional. El CLI solo compila las clases Java en tiempo de ejecución. Por lo tanto, si la versión del entorno Java y el javac que estás usando son diferentes, encontrarás este error. Puedes verificar la versión de Java ejecutando el siguiente comando en tu terminal: $ java -version De manera similar, puedes verificar la versión de javac ejecutando el comando en tu terminal: $ javac -version Si tienes más consultas, puedes contactar al soporte de Catalyst en support@zohocatalyst.com # Inicializar recursos Este problema ocurrirá cuando intentes inicializar tu proyecto en una carpeta que ya contiene un proyecto de Catalyst de una cuenta diferente. Este problema también ocurrirá cuando intentes inicializar un proyecto en una carpeta nueva en una ubicación donde otro proyecto fue previamente inicializado desde una cuenta diferente. Por ejemplo: Supón que inicializas un proyecto en esta ubicación: *C/windows/system32/catalyst/aliencity* Si las raíces de las carpetas llamadas catalyst, system32 o windows ya tienen un proyecto de Catalyst inicializado en ellas, encontrarás este error. Sin embargo, puedes tener proyectos en estos directorios dentro de sus propias carpetas. Para resolver este problema, elimina todos los archivos relacionados con Catalyst, incluyendo el archivo oculto llamado .catalystrc de la carpeta actual así como de las demás carpetas en la ruta, y luego ejecuta el comando catalyst init nuevamente. # Servir recursos Si encuentras este error al ejecutar catalyst serve, puedes resolverlo de las siguientes maneras: * Asegúrate de estar en la ruta de carpeta correcta cuando sirves los targets. * Asegúrate de que tu directorio de proyecto no esté vacío y contenga al menos un recurso que pueda servirse. Catalyst puede servir endpoints de funciones de tipo Basic I/O y Advanced I/O, recursos de Client y AppSail. También puedes obtener el último código de tus recursos desde la consola de Catalyst a tu sistema local a través del comando catalyst pull, antes de servirlo. Catalyst servirá tus funciones en el modo watch de forma predeterminada para garantizar que puedas realizar fácilmente el reemplazo de código en caliente. Puedes ejecutar el comando del CLI catalyst serve --no-watch para cambiar a un modo sin observación. Este error ocurrirá cuando realices operaciones con archivos usando el comando catalyst serve. Para resolver este problema, usa la opción --no-watch con catalyst serve para la depuración local al realizar cualquier operación relacionada con archivos. El comando --no-watch desactiva el reemplazo de módulos en caliente. Catalyst solo admite actualmente las versiones Java 8, Java 11, Java 17, Java 21 y Java 25. Por lo tanto, debes asegurarte de que las versiones de java y javac instaladas sean 1.8.x, 11.0.x, 17.0.x, 21.0.x o 25.0.x antes de depurar una función Java en el CLI. # CLI Functions Shell Puedes ejecutar tu función cron localmente usando el comando catalyst shell en el CLI. Puedes pasar una variable JSON como entrada a la función cron. La función cron contendrá la variable context con todos los detalles de la función, incluso durante la depuración local. Puedes ejecutar tu función de evento localmente usando el comando catalyst shell en el Catalyst CLI. Puedes generar un payload de ejemplo para tu función de evento y probarla ejecutando el comando catalyst event:generate {component} {action}. Por ejemplo: catalyst event:generate DataStore insert. Esto generará un payload de ejemplo para una operación de inserción en Data Store. Luego puedes pasar el payload generado como entrada a tu función de evento en el CLI. # Desplegar recursos Encontrarás este error si hay más de 500 archivos presentes en tu carpeta de cliente. El número máximo de archivos permitidos en el cliente web de Catalyst es 500.