Documentation

Platforms

OmniSync ships official installers for macOS and Windows. macOS is still the most complete experience; Windows is supported with a few differences.

macOS

Primary target for IDE launch, folder permissions, Dock integration, and branded DMG packaging (Apple Silicon and Intel). Unsigned builds may require right-click → Open on first launch.

  • DMG installers for arm64 and x64
  • Broadest IDE launch support, including Xcode
  • Documents / Full Disk Access prompts for workspace paths

Windows

Official NSIS .exe installers are published on GitHub Releases (x64). The installer can change the install directory and creates desktop and Start Menu shortcuts.

  • Unsigned by default. SmartScreen may warn on first run · see Install
  • IDE launch is more limited than macOS (VS Code / Zed are the most reliable; others may fall back)
  • Dashboard terminal defaults to PowerShell; switch to Command Prompt or Git Bash in Settings → General
  • Less battle-tested than macOS. Report rough edges on Issues

Linux

  • AppImage can be produced via electron-builder
  • Less tested than macOS and Windows

Requirements

  • End users · macOS or Windows x64; Git and Node for full workflows (the app can help install tooling where supported)
  • Developers · Node.js 20+ and npm
  • Packaged builds · OS keychain / credential store via Electron safeStorage

Limitations

  • Not a full IDE and not a Git CLI replacement
  • File read/write API capped at 2 MB
  • Xcode launch is macOS only
  • Clone paths are restricted to the home directory or registered workspace parents
  • Shell surfaces run as the user, unsuitable for untrusted shared accounts
  • Beta software: expect rough edges, especially on Windows