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.

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.
  

• 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.
  

• 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.