https://github.com/SergeyTsalkov/unisync

The Programmer's Sync Tool
https://github.com/SergeyTsalkov/unisync

sync synchronization

Last synced: 10 days ago
JSON representation

The Programmer's Sync Tool

• Host: GitHub
• URL: https://github.com/SergeyTsalkov/unisync
• Owner: SergeyTsalkov
• Created: 2022-09-04T19:06:54.000Z (almost 2 years ago)
• Default Branch: master
• Last Pushed: 2023-01-26T18:24:56.000Z (over 1 year ago)
• Last Synced: 2024-03-07T12:31:22.194Z (4 months ago)
• Topics: sync, synchronization
• Language: Go
• Homepage: https://unisync.sh
• Size: 186 KB
• Stars: 8
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Lists

• awesome-stars - SergeyTsalkov/unisync - `★8` The Programmer's Sync Tool (Go)

README

        
Unisync -- The Programmer's Sync Tool

====

Unisync is a command-line tool for **continuous 2-way sync between a folder on your computer, and a folder on a remote server**.

It's meant for using a local text editor to do development on your remote VPS. Unisync generally runs over SSH, but it doesn't have to.

**To get started, see the documentation on our website: https://unisync.sh**

### How to Use

1. Download unisync to local and remote side. The local copy should go somewhere in the system PATH (such as `/usr/local/bin`). The remote copy should go to a directory in the system PATH, or else in the `~/.unisync` folder (if you don't have root access).

1. Create a unisync config file on the local side.

    ```

    mkdir -p ~/.unisync && cd ~/.unisync

    nano remoteserver.conf

    ```

    The format of the config file is a simple "key = value" structure, one per line. Put this into the file:

    ```

    local = /path/to/local/folder

    remote = /path/to/remote/folder

    user = [username]

    host = [ip]

    ```

    The local and remote folders are the ones that will be synced. One of them should be empty the first time you sync, so its contents can be filled in from the other one. The user and host are your SSH connection information for the remote server.

1. Run unisync locally with the name of the config file you created in the last step (remoteserver in this example). It will use SSH to connect to the remote copy of unisync, and they'll sync the specified folders.

    ```

    unisync remoteserver

    ```

### Lots more features!

You should read our documentation at https://unisync.sh to learn more about configuring unisync.