この文章は Salesforce 機械翻訳システムを使用して翻訳されました。詳細はこちらをご参照ください。

CLI ランタイム設定値

現在のプロジェクトまたはすべてのプロジェクトの CLI ランタイム設定値を設定できます。グローバルとローカルの 2 種類の設定値を設定できます。グローバル値は、コンピュータのすべてのプロジェクトに適用されます。ローカル値は、特定のプロジェクトに適用されます。Salesforce DX プロジェクトディレクトリ内からコマンドが実行されると、ローカル値によってグローバル値が上書きされます。

sf から sfdx に新機能を導入して Salesforce CLI を改善するのに伴い、新しい sf のスタイルと名前を反映するために Salesforce DX のドキュメントも少しずつ更新されています。たとえば、sfdx コマンドのサンプルを表示するとき、同等の sf コマンドも表示しています。

設定変数については、sfdx という名前を廃止し、新しい sf という名前に変更しました。古い名前も使えますが、非推奨の警告が表示され、新しい名前への移行を求められます。できるだけ早く新しい名前の使用を開始されることをお勧めします。このトピックでは、非推奨の sfdx と新しい sf の両方の名前を示します。

重要

現在のプロジェクトの設定値を設定するには、次のようにします。

1sfdx config:set name=<value>
2sf config set name=<value>

ローカル設定値の場合、Salesforce DX プロジェクトディレクトリ内からこのコマンドを発行する必要があります。

すべてのプロジェクトの値を設定するには、次のようにします。

1sfdx config:set name=<value> --global
2sf config set name=<value> --global

グローバルコマンドは、任意の場所やプロジェクト内で発行できますが、実行するすべての Salesforce CLI コマンドに適用されます。

設定したローカルおよびグローバル設定値を表示できます。出力には、コマンドを実行するプロジェクトディレクトリのローカル値とすべてのグローバル値がリストされます。

1sfdx config:list
2sf config list

1List Config
2==========================================================
3| Name                Value                       Location 
4| ─────────────────── ─────────────────────────── ──────── 
5| org-instance-url    https://test.salesforce.com Local    
6| org-max-query-limit 20000                       Local    
7| target-dev-hub      DevHub                      Local

以前に設定した 1 つ以上の設定値を返すには、config get を使用します。通常、これは継続的インテグレーション (CI) 環境で簡単に解析できるようにこのコマンドの JSON 出力を指定する場合に役立ちます。たとえば、defaultusername (target-org) および defaultdevhubusername (target-dev-hub) の値を返すには、次のようにします。

1sfdx config:get defaultusername defaultdevhubusername --json
2sf config get target-org target-dev-hub --json

設定値を解除するには、config unset コマンドを実行します。たとえば、instanceUrl (org-instance-url) 設定値の設定を解除するには、次のようにします。

1sfdx config:unset instanceUrl
2sf config unset org-instance-url

または、すべての CLI 設定値を環境変数として設定することもできます。境変数で設定値が上書きされます。

メモ

次の CLI 設定値を設定できます。

apiVersion (sfdx)、org-api-version (sf)

特定のプロジェクトまたはすべてのプロジェクトの API バージョン。通常、CLI では、Dev Hub 組織と同じバージョンの CLI を使用していることを前提としています。

この例では、すべてのプロジェクトの API バージョンを (グローバルに) 51.0 に設定します。

1sfdx config:set apiVersion=57.0 --global
2sf config set org-api-version=57.0 --global

この CLI 設定値を同じような名前の sourceApiVersion プロジェクト設定値と混同しないようにしてください。

環境変数: SFDX_API_VERSION (sfdx)、SF_ORG_API_VERSION (sf)

1SFDX_API_VERSION=57.0

customOrgMetadataTemplates (sfdx)、org-custom-metadata-templates (sf)

force:project:create コマンドで使用されるデフォルトのカスタムコードテンプレートを含むローカルディレクトリまたはコピーされた GitHub リポジトリを指定します。GitHub URL は、テンプレートを含むルートディレクトリ、またはテンプレートを含むリポジトリのブランチ上のサブディレクトリを指します。次に例を示します。

