環境変数

Salesforce CLI 環境変数

環境変数は設定変数を上書きします。実行しているコマンドのみに対して環境変数を設定するには、変数を追加します。

1SF_ORG_API_VERSION=57.0 sf org create scratch -<options>

FORCE_OPEN_URL

org open を実行したときにブラウザーで開く Web ページを指定します。たとえば、Lightning Experience を開くには lightning に設定します。

org open の --path フラグに相当します。

FORCE_SHOW_SPINNER

非同期 CLI コマンドの実行中にコマンドラインにスピナーアニメーションを表示するには、true に設定します。デフォルトは false です。

FORCE_SPINNER_DELAY

スピナーの速度をミリ秒単位で指定します。デフォルト値は 60 です。

SF_ACCESS_TOKEN

org login access-token コマンドを使用するときにアクセストークンを指定します。この環境変数を設定しない場合、このコマンドでアクセストークンの入力が求められます。継続的インテグレーション (CI) スクリプトを使用する場合に役立ちます。

SF_APPLY_REPLACEMENTS_ON_CONVERT

実際にファイルを組織にリリースせずに文字列置換をテストするには、true に設定します。ファイルをメタデータ API 形式に変換し、そのファイルのリリースされる内容を検査するには、代わりに project convert source を実行します。

詳細は、「リリース前のコードの文字列の置換」を参照してください。

SF_AUDIENCE_URL

JWT 認証に使用される [aud] (audience) 項目を上書きし、ログインしている組織の認証サーバー URL の期待される値に一致するようにします。たとえば、本番組織の場合は https://MyDomainName.my.salesforce.com または https://login.salesforce.com、Sandbox の場合は https://MyDomainName--SandboxName.sandbox.my.salesforce.com または https://test.salesforce.com です。

例:

1SF_AUDIENCE_URL=https://MyDomainName.my.salesforce.com

SF_CODE_COVERAGE_REQUIREMENT

apex run test または apex get test に --code-coverage フラグを指定して実行したときに、緑で表示されるコードカバー率を指定します。

Apex テストのコードカバー率がこの設定以上の場合、緑で表示されます。この値未満の場合、赤で表示されます。この環境変数は、人間が読み取り可能な出力にのみ適用されます。デフォルト値は 70% です。

例:

1SF_CODE_COVERAGE_REQUIREMENT=75

SF_CONTAINER_MODE

true に設定されている場合、org open または org login web など、通常はブラウザーで組織を開くコマンドは、ブラウザーで組織を開く代わりに組織の URL を出力します。false (デフォルト値) に設定されている場合は、これらのコマンドはブラウザーで組織を開きます。

この環境変数は、Docker や継続的インテグレーションのようなヘッドレス環境で便利です。

SF_CONTENT_TYPE

JSON に設定した場合、すべての CLI コマンドは JSON 形式の結果を出力することを示します。環境変数を他の値に設定するか、その設定を解除した場合、CLI コマンドはフラグで指定された結果を出力します。

例:

1SF_CONTENT_TYPE=JSON

SF_CUSTOM_ORG_METADATA_TEMPLATES

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

例:

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

SF_DISABLE_AUTOUPDATE または SF_AUTOUPDATE_DISABLE (いずれかの変数が機能します)

CLI の自動更新機能を無効にする場合、true に設定します。デフォルトでは、CLI が定期的に更新を確認してインストールします。

SF_DISABLE_DNS_CHECK

true に設定されている場合は、組織が接続されているかどうかを確認するよう組織に要求する Salesforce CLI コマンドを停止します。たとえば、org create scratch コマンドは Dev Hub 組織に要求します。デフォルト値は false です (常に確認)。

この環境変数は、特定の Salesforce CLI コマ��ドの実行中にこのエラーが発生した場合に役立ちます。

1DomainNotFound: The org cannot be found

まず、Salesforce CLI の応答待機時間 (秒) が長くなるように SF_DNS_TIMEOUT 環境変数を設定します。うまくいかなかった場合は、SF_DISABLE_DNS_CHECK 環境変数を使用して、確認を完全に無効にします。

SF_DISABLE_SOURCE_MEMBER_POLLING

project deploy|retrieve コマンドの実行時に組織の SourceMember オブジェクトのポーリングを無効にするには、true に設定します。

このコマンドは、SourceMember オブジェクトをポーリングして、リリースまたは取得の完了後のローカルソースと組織間の変化を追跡します。ただし、メタデータのリリースの規模が大きい場合は、ポーリングに時間がかかることがあり、タイムアウトになることもあります。継続的インテグレーション (CI) ジョブの場合のように、ソースの追跡がまったく不要なこともあります。これらの使用事例は、この環境変数を設定するのに適しています。

