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

> Auth0 Deploy CLI を Node モジュールとして使用し、独自のデプロイスクリプトから直接利用する方法を説明します。

# Deploy CLI を Node モジュールとして使用する

[Auth0 Deploy CLI](https://github.com/auth0/auth0-deploy-cli) は、スタンドアロンの CLI としてだけでなく、Node モジュールとしても使用できます。これにより、柔軟な Node スクリプト内で Auth0 リソースを管理できるようになります。

設定項目の一覧については、[Deploy CLI の設定](/docs/ja-jp/deploy-monitor/deploy-cli-tool/configure-the-deploy-cli) を参照してください。

<div id="dump-function">
  ## dump 関数
</div>

Auth0テナントから設定を取得し、ローカルマシンに取り込みます。

<div id="argument-parameters">
  ### 引数
</div>

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

オプション: `yaml` または `directory`。エクスポートするリソース設定ファイルの形式を指定します。詳しくは、[利用可能なリソース設定ファイル形式](/docs/ja-jp/deploy-monitor/deploy-cli-tool/available-resource-configuration-formats)をご覧ください。

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

パス。設定ファイルの書き込み先となるディレクトリを指定します。

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

オブジェクト。ユーティリティの動作を構成します。詳しくは、[Deploy CLI の設定](/docs/ja-jp/deploy-monitor/deploy-cli-tool/configure-the-deploy-cli)を参照してください。

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

パス。ユーザー定義の設定ファイル (`config.json`) を指定します。詳細については、[Deploy CLI の設定](/docs/ja-jp/deploy-monitor/deploy-cli-tool/configure-the-deploy-cli)を参照してください。

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

ブール値。有効にすると、各リソースの識別子フィールドがエクスポートされます。デフォルト: `false`。

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

ブール値。ツールが環境変数を取り込むかどうかを指定します。既定値: `false`。

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

リクエストをプロキシ経由で送信するためのURLです。プロキシ環境下にある場合にのみ設定してください。

<div id="example">
  ### 例
</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('Auth0設定のエクスポートが成功しました');
  })
  .catch((err) => {
    console.log('Auth0設定のエクスポート中にエラーが発生しました:', err);
  });
```

<div id="deploy-function">
  ## deploy 関数
</div>

ローカルマシン上の設定をAuth0テナントに適用します。

<div id="argument-parameters">
  ### 引数
</div>

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

パス。リソース設定ファイルの場所を指定します。YAML 形式の場合は `tenant.yaml` ファイルを、ディレクトリ形式の場合はリソース設定ディレクトリを指定します。

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

オブジェクト。ユーティリティの動作を構成します。詳しくは、[Deploy CLI の設定](/docs/ja-jp/deploy-monitor/deploy-cli-tool/configure-the-deploy-cli)を参照してください。

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

パス。ユーザー定義の設定ファイル (`config.json`) を指定します。詳細については、[Deploy CLI の設定](/docs/ja-jp/deploy-monitor/deploy-cli-tool/configure-the-deploy-cli)を参照してください。

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

ブール値。有効にすると、各リソースの識別子フィールドがエクスポートされます。デフォルト: `false`。

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

ブール値。ツールが環境変数を取り込むかどうかを指定します。既定値: `false`。

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

リクエストをプロキシ経由で送信するためのURLです。プロキシ環境下にある場合にのみ設定してください。

<div id="example">
  ### 例
</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('Auth0の設定がテナントに正常に適用されました');
  })
  .catch((err) => {
    console.log('Auth0テナントへの設定適用中にエラーが発生しました:', err);
  });
```