cover 0.1.24

A simple Rust tool for syncing directories with change detection
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110

<p align="center">
    <img
    src="https://raw.githubusercontent.com/ibilalkayy/cover/main/logo.png"
    alt="Logo"
    width="500"
    />
</p>

<p align="center">
  <a href="LICENSE">
    <img src="https://img.shields.io/badge/license-Apache--2.0-blue.svg" alt="License">
  </a>
  <a href="https://www.rust-lang.org">
    <img src="https://img.shields.io/badge/Rust-stable-orange" alt="Rust">
  </a>
</p>

✨ If you would like to help spread the word of Cover, please consider starring the repo!

# Table of Content

- [What is Cover?](#what-is-cover)
- [Features](#features)
  - [Present Features](#present-features)
  - [Upcoming Features](#upcoming-features)
- [Docs](#docs)
- [Get Started](#get-started)
- [Installation](#installation)
- [License](#license)
- [Contributing](#contributing)

# What is Cover?

Cover is a Rust application where the source and destination are synced and any change in the source will be happening in the destination at the same time.

## Features

### Present Features

- **Sync** files and folders of source with destination

### Upcoming Features

- **Archive** projects into `.zip` or `.tar.gz`
- **Restore** from backups easily
- **Schedule** automatic backups (daily, weekly, interval-based)
- **List** archives and scheduled jobs
- **Clean** old backups with rules (`--keep-last`, `--older-than`)

## Docs

Here is the docs that you can read it yourself.

- [Cover Docs](https://docs.rs/crate/cover-files/)

## Get Started

```bash
cargo install cover
```

### Commands 

```bash
cover sync
cover archive
cover restore
cover schedule
cover list
cover clean
```

```bash
cover sync --source src_directory --destination dest_directory --changed-only
cover sync --source src_directory --destination dest_directory --delete
cover sync --source src_directory --destination dest_directory --dry-run
cover sync --source src_directory --destination dest_directory --verbose
```

**Note:** Other commands are in the process.

## Installation

Fork, clone and build from the source:

```bash
git clone https://github.com/ibilalkayy/cover.git
cd cover
cargo build --release
````

The binary will be available at:

```
target/release/cover
```

Optionally, move it to your `$PATH`:

```bash
cp target/release/cover /usr/local/bin/cover
```

## License

This project is licensed under the [Apache-2.0 License](LICENSE).

## Contributing

Contributions, issues, and feature requests are welcome! Feel free to open a PR or file an issue on [GitHub](https://github.com/ibilalkayy/cover/issues).