Skip to content

Git Integration

Pro feature. Git Integration requires a Pro or Teams license.

Git Integration turns any room directory into a git repository, letting you track changes to your requests over time, collaborate via a shared remote, and roll back to any previous state.

Enabling git for a room

Go to Settings → Room → Git and click Initialise Repository. Restroom runs git init in the room directory and creates a .gitignore that excludes history files and local git settings.

Connecting a remote

Paste a remote URL (SSH or HTTPS) into the Remote field and click Save. The branch defaults to main.

The Git screen

The Git screen (branch icon in the left toolbar) shows the current state of the room's repository:

  • Changed files — files with uncommitted modifications
  • Ahead / Behind — how many commits you are ahead of or behind the remote
  • Recent commits — the last few commits on the current branch

Committing changes

Type a commit message and click Commit. All changed .json files in the room directory are staged and committed. History files (.history/) are never committed.

Push and pull

Click Push to push the current branch to the remote. Click Pull to fetch and merge the latest commits from the remote.

If there are conflicts (someone else pushed changes), Restroom will show the error from git. Resolve conflicts using a standard git workflow outside of Restroom, then return to push.

Auto-commit on save

Enable Auto-commit on save in the Git settings. With this on, every time you save a request (Cmd+S), Restroom automatically commits the change with a message like Update: GET /users. This gives you a detailed commit history without any manual steps.

Collaborating

To share a room with a teammate:

  1. Push the room to a shared git remote (GitHub, GitLab, etc.)
  2. They clone the repository to their machine
  3. In Restroom, go to Rooms → Add Existing Room and point it at the cloned directory

Both of you can pull and push changes. Rooms are plain JSON, so most edits merge cleanly.

Released under the Restroom License.