> ## Documentation Index
> Fetch the complete documentation index at: https://auth0-feat-init-gt-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 directement depuis vos propres scripts de déploiement.

# Utiliser le Deploy CLI comme module Node.js

Le [Auth0 Deploy CLI](https://github.com/auth0/auth0-deploy-cli) peut être utilisé non seulement comme CLI autonome, mais aussi comme module Node.js. Vous pouvez ainsi gérer les ressources Auth0 dans des scripts Node.js plus souples.

Pour obtenir une liste complète des options de configuration, veuillez consulter [Configurer le Deploy CLI](/docs/fr-ca/deploy-monitor/deploy-cli-tool/configure-the-deploy-cli).

<h2 id="dump-function">
  fonction dump
</h2>

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

<h3 id="argument-parameters">
  Paramètres
</h3>

<h4 id="format">
  format
</h4>

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

<h4 id="output_folder">
  output\_folder
</h4>

Chemin. Spécifie le répertoire cible dans lequel les fichiers de configuration seront écrits.

<h4 id="config">
  config
</h4>

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

<h4 id="config_file">
  config\_file
</h4>

Chemin. Spécifie le fichier de configuration personnalisé (`config.json`). Pour en savoir plus, consultez [Configurer le Deploy CLI](/docs/fr-ca/deploy-monitor/deploy-cli-tool/configure-the-deploy-cli).

<h4 id="export_ids">
  export\_ids
</h4>

Booléen. Si cette option est activée, les champs d’identifiant de chaque ressource seront exportés. Par défaut : `false`.

<h4 id="env">
  env
</h4>

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

<h4 id="proxy_url">
  proxy\_url
</h4>

Une URL pour faire passer les requêtes par un serveur proxy. À définir uniquement si vous êtes derrière un proxy.

<h3 id="example">
  Exemple
</h3>

```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);
  });
```

<h2 id="deploy-function">
  fonction de déploiement
</h2>

Applique les configurations de la machine locale au tenant Auth0.

<h3 id="argument-parameters-2">
  Paramètres
</h3>

<h4 id="input_file">
  input\_file
</h4>

Chemin. Indique 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, il pointera vers le répertoire de configuration des ressources.

<h4 id="config-2">
  config
</h4>

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

<h4 id="config_file-2">
  config\_file
</h4>

Chemin. Spécifie le fichier de configuration personnalisé (`config.json`). Pour en savoir plus, consultez [Configurer le Deploy CLI](/docs/fr-ca/deploy-monitor/deploy-cli-tool/configure-the-deploy-cli).

<h4 id="export_ids-2">
  export\_ids
</h4>

Booléen. Si cette option est activée, les champs d’identifiant de chaque ressource seront exportés. Par défaut : `false`.

<h4 id="env-2">
  env
</h4>

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

<h4 id="proxy_url-2">
  proxy\_url
</h4>

Une URL pour faire passer les requêtes par un serveur proxy. À définir uniquement si vous êtes derrière un proxy.

<h3 id="example-2">
  Exemple
</h3>

```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 tenant Auth0 :', err);
  });
```