Moduletrace LLC

Repositories

7

Projects Packages

@moduletrace/turbosync (1.0.0)

Published 2024-12-25 19:45:24 +00:00 by tben in Moduletrace/turbo-sync

Installation

Setup this registry in your project .npmrc file:

@moduletrace:registry=

To install the package using npm, run the following command:

npm install @moduletrace/turbosync@1.0.0

or add it to the package.json file:

"@moduletrace/turbosync": "1.0.0"

For more information on the npm registry, see the documentation.

About this package

Turbo Sync

A no-nonsense file/folder synchronization application

Requirements

Turbo sync requires node js and rsync

Installation

To install simply run:

npm install --registry="https://git.tben.me/api/packages/Moduletrace/npm/" -g turbosync

To update run:

npm update --registry="https://git.tben.me/api/packages/Moduletrace/npm/" -g turbosync

Usage

Turbo Sync requires a JSON file with the correct configuration. example:

turbosync ./project/sync/config.json

However if you have a file named turbosync.config.json in the working directory simply run:

turbosync

In this case Turbo Sync will automatically look for a file named turbosync.config.json in the working directory for config params.

Config File

The config file is a json file that contains all the information needed to run turbosync. Example:

[
    {
        "title": "Sync Files",
        "files": [
            "/home/user/file1.txt",
            "/home/user/file2.txt",
            {
                "path": "/home/user/file3",
                "user": "root",
                "host": "5.34.75.236",
                "ssh_key": "/home/user/.ssh/key"
            }
        ]
    },
    {
        "title": "Sync Folders",
        "options": {
            "delete": true
        },
        "folders": [
            "/home/user/folder1",
            "/home/user/folder2",
            {
                "path": "/home/user/folder3",
                "user": "user",
                "host": "5.39.67.76",
                "ssh_key": "/home/user/.ssh/key"
            }
        ]
    }
]

You can also use environment variables in the config file. Example:

[
    {
        "title": "Sync Folders",
        "folders": ["$FOLDER_1", "$FOLDER_2"]
    }
]

Dependencies

Development Dependencies

ID	Version
@types/node	^22.10.2

Details

npm

Moduletrace/turbo-sync

2024-12-25 19:45:24 +00:00

16

Benjamin Toby

ISC

5.4 KiB

Assets (1)

turbosync-1.0.0.tgz 5.4 KiB

Versions (6) View all

1.0.5 2025-02-04

1.0.4 2025-02-04

1.0.3 2025-01-20

1.0.2 2025-01-16

1.0.1 2025-01-16

Issues