この文章は Salesforce 機械翻訳システムを使用して翻訳されました。詳細はこちらをご参照ください。

設定変数

現在のプロジェクトまたはすべてのプロジェクトの設定 (config) 変数を設定できます。グローバルとローカルの 2 種類の config 変数を設定できます。グローバル config 変数は、コンピューターのすべてのプロジェクトに適用されます。ローカル config 変数は、特定のプロジェクトに適用されます。Salesforce DX プロジェクトディレクトリ内からコマンドが実行されると、ローカル config 変数によってグローバル config 変数が上書きされます。

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

1sf config set name <value>

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

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

1sf config set name <value> --global

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

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

1sf config list

1List Config
2==========================================================
3| Name                Value                       Location 
4| ─────────────────── ─────────────────────────── ──────── 
5| org-instance-url    https://test.salesforce.com Local    
6| org-max-query-limit 20000                       Local    
7| target-dev-hub      DevHub                      Local

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

1sf config get target-org target-dev-hub --json

config 変数の設定を解除するには、config unset コマンドを実行します。たとえば、org-instance-url config 変数の設定を解除するには、次のようにします。

1sf config unset org-instance-url

また、すべての CLI の config 変数を環境変数として設定することもできます。環境変数は config 変数を上書きします。

メモ

設定変数のリスト

org-api-version

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

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

1sf config set org-api-version 57.0 --global

この config 変数を同じような名前の sourceApiVersion プロジェクトオプションと混同しないようにしてください。詳細は、「Salesforce CLI の API バージョンとソース API バージョンのしくみ」を参照してください。

環境変数: SF_ORG_API_VERSION

1SF_ORG_API_VERSION=57.0

org-custom-metadata-templates

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

1sf config set org-custom-metadata-templates https://github.com/mygithubacct/salesforcedx-templates

環境変数: SF_ORG_CUSTOM_METADATA_TEMPLATES

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

target-org

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

1sf config set target-org test-scratch-org@example.com

環境変数: SF_TARGET_ORG

1SF_TARGET_ORG=test-scratch-org@example.com

target-dev-hub

デフォルトの Dev Hub 組織のユーザー名または別名。

1sf config set target-dev-hub my-dev-hub@devhub.org

環境変数: SF_TARGET_DEV_HUB

1SF_TARGET_DEV_HUB=my-dev-hub@devhub.org

target-devops-center (DevOps Center コマンドのみ)

DevOps Center がインストールされている組織のユーザー名または別名。

1sf config set target-devops-center myDevOpsCenterOrg@example.com

disable-telemetry

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

1sf config set disable-telemetry true

環境変数: SF_DISABLE_TELEMETRY

org-instance-url

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

1sf config set org-instance-url https://yoda.my.salesforce.com

環境変数: SF_ORG_INSTANCE_URL

1SF_ORG_INSTANCE_URL=https://yoda.my.salesforce.com

org-max-query-limit

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

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

1sf config set org-max-query-limit 20000

環境変数: SF_ORG_MAX_QUERY_LIMIT

1SF_ORG_MAX_QUERY_LIMIT=200000

org-metadata-rest-deploy

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

1sf config set org-metadata-rest-deploy true

環境変数: SF_ORG_METADATA_REST_DEPLOY

Salesforce CLI 設定ガイド

設定変数

設定変数のリスト

関連項目: