Salesforce CLI 設定ガイド
jSalesforce CLI のインストール
コンピュータにインストールする方法を 1 つ選択します。たとえば、.pkg ファイルと npm の両方で macOs にインストールしないでください。両方を使用してインストールすると、コンピュータ上のパスが混乱することがあり、場合によっては、明確なエラーが表示されず、診断が困難になります。
macOS での CLI のインストール
- .pkg ファイルをダウンロードします。
- .pkg ファイルを Finder からダブルクリックするなどして実行し、すべてのプロンプトに回答します。
- インストールが完了したら、ターミナルウィンドウまたは IDE を再起動して、Salesforce CLI が使用可能であることを確認します。
Windows での CLI のインストール
- .exe ファイルをダウンロードします。
- .exe ファイルを Windows Explorer からダブルクリックするなどして実行し、すべてのプロンプトに回答します。
- インストールが完了したら、コマンドプロンプト、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 を実行します。
-
Salesforce CLI をインストールするディレクトリを作成します。
-
TAR ファイルの内容を展開します。
-C は ~/cli/sf ディレクトリの内容を展開し、--strip-components 1 はルートパスのコンポーネントを削除します。
-
PATH 環境変数を更新して、Salesforce CLI の bin ディレクトリを含めます。たとえば、現在のターミナルセッションについては、次のとおり設定します。
PATH を永続的に更新するには、シェルの設定ファイルに適切なエントリを追加します。たとえば、Bash シェルを使用する場合、~/.bashrc または ~/.bash_profile ファイルに次の行を追加します。
npm を使用した CLI のインストール
このインストール方法は、ワークステーションに対する管理者権限がない場合や、グループポリシーによって CLI のインストールと更新がブロックされる場合に適切なオプションです。npm を使用した Salesforce CLI のインストールでは、ルート権限は必要ありません。
-
Node.js の長期サポート (Active LTS) バージョンがコンピュータにインストールされていることを確認します。LTS バージョンをインストールするには、https://nodejs.org/en/download/ にアクセスします。使用しているバージョン番号を確認するには、次のコマンドを実行します。
-
次のコマンドで Salesforce CLI をインストールします。
npm を使用して CLI をインストールするときに権限エラーが発生する場合は、sudo を使用しないことをお勧めします。npm 権限の修正方法を参照してください。
CLI リリース候補版またはナイトリービルドのインストール
また、ナイトリービルドが毎日リリースされています。ナイトリービルドには、すべてのライブラリとプラグインの最新バージョンが含まれています。1 日前にマージされた修正をすぐに試したい場合は、ナイトリービルドをインストールしてみてください。リリース候補と同様に、ナイトリービルドは、安定版リリースに至る前に問題を検出できるため、Salesforce CLI の安定性の向上に利用されます。
最新の (安定版) リリースが最も信頼性が高いですが、リリース候補版やナイトリービルドもテストして GitHub の Issues (問題) リポジトリに問題を報告していただくことをお願いしております。継続的インテグレーション (CI) ジョブを最新リリースとリリース候補版の両方で実行し、破壊的変更が生じる前にその可能性を特定することをお勧めします。
次のコマンドを実行すると、インストール済みの Salesforce CLI のバージョンが表示されます。バージョンにはリリース候補版かナイトリービルドかが示されていないため、リリースノートで現在のバージョン番号を確認してください。
インストーラを使用したインストール
インストーラでは、現在のリリースには stable、リリース候補版には stable-rc、ナイトリービルドには nightly というタグを使用します。
Salesforce CLI をインストール済みで、最新リリースを使用している場合、次のコマンドを実行すると、リリース候補版に切り替わります。
同様に、ナイトリービルドをインストールするには次のコマンドを実行します。
リリース候補版またはナイトリービルドをアンインストールして、最新バージョンに戻すには、次のコマンドを実行します。
npm を使用したインストール
npm インストーラでは、現在のリリースには latest、リリース候補版には latest-rc、ナイトリービルドには nightly というタグを使用します。
npm を使用してリリース候補版をインストールする場合は、次のコマンドを実行します。
同様に、ナイトリービルドをインストールするには次のコマンドを実行します。
リリース候補版またはナイトリービルドをアンインストールして、最新バージョンに戻すには、次のコマンドを実行します。
次のコマンドを実行すると、現在 npm タグに関連付けられている Salesforce CLI のバージョンが表示されます。
TAR ファイルからのインストール
Salesforce CLI では、サポートされているすべてのオペレーティングシステムにインストールできる、リリース候補版およびナイトリービルドの TAR ファイルが配布されています。ダウンロード URL は最新リリースをインストールする場合の URL に似ていますが、stable チャネルではなく、stable-rc または nightly チャネルを使用します。
たとえば、リリース候補版の Linux TAR ファイルの wget を実行する場合、次のコマンドを実行して、stable-rc チャネルからダウンロードします。
次のコマンドはナイトリービルドをダウンロードします。
使用するチャネルが異なる点を除けば、TAR ファイルからリリース候補版またはナイトリービルドをインストールする手順も、最新リリースをインストールする手順と同じです。
Salesforce CLI の古いバージョンのインストール
インストーラ
インストーラを使用して Salesforce CLI をインストールした場合は、--version フラグを使用して古いバージョンに更新してください。たとえば、バージョン 2.0.1 に更新するには、次のコマンドを実行します。
--available フラグによって、更新が可能なすべての旧バージョンを一覧表示できます。また、すでにローカルにコピーがあるかどうかや、ダウンロードが必要かどうかも表示されます。
--interactive を使用することで、バージョンをインタラクティブに選択できます。
このコマンドを使用することで、現在のバージョンに戻ることができます。
npm
npm を使用して Salesforce CLI を古いバージョンで更新するには、@salesforce/cli パッケージ名の後に @<version> でバージョンを指定します。たとえば、バージョン 2.0.1 に更新するには、次のコマンドを実行します。
このコマンドを使用することで、現在のバージョンに戻ることができます。
全バージョンのリストについては、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 |
インストールの確認とバージョン情報の取得
次のコマンドを実行すると、インストール済みのコアプラグインとそのバージョンが表示されます。
次のコマンドを実行すると、使用可能なすべての Salesforce CLI コマンドが表示されます。
コマンドのリストには別名に置き換えられたコマンドも含まれています。たとえば、apex run の別名である sfdx 形式のコマンド force:apex:execute などです。
次のコマンドを実行すると、現在コンピュータにインストールされている Salesforce CLI のバージョンのリリースノートが表示されます。