この環境変数は、スクラッチ組織と Sandbox の両方で機能します。

SourceMember のポーリングを無効にすると、ローカルソースと組織メタデータ間の変化に対する CLI の内部追跡が同期されなくなります。このため、それ以降 project deploy|retrieve コマンドを実行しても、信頼性がなくなり、ソースの同期を自分の責任で行うことになります。ソースの追跡をリセットするには、project reset tracking コマンドを使用します。

警告

SF_DISABLE_TELEMETRY

CLI による使用状況情報、ユーザー環境情報、クラッシュレポートの収集を無効にする場合、true に設定します。

SF_DNS_TIMEOUT

組織が接続されているかどうかを確認するときに、Salesforce CLI コマンドが応答を待機するよう組織に要求する時間 (秒) を指定します。たとえば、org create scratch コマンドは Dev Hub 組織に要求します。コマンドがその時間内に応答を受信しない場合は、タイムアウトになります。デフォルト値は 3 です。

この環境変数は、特定の Salesforce CLI コマンドの実行中にこのエラーが発生した場合に役立ちます。

1DomainNotFound: The org cannot be found

まず、Salesforce CLI の応答待機時間 (秒) が長くなるように SF_DNS_TIMEOUT 環境変数を設定します。うまくいかなかった場合は、SF_DISABLE_DNS_CHECK 環境変数を使用して、確認を完全に無効にします。

SF_DOMAIN_RETRY

Lightning Experience カスタムドメインが解決されて、新しく作成されたスクラッチ組織で使用できるようになるまで CLI が待機する秒数を指定します。

デフォルト値は 240 (4 分) です。変数を 0 に設定すると、Lightning Experience カスタムドメインのチェックが完全にスキップされます。

SF_HIDE_RELEASE_NOTES

true に設定すると、sf update を実行したときにリリースノートが自動的に表示されなくなります。デフォルト値は false です。

例:

1SF_HIDE_RELEASE_NOTES=true

SF_HIDE_RELEASE_NOTES_FOOTER

true に設定すると、sf update を実行したときにリリースノートの表示に関する定型のフッターが表示されなくなります。デフォルト値は false です。

例:

1SF_HIDE_RELEASE_NOTES_FOOTER=true

SF_IMPROVED_CODE_COVERAGE

apex run test と apex get test を実行する場合、Apex テスト結果の範囲を、テスト実行時に入力されたクラスに設定します。コードカバー率を向上させるには、true に設定します。

SF_JSON_TO_STDOUT

Salesforce CLI コマンドが失敗した場合のメッセージを stderr ではなく stdout に送信します。スクリプトの使用事例では、この環境変数を true に設定することが役立ちます。

例:

1SF_JSON_TO_STDOUT=true

SF_LOG_LEVEL

CLI がログファイルに書き込むメッセージのレベル。

例:

1SF_LOG_LEVEL=debug

SF_LOG_ROTATION_PERIOD

Salesforce CLI がログファイルの循環を開始するまでの期間。ログファイルの循環とは、ログファイルのバックアップコピーを作成してから、現在のログファイルを消去してログを再開することを意味します。たとえば、1d に設定した場合、Salesforce CLI はログファイルを毎日深夜に循環します。2w に設定した場合、ファイルは 2 週間ごとに循環されます。他の期間のオプションについては、この表の period エントリを参照してください。デフォルト値は 1d です。

例:

1SF_LOG_ROTATION_PERIOD=2w

SF_LOG_ROTATION_COUNT

ログファイルを循環するときに保持するバックアップファイルの数。デフォルト値は、2 です。詳細は、「SF_LOG_ROTATION_PERIOD」を参照してください。

例:

1SF_LOG_ROTATION_COUNT=10

SF_MDAPI_TEMP_DIR

project retrieve start など、一部の CLI コマンドが実行されると、ファイルを (メタデータ形式で) 指定されたディレクトリに置きます。これらのファイルを保持しておくと、いくつかの理由で便利です。コマンド実行時に発生した問題をデバッグできます。生成される package.xml を後続のコマンド実行時に使用できます。または、必要なすべてのメタデータが含まれるマニフェストを作成するための開始点として使用できます。

1SF_MDAPI_TEMP_DIR=/users/myName/myDXProject/metadata

SF_NEW_VERSION_CHECK_FREQ

