#file-synchronization #directory #remote #local #exclude #tool #read

app oxsync

oxsync is a file synchronization tool. It enables fast, local reads with a remote filesystem

2 unstable releases

0.3.0 Dec 29, 2023
0.2.1 Dec 16, 2023
0.2.0 Nov 26, 2023
0.1.0 Oct 13, 2023

#217 in Filesystem

Download history 4/week @ 2023-12-25 34/week @ 2024-02-19 17/week @ 2024-02-26 70/week @ 2024-04-01

70 downloads per month

MIT license

32KB
714 lines

oxsync

Sync changes from a directory to another

Usage: oxsync.exe [OPTIONS] <SOURCE_DIR> <TARGET_DIR>

Arguments:
  <SOURCE_DIR>  Path of the directory to watch changes from
  <TARGET_DIR>  Path of the directory to write changes to

Options:
  -e, --exclude <EXCLUDE>               Exclude file or dir from the <SOURCE_DIR>
      --exclude-temporary-editor-files  Exclude filenames ending with a tilde `~` [aliases: exclude-tmp]
      --ide-mode                        Exclude `.git` and `.idea` dirs + enable the `exclude-temporary-editor-files` option [aliases: ide]
      --statistics                      Get how much time is needed to copy a file [aliases: stats]
      --trace                           Set the log level to trace
  -h, --help                            Print help
  -V, --version                         Print version

Purpose

oxsync is geared towards enabling fast, local reads with a remote filesystem. The conventional setup advices to initiate with a copy of local files and directories on the remote machine, while the tool monitors and synchronizes the modifications performed when the program is running.

Features

  • Real-time "watch for changes" functionality for near immediate synchronization.
  • CLI interface with intuitive commands.
  • Local copy of remote directories for quick reads.
  • Handle big and small files
  • An "exclude" argument
  • Tested and fully functional on Windows

Installation

# Beforehand make sure to have a functional Rust compiler and 
# the Cargo package manager installed
cargo install oxsync

Acknowledgements

As always, feel free to look at the dependencies of the Cargo.toml file at the root of the repository. It provides a comprehensive list of all the libraries that play a crucial part in the development of this project.

Dependencies

~7–19MB
~233K SLoC