Referencia de comandos del CLI

# Referencia de comandos del CLI

Debes tener Catalyst CLI instalado en tu sistema para acceder a los comandos de Catalyst. Consulta la {{%link href="/es/getting-started/installing-catalyst-cli/"%}}página de ayuda para instalar Catalyst CLI{{%/link%}} para ver los pasos.

### Opciones

<table class="content-table">
	<thead>
		<tr>
			<th>Sintaxis del comando</th>
			<th>Uso</th>
		</tr>
	</thead>
	<tbody>
		<tr>
			<td>{{%link href="/es/cli/v1/cli-options/#version"%}} {{%badge%}}-v{{%/badge%}} | {{%badge%}}--version{{%/badge%}} {{%/link%}}</td>
			<td>Muestra el número de versión del Catalyst CLI</td>
		</tr>
		<tr>
			<td>{{%link href="/es/cli/v1/cli-options/#-p----project-ltname_or_project_idgt---org-ltorg_idgt"%}}{{%badge%}}-p{{%/badge%}} | {{%badge%}}--project &lt;name_or_project_id&gt;{{%/badge%}}{{%/link%}}</td>
			<td>Especifica el proyecto de Catalyst que se usará para un comando</td>
		</tr>
		<tr>
			<td>{{%link href="/es/cli/v1/cli-options/#-p----project-ltname_or_project_idgt---org-ltorg_idgt"%}}{{%badge%}}--org &lt;org id&gt;{{%/badge%}}{{%/link%}}</td>
			<td>Especifica la organización de Catalyst que se usará para un comando. Se utiliza con la opción {{%badge%}}-p{{%/badge%}}.</td>
		</tr>
		<tr>
			<td>{{%link href="/es/cli/v1/cli-options/#--token-lttokengt"%}}{{%badge%}}--token &lt;token&gt;{{%/badge%}}{{%/link%}}</td>
			<td>Proporciona un token de autenticación para un comando</td>
		</tr>
		<tr>
			<td>{{%link href="/es/cli/v1/cli-options/#token"%}}{{%badge%}}--dc &lt;us|eu|in|jp|sa|au|ca&gt;{{%/badge%}}{{%/link%}}</td>
			<td>Proporciona un centro de datos para un comando</td>
		</tr>
		<tr>
			<td>{{%link href="/es/cli/v1/cli-options/#--verbose"%}}{{%badge%}}--verbose{{%/badge%}}{{%/link%}}</td>
			<td>Cambia el nivel de log a verbose para fines de depuración</td>
		</tr>
		<tr>
			<td>{{%link href="/es/cli/v1/cli-options/#-h----help"%}}{{%badge%}}-h{{%/badge%}} | {{%badge%}}--help{{%/badge%}}{{%/link%}}</td>
			<td>Muestra la ayuda para un comando de Catalyst</td>
		</tr>
	</tbody>
</table>

### Comandos