新しい Salesforce CLI バージョンが利用できることを通知する警告メッセージの表示頻度を指定する数値。デフォルトでは、CLI コマンドを実行するたびに新しい Salesforce CLI バージョンの有無が確認され、新しいバージョンがあれば警告メッセージが表示されます。この環境変数を SF_NEW_VERSION_CHECK_FREQ_UNIT と一緒に使用して、メッセージの表示頻度を変更します。バージョンの確認を完全に無効にするには、SF_SKIP_NEW_VERSION_CHECK を使用します。

デフォルト値は 0 で、新しいバージョンが見つかるたびに警告メッセージが表示されます。

たとえば、警告メッセージの表示頻度を 1 日 1 回に設定するには、次のように指定します。

1SF_NEW_VERSION_CHECK_FREQ=1
2SF_NEW_VERSION_CHECK_FREQ_UNIT=days

SF_NEW_VERSION_CHECK_FREQ_UNIT

新しい Salesforce CLI バージョンが利用できることを通知する警告メッセージの表示頻度の時間単位。デフォルトでは、CLI コマンドを実行するたびに新しい Salesforce CLI バージョンの有無が確認され、新しいバージョンがあれば警告メッセージが表示されます。この環境変数を SF_NEW_VERSION_CHECK_FREQ と一緒に使用して、メッセージの表示頻度を変更します。バージョンの確認を完全に無効にするには、SF_SKIP_NEW_VERSION_CHECK を使用します。

可能な値は、days、hours、minutes、seconds、milliseconds です。デフォルト値は minutes です。

たとえば、警告メッセージの表示頻度を 1 日 1 回に設定するには、次のように指定します。

1SF_NEW_VERSION_CHECK_FREQ=1
2SF_NEW_VERSION_CHECK_FREQ_UNIT=days

SF_NETWORK_MUTEX_PORT

SF_USE_NETWORK_MUTEX を true に設定して Salesforce CLI のインストール時または更新時に yarn --mutex network オプションを有効にする場合に、ローカルネットワークサーバーのポートを指定します。

この環境変数は、SF_USE_NETWORK_MUTEX を併せて設定する場合にのみ有効です。デフォルト値は 31997 です。

SF_NPM_REGISTRY

公開するすべてのパッケージが非公開になる、非公開 npm サーバーへの URL を設定します。認証を必要としないリポジトリのみがサポートされます。

例:

1SF_NPM_REGISTRY=http://mypkgs.myclient.com/npm/my_npm_pkg

たとえば、Verdaccio は軽量な非公開 npm プロキシレジストリです。

SF_ORG_API_VERSION

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

SF_ORG_INSTANCE_URL

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

SF_ORG_MAX_QUERY_LIMIT

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

例:

1SF_ORG_MAX_QUERY_LIMIT=200000

SF_ORG_METADATA_REST_DEPLOY

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

SF_PRECOMPILE_ENABLE

テスト実行前の Apex プリコンパイルを有効にするには、true に設定します。この変数は、apex run test コマンドで機能します。デフォルトは false です。

Apex テストのプリコンパイル所要時間に差が出ることがあります。その結果、同じ Apex テストの実行がすぐに終わるときも、タイムアウトするときもあります。この変数を true に設定するのは、Apex テスト (プリコンパイルなし) で、多くのシステムリソースを消費する複数の同時 Apex コンパイルを有効にする場合のみにすることをお勧めします。

重要

SF_PROJECT_AUTOUPDATE_DISABLE_FOR_PACKAGE_CREATE

package create で、sfdx-project.json ファイルへの自動更新を無効にします。

SF_PROJECT_AUTOUPDATE_DISABLE_FOR_PACKAGE_VERSION_CREATE

package version create で、sfdx-project.json ファイルへの自動更新を無効にします。

SF_SKIP_NEW_VERSION_CHECK

true に設定すると、Salesforce CLI の新しいバージョンが確認されなくなります。デフォルトでは、CLI コマンドを実行するたびに新しい Salesforce CLI バージョンの有無が確認され、新しいバージョンがあれば警告メッセージが表示されます。このメッセージは役に立つものの、特に継続的インテグレーション (CI) 環境では不要なこともあります。デフォルトは false です。

新しい CLI バージョンの確認を継続しながら、警告メッセージの表示頻度を変更するには、環境変数の SF_NEW_VERSION_CHECK_FREQ と SF_NEW_VERSION_CHECK_FREQ_UNIT を使用してください。

SF_SOURCE_MEMBER_POLLING_TIMEOUT

