CLI ランタイム設定値
現在のプロジェクトの設定値を設定するには、次のようにします。
1sfdx config:set name=<value>ローカル設定値の場合、Salesforce DX プロジェクトディレクトリ内からこのコマンドを発行する必要があります。
すべてのプロジェクトの値を設定するには、次のようにします。
1sfdx config:set name=<value> --globalグローバルコマンドは、任意の場所やプロジェクト内で発行できますが、実行するすべての Salesforce CLI コマンドに適用されます。
設定したローカルおよびグローバル設定値を表示できます。出力には、コマンドを実行するプロジェクトディレクトリのローカル値とすべてのグローバル値がリストされます。
1sfdx config:list1=== Config
2Name Value Location
3───────────────────── ───────────────────── ────────
4apiVersion 50.0 Local
5defaultdevhubusername my-dev-hub@force.com Global以前に設定した 1 つ以上の設定値を返すには、config:get を使用します。通常、これは継続的インテグレーション (CI) 環境で簡単に解析できるようにこのコマンドの JSON 出力を指定する場合に役立ちます。たとえば、defaultusername および defaultdevhubusername の値を返すには、次のようにします。
1sfdx config:get defaultusername defaultdevhubusername --json設定値の設定を解除するには、config:unset コマンドを実行します。たとえば、instanceUrl 設定値の設定を解除するには、次のようにします。
1sfdx config:unset instanceUrl次の CLI 設定値を設定できます。
- apiVersion
- 特定のプロジェクトまたはすべてのプロジェクトの API バージョン。通常、CLI では、Dev Hub 組織と同じバージョンの CLI を使用していることを前提としています。
プレリリースバージョン (Summer '18 の v43) の CLI を使用することを決定したとします。一方、Dev Hub 組織では現在の API バージョン (Spring '18 の v42) が実行されているとします。この場合は、Dev Hub 組織の API バージョン (v42) に合わせてこの値を設定します。
この例では、すべてのプロジェクトの API バージョンを (グローバルに) 設定します。1sfdx config:set apiVersion=42.0 --globalこの CLI 設定値を同じような名前の sourceApiVersion プロジェクト設定値と混同しないようにしてください。
環境変数: SFDX_API_VERSION
1SFDX_API_VERSION=42.0 - defaultusername
- デフォルトですべてのコマンドが実行される組織のユーザ名。
1sfdx config:set defaultusername=test-scratch-org@example.com環境変数: SFDX_DEFAULTUSERNAME
1SFDX_DEFAULTUSERNAME=test-scratch-org@example.com - defaultdevhubusername
- デフォルトの Dev Hub 組織のユーザ名。
1sfdx config:set defaultdevhubusername=my-dev-hub@devhub.org環境変数: SFDX_DEFAULTDEVHUBUSERNAME
1SFDX_DEFAULTDEVHUBUSERNAME=my-dev-hub@devhub.org - disableTelemetry
- デフォルトでは、CLI は使用状況情報、ユーザ環境情報、クラッシュレポートを収集します。このオプションにより、オプトアウトが可能です。
1sfdx config:set disableTelemetry=true環境変数: SFDX_DISABLE_TELEMETRY
- instanceUrl
- 組織をホストしている Salesforce インスタンスの URL。デフォルト値は、https://login.salesforce.com です。
1sfdx config:set instanceUrl=https://yoda.my.salesforce.com環境変数: SFDX_INSTANCE_URL
1SFDX_INSTANCE_URL=https://yoda.my.salesforce.com - maxQueryLimit
- CLI コマンドで返される Salesforce レコードの最大数。デフォルト値は 10,000 です。
たとえば、sfdx force:mdapi:listmetadata -m Role を実行した Salesforce 組織にロールが 15,000 あったとします。デフォルトではコマンドで表示されるロールは 10,000 のみです。この場合、警告メッセージが表示され、コマンドで取得されたロールが一部のみであることが示されます。すべてのロールを表示するには、この設定値を大きくしてください。
1sfdx config:set maxQueryLimit=20000環境変数: SFDX_MAX_QUERY_LIMIT
1SFDX_MAX_QUERY_LIMIT=200000
- restDeploy
-
true であれば、CLI はリリース用のメタデータ REST API を使用します。デフォルトでは、Salesforce CLI は SOAP を使用します。REST を使用したリリースは、SOAP リリースに適用される 39 MB の .zip ファイルサイズ制限に制約されません。
1sfdx config:set restDeploy=true環境変数: SFDX_REST_DEPLOY
1SFDX_REST_DEPLOY=true