<table class="content-table">
	<thead>
		<tr>
			<th>Sintaxis del comando</th>
			<th>Uso</th>
		</tr>
	</thead>
	<tbody>
		<tr>
			<td>{{%link href="/es/cli/v1/login/login-from-cli/"%}}{{%badge%}}login [options]{{%/badge%}}{{%/link%}}</td>
			<td>Inicia sesión en el CLI con tu cuenta de Catalyst</td>
		</tr>
		<tr>
			<td>{{%link href="/es/cli/v1/working-with-tokens/introduction/"%}}{{%badge%}}token:generate [options]{{%/badge%}}{{%/link%}}</td>
			<td>Genera un token para autenticar el acceso al CLI desde un sistema remoto</td>
		</tr>
		<tr>
			<td>{{%link href="/es/cli/v1/working-with-tokens/list-tokens/"%}}{{%badge%}}token:list{{%/badge%}}{{%/link%}}</td>
			<td>Lista todos los tokens disponibles generados en este CLI</td>
		</tr>
		<tr>
			<td>{{%link href="/es/cli/v1/working-with-tokens/revoke-token/"%}}{{%badge%}}token:revoke &lt;id&gt;{{%/badge%}}{{%/link%}}</td>
			<td>Revoca un token generado en este CLI</td>
		</tr>
		<tr>
			<td>{{%link href="/es/cli/v1/identify-loggedin-user/"%}}{{%badge%}}whoami{{%/badge%}}{{%/link%}}</td>
			<td>Muestra la dirección de correo electrónico del usuario actualmente conectado</td>
		</tr>
		<tr>
			<td>{{%link href="/es/cli/v1/initialize-resources/introduction/"%}}{{%badge%}}init [feature] [options]{{%/badge%}}{{%/link%}}</td>
			<td>Inicializa un proyecto de Catalyst, funciones, AppSail y recursos de Client en el directorio local</td>
		</tr>
		<tr>
			<td>{{%link href="/es/cli/v1/working-with-projects/list-catalyst-projects/"%}}{{%badge%}}project:list{{%/badge%}}{{%/link%}}</td>
			<td>Lista todos los proyectos de Catalyst a los que tienes acceso</td>
		</tr>
		<tr>
			<td>{{%link href="/es/cli/v1/working-with-projects/use-catalyst-project/"%}}{{%badge%}}project:use [name_or_project_id] {{%/badge%}}{{%/link%}}</td>
			<td>Establece un proyecto activo de Catalyst para tu directorio de trabajo</td>
		</tr>
		<tr>
			<td>{{%link href="/es/cli/v1/working-with-projects/reset-active-project/"%}}{{%badge%}}project:reset{{%/badge%}}{{%/link%}}</td>
			<td>Limpia la selección de proyecto activo y restablece al proyecto base</td>
		</tr>
		<tr>
			<td>{{%link href="/es/cli/v1/pull-resources/introduction/"%}}{{%badge%}}pull [feature]{{%/badge%}}{{%/link%}}</td>
			<td>Descarga recursos de tu proyecto desde la consola remota al directorio local</td>
		</tr>
		<tr>
			<td>{{%link href="/es/cli/v1/export-and-import-projects/introduction/"%}}{{%badge%}}iac:export [options]{{%/badge%}}{{%/link%}}</td>
			<td>Exporta el código y las configuraciones de un proyecto como un archivo ZIP</td>
		</tr>
		<tr>
			<td>{{%link href="/es/cli/v1/export-and-import-projects/import-project/"%}}{{%badge%}}iac:import [options][file_path]{{%/badge%}}{{%/link%}}</td>
			<td>Importa el archivo ZIP de un proyecto y crea un nuevo proyecto en la consola</td>
		</tr>
		<tr>
			<td>{{%link href="/es/cli/v1/export-and-import-projects/generate-zip-file/"%}}{{%badge%}}iac:pack [zip_name]{{%/badge%}}{{%/link%}}</td>
			<td>Genera un archivo ZIP listo para importar de un proyecto en el formato estándar</td>
		</tr>
		<tr>
			<td>{{%link href="/es/cli/v1/export-and-import-projects/export-import-job-status/"%}}{{%badge%}}iac:status [options]&lt;operation&gt;{{%/badge%}}{{%/link%}}</td>
			<td>Obtiene el estado actual de un trabajo de importación o exportación programado</td>
		</tr>
 <tr>
			<td>{{%link href="/es/cli/v1/working-with-functions/set-up-functions/"%}}{{%badge%}}functions:setup{{%/badge%}}{{%/link%}}</td>
			<td>Configura el directorio de funciones en tu directorio de proyecto</td>
		</tr>
		<tr>
			<td>{{%link href="/es/cli/v1/working-with-functions/add-functions/"%}}{{%badge%}}functions:add{{%/badge%}}{{%/link%}}</td>
			<td>Agrega una función del stack requerido al directorio de funciones</td>
		</tr>
		<tr>
			<td>{{%link href="/es/cli/v1/working-with-functions/configure-function-memory/"%}}{{%badge%}}functions:config [function_name_or_id] [options] {{%/badge%}}{{%/link%}}</td>
			<td>Realiza configuraciones avanzadas como la asignación de memoria en una función de tu proyecto</td>
		</tr>
		<tr>
			<td>{{%link href="/es/cli/v1/working-with-functions/functions-shell/"%}}{{%badge%}}functions:shell [options]{{%/badge%}}{{%/link%}}</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>{{%link href="/es/cli/v1/working-with-functions/delete-functions/"%}}{{%badge%}}functions:delete [function_name_or_id] [options]{{%/badge%}}{{%/link%}}</td>
			<td>Elimina una función de la consola remota o del directorio local</td>
		</tr>
 <tr>
			<td>{{%link href="/es/cli/v1/cli-config/"%}}{{%badge%}}config:set &lt;key=value&gt; {{%/badge%}}{{%/link%}}</td>
			<td>Establece la configuración de Catalyst como un par clave-valor</td>
		</tr>
		<tr>
			<td>{{%link href="/es/cli/v1/cli-config/#get-the-value-of-a-specific-key"%}}{{%badge%}}config:get &lt;key&gt;{{%/badge%}}{{%/link%}}</td>
			<td>Obtiene el valor de configuración de Catalyst para la clave especificada</td>
		</tr>
		<tr>
			<td>{{%link href="/es/cli/v1/cli-config/#list-configurations"%}}{{%badge%}}config:list{{%/badge%}}{{%/link%}}</td>
			<td>Lista todas las configuraciones de Catalyst</td>
		</tr>
		<tr>
			<td>{{%link href="/es/cli/v1/cli-config/#delete-key"%}}{{%badge%}}config:delete &lt;key&gt; {{%/badge%}}{{%/link%}}</td>
			<td>Elimina una clave de la configuración de Catalyst</td>
		</tr>
		<tr>
			<td>{{%link href="/es/cli/v1/add-appsail/"%}}{{%badge%}}appsail:add{{%/badge%}}{{%/link%}}</td>
			<td>Asocia un directorio de proyecto de Catalyst existente con un servicio AppSail</td>
		</tr>
		<tr>
			<td>{{%link href="/es/cli/v1/working-with-the-client/introduction/"%}}{{%badge%}}client:setup{{%/badge%}}{{%/link%}}</td>
			<td>Configura el directorio de Client en tu directorio de proyecto</td>
		</tr>
		<tr>
			<td>{{%link href="/es/cli/v1/working-with-the-client/delete-client/"%}}{{%badge%}}client:delete [client_version] [options]{{%/badge%}}{{%/link%}}</td>
			<td>Elimina una versión del Client de la consola remota o del directorio local</td>
		</tr>
		<tr>
			<td>{{%link href="/es/cli/v1/data-store-import-and-export/introduction/"%}}{{%badge%}}ds:import [~CSV_file_path] [options]{{%/badge%}}{{%/link%}}</td>
			<td>Escribe registros de forma masiva en una tabla del Data Store de Catalyst</td>
		</tr>
		<tr>
			<td>{{%link href="/es/cli/v1/data-store-import-and-export/export-operation/"%}}{{%badge%}}ds:export [options]{{%/badge%}}{{%/link%}}</td>
			<td>Lee registros de forma masiva desde una tabla del Data Store de Catalyst</td>
		</tr>
		<tr>
			<td>{{%link href="/es/cli/v1/data-store-import-and-export/check-import-export-status/"%}}{{%badge%}}ds:status &lt;operation&gt; [job_id] [options]{{%/badge%}}{{%/link%}}</td>
			<td>Muestra el estado del trabajo de una operación de importación o exportación del Data Store</td>
		</tr>
		<tr>
			<td>{{%link href="/es/cli/v1/working-with-api-gateway/introduction/"%}}{{%badge%}}apig:enable{{%/badge%}}{{%/link%}}</td>
			<td>Habilita API Gateway para tu proyecto</td>
		</tr>
		<tr>
			<td>{{%link href="/es/cli/v1/working-with-api-gateway/disable-api-gateway/"%}}{{%badge%}}apig:disable{{%/badge%}}{{%/link%}}</td>
			<td>Deshabilita API Gateway para tu proyecto</td>
		</tr>
		<tr>
			<td>{{%link href="/es/cli/v1/working-with-api-gateway/obtain-api-gateway-status/"%}}{{%badge%}}apig:status [options]{{%/badge%}}{{%/link%}}</td>
			<td>Obtiene el estado actual de API Gateway para tu proyecto y el progreso programado</td>
		</tr>
		<tr>
			<td>{{%link href="/es/cli/v1/event-generate/introduction/"%}}{{%badge%}}event:generate{{%/badge%}} | {{%badge%}}generate:event &lt;source&gt; &lt;action&gt; [options]{{%/badge%}}{{%/link%}}</td>
			<td>Genera payloads de ejemplo de diferentes componentes o fuentes de eventos personalizados para probar funciones de eventos</td>
		</tr>
		<tr>
			<td>{{%link href="/es/cli/v1/event-generate/sample-payload-integration-functions/"%}}{{%badge%}}event:generate:integ &lt;service&gt; [options]{{%/badge%}}{{%/link%}}</td>
			<td>Genera payloads de ejemplo para el servicio de integración requerido para probar funciones de integración</td>
		</tr>
		<tr>
			<td>{{%link href="/es/serverless/help/functions/job-functions/#testing-job-functions-using-catalyst-cli"%}}{{%badge%}}event:generate:job{{%/badge%}}{{%/link%}}</td><td>Genera payloads de ejemplo para probar funciones de trabajo</td>
		</tr>
		<tr>
			<td>{{%link href="/es/cli/v1/scripts/introduction/"%}}{{%badge%}}run-script{{%/badge%}} | {{%badge%}}run [command]{{%/badge%}}{{%/link%}}</td>
			<td>Ejecuta un script de comando específico definido en {{%badge%}}catalyst.json{{%/badge%}}</td>
		</tr>
		<tr>
			<td>{{%link href="/es/cli/v1/serve-resources/introduction/"%}}{{%badge%}}serve [options]{{%/badge%}}{{%/link%}}</td>
			<td>Sirve funciones Basic I/O, Advanced I/O, BrowserLogic, AppSail y el Client para probarlos localmente</td>
		</tr>
		<tr>
			<td>{{%link href="/es/cli/v1/deploy-resources/introduction/"%}}{{%badge%}}deploy [options] [feature] {{%/badge%}}{{%/link%}}</td>
			<td>Despliega el proyecto de Catalyst y los recursos del proyecto en la consola remota desde el directorio local</td>
		</tr>
		<tr>
			<td>{{%link href="/es/cli/v1/cli-help/command-reference-help/"%}}{{%badge%}}help [command]{{%/badge%}}{{%/link%}}</td>
			<td>Muestra la referencia de comandos o la ayuda para un comando específico</td>
		</tr>
		<tr>
			<td>{{%link href="/es/cli/v1/logout/"%}}{{%badge%}}logout{{%/badge%}}{{%/link%}}</td>
			<td>Cierra la sesión del CLI de tu cuenta de Catalyst</td>
		</tr>
		<tr>
			<td>{{%link href="/es/codelib/install-a-codelib-solution/"%}}{{%badge%}}codelib:install{{%/badge%}}{{%/link%}}</td><td>Instala los componentes preconfigurados de Catalyst CodeLib en tu proyecto</td>
		</tr>
	</tbody>
