> ## Documentation Index
> Fetch the complete documentation index at: https://translations.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

> Aprenda a usar Auth0 Deploy CLI como módulo de Node.

# Usar como módulo de Node

Deploy CLI no solo puede usarse como una CLI independiente, sino también como un módulo de Node. Esto le permite administrar recursos de Auth0 desde scripts de Node.

Para obtener una lista completa de los ajustes de configuración, lea [Configurar Deploy CLI](/es/docs/deploy-monitor/deploy-cli-tool/configure-the-deploy-cli).

<div id="dump-function">
  ## función dump
</div>

Obtiene la configuración del Tenant de Auth0 y la descarga en la máquina local.

<div id="argument-parameters">
  ### Parámetros de los argumentos
</div>

<div id="format">
  #### formato
</div>

Opciones: `yaml` o `directory`. Determina el formato de los archivos de configuración de recursos exportados. Para obtener más información, consulta [Formatos de configuración de recursos disponibles](/es/docs/deploy-monitor/deploy-cli-tool/available-resource-configuration-formats).

<div id="output_folder">
  #### output\_folder
</div>

Ruta. Especifica el directorio de destino donde se escribirán los archivos de configuración.

<div id="config">
  #### config
</div>

Objeto. Configura el comportamiento de la utilidad. Para obtener más información, consulta [Configurar el Deploy CLI](/es/docs/deploy-monitor/deploy-cli-tool/configure-the-deploy-cli).

<div id="config_file">
  #### config\_file
</div>

Ruta. Especifica el archivo de configuración personalizado (`config.json`). Para obtener más información, consulta [Configurar Deploy CLI](/es/docs/deploy-monitor/deploy-cli-tool/configure-the-deploy-cli).

<div id="export_ids">
  #### export\_ids
</div>

Booleano. Cuando está activado, exporta los campos de identificador de cada recurso. Valor predeterminado: `false`.

<div id="env">
  #### env
</div>

Booleano. Indica si la herramienta debe usar variables de entorno o no. Valor predeterminado: `false`.

<div id="proxy_url">
  #### proxy\_url
</div>

Una URL para enviar solicitudes a través de un proxy. Configúrala solo si estás detrás de un proxy.

<div id="example">
  ### Ejemplo
</div>

```jsx lines theme={null}
import { dump } from 'auth0-deploy-cli';

dump({
  output_folder: './local',
  format: 'yaml',
  config: {
    AUTH0_DOMAIN: '<YOUR_AUTH0_TENANT_DOMAIN>',
    AUTH0_CLIENT_ID: '<YOUR_AUTH0_CLIENT_ID>',
    AUTH0_CLIENT_SECRET: '<YOUR_AUTH0_CLIENT_SECRET>',
  },
})
  .then(() => {
    console.log('Exportación de configuración de Auth0 exitosa');
  })
  .catch((err) => {
    console.log('Error durante la exportación de configuración de Auth0:', err);
  });
```

<div id="deploy-function">
  ## función deploy
</div>

Aplica configuraciones de la máquina local al Tenant de Auth0.

<div id="argument-parameters">
  ### Parámetros de los argumentos
</div>

<div id="input_file">
  #### input\_file
</div>

Ruta. Especifica la ubicación de los archivos de configuración de recursos. En los formatos YAML, apuntará al archivo `tenant.yaml`. En los formatos de directorio, apuntará al directorio de configuración de recursos.

<div id="config">
  #### config
</div>

Objeto. Configura el comportamiento de la utilidad. Para obtener más información, consulta [Configurar el Deploy CLI](/es/docs/deploy-monitor/deploy-cli-tool/configure-the-deploy-cli).

<div id="config_file">
  #### config\_file
</div>

Ruta. Especifica el archivo de configuración personalizado (`config.json`). Para obtener más información, consulta [Configurar Deploy CLI](/es/docs/deploy-monitor/deploy-cli-tool/configure-the-deploy-cli).

<div id="export_ids">
  #### export\_ids
</div>

Booleano. Si está habilitado, exporta los campos de identificador de cada recurso. Valor predeterminado: `false`.

<div id="env">
  #### env
</div>

Booleano. Indica si la herramienta debe leer las variables de entorno. Valor predeterminado: `false`.

<div id="proxy_url">
  #### proxy\_url
</div>

Una URL para enrutar solicitudes a través de un proxy. Configúrala solo si estás detrás de un proxy.

<div id="example">
  ### Ejemplo
</div>

```jsx lines theme={null}
import { deploy } from 'auth0-deploy-cli';

deploy({
  input_file: './local/tenant.yaml',
  config: {
    AUTH0_DOMAIN: '<YOUR_AUTH0_TENANT_DOMAIN>',
    AUTH0_CLIENT_ID: '<YOUR_AUTH0_CLIENT_ID>',
    AUTH0_CLIENT_SECRET: '<YOUR_AUTH0_CLIENT_SECRET>',
  },
})
  .then(() => {
    console.log('Configuración de Auth0 aplicada al Tenant correctamente');
  })
  .catch((err) => {
    console.log('Error al aplicar la configuración al Tenant de Auth0:', err);
  });
```
