Documentation
Overview
OmniSync is a desktop workspace launcher and sync dashboard for local and GitHub-backed repositories, built with Electron and Next.js.
What OmniSync is
OmniSync is a workspace hub that connects your local repositories, Git remotes, and development tooling into one desktop dashboard. From a single window you can launch projects, sync with GitHub, diagnose the environment, and run your app.
- Multi-workspace profiles with one-click switching
- Clone from GitHub or register an existing local folder
- Integrated file tree, tabbed editor, and Markdown preview
- Git sync with ahead/behind status and a three-pane conflict resolver
- Environment diagnostics and a built-in dev runner
- Encrypted credential storage via the OS keychain
What OmniSync is not
OmniSync is not a full IDE or a replacement for Git on the command line. It orchestrates your workspace; it does not replace your editor of choice. Use it alongside Cursor, VS Code, Xcode, or IntelliJ.
Where to start
- Download · macOS or Windows installer matched to your machine
- Install · open the app, Gatekeeper / SmartScreen notes, and package details
- Getting started · first-run setup, sign-in, and your first workspace
- Workspace · browse, edit, and review files in the dashboard
- Build from source · run OmniSync locally for development
Dashboard views
The main dashboard is organized around five sidebar tabs:
| Tab | What it does |
|---|---|
| Workspace | File tree, resizable editor panes, git history column, and line diff viewer |
| Git Sync | Local/remote branches, collaboration feed, upstream status, and the conflict resolver |
| Diagnostics | Environment audits, dependency inventory, releases/deployments, and repair commands |
| Timeline | Repository commit calendar and history |
| Settings | Per-workspace Git identity/sync, workspace paths, run scripts, and global defaults |