Skip to main content

How to Install and Use the Gearset Extension

Learn how to install and use the Gearset extension to track Salesforce changes and send them to a feature branch.

Evan Craven avatar
Written by Evan Craven
Updated this week

Gearset’s browser extension makes it easy to capture the declarative changes you make directly inside your Salesforce org and commit them to a feature branch. As you work, the extension automatically detects supported metadata edits and allows you to jump straight into a comparison in Gearset preloaded with those changes. This eliminates the need to remember each modification or track which metadata types you touched, helping you work faster and more accurately as part of your CI and pipeline workflow.


Prerequisites

Before installing the extension, make sure:

  • Your dev sandbox is added to a single Gearset Pipeline.

  • You are building changes in the dev sandbox (not a static or upstream environment).

  • You have access to the repository configured in your pipeline.

  • You are logged into Gearset or able to authenticate when prompted.


Installing the Gearset Browser Extension

  1. Open the Chrome Web Store and search for Gearset, or install it directly using this link:
    https://chromewebstore.google.com/detail/gearset/ckndonihnehkbhmmigecghogbfphojfc

  2. Click Add to Chrome (or Add to Edge).

  3. Once installed, pin the extension so it remains visible in your browser toolbar.


Connecting the Extension to Your Salesforce Org

  1. Login Salesforce using the credentials of a dev sandbox that is part of your pipeline.

    • The extension uses this org to determine which pipeline to connect to.

  2. Click the Gearset extension icon to open it.

    • The first load can take up to 10 seconds.

      • If it hangs on the loading screen, refresh the page and open the extension again

  3. If you're already logged into Gearset, the extension authenticates automatically.
    Otherwise, you’ll be prompted to log in.


Selecting or Creating a Feature Branch

To begin tracking changes, you must select a feature branch:

  1. Open the extension.

  2. Choose an existing feature branch or create a new one.

  3. When creating a new branch, you can optionally link a Jira ticket, or skip that step.

Once selected, the extension starts monitoring for supported metadata changes.


Tracking Changes in Your Salesforce Org

As you save changes inside Salesforce, the extension automatically detects and queues them.

Notification behavior

  • When a change is detected, a badge appears on the extension icon.

    • The badge will contain a number equal to the number of changes that have been tracked.

  • Opening the extension shows tracked items, which may briefly display as “in progress.”

  • Once processed, each change is labeled as:

    • New

    • Changed

    • Deleted


Comparing and Deploying Your Changes

When you're ready to commit the changes:

  1. Open the extension.

  2. Click Compare with Gearset.

  3. Gearset opens a comparison automatically populated with your tracked changes.

    From there, you can review and commit your changes through your normal CI or pipeline workflow.


Notes on Extension Behavior

Clearing Tracked changes

  • After generating a comparison and committing those items, the extension cannot track new changes against that same branch until it is cleared.

  • If you're beginning new work, create a new feature branch inside the extension.

Uncommitted Sub-component Inclusion

  • Because custom fields are subcomponents of their parent object, tracking a single field with the extension (Field A) will cause all fields on that object — including uncommitted ones like Field B — to appear in the comparison, even if they weren’t changed. You can always deselect Field B in the comparison before committing.

  • For example: If you update Field A on Object X, but Field B also exists on that object and hasn’t been committed yet, the comparison will show both fields since they belong to the same object component — simply deselect Field B if you don’t want it included.


Supported Metadata Types

The extension currently supports the most common declarative metadata types, including:

  • Flows

  • Custom fields

  • Custom objects

  • Lightning App Builder

  • Layouts

  • Email templates

  • Custom settings

  • Profiles & permission sets

  • Reports & dashboards

  • Schema Builder changes

  • Object Manager changes

  • Apex classes

  • Workflow rules & approval processes

Support for additional metadata types will be added over time. If you rely on types that aren’t yet supported, Gearset welcomes feedback to help prioritize future releases.

We encourage you to message us on the in-app chat to let us know which metadata types you would like to see supported!

Did this answer your question?