Zync Documentation
Welcome to the official documentation for Zync. Here you'll find guides for getting started, using the app, and extending it with plugins and themes.
Getting Started
New to Zync? Install the app and add your first connection.
Installation
Download and install Zync on Linux, Windows, or macOS. One-line install script included.
Welcome Screen
Quick Connect, local terminal first, saved host cards, and in-app release notes.
Connections
Add SSH hosts, multi-location All Hosts, Keep from Google Drive, jump hosts, and import from ~/.ssh/config.
Data & Security
Local-first data ownership, encrypted vault, and optional backup to your own Google Drive.
Vault
Encrypted on-device storage for passwords and keys, with recovery key and revision history.
Sync & Backup
Encrypted collections in your Google Drive — hosts, tunnels, snippets, and settings.
Security
How Zync handles credentials, OAuth, and your data — no Zync-hosted workspace.
Using Zync
Core features: terminal, file manager, and port forwarding.
Terminal
Local and remote terminals, multiple tabs, copy/paste, search.
Snippets
Save reusable commands, scope them globally or per host, and run them instantly with quick overlays.
File Manager
SFTP browsing, drag-and-drop uploads, archive downloads, transfers, copy to server.
Port Forwarding
Manage SSH tunnels visually: local, remote, and SOCKS forwards.
Extending Zync
Zync is modular. Build plugins and themes and share them via the marketplace.
Plugins & Extensions
Build sandboxed UI panels, commands, and widgets. Use the zync API and panel.register.
Theme Engine
Create color palettes and terminal themes with theme.json and the semantic token system.
zync-extensions
All official and community extensions live in the zync-extensions GitHub repository. Zync uses it as the marketplace registry; extensions listed there appear in Settings → Plugins → Marketplace.
To publish your plugin or theme: open a Pull Request adding your entry to marketplace.json in zync-extensions. Once merged, it becomes installable by all Zync users from the in-app Marketplace.
Reference
AI & LLM Context Files
Zync publishes machine-readable context files to help AI assistants and LLM-powered tools understand the codebase. If you're using Claude, Cursor, Copilot, or any AI coding tool while working on Zync, point it at these files first.