# 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-11-03T15:16:51.000Z" 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](https://docs.catalyst.zoho.com/es/getting-started/installing-catalyst-cli/) para ver los pasos. ### Opciones
| Sintaxis del comando | Uso |
|---|---|
| [ `-v` | `--version` ](https://docs.catalyst.zoho.com/es/cli/v1/cli-options/#-v----version) | Muestra el número de versión del Catalyst CLI |
| [`-p` | `--project <name_or_project_id>`](https://docs.catalyst.zoho.com/es/cli/v1/cli-options/#-p----project-name_or_project_id---org-org_id) | Especifica el proyecto de Catalyst que se usará para un comando |
| [`--org <org id>`](https://docs.catalyst.zoho.com/es/cli/v1/cli-options/#-p----project-name_or_project_id---org-org_id) | Especifica la organización de Catalyst que se usará para un comando. Se utiliza con la opción `-p`. |
| [`--token <token>`](https://docs.catalyst.zoho.com/es/cli/v1/cli-options/#--token-token) | Proporciona un token de autenticación para un comando |
| [`--dc <us|eu|in|jp|sa|au|ca>`](https://docs.catalyst.zoho.com/es/cli/v1/cli-options/#--dcuseuinjpsaauca) | Proporciona un centro de datos para un comando |
| [`--verbose`](https://docs.catalyst.zoho.com/es/cli/v1/cli-options/#--verbose) | Cambia el nivel de log a verbose para fines de depuración |
| [`-h` | `--help`](https://docs.catalyst.zoho.com/es/cli/v1/cli-options/#-h----help) | Muestra la ayuda para un comando de Catalyst |
| Sintaxis del comando | Uso |
|---|---|
| [`login [options]`](https://docs.catalyst.zoho.com/es/cli/v1/login/login-from-cli/) | Inicia sesión en el CLI con tu cuenta de Catalyst |
| [`token:generate [options]`](https://docs.catalyst.zoho.com/es/cli/v1/working-with-tokens/introduction/) | Genera un token para autenticar el acceso al CLI desde un sistema remoto |
| [`token:list`](https://docs.catalyst.zoho.com/es/cli/v1/working-with-tokens/list-tokens/) | Lista todos los tokens disponibles generados en este CLI |
| [`token:revoke <id>`](https://docs.catalyst.zoho.com/es/cli/v1/working-with-tokens/revoke-token/) | Revoca un token generado en este CLI |
| [`whoami`](https://docs.catalyst.zoho.com/es/cli/v1/identify-loggedin-user/) | Muestra la dirección de correo electrónico del usuario actualmente conectado |
| [`init [feature] [options]`](https://docs.catalyst.zoho.com/es/cli/v1/initialize-resources/introduction/) | Inicializa un proyecto de Catalyst, funciones, AppSail y recursos de Client en el directorio local |
| [`project:list`](https://docs.catalyst.zoho.com/es/cli/v1/working-with-projects/list-catalyst-projects/) | Lista todos los proyectos de Catalyst a los que tienes acceso |
| [`project:use [name_or_project_id] `](https://docs.catalyst.zoho.com/es/cli/v1/working-with-projects/use-catalyst-project/) | Establece un proyecto activo de Catalyst para tu directorio de trabajo |
| [`project:reset`](https://docs.catalyst.zoho.com/es/cli/v1/working-with-projects/reset-active-project/) | Limpia la selección de proyecto activo y restablece al proyecto base |
| [`pull [feature]`](https://docs.catalyst.zoho.com/es/cli/v1/pull-resources/introduction/) | Descarga recursos de tu proyecto desde la consola remota al directorio local |
| [`iac:export [options]`](https://docs.catalyst.zoho.com/es/cli/v1/export-and-import-projects/introduction/) | Exporta el código y las configuraciones de un proyecto como un archivo ZIP |
| [`iac:import [options][file_path]`](https://docs.catalyst.zoho.com/es/cli/v1/export-and-import-projects/import-project/) | Importa el archivo ZIP de un proyecto y crea un nuevo proyecto en la consola |
| [`iac:pack [zip_name]`](https://docs.catalyst.zoho.com/es/cli/v1/export-and-import-projects/generate-zip-file/) | Genera un archivo ZIP listo para importar de un proyecto en el formato estándar |
| [`iac:status [options]<operation>`](https://docs.catalyst.zoho.com/es/cli/v1/export-and-import-projects/export-import-job-status/) | Obtiene el estado actual de un trabajo de importación o exportación programado |
| [`functions:setup`](https://docs.catalyst.zoho.com/es/cli/v1/working-with-functions/set-up-functions/) | Configura el directorio de funciones en tu directorio de proyecto |
| [`functions:add`](https://docs.catalyst.zoho.com/es/cli/v1/working-with-functions/add-functions/) | Agrega una función del stack requerido al directorio de funciones |
| [`functions:config [function_name_or_id] [options] `](https://docs.catalyst.zoho.com/es/cli/v1/working-with-functions/configure-function-memory/) | Realiza configuraciones avanzadas como la asignación de memoria en una función de tu proyecto |
| [`functions:shell [options]`](https://docs.catalyst.zoho.com/es/cli/v1/working-with-functions/functions-shell/) | Inicia un shell de Node para probar funciones emuladas de cualquier stack o tipo, excepto funciones Advanced I/O |
| [`functions:delete [function_name_or_id] [options]`](https://docs.catalyst.zoho.com/es/cli/v1/working-with-functions/delete-functions/) | Elimina una función de la consola remota o del directorio local |
| [`config:set <key=value> `](https://docs.catalyst.zoho.com/es/cli/v1/cli-config/) | Establece la configuración de Catalyst como un par clave-valor |
| [`config:get <key>`](https://docs.catalyst.zoho.com/es/cli/v1/cli-config/#get-the-value-of-a-specific-key) | Obtiene el valor de configuración de Catalyst para la clave especificada |
| [`config:list`](https://docs.catalyst.zoho.com/es/cli/v1/cli-config/#list-configurations) | Lista todas las configuraciones de Catalyst |
| [`config:delete <key> `](https://docs.catalyst.zoho.com/es/cli/v1/cli-config/#delete-key) | Elimina una clave de la configuración de Catalyst |
| [`appsail:add`](https://docs.catalyst.zoho.com/es/cli/v1/add-appsail/) | Asocia un directorio de proyecto de Catalyst existente con un servicio AppSail |
| [`client:setup`](https://docs.catalyst.zoho.com/es/cli/v1/working-with-the-client/introduction/) | Configura el directorio de Client en tu directorio de proyecto |
| [`client:delete [client_version] [options]`](https://docs.catalyst.zoho.com/es/cli/v1/working-with-the-client/delete-client/) | Elimina una versión del Client de la consola remota o del directorio local |
| [`ds:import [~CSV_file_path] [options]`](https://docs.catalyst.zoho.com/es/cli/v1/data-store-import-and-export/introduction/) | Escribe registros de forma masiva en una tabla del Data Store de Catalyst |
| [`ds:export [options]`](https://docs.catalyst.zoho.com/es/cli/v1/data-store-import-and-export/export-operation/) | Lee registros de forma masiva desde una tabla del Data Store de Catalyst |
| [`ds:status <operation> [job_id] [options]`](https://docs.catalyst.zoho.com/es/cli/v1/data-store-import-and-export/check-import-export-status/) | Muestra el estado del trabajo de una operación de importación o exportación del Data Store |
| [`apig:enable`](https://docs.catalyst.zoho.com/es/cli/v1/working-with-api-gateway/introduction/) | Habilita API Gateway para tu proyecto |
| [`apig:disable`](https://docs.catalyst.zoho.com/es/cli/v1/working-with-api-gateway/disable-api-gateway/) | Deshabilita API Gateway para tu proyecto |
| [`apig:status [options]`](https://docs.catalyst.zoho.com/es/cli/v1/working-with-api-gateway/obtain-api-gateway-status/) | Obtiene el estado actual de API Gateway para tu proyecto y el progreso programado |
| [`event:generate` | `generate:event <source> <action> [options]`](https://docs.catalyst.zoho.com/es/cli/v1/event-generate/introduction/) | Genera payloads de ejemplo de diferentes componentes o fuentes de eventos personalizados para probar funciones de eventos |
| [`event:generate:integ <service> [options]`](https://docs.catalyst.zoho.com/es/cli/v1/event-generate/sample-payload-integration-functions/) | Genera payloads de ejemplo para el servicio de integración requerido para probar funciones de integración |
| [`event:generate:job`](https://docs.catalyst.zoho.com/es/serverless/help/functions/job-functions/#testing-job-functions-using-catalyst-cli) | Genera payloads de ejemplo para probar funciones de trabajo |
| [`run-script` | `run [command]`](https://docs.catalyst.zoho.com/es/cli/v1/scripts/introduction/) | Ejecuta un script de comando específico definido en `catalyst.json` |
| [`serve [options]`](https://docs.catalyst.zoho.com/es/cli/v1/serve-resources/introduction/) | Sirve funciones Basic I/O, Advanced I/O, BrowserLogic, AppSail y el Client para probarlos localmente |
| [`deploy [options] [feature] `](https://docs.catalyst.zoho.com/es/cli/v1/deploy-resources/introduction/) | Despliega el proyecto de Catalyst y los recursos del proyecto en la consola remota desde el directorio local |
| [`help [command]`](https://docs.catalyst.zoho.com/es/cli/v1/cli-help/command-reference-help/) | Muestra la referencia de comandos o la ayuda para un comando específico |
| [`logout`](https://docs.catalyst.zoho.com/es/cli/v1/logout/) | Cierra la sesión del CLI de tu cuenta de Catalyst |
| [`codelib:install`](https://docs.catalyst.zoho.com/es/codelib/install-a-codelib-solution/) | Instala los componentes preconfigurados de Catalyst CodeLib en tu proyecto |
| Servicio Publisher | Nombre del evento | Acción del evento |
|---|---|---|
| DataStore | `row_inserted` | Cuando se inserta una fila en la tabla |
| `row_updated` | Cuando se actualiza una fila en una tabla | |
| `row_deleted` | Cuando se elimina una fila de la tabla | |
| Stratus | `stratus_object_uploaded` | Cuando se sube un objeto a un bucket en Stratus |
| `stratus_object_downloaded` | Cuando se descarga un objeto de un bucket en Stratus | |
| `stratus_object_updated` | Cuando se actualiza un objeto en Stratus | |
| `stratus_object_deleted` | Cuando se elimina un objeto de Stratus | |
| Cache | `cache_item_created` | Cuando se crea un elemento de cache |
| `cache_item_updates` | Cuando se actualiza el cache | |
| Authentication | `user_signedup` | Cuando un usuario se registra en una aplicación |
| `user_confirmed` | Cuando un usuario completa el proceso de verificación | |
| `user_deleted` | Cuando se elimina un usuario de la aplicación. |
| Comando/Componente | Errores | Soluciones |
|---|---|---|
| Autenticación | Contenedor de tokens vacío | [Genera un nuevo token](https://docs.catalyst.zoho.com/es/cli/v1/working-with-tokens/generate-token/) |
| Error al recuperar el token | [Usa un token válido de la lista](https://docs.catalyst.zoho.com/es/cli/v1/working-with-tokens/list-tokens/) | |
| Sesión cerrada del CLI | [Inicia sesión en el CLI](https://docs.catalyst.zoho.com/es/cli/v1/login/login-from-cli/) | |
| Error al recuperar el Refresh Token o Access Token | [Inicia sesión en el CLI usando `--no-localhost`](https://docs.catalyst.zoho.com/es/cli/v1/login/options) | |
| Error al generar el token | [Genera un nuevo token](https://docs.catalyst.zoho.com/es/cli/v1/working-with-tokens/generate-token/) | |
| Token inválido proporcionado con la opción `--token` | [Proporciona un token válido con la opción](https://docs.catalyst.zoho.com/es/cli/v1/cli-options/#--token-token) | |
| Error de autenticación | [Vuelve a iniciar sesión con la opción `--force`](https://docs.catalyst.zoho.com/es/cli/v1/login/options/#--force) | |
| Centro de datos | Entrada inválida para la opción `--dc` | [Especifica una entrada válida e intenta de nuevo](https://docs.catalyst.zoho.com/es/cli/v1/cli-options/#--dcuseuinjpsaauca) |
| Proyecto | Primer proyecto de Catalyst no creado | [Crea un nuevo proyecto](https://docs.catalyst.zoho.com/es/getting-started/catalyst-projects/) |
| Proyecto proporcionado con la opción `-p` no encontrado | [Selecciona un proyecto existente de la lista](https://docs.catalyst.zoho.com/es/cli/v1/cli-options/#-p----project-name_or_project_id---org-org_id) | |
| Archivo faltante en el directorio del proyecto | [Inicializa el proyecto](https://docs.catalyst.zoho.com/es/cli/v1/initialize-resources/introduction/) o configura el [componente faltante](https://docs.catalyst.zoho.com/es/cli/v1/project-directory-structure/introduction/) | |
| Recurso no encontrado en el directorio del proyecto | [Inicializa el proyecto](https://docs.catalyst.zoho.com/es/cli/v1/initialize-resources/introduction/) o configura el [componente faltante](https://docs.catalyst.zoho.com/es/cli/v1/project-directory-structure/introduction/) | |
| Proyecto no encontrado en la consola remota | [Usa un proyecto disponible de la lista](https://docs.catalyst.zoho.com/es/cli/v1/working-with-projects/use-catalyst-project/) | |
| Archivo corrupto en el directorio del proyecto | Elimina el archivo corrupto e [inicializa el proyecto de nuevo](https://docs.catalyst.zoho.com/es/cli/v1/initialize-resources/initialize-options/) | |
| Proyecto activo no encontrado en la consola remota | [Cambia el proyecto activo existente a uno disponible](https://docs.catalyst.zoho.com/es/cli/v1/working-with-projects/use-catalyst-project/) | |
| API Gateway | Error al habilitar APIG: Programador de APIG en progreso | [Verifica el estado del trabajo programado](https://docs.catalyst.zoho.com/es/cli/v1/working-with-api-gateway/obtain-api-gateway-status/) e intenta de nuevo después de un momento |
| Informes de APIG no encontrados | [Despliega las reglas de APIG desde el CLI](https://docs.catalyst.zoho.com/es/cli/v1/deploy-resources/deploy-api-gateway/) | |
| Error al deshabilitar APIG: Programador de APIG en progreso | [Verifica el estado del trabajo programado](https://docs.catalyst.zoho.com/es/cli/v1/working-with-api-gateway/obtain-api-gateway-status/) e intenta de nuevo después de un momento | |
| No se puede leer el archivo de reglas de APIG | Rectifica los errores especificados e intenta de nuevo | |
| Archivo de reglas de APIG faltante | [Crea el archivo faltante o especifica un nombre de archivo válido](https://docs.catalyst.zoho.com/es/cli/v1/working-with-api-gateway/api-gateway-json-file/) | |
| Nombre faltante en la regla de APIG | [Proporciona un nombre para la regla de APIG](https://docs.catalyst.zoho.com/es/cli/v1/working-with-api-gateway/api-gateway-json-file/) | |
| Nombre duplicado en la regla de APIG | [Cambia el nombre o elimina la regla de APIG](https://docs.catalyst.zoho.com/es/cli/v1/working-with-api-gateway/api-gateway-json-file/) | |
| Valores obligatorios faltantes en la regla de APIG | [Agrega los valores obligatorios especificados a la regla de APIG](https://docs.catalyst.zoho.com/es/cloud-scale/help/api-gateway/key-concepts/#routing) | |
| Valores duplicados en la regla de APIG | [Modifica la regla de APIG y resuelve el conflicto](https://docs.catalyst.zoho.com/es/cloud-scale/help/api-gateway/key-concepts/#routing) | |
| Client inválido especificado en la regla de APIG | Rectifica los errores especificados en el Client e intenta de nuevo | |
| No se puede autenticar la regla de APIG con destino Client | [Elimina la clave especificada de la regla de APIG](https://docs.catalyst.zoho.com/es/cloud-scale/help/api-gateway/key-concepts/#authentication-request-processor) | |
| RegEx inválida en la regla de APIG | [Rectifica el error de RegEx especificado](https://docs.catalyst.zoho.com/es/cloud-scale/help/api-gateway/key-concepts/#routing) | |
| Parámetros inválidos en la regla de APIG | [Rectifica el error especificado para continuar](https://docs.catalyst.zoho.com/es/cloud-scale/help/api-gateway/key-concepts/#routing) | |
| URL de solicitud o destino inválida en la regla de APIG | [Proporciona una URL de destino válida en la regla de APIG](https://docs.catalyst.zoho.com/es/cloud-scale/help/api-gateway/key-concepts/#routing) | |
| Data Store | Identificador de tabla faltante en la operación de exportación/importación | [Proporciona el identificador de tabla en el comando o archivo de configuración](https://docs.catalyst.zoho.com/es/cli/v1/data-store-import-and-export/introduction/) |
| Archivo fuente faltante en la operación de importación | [Proporciona la ruta del archivo CSV en la máquina local con el comando](https://docs.catalyst.zoho.com/es/cli/v1/data-store-import-and-export/import-operation/#input-csv-file) | |
| Client | Client web no encontrado en la máquina local | [Crea un nuevo Client web](https://docs.catalyst.zoho.com/es/cli/v1/working-with-the-client/set-up-client/) |
| Client web no encontrado en la consola remota | [Despliega un Client web desde el CLI](https://docs.catalyst.zoho.com/es/cli/v1/deploy-resources/deploy-client/) | |
| Versión del Client web no encontrada en la máquina local/consola remota para eliminar | [Elimina una versión de la lista de versiones disponibles](https://docs.catalyst.zoho.com/es/cli/v1/working-with-the-client/delete-client/) | |
| La versión del Client web está en producción y no se puede eliminar | [Cambia la versión en producción a una diferente](https://docs.catalyst.zoho.com/es/cloud-scale/help/web-client-hosting/implementation/#deploy-an-older-version-of-a-web-application) o [despliega una nueva versión del Client web](https://docs.catalyst.zoho.com/es/cli/v1/deploy-resources/deploy-client/) | |
| No se pueden usar las opciones `--local` y `--remote` simultáneamente para eliminar | [Usa solo una de las opciones a la vez](https://docs.catalyst.zoho.com/es/cli/v1/working-with-the-client/delete-client/#delete-client-options) | |
| No se puede analizar el archivo del Client | Rectifica el error especificado e intenta de nuevo | |
| Archivo faltante en el directorio del Client | [Crea el archivo especificado en el directorio fuente del Client](https://docs.catalyst.zoho.com/es/cli/v1/project-directory-structure/client-directory/) | |
| Archivo corrupto en el directorio del Client | [Rectifica el error especificado o proporciona destinos válidos](https://docs.catalyst.zoho.com/es/cli/v1/project-directory-structure/client-directory/) | |
| Functions | No hay Functions en la consola remota para configurar o usar la funcionalidad | [Crea una nueva función en la consola](https://docs.catalyst.zoho.com/es/serverless/help/functions/implementation/) o [despliega una función en la consola](https://docs.catalyst.zoho.com/es/cli/v1/deploy-resources/deploy-functions/) |
| Valor inválido con la opción `--memory` al configurar | [Proporciona un número válido con la opción](https://docs.catalyst.zoho.com/es/cli/v1/working-with-functions/configure-function-memory/) | |
| Función no encontrada en la máquina local para eliminar | [Selecciona una función disponible de la lista para eliminar](https://docs.catalyst.zoho.com/es/cli/v1/working-with-functions/delete-functions/) | |
| No hay Functions en la máquina local para eliminar | [Crea una nueva función en el directorio del proyecto](https://docs.catalyst.zoho.com/es/cli/v1/working-with-functions/add-functions/) | |
| Función no encontrada en la consola remota para eliminar | [Selecciona una función disponible de la lista para eliminar](https://docs.catalyst.zoho.com/es/cli/v1/working-with-functions/delete-functions/) | |
| No hay Functions en la consola remota para eliminar | [Crea una nueva función en la consola](https://docs.catalyst.zoho.com/es/cli/v1/working-with-functions/add-functions/) o [despliega una función en la consola](https://docs.catalyst.zoho.com/es/cli/v1/deploy-resources/deploy-functions/) | |
| No se puede usar el ID de función en la máquina local para eliminar | [Usa el nombre de la función o ejecuta el comando sin especificar identificadores de función](https://docs.catalyst.zoho.com/es/cli/v1/working-with-functions/delete-functions/) | |
| No se pueden usar las opciones `--local` y `--remote` simultáneamente para eliminar | [Usa solo una de las opciones a la vez](https://docs.catalyst.zoho.com/es/cli/v1/working-with-functions/delete-functions/#delete-functions-options) | |
| Archivos de configuración | Functions especificadas en el archivo de configuración no encontradas | [Especifica nombres de función válidos bajo la clave `functions`](https://docs.catalyst.zoho.com/es/cli/v1/project-directory-structure/catalyst-json/) |
| Client especificado en el archivo de configuración no encontrado | [Especifica un directorio fuente de Client válido bajo la clave `client`](https://docs.catalyst.zoho.com/es/cli/v1/project-directory-structure/catalyst-json/) | |
| Directorio especificado en el archivo de configuración no encontrado | [Especifica un nombre de directorio válido que esté disponible en el directorio del proyecto](https://docs.catalyst.zoho.com/es/cli/v1/project-directory-structure/introduction/) | |
| Destinos inválidos en el archivo de configuración | [Especifica valores válidos como `targets` en el archivo de configuración](https://docs.catalyst.zoho.com/es/cli/v1/project-directory-structure/catalyst-json/) | |
| Archivo faltante en el directorio raíz del proyecto | [Inicializa el proyecto de nuevo](https://docs.catalyst.zoho.com/es/cli/v1/initialize-resources/introduction/) | |
| Scripts | Comando de script inválido | [Especifica el comando en un formato válido](https://docs.catalyst.zoho.com/es/cli/v1/scripts/introduction/) |
| Funcionalidad especificada inválida | [Especifica una funcionalidad válida para ejecutar el script](https://docs.catalyst.zoho.com/es/cli/v1/scripts/run-script/) | |
| Script no disponible en el archivo | [Ejecuta un script disponible](https://docs.catalyst.zoho.com/es/cli/v1/scripts/run-script/) | |
| El script finalizó con error | [Rectifica el error e intenta de nuevo](https://docs.catalyst.zoho.com/es/cli/v1/scripts/run-script/) | |
| Generación de eventos | Opciones proporcionadas no están en pares | [Proporciona las opciones como pares en el formato correcto](https://docs.catalyst.zoho.com/es/cli/v1/event-generate/introduction/) |
| Fuente inválida | [Proporciona una fuente disponible](https://docs.catalyst.zoho.com/es/cli/v1/event-generate/introduction/) | |
| Opciones en formato inválido | [Proporciona las opciones en un formato válido](https://docs.catalyst.zoho.com/es/cli/v1/event-generate/introduction/) | |
| Nombre del Event Bus faltante en evento personalizado | [Proporciona el nombre del Event Bus](https://docs.catalyst.zoho.com/es/cli/v1/event-generate/sample-payload-custom-event/) | |
| Identificador de regla faltante en evento personalizado | [Proporciona el identificador de regla](https://docs.catalyst.zoho.com/es/cli/v1/event-generate/sample-payload-custom-event/) | |
| Event Bus no encontrado en la consola remota | [Proporciona un nombre de Event Bus disponible](https://docs.catalyst.zoho.com/es/cli/v1/event-generate/sample-payload-custom-event/) | |
| Acción no compatible con la fuente | [Proporciona una acción compatible con la fuente](https://docs.catalyst.zoho.com/es/cli/v1/event-generate/introduction/) | |
| Identificador de segmento/tabla/carpeta incorrecto | [Proporciona un identificador válido con la opción](https://docs.catalyst.zoho.com/es/cli/v1/event-generate/sample-payload-component-event/) | |
| Generación de eventos: funciones de integración | Valor de entrada incorrecto para evento de integración con Cliq | [Proporciona la entrada en el formato correcto](https://docs.catalyst.zoho.com/es/cli/v1/event-generate/sample-payload-integration-functions/) |
| Combinación desconocida de componente Cliq | [Elige la combinación apropiada de componentes Cliq de la lista](https://docs.catalyst.zoho.com/es/cli/v1/event-generate/sample-payload-integration-functions/) | |
| Servicio de integración no disponible | [Proporciona un servicio de integración disponible](https://docs.catalyst.zoho.com/es/cli/v1/event-generate/sample-payload-integration-functions/) | |
| Pull | Valor inválido con el comando | [Proporciona los valores `client`, `functions` o `apig` con el comando](https://docs.catalyst.zoho.com/es/cli/v1/pull-resources/pull-all-resources/) |
| Serve | No hay componentes válidos para servir | [Rectifica los errores e intenta de nuevo](https://docs.catalyst.zoho.com/es/cli/v1/serve-resources/introduction/) |
| Puertos en el rango indicado no disponibles | [Especifica un puerto fuera del rango indicado](https://docs.catalyst.zoho.com/es/cli/v1/serve-resources/serve-options/) | |
| Shell | No hay funciones válidas para servir | [Rectifica los errores e intenta de nuevo](https://docs.catalyst.zoho.com/es/cli/v1/working-with-functions/functions-shell/) |
| Deploy | No hay Functions listas para desplegar | [Ejecuta el comando deploy con una opción apropiada](https://docs.catalyst.zoho.com/es/cli/v1/deploy-resources/deploy-options/) |
| Despliegue de APIG omitido | [Habilita API Gateway localmente](https://docs.catalyst.zoho.com/es/cli/v1/working-with-api-gateway/enable-api-gateway/) y [despliégalo una vez más](https://docs.catalyst.zoho.com/es/cli/v1/deploy-resources/introduction/) | |
| Configuración de Functions Java | Archivo JAR faltante en la ruta especificada en el archivo de configuración | [Especifica una ruta válida al archivo JAR](https://docs.catalyst.zoho.com/es/cli/v1/project-directory-structure/functions-directory/) |
| Archivo corrupto en el directorio de Functions | [Elimina el archivo corrupto y ejecuta el comando de nuevo](https://docs.catalyst.zoho.com/es/cli/v1/project-directory-structure/functions-directory/) | |
| Nombre de proyecto no coincide en el archivo de configuración | [Cambia el nombre del proyecto a un valor apropiado](https://docs.catalyst.zoho.com/es/cli/v1/project-directory-structure/introduction/) | |
| Error en la verificación de la versión del compilador Java | [Asegúrate de que el compilador Java esté instalado](https://docs.catalyst.zoho.com/es/getting-started/installing-catalyst-cli/#pre-requisities) y ejecuta el comando de nuevo | |
| Compilador Java por encima de la versión compatible | [Degrada el compilador Java a una versión compatible](https://docs.catalyst.zoho.com/es/getting-started/installing-catalyst-cli/#pre-requisities) | |
| Archivo principal faltante en el directorio de Functions | [Especifica un archivo principal válido en el archivo de configuración](https://docs.catalyst.zoho.com/es/cli/v1/project-directory-structure/functions-directory/) | |
| Error de compilación Java | Rectifica los errores especificados para continuar | |
| Configuración de Functions Node.js | Archivo principal faltante en el directorio de Functions | [Especifica un archivo principal válido en el archivo de configuración](https://docs.catalyst.zoho.com/es/cli/v1/project-directory-structure/functions-directory/) |
| Uso de opciones | Destinos duplicados especificados para la opción | Elimina el valor duplicado e intenta de nuevo |
| Destino inválido especificado con la opción | Proporciona un destino válido según lo especificado | |
| Destino especificado con y sin filtro | Proporciona el destino en un formato válido | |
| No se puede depurar el destino Client | Elimina el Client como destino en `-\-debug` e intenta de nuevo | |
| Conflicto en el uso de opciones | Usa solo una de las opciones a la vez | |
| Entrada inválida para la opción | Proporciona una entrada válida según lo especificado e intenta de nuevo | |
| APIG no se puede servir por separado | [Incluye al menos otro componente como Functions o Client](https://docs.catalyst.zoho.com/es/cli/v1/serve-resources/introduction/) | |
| La opción Org es necesaria cuando se proporciona la opción Project | 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`](https://docs.catalyst.zoho.com/es/cli/v1/cli-options/#-p----project-ltname_or_project_idgt---org-ltorg_idgt) | |
| General | No se está en el directorio de la aplicación Catalyst durante la ejecución del comando | [Ejecuta el comando desde un directorio válido de Catalyst](https://docs.catalyst.zoho.com/es/cli/v1/project-directory-structure/introduction/) o [inicializa un proyecto para hacer de este un directorio de aplicación Catalyst](https://docs.catalyst.zoho.com/es/cli/v1/initialize-resources/introduction/) |
| Uso incorrecto del comando | [Usa `catalyst help` o ejecuta el comando con la opción `--help` para obtener instrucciones de uso](https://docs.catalyst.zoho.com/es/cli/v1/cli-help/command-reference-help/) | |
| No se puede cargar el archivo | Rectifica los errores especificados para continuar | |
| Puerto solicitado no disponible | Proporciona un puerto diferente con el comando |
| Fuente | Acción | Entradas opcionales |
|---|---|---|
| datastore | Insert Update Delete | --table <table_name_or_id> |
| cache | Put | --segment <segment_name_or_id> |
| user | SignUp Delete | NA |
| webapp | Success | NA |
| github | Success Failure | NA |
| Fuente | Acción |
|---|---|
| custom | Produce |
| Componente | Clases de handler |
|---|---|
| bot | welcome_handler message_handler context_handler mention_handler action_handler incomingwebhook_handler participation_handler |
| command | execution_handler suggestion_handler |
| messageaction | execution_handler |
| widget | view_handler |
| function | button_handler form_handler form_change_handler form_values_handler widget_button_handler |
| installation | installation_handler installation_validator |
| Atributos | Descripción |
|---|---|
| `table_identifier` (String, Obligatorio) | El [ID único de la tabla](https://docs.catalyst.zoho.com/es/cloud-scale/help/data-store/tables/) 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](https://docs.catalyst.zoho.com/es/cli/v1/data-store-import-and-export/import-operation/#import-options)`. |
| `operation` (String, Opcional) | Especifica la operación a ejecutar. Valores permitidos:`insert`, `update`, `upsert` Operación predeterminada: `insert` |
| `object_url` (String, Obligatorio) | La [Object URL única del archivo CSV](https://docs.catalyst.zoho.com/es/cloud-scale/help/stratus/objects/introduction/#object-url) en Stratus. También puedes especificar la ruta del archivo CSV con el comando. |
| `find_by` (String, Obligatorio para operaciones `update` y `upsert`. No obligatorio para la operación `insert`) | La columna única mediante la cual se identifican los registros. 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 EmployeeID. Para la operación de actualización, Catalyst actualizará las filas que coincidan con el valor de EmployeeID 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. Update: Puede ser una columna con valores únicos configurados en el Data Store, o el [ROWID](https://docs.catalyst.zoho.com/es/cloud-scale/help/data-store/columns/#default-columns) generado por Catalyst para los registros. Upsert: 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. Insert: 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. |
| `fk_mapping` (JSON, Opcional) | 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. Debes mapear las claves foráneas en el siguiente formato: { "local_column" : "local_column_name_1", "reference_column" : "reference_column_name_1" } 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. |
| `callback` (JSON, Opcional) | 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. |
| Atributo | Descripción |
|---|---|
| `url` (String, Obligatorio si deseas especificar la URL de callback) | 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. El CLI también mostrará una transmisión en tiempo real de la ejecución y el estado final del trabajo. |
| `headers` (String, Opcional) | Encabezados que necesitas que se pasen en la respuesta JSON a la URL de callback Debes especificar los encabezados como: { "{header_name_1}" : "{header_value_1}", "{header_name_2}" : "{header_value_2}" } y así sucesivamente. |
| `params` (String, Opcional) | Parámetros que necesitas que se agreguen a la URL de callback Debes especificar los parámetros como: { "{param_name_1}" : "{param_value_1}", "{param_name_2}" : "{param_value_2}" } y así sucesivamente. |
| Atributos | Descripción |
|---|---|
| `table_identifier` (String, Obligatorio) | El [ID único](https://docs.catalyst.zoho.com/es/cloud-scale/help/data-store/tables/) 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`](https://docs.catalyst.zoho.com/es/cli/v1/data-store-import-and-export/export-operation/#export-options). |
| `query` (JSON, Opcional) | La sección donde puedes definir las condiciones y criterios para el trabajo de exportación |
| `page` (Numérico, Opcional) | El archivo CSV generado como resultado del proceso de lectura masiva contiene doscientos mil registros en una página. 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. Por ejemplo, si deseas obtener registros del rango 200,001 a 400,000, debes especificar el valor de página como '2'. Valor predeterminado: 1 También puedes especificar el valor de página usando la [opción `--page`](https://docs.catalyst.zoho.com/es/cli/v1/data-store-import-and-export/export-operation/#export-options). |
| `select_columns` (Array, Opcional) | 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. Puedes incluir múltiples columnas en un array. |
| `callback` (JSON, Opcional) | 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 |
| `url` (String, Obligatorio si deseas especificar la URL de callback | 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. El CLI también mostrará una transmisión en tiempo real de la ejecución y el estado final del trabajo. |
| `headers` (String, Opcional) | Encabezados que necesitas que se pasen en la respuesta JSON a la URL de callback Debes especificar los encabezados como: { "{header_name_1}" : "{header_value_1}", "{header_name_2}" : "{header_value_2}" } y así sucesivamente. |
| `params` (String, Opcional) | Parámetros que necesitas que se agreguen a la URL de callback Debes especificar los parámetros como: { "{param_name_1}" : "{param_value_1}", "{param_name_2}" : "{param_value_2}" } y así sucesivamente. |
| `criteria` (JSON, Opcional) | 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. |
| Atributos | Descripción |
|---|---|
| `group_operator` (String, Obligatorio si deseas especificar los criterios | El operador que vinculará los grupos de criterios entre sí. Operadores admitidos: `AND`, `OR` 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. > **Nota:** No podrás usar combinaciones de ambos operadores. Puedes usar `AND` o `OR` en una sola ejecución de comando. |
| `group` (JSON, Obligatorio si deseas especificar los criterios) | Puedes incluir hasta 25 conjuntos de criterios en esta sección. El archivo JSON de ejemplo muestra 2 conjuntos de criterios. Nota: Solo puedes incluir un grupo general con un operador de grupo en una sola ejecución. |
| `column_name` (String, Obligatorio si deseas especificar los criterios) | Nombre de la columna específica de la tabla para la cual se deben definir los criterios |
| `comparator` (String, Obligatorio si deseas especificar los criterios) | El operador de comparación que coincide el nombre de la columna con el valor del criterio Comparadores admitidos: `equal`, `not_equal`, `greater_than`, `greater_equal`, `less_than`, `less_equal`, `starts_with`, `ends_with`, `contains`, `not_contains`, `in`, `not_in`, `between`, `not_between` > **Nota:** * 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. |
| `value` (String, Obligatorio si deseas especificar los criterios) | El valor para la columna específica en el registro que deseas definir como criterio |
| Framework | Comando de inicio predeterminado |
|---|---|
| Create React App | `PORT=$ZC_SLATE_PORT npm start` |
| Solid JS(Vite) | `npm run dev -\- -\-port $ZC_SLATE_PORT` |
| React + Vite | `npm run dev -\- -\-port $ZC_SLATE_PORT` |
| Next.js | `npm run dev -\- -\-port $ZC_SLATE_PORT` |
| Astro | `npm run dev -\- -\-port $ZC_SLATE_PORT` |
| Angular | `npm start -\- -\-port $ZC_SLATE_PORT` |
| Vue (Vite) | `npm run dev -\- -\-port $ZC_SLATE_PORT` |
| Preact | `npm run dev -\- -\-port $ZC_SLATE_PORT` |
| Svelte | `npm run dev -\- -\-port $ZC_SLATE_PORT` |