CumulusCI をインストールする

学習の目的

  • macOS または Windows に CumulusCI をインストールする。
  • CumulusCI がインストールされていることを確認する。
メモ

メモ

すでに CumulusCI がインストールされている場合、この単元を続行する前に、cci version コマンドを入力して最新バージョンを使用していることを確認します。もっと新しいバージョンがあると表示されたら、ターミナルに表示されているバージョン情報に記載されたコマンドを実行します。

Tasha とそのチームは、次のステップに進んで CumulusCI をインストールする準備ができています。一緒に実行していく場合、この単元の想定時間は、あくまで想定であることに注意してください。システム設定とネットワーク速度に応じて、実際のインストール時間の方が長くなることがあります。

Mac ユーザの場合

Mac で最も簡単に CumulusCI をインストールする方法は、Homebrew をインストールすることです。

  1. VS Code を開き、[Terminal (ターミナル)] パネルに移動します。
  2. コマンド /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install.sh)" をコピーして、ターミナルパネルに入力します。 
  3. パスワードを求められたら、コンピュータのパスワードを入力して、コンピュータが Homebrew をインストールすることを許可します。ターミナルにパスワードを入力するとき、文字が表示されないことがあります。

パスワードを入力して Return キーを押すと、ターミナルウィンドウに Homebrew のインストールで完了したステップが表示されます (アクティビティの多くは Python のインストール関連のものです)。

  1. インストールが完了したら、ターミナルウィンドウに次のコマンドを入力できることを示すプロンプト (おそらく $ 記号) が表示されます。
  2. brew install python3 コマンドを入力して Python をインストールします。
  3. brew tap SFDO-Tooling/homebrew-sfdo && brew install cumulusci コマンドを入力して、CumulusCI をインストールします。

インストールに 4 分ほどかかります。完了したら、コマンドプロンプトが再表示されます。これで完了です。この単元の「CumulusCI インストールの確認」セクションに進みます。

Windows ユーザの場合

Python3 をインストールする

  1. Python 3.9 ダウンロードページに移動します。
  2. [Files (ファイル)] セクションで、コンピュータに適したインストーラを選択します。どのリリースが適しているかわからない場合は、[Windows x86-64 executable installer] を選択します。
  3. インストーラがダウンロードされたら、インストールウィザードを開きます。
  4. Python を PATH に追加する必要があります。このために [Add Python [version number] to PATH (Python [バージョン番号] を PATH に追加する)] のようなチェックボックスがあります。
  5. [Install Now (今すぐインストール)] オプションを使用します。インストールをカスタマイズする必要はありません。

pipx をインストールする

  1. VS Code を開き、パネルの [Terminal (ターミナル)] に移動します。すでに VS Code が開いている場合は、閉じてから再度開きます。
  2. python -m pip install --user pipx コマンドを入力します。

pipx のインストール中に PATH に関する警告がいくつか表示されますが、問題はありません。これらの警告の原因には、後ほど対処します。

環境変数の PATH を変更する

すべてのターミナル環境で、インストールした Python と Python スクリプト (CumulusCI を含む) の場所が認識されるためには、コンピュータの環境変数を編集します。これらの設定を編集するには、マシンへの無制限のアクセス権 (管理者権限) が必要です。

  1. コンピュータで「環境変数の編集」と検索します。通常は、[コントロールパネル] の [システムの詳細設定] にあります。
  2. [環境変数] をクリックします。
  3. PATH ユーザ環境変数を選択して、[編集] をクリックします。
  4. [新規] をクリックし、次の値を追加します。
    1. %USERPROFILE%\AppData\Roaming\Python\Python39\Scripts 
    2. %USERPROFILE%\.local\bin

[システムのプロパティ] 画面
[システムの詳細設定] 画面

pipx がインストールされたことを確認する

  1. VS Code を閉じて、再度開きます。
  2. 新しいターミナルを開きます ([Terminal (ターミナル)] → [New Terminal (新規ターミナル)])。
  3. pipx --version コマンドを入力して、pipx が使用可能であることを確認します。

バージョン番号 (0.12.3.1 など) が表示されます。代わりにエラー ('pipx' is not recognized as an internal or external command, operable program or batch file (「pipx」は内部または外部コマンド、動作可能なプログラム、バッチファイルとして認識されません) など) が表示された場合、環境変数が更新されていることと、新しいターミナルを開いたことを確認します。

CumulusCI をインストールする

引き続き VS Code ターミナルで、pipx install cumulusci コマンドを入力します。

CumulusCI のインストールが開始します。インストールにしばらく時間がかかることがあります。インストールが完了すると、確認メッセージが表示されます。

CumulusCI のインストールを確認する (Mac または Windows)

cci コマンドを入力して、CumulusCI コマンドが使用可能であることを確認します。

初回使用時、Mac ユーザには、キーチェーンにパスワードを保存する許可を求めるポップアップが表示されることがあります。これは予期された要求であるため、コンピュータのパスワードを入力し、[常に許可] をクリックします。次のような出力が表示されます。

Usage: cci [OPTIONS] COMMAND [ARGS]...
Options:
 --help  Show this message and exit.
Commands:
 flow     Commands for finding and running flows for a project
 org      Commands for connecting and interacting with Salesforce orgs
 project  Commands for interacting with project repository configurations
 service  Commands for connecting services to the keychain
 shell    Drop into a Python shell
 task     Commands for finding and running tasks for a project
 version  Print the current version of CumulusCI

エラーメッセージや別の内容が表示された場合は、CumulusCI のインストールを再試行してください。

リソース