hbackup 0.2.1

hbackup is a sample, high-performance, cross-platform backup tool written in Rust. It is designed to be fast, efficient, and easy to use, with a focus on performance and reliability.
Documentation 
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
111
112
113
114

# hbackup

[![Build status](https://github.com/asthetik/hbackup/workflows/build/badge.svg)](https://github.com/asthetik/hbackup/actions)
[![Crates.io](https://img.shields.io/crates/v/hbackup.svg)](https://crates.io/crates/hbackup)
![Crates.io](https://img.shields.io/crates/d/hbackup)
[![MIT License](https://img.shields.io/badge/license-MIT-blue)](LICENSE)

[English](./README.md) | [简体中文](./README.zh-CN.md)

hbackup is a sample, high-performance, cross-platform backup tool written in Rust. It is designed to be fast, efficient, and easy to use, with a focus on performance and reliability.

## Features

- Simple and fast file/directory backup via CLI
- Cross-platform: macOS, Linux, Windows
- Supports custom backup tasks with unique IDs
- Configuration and task management via JSON in user config directory
- Supports '~', '$HOME' and relative paths for source and target paths

## Quick Start

### 1. Install

```sh
cargo install hbackup
```

### 2. Add one or more jobs

```sh
bk add --source ~/my_path1/my_file1.txt --target ~/back
bk add --source ~/my_path2/my_file2.txt --target ~/back
```

### 3. List all jobs

```sh
bk list
```

### 4. Run all backed jobs

- run all jobs:

```sh
bk run
```

- Run the job with the specified ID:

```sh
bk run --id 1
```

- run a specific job with source and target:

```sh
bk run ~/my_path/myfile.txt ~/back
```

### 5. Delete a job

- Delete a job by id:

```sh
bk delete --id 1
```

- Delete all jobs:

```sh
bk delete --all
```

### 6. Edit a job

```sh
bk edit --id 1 --source ~/newfile.txt --target ~/newbackup/
```

### 7. configuration file

display configuration file path

```shell
bk config
```

- backup configutation file

```sh
bk config --copy
```

- reset configuration file (The file will be automatically backed up before resetting it)

```sh
bk config --reset
```

- Rollback the last backed up configuration file

```sh
bk config --rollback
```

## Configuration File Location

- macOS/Linux: `~/.config/hbackup/hbackup.json`
- Windows: `C:\Users\<User>\AppData\Roaming\hbackup\hbackup.json`

## License

MIT