BindRS 📁🔗📁

Two way file syncer using platform native notify in Rust

Rebuilding https://github.com/daveallie/entangler in Rust.

TODO

• Add tests (both unit and integration)
• Add documentation

Installation

Installation through cargo

1. Install Rustup
2. Run

cargo install --git https://github.com/daveallie/bindrs --tag v0.1.2

Installing binary manually

1. Download the zipped binary for your platform from the latest release page
2. Copy or symlink the binary to /usr/local/bin or place it on your PATH.

Usage

$ bindrs -h
BindRS 0.1.2
Dave Allie
Two way file syncer using platform native notify in Rust

USAGE:
    bindrs <SUBCOMMAND>

FLAGS:
    -h, --help       Prints help information
    -V, --version    Prints version information

SUBCOMMANDS:
    help     Prints this message or the help of the given subcommand(s)
    run      Runs BindRS to keep two directories in sync
    slave    Runs BindRS in slave mode - launched from a master process

---

$ bindrs run -h
bindrs-run 0.1.2
Runs BindRS to keep two directories in sync

USAGE:
    bindrs run [FLAGS] [OPTIONS] <BASE DIR> <REMOTE DIR>

FLAGS:
    -h, --help       Prints help information
    -V, --version    Prints version information
    -v, --verbose    Log debug lines

OPTIONS:
    -i, --ignore <FILE>...    Ignores a file or regex match
    -p, --port <PORT>         Override SSH port (defaults to 22)

ARGS:
    <BASE DIR>      Local folder path
    <REMOTE DIR>    Local folder path or folder path over ssh
                    (<remote_user>@<remote_host>:<remote_dir>)

Example command

bindrs run -v /some/local/folder user@1.1.1.1:/some/remote/folder -p 2222 -i 'log' -i '^\tmp(?:/[^/]+){2,}$'

Command breakdown

Command	Meaning
-v	Verbose mode
/some/local/folder	Local folder
user@1.1.1.1:/some/remote/folder	Remote folder on remote host
-p 2222	Override SSH port from 22 to 2222
-i 'log'	Ignore the log directory and everything in it
-i '^\.tmp/[^/]+/.*$'	Ignore everything in all subdirectories of .tmp, but allow things directly in .tmp

Ignoring files

By default the .git folder is ignored, but by defining an custom ignores, that is overridden.

There are two ways to ignore files:

Ignoring whole directories

Something like -i 'log' will ignore the log directory and everything in it. -i 'log/debug' will ignore the log/debug directory and everything in it, but will sync changes in the root of the log directory and other subdirectories of the log directory.

Some good examples of directories you might like to prevent from syncing are things like log, tmp, node_modules and other fast changing directories.

Ignoring regex matches

Regex match ignores must start with a ^ and end with a $. The regex is tested against the relative path, so if you're syncing /some/folder and /some/folder/some/file changes, then some/file is what the regex will be tested against.

An example is if you wanted to wanted to ignore all subdirectories of .tmp, but allow all things in the root of .tmp, then your CLI argument would look like: -i '^\.tmp/[^/]+/.*$'.

Note: You don't need to escape /.

Troubleshooting

If you're using a JetBrains IDE, you should disable the "safe write" option:

Contributing

1. Fork it!

• Create your feature branch: git checkout -b my-new-feature
• Commit your changes: git commit -am 'Add some feature'
• Push to the branch: git push origin my-new-feature
• Submit a pull request :D

Development

1. Install Vagrant

• Navigate to the development directory
• Run vagrant up
• Run vagrant ssh
• Project will be in the ~/bindrs folder
• Run cargo build to build the source

License

The project is available as open source under the terms of the MIT License.