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.

Connections

Add SSH connections, use keys or passwords, jump hosts, and import from ~/.ssh/config.

Using Zync

Core features: terminal, file manager, and port forwarding.

Terminal

Local and remote terminals, multiple tabs, copy/paste, search.

File Manager

SFTP browsing, drag-and-drop uploads, transfers, copy to server.

Port Forwarding

Manage SSH tunnels visually: local and remote 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.

Keyboard shortcuts

Quick reference for the most-used shortcuts. All shortcuts can be customized in Settings → Shortcuts.

Action	Linux / Windows	macOS
Command palette	`Ctrl+K`	`⌘K`
New connection	`Ctrl+N`	`⌘N`
New terminal tab	`Ctrl+Shift+T`	`⌘T`
Close tab	`Ctrl+Shift+W`	`⌘W`
Copy (terminal)	`Ctrl+Shift+C`	`⌘C`
Paste (terminal)	`Ctrl+Shift+V`	`⌘V`
Search in terminal	`Ctrl+Shift+F`	`⌘F`
Open file manager	`Ctrl+Shift+F`	`⌘⇧F`
Settings	`Ctrl+,`	`⌘,`
Increase font size	`Ctrl+=`	`⌘=`
Decrease font size	`Ctrl+-`	`⌘-`

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.