hbackup-0.3.10 is not a library.

Visit the last successful build: hbackup-0.5.6

hbackup

Crates.io

hbackup is a simple, 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, reliability, and flexible backup management.

Features

🚀 Fast and simple file/directory backup via CLI
🖥️ Cross-platform: macOS, Linux, Windows
🗂️ Custom backup jobs with unique IDs
📝 Configuration and task management via TOML in user config directory
🏠 Supports ~, $HOME, and relative paths for source and target
🔄 Edit, delete, and list backup jobs easily
🗜️ Compression support: gzip, zip, sevenz, zstd, bzip2, xz and lz4 for files and directories
🛠️ Config file backup, reset, and rollback
📦 One-time backup: run a backup without saving a job
🧩 Extensible: easy to add new features

Quick Start

1. Install

cargo install hbackup

2. Add one or more jobs

bk add --source ~/my_path1/my_file1.txt --target ~/back
bk add --source ~/my_path2/my_file2.txt --target ~/back
# Add a job with compression (gzip or zip)
bk add -s ~/my_path3/my_dir -t ~/back -c gzip
bk add -s ~/my_path4/my_dir -t ~/back -c zip

3. List all jobs

bk list

4. Run backup jobs

Run all jobs:
```
bk run
```
Run a job by ID:
```
bk run --id 1
```

Run a one-time backup (without saving as a job):

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

You can also specify compression for a one-time backup:

bk run ~/my_path/mydir ~/back gzip
bk run ~/my_path/mydir ~/back zip

5. Delete jobs

Delete a job by ID:
```
bk delete --id 1
```
Delete all jobs:
```
bk delete --all
```

6. Edit a job

Update the source and/or target of a job by its ID:

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

7. Manage configuration file

Show configuration file path:
```
bk config
```
Backup configuration file:
```
bk config --copy
```
Reset configuration file (auto-backup before reset):
```
bk config --reset
```
Rollback to the last backed up configuration file:
```
bk config --rollback
```

Compression Support

You can specify compression format (gzip, zip, sevenz, zstd, bzip2 or lz4) when adding or running jobs:

# Add a job with gzip compression
bk add --source ~/file.txt --target ~/back --compression gzip
# or a short command line
bk add -s ~/file.txt -t ~/back -c gzip

# One-time backup with compression
bk run ~/my_path/mydir ~/back gzip

Compression works for both files and directories.
Output files will have gz, zip, 7z, zst, bzip2, xz or lz4 extensions.
If no compression is specified, files are copied as-is.

Command Reference

Command	Description
`bk add`	Add a new backup job
`bk list`	List all backup jobs
`bk run`	Run all jobs, a job by ID, or a one-time backup
`bk delete`	Delete a job by ID or delete all jobs
`bk edit`	Edit a job's source/target by ID
`bk config`	Show, backup, reset, or rollback config file

Run bk <command> --help for detailed options.

Configuration File Location

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

A backup of the config file is automatically created before resetting.

Error Handling

All errors are reported with clear messages.
If you run bk without a command, you'll see:

  error: hbackup requires at least one command to execute.

  See 'bk --help' for usage.

License

MIT

hbackup 0.3.10