https://github.com/sergio0694/quickup
A .NET Core 2.1 CLI tool to quickly create one-way backups from one folder to another
https://github.com/sergio0694/quickup
backup backup-utility cli cli-app csharp dotnet dotnet-tool dotnetcore netcoreapp
Last synced: about 1 year ago
JSON representation
A .NET Core 2.1 CLI tool to quickly create one-way backups from one folder to another
- Host: GitHub
- URL: https://github.com/sergio0694/quickup
- Owner: Sergio0694
- License: mit
- Created: 2018-10-18T21:12:01.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-10-22T14:22:21.000Z (over 7 years ago)
- Last Synced: 2025-02-23T21:42:33.569Z (over 1 year ago)
- Topics: backup, backup-utility, cli, cli-app, csharp, dotnet, dotnet-tool, dotnetcore, netcoreapp
- Language: C#
- Size: 60.5 KB
- Stars: 5
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# quickup - quick backup tool
[](https://www.nuget.org/packages/quickup/) [](https://www.nuget.org/stats/packages/quickup?groupby=Version) [](https://twitter.com/SergioPedri)
A .NET Core 2.1 CLI tool to create one-way backups from one folder to another. This can be used to keep an up-to-date copy of a given folder on another hard-drive.
## Installing from DotGet
Make sure to get the [.NET Core 2.1 SDK](https://www.microsoft.com/net/download/dotnet-core/sdk-2.1.300), then just run this command:
```
dotnet tool install quickup -g
```
And that's it, you're ready to go!
## Quick start
**quickup** is super easy to use: just pick the source and target folders and you-re ready to go.
Other options include:
* `-i` | `--include`: a list of file extensions to use to filter the files in the source directory.
* `-e` | `--exclude`: an optional list of file extensions to ignore (this option and `include` are mutually exclusive).
* `--ignore-dir`: an optional list of directory names to ignore from the source tree.
* `-p` | `--preset`: An optional preset to quickly filter common file types [documents|images|music|videos|code|VS|UWP].
* `-b` | `--beep`: play a short feedback sound when the requested operation completes.
* `-v` | `--verbose`: display additional info after analyzing the source directory.
* `--id`: an optional backup id, to keep multiple backups in the same directory with different versions.
* `--source-current`: use the current working directory as the source path.
* `--multithread` : automatically parallelize the backup creation on the available CPU threads.
* `--threads` : when combined with `multithread`, specifies the maximum number of threads to use.
### Examples
Create a backup of folder A on another drive, notify when the operation finishes and play a notification sound:
```
quickup -s C:\Users\MyName\Documents\A -t D:\Backups -b -v
```
Backup the current directory on another drive, using the Visual Studio preset (ignores \.vs, \bin, \obj folders):
```
quickup --source-current -t D:\Backups -p vs
```
## Dependencies
The libraries use the following libraries and NuGet packages:
* [CommandLineParser](https://www.nuget.org/packages/commandlineparser/)
* [JetBrains.Annotations](https://www.nuget.org/packages/JetBrains.Annotations/)