Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/puutaro/difbk
Differential backup tool made with 100% shellscript
https://github.com/puutaro/difbk
backup debian difbk find-fd linux ripgrep shellscript ubuntu wsl2
Last synced: 5 days ago
JSON representation
Differential backup tool made with 100% shellscript
- Host: GitHub
- URL: https://github.com/puutaro/difbk
- Owner: puutaro
- License: mit
- Created: 2022-11-03T03:48:14.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2024-06-10T01:58:21.000Z (5 months ago)
- Last Synced: 2024-06-10T02:57:33.685Z (5 months ago)
- Topics: backup, debian, difbk, find-fd, linux, ripgrep, shellscript, ubuntu, wsl2
- Language: Shell
- Homepage:
- Size: 133 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# `difbk`
[]((https://opensource.org/licenses/MIT))
Command line differential backup tool made by 100% shell script.
It's a differential backup tool, which have ritch feature: backup, fullbackup, search, grep, diff, restore, clean up.
Pros
----
- Ritch feature
- use filesystem itself (when you want to complement the function, you can use shell command very easily, you can easily transfer data to other pc or file system)
- Since it is compressed and save, saves data (gzip type)
- It form golden combination with git (when your project is too security sensitive to use git, file transfer other branch, and you have half-finished but important edits)
Table of Contents
-----------------
* [Installation](#installation)
* [For Ubuntu or Debian or Wsl](#for-ubuntu-or-debian-or-wsl)
* [Upgrading](#upgrading)
* [Upgrading for Ubuntu or Debian or Wsl](#upgrading-for-ubuntu-or-debian-orwsl)
* [Demo](#demo)
* [Usage](#usage)
* [Buckup](#buckup)
* [Status](#status)
* [Reset](#reset)
* [List backup files](#list-backup-files)
* [Search](#search)
* [Path search](#path-search)
* [contents search](#contents-search)
* [Status diff](#status-diff)
* [Diff](#diff)
* [Restore](#restore)
* [All buckup files restore](#all-buckup-files-restore)
* [One buckup file restore](#one-buckup-file-restore)
* [Clean](#install)
* [Validate backup list file](#validate-backup-list-file)
* [Delete specify backup generation](#delete-specify-backup-generation)
* [Merge](#merge)
Installation
-----
### For Ubuntu or Debian or Wsl
- Support Ubuntu20.04+
```
git clone https://github.com/kitamura-take/difbk.git ~/.difbk
cd ~/.difbk/install
bash install.sh l
```
Upgrading.
-----
### Upgrading for Ubuntu or Debian
1. delete $HOME/.difbk directory
2. same as installation.
Usage
-----
### Buckup
It mean diffrencial backup
1. type bellow command
```
difbk bk -d "{backup description}"
```
2. If `label stamp` exist, select and type esc
- back up option
| option| set value | comment |
| --------- | --------- | ------------ |
| `-d` | string | backup'e description |
| `-dn` | no | no set backup'e description |
| `-mklabel` | string | label stamp attached to the beginning of the description (ex label -> [label] ~ ) |
| `-rmlabel` | string | remove registerd label |
| `-lslabel` | no | list registerd labels |
| `-ln` | no | when backup, not add label stamp |
### Status
It mean confirm status
1. type bellow command
```
difbk st (target mergelist number (reffrer lrs merge list num or target file)|merge list path)
```
### Reset
remove recent backup
1. type bellow command
```
difbk reset
```
- lrs option
| option| set value | comment |
| --------- | --------- | ------------ |
| `-s` | no | without comfirm, remove it |
### List backup files
`difbk` management backup generation by backup files's text file(in fact commpressed into gz). Here list backup's list text files. this subcommand is base command in `difbk`. This is used for `sch`, `rs` and `diff`, etc. When add no `-full` option, display recent 30 merge file path
1. type bellow command
```
difbk lrs -e
```
- lrs option
| option| set value | comment |
| --------- | --------- | ------------ |
| `-e` | no | display every backup file |
| `-d` | string | description's `include` filter string |
| `-de` | string | description's `or` filter string |
| `-dv` | string | description's `exclude` filter label |
| `-full` | no | full merge list display |
### Search
`difbk` can search path or file contents. It's freqently use feature, and strong one at the same time.
#### Path search
1. type bellow command
```
difbk sch {search path word1} {search path word2} {search path word3} ...
```
- It's `and` search.
- sch option
| option| set value | comment |
| --------- | --------- | ------------ |
| `-e` | string | `or` search |
| `-v` | string | `exclude` search |
| `-d` | string | description's `include` filter string |
| `-de` | string | description's `or` filter string |
| `-dv` | string | description's `exclude` filter label |
| `-da` | datetime string (YYYY/MM/DD/hhmm) | delete after datetme |
| `-db` | datetime string (YYYY/MM/DD/hhmm) | delete before datetme |
| `-j` | int | generation number (when `difbk lrs -e`, display in left brackets) |
#### Contents search
1. type bellow command
```
difbk sch -c {search path word}
```
- sch -c option
| option| set value | comment |
| --------- | --------- | ------------ |
| `-d` | string | description's `include` filter string |
| `-de` | string | description's `or` filter string |
| `-dv` | string | description's `exclude` filter label |
| `-da` | datetime string (YYYY/MM/DD/hhmm) | delete after datetme |
| `-db` | datetime string (YYYY/MM/DD/hhmm) | delete before datetme |
| `-j` | int | every generation number (when `difbk lrs -e`, display in left brackets) |
### Status diff
1. type bellow command
```
difbk diff (target mergelist number (reffrer lrs merge list num or target file)|merge list path)
```
### Diff
1. type bellow command
```
difbk diff { blank (current direcotry diff) | generation number or backup list file path or backuped file path}
```
- diff option
| option| set value | comment |
| --------- | --------- | ------------ |
| `-e` | int | every generation search on (default daily diff) |
| `-de` | string | description's `or` filter string |
| `-dv` | string | description's `exclude` filter label |
| `-da` | datetime string (YYYY/MM/DD/hhmm) | delete after datetme |
| `-db` | datetime string (YYYY/MM/DD/hhmm) | delete before datetme |
### Restore
#### All buckup files restore
This is generally called restore
1. type bellow command
```
difbk rs {backup list file path} {destination directory} (grep path from backup list)
```
#### One buckup file restore
This restore only one buckup file. In a nutshell, `merge` or `copy`
1. type bellow command
```
difbk rs {backup one file path}
```
- above command mean `merge`
- merge option
| option| set value | comment |
| --------- | --------- | ------------ |
| `-c` | no | not `merge` but `copy` |
#### Restore buckup to current project directory
1. type bellow command
```
difbk rbk [merge list path or order num (number in left brackets when type difkb lrs -e )]
```
### Clean
#### Validate backup list file
`difbk` mainly use backup list file. Threfore, this have sub command that varidate backup list file.
1. type bellow command
```
difbk clean -vl
```
- latest backup file check and if finding miss, correct.
#### Delete specify backup generation
Although `difbk` compress file and save one, Data can be bloated with long use. when so , delete spedify generation, and litghten the buckup.
1. type bellow command
```
difbk clean -dddd {generation number you wont to leaves last}
```
- `generation number` is larger three.
### Merge
When you want to merge backups and you want to rename project directory, `difbk` can do.
1. type bellow command
```
difbk mrg -alt {project directory after renamd} {backup root directory after renamed}
```
- `backup root project directory` mean `old_{project directory name}` in the same hierarchy as the project directory
- `{project directory after renamd}` can use `-` for current project directory name and `_` for deleting current project directory name
- `{backup root directory after renamed}` can use `-` for current backup root project directory name and `_` for deleting current backup root project directory name
- merge option
| option| set value | comment |
| --------- | --------- | ------------ |
| `-dest` | string | destination directory full path for move|