CLI ランタイム設定値

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

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

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

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

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

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

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

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

apiVersion

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

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

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

環境変数: SFDX_API_VERSION

customOrgMetadataTemplates

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

環境変数: SFDX_CUSTOM_ORG_METADATA_TEMPLATES

defaultusername

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

環境変数: SFDX_DEFAULTUSERNAME

defaultdevhubusername

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

環境変数: SFDX_DEFAULTDEVHUBUSERNAME

disableTelemetry

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

環境変数: SFDX_DISABLE_TELEMETRY

instanceUrl

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

環境変数: SFDX_INSTANCE_URL

maxQueryLimit

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

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

環境変数: SFDX_MAX_QUERY_LIMIT

restDeploy

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

環境変数: SFDX_REST_DEPLOY