project deploy start コマンドが SourceMember オブジェクトをポーリングする時間 (秒) を設定します。この時間を過ぎると、コマンドはタイムアウトになります。project deploy start コマンドは、SourceMember オブジェクトをポーリングして、リリース完了後のローカルソースと組織間の変化を追跡します。Salesforce CLI は、project deploy start コマンドを実行するたびに、リリースするコンポーネント数に基づいてタイムアウトを計算します。この環境変数は、計算されたタイムアウトを上書きする場合に使用します。

たとえば、リリースが 3 分後にタイムアウトになる場合は、5 分 (300 秒) をタイムアウトに設定してみてください。

1SF_SOURCE_MEMBER_POLLING_TIMEOUT=300

SF_SOURCE_TRACKING_BATCH_SIZE

リリースまたは取得時にソースが追跡されるファイルのバッチサイズを設定します。デフォルト値は 8,000 (Windows) または 15,000 (Linux/macOS) です。

この環境変数は、リリースまたは取得する大規模なプロジェクトに、ソースが追跡されるファイルが多数含まれている場合や、オペレーティングシステムのオープンファイルの上限を超える場合に便利です。この場合でも、リリースや取得はたいてい正常に完了しますが、ソース追跡でエラーが発生することがあります。ulimit -Hn <number> コマンド (Linux/macOS) を使用するなどしてオープンファイルの上限を高くするか、または SF_SOURCE_TRACKING_BATCH_SIZE 環境変数を ulimit -Hn の出力より大幅に小さい数値に設定します。

SF_TARGET_DEV_HUB

デフォルトの Dev Hub 組織のユーザー名を指定します。これにより --target-dev-hub フラグを使用する必要がなくなります。target-dev-hub の設定値を上書きします。

別名に設定する例:

1SF_TARGET_DEV_HUB=myDevHub

組織名に設定する例:

1SF_TARGET_DEV_HUB=mydevhuborg@example.com

SF_TARGET_ORG

デフォルト組織のユーザー名を指定します。これにより --target-org フラグを使用する必要がなくなります。target-org 設定変数の値を上書きします。

別名に設定する例:

1SF_TARGET_ORG=myscratchorg

ユーザー名に設定する例:

1SF_TARGET_ORG=test-xhquykly9fhl@example.com

SF_USE_GENERIC_UNIX_KEYCHAIN

(Linux と macOS のみ) Linux libsecret ライブラリまたは macOS キーチェーンではなく汎用 UNIX キーチェーンを使用する場合、true に設定します。Salesforce CI 環境で ssh または「headless」と共に CLI を使用する場合、この変数を指定します。

SF_USE_NETWORK_MUTEX

true に設定すると、Salesforce CLI のインストール時または更新時に yarn --mutex network オプションが有効になります。デフォルト値は false です (--mutex file オプションが有効になります)。

Salesforce CLI プラグインのインストールでは、内部で yarn が使用されます。インストール時や更新時にエラーとなる場合は、この環境変数を true に設定してローカルネットワークを開き、yarn の同時インスタンスを管理します。この動作のほうが信頼性が高く、インストールエラーを解決できる場合があります。ローカルネットワークサーバーのデフォルトポートは 31997 です。別のポートを使用するには、SF_NETWORK_MUTEX_PORT 環境変数を設定します。

詳細は yarn のドキュメントを参照してください。

SF_USE_PROGRESS_BAR

project deploy start の場合に、進行状況バーを無効にするには、false に設定します。

例:

SF_USE_PROGRESS_BAR=false。

一般的な環境変数

HTTP_PROXY

ファイアウォールまたは Web プロキシの背後にあるコンピューターに Salesforce CLI をインストールしたり更新したりするときにエラーが発生する場合、この環境変数を設定します。次のように会社の URL とポートを使用します。

1http://username:pwd@proxy.company.com:8080

HTTPS_PROXY

ファイアウォールまたは Web プロキシの背後にあるコンピューターに Salesforce CLI をインストールしたり更新したりするときにエラーが発生する場合、この環境変数を設定します。次のように会社の URL とポートを使用します。

1http://username:pwd@proxy.company.com:8080

NODE_EXTRA_CA_CERTS

自己署名証明書をインストールします。証明書ファイル名への完全修飾パスを指定します。次に sf update を実行します。

詳細は、NODE_EXTRA_CA_CERTS=file を参照してください。

NODE_TLS_REJECT_UNAUTHORIZED

Node.js が証明書チェーンで自己署名証明書を使用できるようにするには、0 を指定します。