環境変数

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

1SF_ORG_API_VERSION=54.0 sf retrieve metadata --metadata ApexClass

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_CONTENT_TYPE

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

例:

1SF_CONTENT_TYPE=JSON

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

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

SF_DISABLE_SOURCE_MEMBER_POLLING

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

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

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

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

警告

SF_DISABLE_TELEMETRY

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

SF_DNS_TIMEOUT

組織が接続されているかどうかを確認するときに env create コマンドが応答を待機する秒数を指定します。コマンドがその時間内に応答を受信しない場合は、タイムアウトになります。デフォルト値は 3 です。

SF_DOMAIN_RETRY

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

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

SF_LOG_LEVEL

Salesforce 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

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

1SF_MDAPI_TEMP_DIR=/users/myName/myDXProject/metadata

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_CUSTOM_METADATA_TEMPLATES

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

例:

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

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 を使用します。デフォルトでは、CLI が SOAP を使用します。REST を使用したリリースは、SOAP リリースに適用される 39 MB の .zip ファイルサイズ制限に制約されません。

SF_SOURCE_MEMBER_POLLING_TIMEOUT

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

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

1SF_SOURCE_MEMBER_POLLING_TIMEOUT=300

SF_TARGET_DEV_HUB

デフォルトの Dev Hub 組織のユーザ名または別名を指定します。指定すると --target-dev-hub CLI フラグを使用する必要がなくなります。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_PROGRESS_BAR

false に設定すると、sf deploy metadata コマンドの進行状況バーが無効になります。

例:

1SF_USE_PROGRESS_BAR=false