Skip to content

tarikguney/copier

Repository files navigation

Table of Contents

What is it?

A cross-platform (works on Windows, Linux, and Mac) and open-source file watcher and copier application. It allows you to specify folders/files to track and copies them to a target location. It continuously watches changes on the specified files in the background and copies them to the destination directory.

Underlying Technology

The application has been developed with .NET Core technology and depends on the existence of .NET Core framework on the target machine where it is being used. You can simply download the framework from http://dot.net.

Note: The future release will be built without .net core dependency.

How to use?

Currently, it is a command-line application; therefore, you need to be passing a few options to be able to tell what to copy, the source directory, and the destination directory.

The simple way to find all the available options is to run the tool with --help flag such as dotnet Copier.dll --help.

An example:

A simple way to start off with this tool would be as follows:

dotnet Copier.dll -s "C:\source-folder\" -f "*.txt" -d "C:\destination-folder"
  • -s is the source folder.
  • -f is the file name pattern in glob format. For instance, *.txt means all the files ending with .txt extension.
  • -d is the destination folder where the files will be copied over.

By default, if a file already exists in the destination directory, the file won't be copied unless told otherwise with -o flag. Check out --help for more information about all the available options.

Delayed Copy

One of the major features of this tool is to be able to queue all the files that are changed and copy them to the destination folder with a given delay. For instance, if you specify -t 5000 option along with the other required options when running the application, it will wait for 5 seconds before copying all the changed files that it has been queuing. An example would look like as following:

dotnet Copier.dll -s "C:\source-folder\" -f "*.txt" -d "C:\destination-folder" -t 5000

Plugins

Copier app supports plugin integration. You can easily develop your own plugins and have them executed before and after the copy operations. All you have to do is to reference CopierPluginBase in your dotnet core class library, and implement IPostCopyEventListener and|or IPreCopyEventListener interfaces. Once you build your class library, put the .dll file under plugins folder in the Copier app installation location. If you don't see this folder, simply create it where the Copier.dll file exists.

Having issues?

Copier app has been developed with an in-depth logging mechanism. You can see all the steps it takes when running it with the debug -e flag. If you would like to see more than regular messages but less than debug messages, use -v verbose flag. If you still have issues, create a new issue at https://github.com/tarikguney/copier/issues or please send a pull request with the fix. I'd love to see other people's contributions.

How to download?

You can go to release page (https://github.com/tarikguney/copier/releases) and find the most recent version to download. It is a zip file that you need to unzip on your machine.

Watch how this application was developed!

If you speak in Turkish, you can watch the entire process of this application being developed here:

https://www.youtube.com/watch?v=aW8W2gze8JE&list=PL_Z0TaFYSF3LLSRobjiV0y-I18kjRm7cx

Roadmap

  1. Accepts all of the arguments from a config file. An sample command would look like the following: dotnet Copier.dll -f Config.txt. -f is the path of the config file.
  2. Make the executable self-contained, meaning that it won't require .NET Core runtime to be installed on the target machine.
  3. Bump the .NET Core framework version to the latest .NET 5 framework.

Note

If you'd like to store all the options in a file and have copier app read the options from that file, check out the branch configfile-experiment. The further development will continue from that branch until it is fully merged into master branch. For more information, take a look at the readme.md file from configfile-experiment branch.

How will you feel when using this tool?

Laughing