---
id: cumulusci
version: "4.10.0"
license: BSD 3-Clause License
license_treatment: permissive
maintenance: active
---

# cumulusci — Build and release tools for Salesforce developers

License: permissive · Maintenance: active · Downloads: 103.9K/mo

## What it is and what it does

CumulusCI is a development and release automation platform for Salesforce applications, built and maintained by Salesforce.org. It provides a task-and-flow framework that lets developers, admins, and testers define repeatable automation in source control—from org provisioning and dependency installation to metadata transformation, data loading, and end-to-end testing. The tool runs on scratch orgs (via Salesforce CLI), sandboxes, and production orgs, and can be invoked from the command line, CI/CD systems, or customer-facing MetaDeploy installers.

The package includes batteries-in-the-box: Robot Framework integration for browser automation, Snowfakery for synthetic data generation at scale, metadata transformation pipelines, and a large ecosystem of pre-built tasks. Its 32 runtime dependencies cover CLI interaction (click), cryptography (pyjwt, cryptography), web automation (selenium, robotframework-seleniumlibrary), Salesforce API clients (simple-salesforce, salesforce-bulk, github3-py), and data handling (pyyaml, jinja2, faker, pydantic). This breadth makes it a comprehensive solution for teams building on Salesforce, but also means a substantial dependency footprint.

Use it for:

- Automate scratch org creation and configuration in CI/CD pipelines to run tests on fresh, isolated environments.
- Define and run end-to-end browser tests against Salesforce UIs using Robot Framework and Selenium without writing custom test harnesses.
- Generate realistic sample datasets at scale (single records to millions) using Snowfakery to populate test orgs.
- Orchestrate multi-step deployment workflows (metadata push, data migration, post-install setup) as portable, version-controlled flows.
- Build MetaDeploy installers that guide non-technical users through org setup and customization without CLI knowledge.
- Transform and adapt Salesforce metadata (custom fields, page layouts, permissions) across different org types and environments.

## Worth the install?

AI-flagged interpretation of the facts above — verify before relying.

CumulusCI automates Salesforce application development workflows—org setup, testing, deployment, and data synthesis—through a command-line tool and portable task/flow framework.

Yes, if you are building or maintaining Salesforce applications and need to automate org setup, testing, or deployment. CumulusCI is production-stable (active maintenance, 399 GitHub stars, no known vulnerabilities), permissively licensed, and has low install friction. The 32 runtime dependencies are substantial but justified by the breadth of features; evaluate whether you need the full feature set (Robot Framework, Snowfakery, Salesforce Bulk API) or only a subset. Requires Salesforce CLI and valid credentials to be useful.

## Install

pip install cumulusci
uv add cumulusci
poetry add cumulusci

## Installing cumulusci

Before you install: Low install friction; pure Python wheel with no compiled dependencies. Active maintenance with last commit 2026-08-10 and 126 days since latest release. Supports Python 3.11–3.13.

License in practice: BSD 3-Clause License (permissive). You may use, modify, and distribute freely with attribution; no copyleft obligations or restrictions on commercial use.

Quickstart:

pip install cumulusci
cci
cci org list

Requires Salesforce CLI installed and configured for scratch org creation; most features also require valid Salesforce credentials and org access.

Verify before relying:

- Whether the 32 runtime dependencies (including robotframework, selenium, salesforce-bulk, snowfakery) are all required for basic usage or only for specific advanced features.
- Performance and scalability characteristics when running large test suites or data synthesis operations.
- Compatibility with the latest Salesforce API versions and any known breaking changes in recent releases.

## Package facts

- License: BSD 3-Clause License (permissive)
- Python support: supports_current
- Install friction: low
- Maintenance: active
- Downloads: 103.9K/month (top 15,000 on PyPI)
- Known vulnerabilities: none known

## Tags

salesforce deployment automation, salesforce org setup and testing, salesforce ci/cd pipeline, robot framework salesforce testing, salesforce metadata automation, salesforce data generation, salesforce build tools, salesforce, ci-cd, automation

[View on SkillFed](https://skillfed.io/packages/cumulusci) · [View on PyPI](https://pypi.org/project/cumulusci/)