Search docs

Jump to a BRB documentation page

Command reference

brb sync

Run a one-off sync for current repository, auto-register it if needed, and optionally bootstrap background syncing.

Reference
https://docs.brbgit.com/brb-sync

Syntax

bash
brb sync [--source <path>] [--message <message>] [--ensure-daemon] [--base-url <url>]

Behavior

  • If repo is not registered yet, BRB auto-registers it from current git root and inferred project name.
  • Computes the local delta from the last synced manifest.
  • Syncs conversation context first when available.
  • Pushes file additions, updates, and deletions to the remote repo agent.
  • Creates a remote commit only if the effective repo snapshot changed.
Usually optional

You usually do not need to run brb sync before brb watch or the daemon. Both perform a startup sync automatically.

Authentication

Login required

brb sync requires a saved CLI token. Run brb login once before syncing.

Parameters

ParameterDescriptionDefault
--sourceLocal repo path. Defaults to the current working directory.
--messageOptional manual commit message override for the remote commit.
--ensure-daemonOn macOS, install and load BRB launchd daemon after sync. Good for one-shot agent bootstrap.
--base-urlBRB service URL. Defaults to BRB_BASE_URL when present or https://app.brbgit.com otherwise.

Example

bash
cd ~/github/sample
brb sync
Agent-first example on macOS
cd ~/github/sample
brb sync --ensure-daemon

Authentication

Login required

brb watch uses authenticated startup sync and subsequent syncs, so it requires a saved CLI token.