Download Synq

Get started with Synq on your preferred platform. Our lightweight installer includes everything you need to begin using next-generation version control.

Windows

Size: 9.6 MB

macOS

Size: 20.1 MB

Installation Instructions

Installation Instructions
Follow these simple steps to get Synq up and running on your system.
1

Download

Click the download button for your operating system above to get the installer.

2

Install

Run the installer and follow the setup wizard. Administrator privileges may be required.

3

Login

Open your terminal and run

synq login

to confirm installation.

Start using Synq
Get started with collaboration and repository management.
1

Join or Create

See repositories you have been invited to from your registered email inbox, or create your own repository from the dashboard after logging in.

2

Open VS Code

Launch VS Code and open your terminal. Type

synq

to see all available commands.

3

Initialize

Initialize your repository with:

synq init <repo_id>

Copy the repo_id from your repository page to get started.

Or migrate directly from GitHub:

synq init <github_url>

Move your existing GitHub repository to Synq using the GitHub URL to seamlessly transition your project.

User Documentation

Share your repository
Invite others to collaborate or view your repository with different access levels.
1

Invite Collaborators

Grant full access for direct collaboration:

synq share -c <email>

They can push changes and collaborate directly on your repository.

2

Share for Viewing

Allow view access to copy and work separately:

synq share -v <email>

They can view and copy the repository to work on it independently.

Working and Synqing
Make updates to your code and sync changes, or revert to previous versions.
1

Revert to Previous Version

Revert to an old version of the repository if needed:

synq revert <ver> [path...]

Revert file(s) to a specific version. Check the website for logs.

2

Sync All Changes

Sync all files with an optional message:

synq . [-m message]

Syncs all changes and allows you to send a sync message with it.

3

Sync Specific Files

Sync particular files with an optional message:

synq <file(s)> [-m message]

Sync specific files and have a message associated with it.

Know Your Environment
Know what people are doing and what they are working on.
1

Check Repository Status

See files locked by you and others in the repository:

synq status

Shows which files are currently locked and by whom, helping you understand the current state of collaboration.

2

View Account Details

Check your own account information and settings:

synq account

Displays your account details, helping you verify your login status and account configuration.