</table>

{{%note%}}{{%bold%}}Nota:{{%/bold%}} Si eres usuario de {{%bold%}}Visual Studio Code IDE{{%/bold%}}, 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 {{%link href="/es/catalyst-extensions/vs-code-extension/introduction/" %}}sección de ayuda{{%/link%}}.{{%/note%}}

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

Sintaxis del comando	Uso
-v \| –version	Muestra el número de versión del Catalyst CLI
-p \| –project <name_or_project_id>	Especifica el proyecto de Catalyst que se usará para un comando
–org <org id>	Especifica la organización de Catalyst que se usará para un comando. Se utiliza con la opción -p.
–token <token>	Proporciona un token de autenticación para un comando
–dc <us\|eu\|in\|jp\|sa\|au\|ca>	Proporciona un centro de datos para un comando
–verbose	Cambia el nivel de log a verbose para fines de depuración
-h \| –help	Muestra la ayuda para un comando de Catalyst

Comandos

Sintaxis del comando	Uso
login [options]	Inicia sesión en el CLI con tu cuenta de Catalyst
token:generate [options]	Genera un token para autenticar el acceso al CLI desde un sistema remoto
token:list	Lista todos los tokens disponibles generados en este CLI
token:revoke <id>	Revoca un token generado en este CLI
whoami	Muestra la dirección de correo electrónico del usuario actualmente conectado
init [feature] [options]	Inicializa un proyecto de Catalyst, funciones, AppSail y recursos de Client en el directorio local
project:list	Lista todos los proyectos de Catalyst a los que tienes acceso
project:use [name_or_project_id]	Establece un proyecto activo de Catalyst para tu directorio de trabajo
project:reset	Limpia la selección de proyecto activo y restablece al proyecto base
pull [feature]	Descarga recursos de tu proyecto desde la consola remota al directorio local
iac:export [options]	Exporta el código y las configuraciones de un proyecto como un archivo ZIP
iac:import [options][file_path]	Importa el archivo ZIP de un proyecto y crea un nuevo proyecto en la consola
iac:pack [zip_name]	Genera un archivo ZIP listo para importar de un proyecto en el formato estándar
iac:status [options]<operation>	Obtiene el estado actual de un trabajo de importación o exportación programado
functions:setup	Configura el directorio de funciones en tu directorio de proyecto
functions:add	Agrega una función del stack requerido al directorio de funciones
functions:config [function_name_or_id] [options]	Realiza configuraciones avanzadas como la asignación de memoria en una función de tu proyecto
functions:shell [options]	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]	Elimina una función de la consola remota o del directorio local
config:set <key=value>	Establece la configuración de Catalyst como un par clave-valor
config:get <key>	Obtiene el valor de configuración de Catalyst para la clave especificada
config:list	Lista todas las configuraciones de Catalyst
config:delete <key>	Elimina una clave de la configuración de Catalyst
appsail:add	Asocia un directorio de proyecto de Catalyst existente con un servicio AppSail
client:setup	Configura el directorio de Client en tu directorio de proyecto
client:delete [client_version] [options]	Elimina una versión del Client de la consola remota o del directorio local
ds:import [~CSV_file_path] [options]	Escribe registros de forma masiva en una tabla del Data Store de Catalyst
ds:export [options]	Lee registros de forma masiva desde una tabla del Data Store de Catalyst
ds:status <operation> [job_id] [options]	Muestra el estado del trabajo de una operación de importación o exportación del Data Store
apig:enable	Habilita API Gateway para tu proyecto
apig:disable	Deshabilita API Gateway para tu proyecto
apig:status [options]	Obtiene el estado actual de API Gateway para tu proyecto y el progreso programado
event:generate \| generate:event <source> <action> [options]	Genera payloads de ejemplo de diferentes componentes o fuentes de eventos personalizados para probar funciones de eventos
event:generate:integ <service> [options]	Genera payloads de ejemplo para el servicio de integración requerido para probar funciones de integración
event:generate:job	Genera payloads de ejemplo para probar funciones de trabajo
run-script \| run [command]	Ejecuta un script de comando específico definido en catalyst.json
serve [options]	Sirve funciones Basic I/O, Advanced I/O, BrowserLogic, AppSail y el Client para probarlos localmente
deploy [options] [feature]	Despliega el proyecto de Catalyst y los recursos del proyecto en la consola remota desde el directorio local
help [command]	Muestra la referencia de comandos o la ayuda para un comando específico
logout	Cierra la sesión del CLI de tu cuenta de Catalyst
codelib:install	Instala los componentes preconfigurados de Catalyst CodeLib en tu proyecto

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.

Última actualización 2026-03-20 21:51:56 +0530 IST

Yes

Thank you for your feedback!

Send your feedback to us

Skip

Submit