Skip to content

JulesTanguy/oxsync

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

18 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

oxsync

Sync changes from a directory to another

GitHub Workflow Status (with event) Crates.io Version GitHub License

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>, can be used multiple times
      --no-temporary-editor-files  Exclude files with names ending by a tilde `~` [aliases: no-tmp]
      --no-creation-events         Ignore creation events [aliases: no-create]
      --ide-mode                   Exclude `.git`, `.idea` dirs + enables `no-temporary-editor-files`, `no-creation-events` options [aliases: ide]
      --statistics                 Display the time spent copying the 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.

About

oxsync is a file synchronization tool with a focus on 'watch for changes' feature. It enables fast, local reads with a remote filesystem

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages