Salesforce DX 開発者ガイド
j環境変数
環境変数を設定して、Salesforce CLI および Salesforce DX ツールで使用する特定の値を設定できます。
Salesforce CLI 環境変数
環境変数で CLI ランタイム設定値が上書きされます。実行しているコマンドのみに対して環境変数を設定するには、次のように変数を追加します。
1SFDX_API_VERSION=44.0 sfdx force:org:create -<options>| 環境変数 | 説明 |
|---|---|
| FORCE_OPEN_URL |
force:org:open を実行したときにブラウザで開く Web ページを指定します。たとえば、Lightning Experience を開くには lightning に設定します。 force:org:open の --path パラメータに相当します。 |
| FORCE_SHOW_SPINNER | 非同期 CLI コマンドの実行中にコマンドラインにスピナーアニメーションを表示するには、true に設定します。デフォルトは false です。 |
| FORCE_SPINNER_DELAY | スピナーの速度をミリ秒単位で指定します。デフォルトは 60 です。 |
| SFDX_API_VERSION | 特定のプロジェクトまたはすべてのプロジェクトの API バージョン。通常、Salesforce CLI では、本番組織と同じバージョンの CLI を使用していることを前提としています。ただし、プレリリースバージョン (Summer '18 の v43) の CLI を使用することを決定したが、本番組織では現在の API バージョン (Spring '18 の v42) が実行されている場合、本番組織の API バージョン (v42) に合わせてこの値を設定します。 |
| SFDX_CODE_COVERAGE_REQUIREMENT |
force:apex:test:run または force:apex:test:report に --codecoverage パラメータを指定して実行したとき、緑で表示されるコードカバー率を指定します。 Apex テストのコードカバー率がこの設定以上の場合、緑で表示されます。この値未満の場合、赤で表示されます。人間が読み取り可能な出力にのみ適用されます。デフォルトは 70% です。 |
| SFDX_CONTENT_TYPE | JSON 形式のすべての CLI コマンド出力結果。 |
| SFDX_DEFAULTUSERNAME | デフォルト組織のユーザ名を指定します。指定すると --targetusername CLI パラメータを使用する必要がなくなります。defaultusername ランタイム設定値の値を上書きします。 |
| SFDX_DISABLE_AUTOUPDATE または SFDX_AUTOUPDATE_DISABLE (いずれかの変数が機能します) | CLI の自動更新機能を無効にする場合、true に設定します。デフォルトでは、CLI が定期的に更新を確認してインストールします。 |
| SFDX_DISABLE_TELEMETRY | CLI による使用状況情報、ユーザ環境情報、クラッシュレポートの収集を無効にする場合、true に設定します。 |
| SFDX_DOMAIN_RETRY |
Lightning Experience カスタムドメインが解決されて、新しく作成されたスクラッチ組織で使用できるようになるまで CLI が待機する秒数を指定します。 デフォルト値は 240 (4 分) です。変数を 0 に設定すると、Lightning Experience カスタムドメインのチェックが完全にスキップされます。 |
| SFDX_IMPROVED_CODE_COVERAGE | force:apex:test:run と force:apex:test:report を実行する場合、Apex テスト結果の範囲を、テスト実行時に入力されたクラスに設定します。コードカバー率を向上させるには、true に設定します。 |
| SFDX_JSON_TO_STDOUT | Salesforce CLI コマンドが失敗した場合のメッセージを stderr ではなく stdout に送信します。スクリプ���の使用事例では、この環境変数を true に設定することが役立ちます。 例: |
| SFDX_LOG_LEVEL | CLI がログファイルに書き込むメッセージのレベル。 |
| SFDX_MDAPI_TEMP_DIR |
force:source:<name> など、一部の CLI コマンドが実行されると、ファイルを (メタデータ形式で) 指定されたディレクトリに置きます。これらのファイルを保持しておくと、いくつかの理由で便利です。コマンド実行時に発生した問題をデバッグできます。生成される package.xml を後続のコマンド実行時に使用できます。または、必要なすべてのメタデータが含まれるマニフェストを作成するための開始点として使用できます。 |
| SFDX_NPM_REGISTRY | 公開するすべてのパッケージが非公開になる、非公開 npm サーバへの URL を設定します。認証を必要としないリポジトリのみがサポートされます。例: たとえば、Verdaccio は軽量な非公開 npm プロキシレジストリです。 |
| SFDX_PRECOMPILE_ENABLE | テスト実行前の Apex プリコンパイルを有効にするには、true に設定します。この変数は、force:apex:test:run コマンドで機能します。デフォルトは false です。 |
| SFDX_PROJECT_AUTOUPDATE_DISABLE_FOR_PACKAGE_CREATE | force:package:create で、sfdx-project.json ファイルへの自動更新を無効にします。 |
| SFDX_PROJECT_AUTOUPDATE_DISABLE_FOR_PACKAGE_VERSION_CREATE | force:package:version:create で、sfdx-project.json ファイルへの自動更新を無効にします。 |
| SFDX_USE_GENERIC_UNIX_KEYCHAIN | (Linux と macOS のみ) Linux libsecret ライブラリまたは macOS キーチェーンではなく汎用 UNIX キーチェーンを使用する場合、true に設定します。CI 環境で ssh または「headless」と共に CLI を使用する場合、この変数を指定します。 |
| SFDX_USE_PROGRESS_BAR |
force:mdapi:deploy、force:source:deploy、force:source:push では false に設定して進行状況バーを無効にします。 例: グローバルに設定する場合: SFDX_USE_PROGRESS_BAR=false。 単一のコマンドに対して指定する場合: SFDX_USE_PROGRESS_BAR=false sfdx force:source:deploy。 |
一般的な環境変数
| 環境変数 | 説明 |
|---|---|
| HTTP_PROXY | ファイアウォールまたは Web プロキシの背後にあるコンピュータに Salesforce CLI をインストールしたり更新したりするときにエラーが発生する場合、この環境変数を設定します。次のように会社の URL とポートを使用します。 |
| HTTPS_PROXY | ファイアウォールまたは Web プロキシの背後にあるコンピュータに Salesforce CLI をインストールしたり更新したりするときにエラーが発生する場合、この環境変数を設定します。次のように会社の URL とポートを使用します。 |
| NODE_EXTRA_CA_CERTS | 自己署名証明書をインストールします。証明書ファイル名への完全修飾パスを指定します。次に sfdx update を実行します。 詳細は、NODE_EXTRA_CA_CERTS=file を参照してください。 |
| NODE_TLS_REJECT_UNAUTHORIZED | Node.js が証明書チェーンで自己署名証明書を使用できるようにするには、0 を指定します。 |