Getting started

Set up BRB and connect a repo in minutes

Install the published brbgit package, register a repo, run the first sync, and move to watch mode or the daemon.

Install the CLI

npm install -g brbgit
brb help
Package vs command

The npm package is brbgit. The installed command is brb.

Requirements

  • Node.js 20 or newer.
  • A real local git repository.
  • Access to the hosted BRB service.
  • Codex session logs under ~/.codex/sessions if you want conversation sync.

Register a repo

BRB keeps a local registry at ~/.brb/registry.json. Registering a repo creates the remote repo agent if it does not already exist and stores the local-to-remote mapping.

brb init \
  --repo my-project \
  --source /absolute/path/to/my-project \
  --base-url https://app.brbgit.com

Run the first sync

brb sync \
  --source /absolute/path/to/my-project \
  --base-url https://app.brbgit.com
  1. 1BRB compares the local working tree with the last synced manifest.
  2. 2Only the changed files and deletions are sent to the remote repo agent.
  3. 3The repo agent writes the new state, records continuity, and creates a remote commit.

Move to background sync

  • Use watch while testing one repo interactively.
  • Use the macOS daemon to watch every registered repo automatically at login.
  • The UI will then show sync state, recent activity, resume context, commits, and restore points.