Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Install Vsync

Download current client packages from the Vsync downloads page. Preview packages are not yet signed by Microsoft or Apple. Before overriding an operating-system warning, compare the download with its entry in the release's SHA256SUMS.txt file.

Windows

Run the x86-64 NSIS installer and launch Vsync from the Start menu. The installer is per-user and does not normally require administrator access.

Unsigned preview: The installer and CLI are not yet code-signed. Windows may show Windows protected your PC. If you downloaded Vsync from the official downloads page, choose More info, then Run anyway. If that option is unavailable, Smart App Control or an organization policy is blocking unsigned software and has no per-app bypass. Do not disable security protection just to install Vsync; ask your IT administrator or wait for a signed build. See Microsoft's SmartScreen guidance.

For command-line or CI use, download the Windows CLI zip, extract vsync.exe, and place it in a directory on PATH.

macOS

Download the universal DMG, open it, and drag Vsync into Applications. The universal application supports Apple Silicon and Intel Macs.

Unsigned preview: The app and CLI are not yet signed or notarized. macOS may say that Apple cannot check Vsync for malicious software or that its developer cannot be verified. If you downloaded Vsync from the official downloads page, try to open it once, then open System Settings → Privacy & Security, scroll to Security, choose Open Anyway, then Open. See Apple's instructions.

The CLI tarball contains a universal vsync binary. Extract it into a location on PATH, such as /usr/local/bin.

Linux

Ubuntu 26.04 or newer on x86-64 is required. Download the AppImage, make it executable, and run it:

chmod +x Vsync_*.AppImage
./Vsync_*.AppImage

The CLI tarball contains the vsync binary:

tar -xzf vsync_*_linux-x86_64.tar.gz
sudo install -m 755 vsync /usr/local/bin/vsync

Verify the CLI

vsync --version

The desktop app and CLI share the same login, build root, and local cache on a machine.

Continue with the desktop quick start or connect the CLI.

Staying current

The desktop app checks automatically on launch and periodically while running; Settings can disable the check or run it manually. The CLI checks at most once a day and prints at most one reminder per day. It stays silent in CI and when output is piped. Set VSYNC_UPDATE_CHECK=0 to disable the CLI check.