How to install/setup cumulus ci on your computer

Oct 03, 2023


 

 

What is Cumulus CI?

CumulusCI helps development teams build great applications on the Salesforce platform by automating org setup, testing, and deployment.

CumulusCI stands for Cumulus (as in the cloud) Continuous Integration—and is so named for how Salesforce.org builds and delivers its managed packages continuously. CumulusCI can be used by employees, partners, as well as community collaborators, and allows anyone who’s working on a Salesforce-related project.

 

System requirements

Before setup cumulus  ci on your compter below steps must meet these requirements

  1. Windows 7 (64-bit and 32-bit) or later, or
  2. MacOS 10.11 or later

 

Install Cumulus CI

  1. Go to the python page to download a Python 
  2.  

     

  3. Install using the installation wizard.
    1. Select Add Python version to PATH
    2. Click “Install Now”.

     

     

  4. On the screen entitled “Setup was successful,” click the “Disable path length limit” button (if it’s present).
  5.  

     

  6. Go to the "C:\Users\username\AppData\Local\Programs\Python\Python311\Scripts" folder and copy the path, Note this copied path will use in next step, Like below image 
  7.  

     

  8. Search in the Searchbar - Edit the system environment variable and click on it, below screen will appear
  9. Select the Advanced tab and click on Environment variables button at bottom, below screen will appear
  10.  

     

  11. Select path and Edit button and click on New button to set a path and Paste the copied path Like- "C:\Users\username\AppData\Local\Programs\Python\Python311\Scripts" Note this path may different in your pc as you installed
  12.  

     

  13. Click on OK button, again clik OK button and then Apply button
  14. To confirm that python is installed or not . Reopen Command Prompt
  15. cmd /> python --version
  16.  

     

  17. Now we will do install pipx
  18. Open pereferred terminal application (Like Command Prompt). If your terminal is already open then reopen it. Enter the below command.
  19. cmd /> python -m pip install --user pipx
  20. cmd /> python -m pipx ensurepath
  21. To confirm that pipx is installed or not. Reopen Command Prompt. Enter below command.
  22. cmd /> pipx --version
  23.  

     

  24. If you see error like 'pipx' is not recognized as an internal or external command, operable program or batch file.   Then you update/set environment variables manually.
  25. Install cumulus ci with below command
  26. cmd /> pipx install cumulusci
  27. After installed Cumulus CI edit envrioment variables. like below path:
  28.  

     

     

     

  29. %USERPROFILE%\.local\bin (Note: Below copied path is in my case, it may be different in your computer.)

  30.  

  31. Paste the copied path like below image.
  32.  

     

  33. %USERPROFILE%\AppData\Roaming\Python\Python38\Scripts(Note: Below paste path is in my case, it may be different in your computer.)

  34.  

  35. Paste the copied path like below image.
  36.  

     

  37. To confirm that cumulus ci is installed or not. Reopen Command Prompt. Enter below command.
  38. cmd /> cci version


  39. If you see version detail it means Cumulus CI is successfully installed.

 

Note: When you entered the command on command prompt cci version. I think you will have faced this problem : Long path support is not enabled. This can lead to errors with some task. Your administrator will need to activate the "Enabled Win32 long paths"

Actully this error comes cause by Python. It is not CumulusCI error. When you update the CumuluCI through pip install cumulusci --upgrade command. May be you can see this type of error.

 

To solve this problem you have to uninstall the python and re-install the same python version.

 

After installed python, repeat the step from 11 to 16 and then 25 to 26.

If you download other version you can see error like this:

No Python at "C:\Users\xyz\AppData\Local\Programs\Python\Python<version_number>\python.exe" at the last moment when you hit cci version command in command prompt. So please install same python version which had already installed on your system.


 

 

I hope this blog helped you!