Advanced — CLI & automation
The Sync app is the recommended way to use it. For terminal workflows and CI, the same binary is also a CLI.
The desktop app is the recommended way to use Sync — it handles setup, keeps knowledge fresh, and runs your agent for you. This page is for people who want terminal or CI control.
Sync ships as a single binary, git-sync, that is both the CLI and the MCP
server. Once it's on your PATH, git sync <command> works too.
The commands that matter
| Command | What it does |
|---|---|
git sync init | Set up Sync in the current repository. |
git sync status | Show project health, including how much knowledge is stale. |
git sync search "<query>" | Search the knowledge base. |
git sync revalidate <id> | Confirm a stale document still holds, marking it fresh. |
git sync precheck | Fail if stale documents are pending — handy as a pre-push or CI gate. |
Every command takes --help. Run git sync <command> --help for its exact
options. Authoring and reviewing knowledge is best done in the app or through
your agent, not by editing files by hand.
In CI
To stop out-of-date documentation from merging, run the same gate the app uses:
git sync precheckIt exits non-zero while stale documents are pending, so a pull request can't quietly ship knowledge that no longer matches the code.
Building from source
Prebuilt downloads are on the releases page. To build it yourself (Intel Macs, other targets, or to hack on Sync), see the README on GitHub.