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

# Utilisation en tant que module Node

> Apprenez à utiliser l’outil Auth0 Deploy CLI en tant que module node.

L’outil Deploy CLI peut être utilisé non seulement comme interface de ligne de commande autonome, mais aussi comme un module node. Cela vous permet de gérer les ressources Auth0 dans des scripts node expressifs.

Pour une liste complète des paramètres de configuration, veuillez consulter [Configurer l’outil Deploy CLI](/docs/fr-CA/fr-ca/deploy-monitor/deploy-cli-tool/configure-the-deploy-cli).

<div id="dump-function">
  ## Fonction dump
</div>

Récupère les configurations du locataire Auth0 sur la machine locale.

<div id="argument-parameters">
  ### Paramètres de l’argument
</div>

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

Options : `yaml` ou `directory`. Détermine le format des fichiers de configuration des ressources exportés. Pour en savoir plus, lisez [Formats de configuration des ressources disponibles](/docs/fr-CA/fr-ca/deploy-monitor/deploy-cli-tool/available-resource-configuration-formats).

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

Chemin d’accès. Spécifie le répertoire cible dans lequel les fichiers de configuration doivent être écrits.

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

Objet. Configure le comportement de l’utilitaire. Pour en savoir plus, consultez [Configurer l’outil Deploy CLI](/docs/fr-CA/fr-ca/deploy-monitor/deploy-cli-tool/configure-the-deploy-cli).

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

Chemin d’accès. Indique le fichier de configuration défini par l’utilisateur (`config.json`). Pour en savoir plus, consultez [Configurer l’outil Deploy CLI](/docs/fr-CA/fr-ca/deploy-monitor/deploy-cli-tool/configure-the-deploy-cli).

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

Valeur booléenne. Lorsque cette option est activée, elle exporte les champs d’identifiant de chaque ressource. Valeur par défaut : `false`.

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

Valeur booléenne. Indique si l’outil doit ingérer des variables d’environnement ou non. Valeur par défaut : `false`.

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

URL pour les demandes de proxy. Ne définissez cette option que si vous êtes derrière un proxy.

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

```javascript 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('Auth0 configuration export successful');
  })
  .catch((err) => {
    console.log('Error during Auth0 configuration export:', err);
  });
```

<div id="deploy-function">
  ## Fonction deploy
</div>

Applique les configurations de la machine locale au locataire Auth0.

<div id="argument-parameters">
  ### Paramètres de l’argument
</div>

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

Chemin d’accès. Spécifie l’emplacement des fichiers de configuration des ressources. Pour les formats YAML, il pointera vers le fichier `tenant.yaml`. Pour les formats de répertoire, ce chemin pointera vers le répertoire de configuration des ressources.

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

Objet. Configure le comportement de l’utilitaire. Pour en savoir plus, consultez [Configurer l’outil Deploy CLI](/docs/fr-CA/fr-ca/deploy-monitor/deploy-cli-tool/configure-the-deploy-cli).

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

Chemin d’accès. Indique le fichier de configuration défini par l’utilisateur (`config.json`). Pour en savoir plus, consultez [Configurer l’outil Deploy CLI](/docs/fr-CA/fr-ca/deploy-monitor/deploy-cli-tool/configure-the-deploy-cli).

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

Valeur booléenne. Lorsque cette option est activée, elle exporte les champs d’identifiant de chaque ressource. Valeur par défaut : `false`.

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

Valeur booléenne. Indique si l’outil doit ingérer des variables d’environnement ou non. Valeur par défaut : `false`.

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

URL pour les demandes de proxy. Ne définissez cette option que si vous êtes derrière un proxy.

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

```javascript 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('Auth0 configuration applied to tenant successful');
  })
  .catch((err) => {
    console.log('Error when applying configuration to Auth0 tenant:', err);
  });
```