Salesforce CLI 設定ガイド
jSalesforce CLI のインストール
コンピューターにインストールする方法を 1 つ選択します。たとえば、.pkg ファイルと npm の両方で macOs にインストールしないでください。両方を使用してインストールすると、コンピューター上のパスが混乱することがあり、場合によっては、明確なエラーが表示されず、診断が困難になります。
macOS での CLI のインストール
- .pkg ファイルをダウンロードします。
- .pkg ファイルを Finder からダブルクリックするなどして実行し、すべてのプロンプトに回答します。
- インストールが完了したら、ターミナルウィンドウまたは IDE を再起動して、Salesforce CLI が使用可能であることを確認します。
Windows での CLI のインストール
- .exe ファイルをダウンロードします。
-
.exe ファイルを Windows Explorer からダブルクリックするなどして実行し、すべてのプロンプトに回答します。
(省略可能) Microsoft Defender ウイルス対策によるスキャン時に、インストールされている Salesforce CLI ファイルを除外したい場合は、[Choose Components (コンポーネントを選択)] ウィンドウで [Add %LOCALAPPDATA%\sf to Windows Defender exclusions (%LOCALAPPDATA%\sf を Windows Defender の除外リストに追加)] を選択します。デフォルトの Windows インストールのセキュリティを高めるため、このオプションは初期設定では選択解除されています。ですが、ウイルス対策スキャンから CLI ファイルを除外することで Salesforce CLI のパフォーマンスが高まるため、このオプションが用意されています。慎重に使用してください。
- インストールが完了したら、コマンドプロンプト、PowerShell ウィンドウ、または IDE を再起動して、Salesforce CLI が使用可能であることを確認します。
TAR ファイルを使用した CLI のインストール
下表に、オペレーティングシステム用の TAR ファイル (.tar.gz または .tar.xz) のバージョン設定されていない URL がリストされています。毎週 Salesforce CLI の新バージョンのリリース時に、この URL も最新バージョンを参照するように更新されます。CI の使用事例では特にバージョン設定されていない URL が役立ちます。同表には、各ファイルのバージョン設定されたマニフェスト URL も示されています。
| オペレーティングシステム | Tar ファイル | マニフェスト |
|---|---|---|
| Linux | ||
| macOS | ||
| Windows |
以下の例では、Salesforce CLI を Linux およびホームディレクトリの cli/sf サブディレクトリにインストールすることを想定しています。
- タイミングウィンドウを開きます。
-
上記のいずれかの TAR ファイルをダウンロードします。もしくは、ターミナルで wget を実行した TAR ファイルを取得します。
wget https://developer.salesforce.com/media/salesforce-cli/sf/channels/stable/sf-linux-x64.tar.xz -
Salesforce CLI をインストールするディレクトリを作成します。
mkdir ~/cli/sf -
TAR ファイルの内容を展開します。
tar xJf sf-linux-x64.tar.xz -C ~/cli/sf --strip-components 1-C は ~/cli/sf ディレクトリの内容を展開し、--strip-components 1 はルートパスのコンポーネントを削除します。
-
PATH 環境変数を更新して、Salesforce CLI の bin ディレクトリを含めます。たとえば、現在のターミナルセッションについては、次のとおり設定します。
export PATH=~/cli/sf/bin:$PATHPATH を永続的に更新するには、シェルの設定ファイルに適切なエントリを追加します。たとえば、Bash シェルを使用する場合、~/.bashrc または ~/.bash_profile ファイルに次の行を追加します。
PATH=~/cli/sf/bin:$PATH
npm を使用した CLI のインストール
このインストール方法は、ワークステーションに対する管理者権限がない場合や、グループポリシーによって CLI のインストールと更新がブロックされる場合に適切なオプションです。npm を使用した Salesforce CLI のインストールでは、ルート権限は必要ありません。
- ターミナル (macOS および Linux) またはコマンドプロンプト (Windows) を開きます。
-
Node.js の長期サポート (Active LTS) バージョンがコンピューターにインストールされていることを確認します。LTS バージョンをインストールするには、https://nodejs.org/en/download/ にアクセスします。バージョン番号を確認するには、ターミナルまたはコマンドプロンプトで次のコマンドを実行します。
node --version -
Salesforce CLI をインストールするには、次のコマンドを実行します。
npm install @salesforce/cli --globalmacOS または Linux で npm を使用して Salesforce CLI をインストールするときに権限エラーが発生する場合は、sudo の使用はお勧めしません。npm 権限の修正方法を参照してください。
Salesforce CLI の古いバージョンのインストール
インストーラー
インストーラーを使用して Salesforce CLI をインストールした場合は、--version フラグを使用して古いバージョンに更新してください。たとえば、バージョン 2.0.1 に更新するには、ターミナル (macOS または Linux) もしくはコマンドプロンプト (Windows) で次のコマンドを実行します。
sf update --version 2.0.1--available フラグによって、更新が可能なすべての旧バージョンを一覧表示できます。また、すでにローカルにコピーがあるかどうかや、ダウンロードが必要かどうかも表示されます。
sf update --available--interactive を使用することで、バージョンをインタラクティブに選択できます。
このコマンドを使用することで、現在のバージョンに戻ることができます。
sf update stablenpm
npm を使用して Salesforce CLI を古いバージョンで更新するには、@salesforce/cli パッケージ名の後に @<version> でバージョンを指定します。たとえば、バージョン 2.0.1 に更新するには、ターミナル (macOS または Linux) もしくはコマンドプロンプト (Windows) で次のコマンドを実行します。
npm install @salesforce/cli@2.0.1 --global現在のバージョンに戻すには、次のコマンドを実行します。
npm install @salesforce/cli --global全バージョンのリストについては、Salesforce CLI の npmjs.com のページを参照してください。Salesforce では、@salesforce/cli および sfdx-cli (廃止) npm パッケージのすべての古いバージョンを保管しています。
TAR ファイル
Salesforce は、最近のバージョンのインストーラーのダウンロード URL、およびサポートされる各オペレーティングシステムの TAR ファイルをリストした JSON ファイルを公開しています。このリストには、新しいバージョンが継続的に追加されており、追加されたバージョンは 20 週間リストに残されます。TAR ファイルとインストーラーファイル自体は少なくとも 40 週間保持されます。
sf (v2)
| オペレーティングシステム | ファイルの種類 | TAR 圧縮の種類 | JSON ファイルへのリンク |
|---|---|---|---|
| Linux ARM | TAR | gz | sf-linux-arm-tar-gz.json |
| Linux ARM | TAR | xz | sf-linux-arm-tar-xz.json |
| Linux 64 | TAR | gz | sf-linux-x64-tar-gz.json |
| Linux 64 | TAR | xz | sf-linux-x64-tar-xz.json |
| Windows 64 | TAR | gz | sf-win32-x64-tar-gz.json |
| Windows 64 | TAR | xz | sf-win32-x64-tar-xz.json |
| Windows x86 | TAR | gz | sf-win32-x86-tar-gz.json |
| Windows x86 | TAR | xz | sf-win32-x86-tar-xz.json |
| macOS (Intel CPU) | TAR | gz | sf-darwin-x64-tar-gz.json |
| macOS (Intel CPU) | TAR | xz | sf-darwin-x64-tar-xz.json |
| macOS (Apple シリコン) | TAR | gz | sf-darwin-arm64-tar-gz.json |
| macOS (Apple シリコン) | TAR | xz | sf-darwin-arm64-tar-xz.json |
| Windows 64 | インストーラー | sf-x64-exe.json | |
| Windows x86 | インストーラー | sf-x86-exe.json | |
| macOS (Intel CPU) | インストーラー | sf-x64-pkg.json | |
| macOS (Apple シリコン) | インストーラー | sf-arm64-pkg.json |
| オペレーティングシステム | ファイルの種類 | TAR 圧縮の種類 | JSON ファイルへのリンク |
|---|---|---|---|
| Linux ARM | TAR | gz | sfdx-linux-arm-tar-gz.json |
| Linux ARM | TAR | xz | sfdx-linux-arm-tar-xz.json |
| Linux 64 | TAR | gz | sfdx-linux-x64-tar-gz.json |
| Linux 64 | TAR | xz | sfdx-linux-x64-tar-xz.json |
| Windows 64 | TAR | gz | sfdx-win32-x64-tar-gz.json |
| Windows 64 | TAR | xz | sfdx-win32-x64-tar-xz.json |
| Windows x86 | TAR | gz | sfdx-win32-x86-tar-gz.json |
| Windows x86 | TAR | xz | sfdx-win32-x86-tar-xz.json |
| macOS (Intel CPU) | TAR | gz | sfdx-darwin-x64-tar-gz.json |
| macOS (Intel CPU) | TAR | xz | sfdx-darwin-x64-tar-xz.json |
| macOS (Apple シリコン) | TAR | gz | sfdx-darwin-arm64-tar-gz.json |
| macOS (Apple シリコン) | TAR | xz | sfdx-darwin-arm64-tar-xz.json |
| Windows 64 | インストーラー | sfdx-x64-exe.json | |
| Windows x86 | インストーラー | sfdx-x86-exe.json | |
| macOS (Intel CPU) | インストーラー | sfdx-x64-pkg.json | |
| macOS (Apple シリコン) | インストーラー | sfdx-arm64-pkg.json |
インストールの確認とバージョン情報の取得
sf --version次の出力例のように、バージョンに関する詳細が返されます。
@salesforce/cli/2.17.10 darwin-x64 node-v20.9.0インストールされたコアプラグインとそれぞれのバージョンを表示するには、次のコマンドを実行します。
sf plugins --core次の出力例のような情報が返されます。
@oclif/plugin-autocomplete 3.0.1 (core)
@oclif/plugin-commands 3.0.6 (core)
@oclif/plugin-help 6.0.5 (core)
@oclif/plugin-not-found 3.0.3 (core)
@oclif/plugin-plugins 4.1.0 (core)
@oclif/plugin-search 1.0.6 (core)
@oclif/plugin-update 4.1.3 (core)
@oclif/plugin-version 2.0.6 (core)
@oclif/plugin-warn-if-update-available 3.0.2 (core)
@oclif/plugin-which 3.0.8 (core)
@salesforce/cli 2.17.10 (core)
apex 2.3.20 (core)
auth 2.8.26 (core)
data 2.6.3 (core)
deploy-retrieve 1.20.0 (core)
info 3.0.1 (core)
limits 3.0.1 (core)
login 2.0.1 (core)
marketplace 1.0.2 (core)
org 2.11.8 (core)
schema 3.0.1 (core)
settings 2.0.2 (core)
sobject 0.2.15 (core)
source 2.11.0 (core)
telemetry 3.1.0 (core)
templates 55.5.18 (core)
trust 3.0.1 (core)
user 2.3.42 (core)
Uninstalled JIT Plugins:
community 2.4.9
custom-metadata 2.2.12
dev 1.3.2
devops-center 1.2.4
env 3.0.1
functions 1.22.9
packaging 1.27.1
signups 1.5.6
@salesforce/sfdx-plugin-lwc-test 1.1.1
@salesforce/sfdx-scanner 3.18.0利用可能な Salesforce CLI コマンドをすべて表示するには、次のコマンドを実行します。
sf commandsコマンドのリストには別名に置き換えられたコマンドも含まれています。たとえば、apex run の別名である sfdx 形式のコマンド force:apex:execute などです。
現在コンピューターにインストールされている Salesforce CLI のバージョンのリリースノートを表示するには、次のコマンドを実行します。
sf whatsnew