Git Integration & Collaboration
Collaboration via GUI
Provider

Initializing Git

Initializing Git in Bruno is the first step towards managing your API collections with version control. It’s easy and quick to set up. Follow the steps below to initialize Git.

  1. Launch the Bruno app.
  2. Navigate to the collection you want to initialize with Git.
  3. Click on the Git Icon in the top-right corner of the navbar.
  4. Click the Initialize button to set up your collection with Git.

This allows you to perform other Git operations such as adding, committing, pushing, pulling changes, and more.

Connecting to Remote Repository

Once you have initialized your collection, the next step is to connect it to a remote Git repository. You can directly connect to remote repository from Bruno using Git GUI feature.

To connect Bruno to GitHub, you need to set up either an SSH key or a Personal Access Token (PAT) on GitHub. Follow this official GitHub guide (opens in a new tab) to set it up.

  1. Create empty Git repository on your GtiHub.
  2. Open Git initialized Bruno collection.
  3. Click on main (top right corner).
  4. Select Remotes from the dropdown.

remotes

  1. Click on Add Remote button.

remotes

  1. Enter Remote Name and URL (Https or SSH) and click on save.

remotes

After completing the above steps, your collection will be conected to GitHub. We have to add and commit (refer below section) some changes to pushed collection to GitHub.

Once your collection is connected to the remote repository, you can manage it directly from the Bruno app.

Adding and Committing Changes

Once you’ve made changes to your collection in Bruno, you can easily commit those changes using the Git UI. This allows you to track changes and collaborate with your team efficiently.

Follow these steps to add and commit changes:

  1. Open the collection you've initialized with Git and access the Git UI from the main dropdown in the top-right corner.
  2. Go to the Changes Tab.
  3. Click on Add Icon for the changes you want to commit.
  4. Click on Commit Changes button.
  5. Write a Commit Message and click Commit.

You can commit all changes in a single click by pressing the Add All Changes button.

By following these steps, your changes are now committed and tracked in Git, ready to be pushed or shared with others.

Pushing and Pulling Changes

The GUI-based Git integration in Bruno allows both engineering and non-engineering teams to work together in a fast, efficient, and accurate manner. This integration ensures that your collections remain consistently up-to-date across all team members.

Before you can push or pull changes, ensure that the remote repository is linked to your project.

Pushing Changes

Push your local changes to the remote repository with just a few clicks.

  1. Click on main from top-right corner and select Push from drop-down.
  2. Confirm the Remote Server configurations.
  3. Click on Push button.

Now you can see all your local changes pushed to the remote repository.

Follow Consumer guide to learn about pulling changes feature.

Branch Creation and Checkout

With branches in Bruno, you can manage your code effectively by isolating different features or tasks.

Creating Branches

Follow the below steps to create branches in Bruno.

  1. Navigate to the Collection in Bruno.

  2. Click on the main from the top-right and select Create New Branch from dropdown.

  3. Enter Branch Name.

  4. Click on Save button.

Once the branch is created, you can start making changes to the branch.

Branch Checkout

  1. Click on Checkout Branch from main.
  2. Select the branch you want to switch from Local or Remote.
  3. Click on Checkout button.
  4. Now you're switched to your selected branch.