FAQ

How do I use Sync?

Through the desktop app. You open a repository, run your agent in the built-in terminal, and browse the project's knowledge and roadmap visually. The app keeps everything set up and up to date for you. There's also a CLI and MCP server in the same binary for terminal and CI workflows — see Advanced.

How is it different from a wiki or Markdown docs?

Wikis and Markdown rot silently — nothing tells you when a page no longer matches the code. In Sync, every document carries a status, and the moment a commit moves past it, it's marked stale — so your agent never relies on out-of-date information.

Is Sync free?

Yes. Sync is open source under the Functional Source License (FSL-1.1-MIT), which converts to MIT two years after each release. It's free for all non-competing use.

Where is my data stored?

In your repository, in git. Sync writes plain files under .sync/. There's no SaaS backend — nothing is uploaded, and your knowledge never leaves your machine unless you git push it.

Does Sync phone home?

No. There is no telemetry, ever, and the agent connection is a local subprocess that opens no network sockets. The only network call is an optional, one-time download of a search model — which you can replace with a local file.

Which editors and agents work with Sync?

Any MCP-capable client — Claude Code, Cursor, Zed, Codex, OpenCode, and others. The app connects them for you.

Does it change my docs or commit for me?

No. The agent writes new knowledge, but nothing is committed for you — you review and commit it like any other change.

Is it production-ready?

Sync is in alpha. The data model is still stabilizing, so expect some rough edges and the occasional format migration before 1.0. macOS is the most polished platform today; Linux and Windows work but are less battle-tested.

Where do I report a bug?

Open an issue on GitHub. The project improves on real friction reports.