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

> Découvrez comment utiliser le Deploy CLI d’Auth0 comme module Node.js.

# Utiliser comme module Node.js

Le Deploy CLI peut être utilisé non seulement comme interface de ligne de commande autonome, mais aussi comme module Node.js. Vous pouvez ainsi gérer les ressources Auth0 dans des scripts Node.js plus souples.

Pour obtenir la liste complète des paramètres de configuration, consultez [Configurer le Deploy CLI](/fr-CA/docs/deploy-monitor/deploy-cli-tool/configure-the-deploy-cli).

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

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

<div id="argument-parameters">
  ### Paramètres des arguments
</div>

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

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

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

Chemin. Indique le répertoire cible dans lequel écrire les fichiers de configuration.

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

Objet. Définit le comportement de l’utilitaire. Pour en savoir plus, consultez [Configurer le Deploy CLI](/fr-CA/docs/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 le Deploy CLI](/fr-CA/docs/deploy-monitor/deploy-cli-tool/configure-the-deploy-cli).

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

Booléen. Lorsqu’elle est activée, cette option exporte les champs d’identifiant de chaque ressource. Par défaut : `false`.

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

Booléen. Indique si l’outil doit utiliser les variables d’environnement ou non. Valeur par défaut : `false`.

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

URL utilisée pour acheminer les requêtes via un proxy. Définissez-la uniquement si vous êtes derrière un proxy.

<div id="example">
  ### Exemple
</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('Exportation de la configuration Auth0 réussie');
  })
  .catch((err) => {
    console.log('Erreur lors de l\'exportation de la configuration Auth0 :', err);
  });
```

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

Applique la configuration de la machine locale au locataire Auth0.

<div id="argument-parameters">
  ### Paramètres des arguments
</div>

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

Chemin. Indique l’emplacement des fichiers de configuration des ressources. Pour les formats YAML, il pointe vers le fichier `tenant.yaml`. Pour les formats de répertoire, il pointe vers le répertoire de configuration des ressources.

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

Objet. Définit le comportement de l’utilitaire. Pour en savoir plus, consultez [Configurer le Deploy CLI](/fr-CA/docs/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 le Deploy CLI](/fr-CA/docs/deploy-monitor/deploy-cli-tool/configure-the-deploy-cli).

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

Booléen. Lorsqu’elle est activée, cette option exporte les champ d’identifiant de chaque ressource. Valeur par défaut : `false`.

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

Booléen. Indique si l’outil doit lire les variables d’environnement ou non. Par défaut : `false`.

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

URL utilisée pour acheminer les requêtes via un proxy. Définissez-la uniquement si vous êtes derrière un proxy.

<div id="example">
  ### Exemple
</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('Configuration Auth0 appliquée au locataire avec succès');
  })
  .catch((err) => {
    console.log('Erreur lors de l\'application de la configuration au locataire Auth0 :', err);
  });
```