1sfdx config:set customOrgMetadataTemplates=https://github.com/mygithubacct/salesforcedx-templates
2sf config set org-custom-metadata-templates=https://github.com/mygithubacct/salesforcedx-templates

環境変数: SFDX_CUSTOM_ORG_METADATA_TEMPLATES (sfdx)、SF_ORG_CUSTOM_METADATA_TEMPLATES (sf)

1SFDX_CUSTOM_ORG_METADATA_TEMPLATES=https://github.com/mygithubacct/salesforcedx-templates

defaultusername (sfdx)、target-org (sf)

デフォルトですべてのコマンドが実行される組織のユーザ名。

1sfdx config:set defaultusername=test-scratch-org@example.com
2sf config set target-org=test-scratch-org@example.com

環境変数: SFDX_DEFAULTUSERNAME (sfdx)、SF_TARGET_ORG (sf)

1SFDX_DEFAULTUSERNAME=test-scratch-org@example.com

defaultdevhubusername (sfdx)、target-dev-hub (sf)

デフォルトの Dev Hub 組織のユーザ名。

1sfdx config:set defaultdevhubusername=my-dev-hub@devhub.org
2sf config set target-dev-hub=my-dev-hub@devhub.org

環境変数: SFDX_DEFAULTDEVHUBUSERNAME (sfdx)、SF_TARGET_DEV_HUB (sf)

1SFDX_DEFAULTDEVHUBUSERNAME=my-dev-hub@devhub.org

disableTelemetry (sfdx)、disable-telemetry (sf)

デフォルトでは、CLI は使用状況情報、ユーザ環境情報、クラッシュレポートを収集します。このオプションにより、オプトアウトが可能です。

1sfdx config:set disableTelemetry=true
2sf config set disable-telemetry=true

環境変数: SFDX_DISABLE_TELEMETRY (sfdx)、SF_DISABLE_TELEMETRY (sf)

instanceUrl (sfdx)、org-instance-url (sf)

組織をホストしている Salesforce インスタンスの URL。デフォルト値は、https://login.salesforce.com です。この値は、組織の [私のドメイン] ログイン URL に設定することをお勧めします。[私のドメイン] ログイン URL は、[設定] の [私のドメイン] ページで確認できます。

1sfdx config:set instanceUrl=https://yoda.my.salesforce.com
2sf config set org-instance-url=https://yoda.my.salesforce.com

環境変数: SFDX_INSTANCE_URL (sfdx)、SF_ORG_INSTANCE_URL (sf)

1SFDX_INSTANCE_URL=https://yoda.my.salesforce.com

maxQueryLimit (sfdx)、org-max-query-limit (sf)

CLI コマンドで返される Salesforce レコードの最大数。デフォルト値は 10,000 です。

たとえば、sfdx force:mdapi:listmetadata -m Role を実行した Salesforce 組織にロールが 15,000 あったとします。デフォルトではコマンドで表示されるロールは 10,000 のみです。この場合、警告メッセージが表示され、コマンドで取得されたロールが一部のみであることが示されます。すべてのロールを表示するには、この設定値を大きくしてください。

1sfdx config:set maxQueryLimit=20000
2sf config set org-max-query-limit=20000

環境変数: SFDX_MAX_QUERY_LIMIT (sfdx)、SF_ORG_MAX_QUERY_LIMIT (sf)

1SFDX_MAX_QUERY_LIMIT=200000

restDeploy (sfdx)、org-metadata-rest-deploy (sf)

true であれば、CLI はリリース用のメタデータ REST API を使用します。デフォルトでは、Salesforce CLI は SOAP を使用します。REST を使用したリリースは、SOAP リリースに適用される 39 MB の .zip ファイルサイズ制限に制約されません。

1sfdx config:set restDeploy=true
2sf config set org-metadata-rest-deploy=true

環境変数: SFDX_REST_DEPLOY (sfdx)、SF_ORG_METADATA_REST_DEPLOY (sf)

Salesforce CLI 設定ガイド

CLI ランタイム設定値

関連項目: