> ## Documentation Index
> Fetch the complete documentation index at: https://docs-dev-docs-event-stream-action-templates.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# ノードモジュールとして使用する

> Auth0 Deploy CLIをノードモジュールとして使用する方法について説明します。

Deploy CLIは、スタンドアロンのCLIとしてだけでなく、ノードモジュールとしても使用できます。これにより、Auth0リソースを表現豊かなノードスクリプト内で管理できるようになります。

設定の包括的なリストについては、「[Deploy CLIを構成する](/docs/ja-jp/deploy-monitor/deploy-cli-tool/configure-the-deploy-cli)」をお読みください。

## dump関数

Auth0テナントからローカルマシンに構成を取得します。

### 引数パラメーター

#### format

オプション：`yaml`または`directory`。エクスポートされるリソース構成ファイルのファイル形式を決定します。詳細については、「[利用可能なリソース構成形式](/docs/ja-jp/deploy-monitor/deploy-cli-tool/available-resource-configuration-formats)」をお読みください。

#### output\_folder

パス。構成ファイルを書き込む目的のディレクトリを指定します。

#### config

オブジェクト。ユーティリティの動作を構成します。詳細については、「[Deploy CLIを構成する](/docs/ja-jp/deploy-monitor/deploy-cli-tool/configure-the-deploy-cli)」をお読みください。

#### config\_file

パス。ユーザー定義の構成ファイル（`config.json`）を指定します。詳細については、「[Deploy CLIを構成する](/docs/ja-jp/deploy-monitor/deploy-cli-tool/configure-the-deploy-cli)」をお読みください。

#### export\_ids

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

#### env

ブール値。ツールが環境変数を取り込むかどうかを示します。デフォルト：`false`。

#### proxy\_url

要求をプロキシするためのURL。プロキシを使用している場合にのみこれを設定します。

### 例

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

## デプロイ機能

ローカルマシンからAuth0テナントに構成を適用します。

### 引数パラメーター

#### input\_file

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

#### config

オブジェクト。ユーティリティの動作を構成します。詳細については、「[Deploy CLIを構成する](/docs/ja-jp/deploy-monitor/deploy-cli-tool/configure-the-deploy-cli)」をお読みください。

#### config\_file

パス。ユーザー定義の構成ファイル（`config.json`）を指定します。詳細については、「[Deploy CLIを構成する](/docs/ja-jp/deploy-monitor/deploy-cli-tool/configure-the-deploy-cli)」をお読みください。

#### export\_ids

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

#### env

ブール値。ツールが環境変数を取り込むかどうかを示します。デフォルト：`false`。

#### proxy\_url

要求をプロキシするためのURL。プロキシを使用している場合にのみこれを設定します。

### 例

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