Updated README.md
This commit is contained in:
Robert Vokac
parent
5280c45f04
commit
ef26009a09
127
README.md
127
README.md
@ -2,15 +2,21 @@
|
||||
|
||||
"Bit Inspector" (Bir) is a tool to manage files.
|
||||
|
||||
## Requirements to run "Bit Inspector"
|
||||
## How to run
|
||||
|
||||
Requirements to run "Bit Inspector":
|
||||
* Java 19
|
||||
* Java 21
|
||||
|
||||
## How to build "Bit Inspector" on your own
|
||||
### How to setup your environment on Linux
|
||||
|
||||
Add to your .bashrc:
|
||||
|
||||
alias bir='java -jar {path to bit-inspector jar with dependencies file}/bit-inspector-0.0.0-SNAPSHOT-jar-with-dependencies.jar'
|
||||
|
||||
## How to build
|
||||
|
||||
Requirements to build "Bit Inspector:
|
||||
* Java 19
|
||||
* Java 21
|
||||
* Maven
|
||||
|
||||
```
|
||||
@ -19,12 +25,6 @@ cd bit-inspector
|
||||
mvn clean install
|
||||
```
|
||||
|
||||
## How to setup your environment on Linux
|
||||
|
||||
Add to your .bashrc:
|
||||
|
||||
alias bir='java -jar {path to bit-inspector jar with dependencies file}/bit-inspector-0.0.0-SNAPSHOT-jar-with-dependencies.jar'
|
||||
|
||||
## Features
|
||||
|
||||
### Feature 1 : Bit Rot Detection (to keep your files forever)
|
||||
@ -43,13 +43,14 @@ Inspired by:
|
||||
#### File .birignore
|
||||
|
||||
You can create file .birignore containing the names of the files/directories you wish to ignore
|
||||
* .birignore is similar to Git file .gitignore
|
||||
* each line should contain exactly one name
|
||||
* lines starting with # are skipped
|
||||
* you may use Unix shell-style wildcards
|
||||
|
||||
#### File .bir.sqlite3
|
||||
|
||||
An SQLite database
|
||||
An SQLite database created and managed automatically by bit-inspector.
|
||||
|
||||
#### File .bir.sqlite3.sha512
|
||||
|
||||
@ -62,7 +63,14 @@ Inspired by Git, but goals are slightly different.
|
||||
* https://git-scm.com/docs
|
||||
|
||||
#### File .birbackup
|
||||
|
||||
File .birbackup is stored in local directory, which you are going to backup.
|
||||
|
||||
Content:
|
||||
|
||||
```
|
||||
remotes=remote1,remote2,remote3
|
||||
```
|
||||
|
||||
#### Features
|
||||
|
||||
@ -100,8 +108,60 @@ You can:
|
||||
#### Directory .bir/pack
|
||||
.bir/pack/pack-{sha-512}.pack
|
||||
|
||||
{sha-512}::::{length in bytes}::::{sha-512}::::{length in bytes}::::{sha-512}::::{length in bytes}::::{sha-512}::::{length in bytes}::::{sha-512}::::{length in bytes}::::::::{bytes -base}{bytes-incremental}{bytes-incremental}{bytes-incremental}{bytes-incremental}{bytes-incremental}
|
||||
|
||||
binary diffs
|
||||
|
||||
#### File .bir/birindex.{number}
|
||||
|
||||
https://stackabuse.com/linux-display-file-properties-via-terminal/
|
||||
|
||||
##### Content
|
||||
|
||||
```
|
||||
DATE=20231105
|
||||
TIME=102950
|
||||
VERSION=1
|
||||
MESSAGE=
|
||||
TAG=
|
||||
-----
|
||||
PATH FILE_NAME TYPE LINK_TARGET PERMISSIONS SUID SGID STICKY_BIR EXECUTABLE UID GID OWNER GROUP LAST_MOD_TIME LAST_CHANGE_TIME LAST_ACCESS_TIME SIZE HASH PACKAGE_UUID ACL ATTRS IMMUTABLE UNDELETABLE
|
||||
/home/robertvokac doc.txt - rwxrw-r-- 2 2 robertvokac robertvokac 20220110151617999 20220110151617999 20220110151617999 263 {} PACKAGE_UUID 1 1
|
||||
```
|
||||
|
||||
```
|
||||
TYPE DIR d, REGULAR -, LINK l
|
||||
LINK_TARGET The target is in the content of binary object
|
||||
PERMISSIONS rwxrw-r--
|
||||
HASH SHA-512:{}
|
||||
```
|
||||
|
||||
https://superuser.com/questions/283008/binary-diff-patch-for-large-files-on-linux
|
||||
|
||||
https://stackabuse.com/guide-to-understanding-chmod/
|
||||
|
||||
https://www.guiffy.com/Binary-Diff-Tool.html
|
||||
|
||||
```
|
||||
Permission Symbolic Representation Octal Representation
|
||||
read r 4
|
||||
write w 2
|
||||
execute x 1
|
||||
no permission - 0
|
||||
```
|
||||
|
||||
```
|
||||
Creates local .birindex
|
||||
|
||||
Downloads remote .birindex – if does not exist, empty file will be returned.
|
||||
|
||||
Compares these indexes, uploads new blobs to object addressed system (SHA-512) – packaged to 7z archives (compression=ultra + other settings)
|
||||
|
||||
The most reliable way would be to make md5 hashes of all the local files you care about and store it in a file. So the file will contain a list of filenames and their md5 hashes. Store that file on your ftp server. When you want to update the files on your ftp server, download the file containing the list, compare that against all your local files, and upload the files that have changed (or are new). That way you don't have to worry about archive bits, modified date, or looking at file sizes, the use of which can never be 100% reliable.
|
||||
|
||||
Using file sizes isn't reliable for the obvious reason - a file could change but have the same size. I'm not a fan of using the archive bit or modified date because either of those could be confused if you backup or restore your local directory with another backup program.
|
||||
```
|
||||
|
||||
#### File .bir/birlog
|
||||
|
||||
Contains index number of last bir index.
|
||||
@ -136,7 +196,7 @@ Checks for bitrots in current directory
|
||||
### clone : Cloning a remote repo
|
||||
|
||||
```
|
||||
bir clone {url} [[--bare
|
||||
bir clone {url} [[--bare]] [[revision number|tag]]
|
||||
```
|
||||
|
||||
#### Local
|
||||
@ -172,8 +232,9 @@ bir clone bir:://[{user}:{password}]@{host url}:{port}/[path to repository/]{rep
|
||||
### init
|
||||
|
||||
Init commands creates new directory .bir with its structure
|
||||
|
||||
```
|
||||
bir init
|
||||
bir init [[--bare]]
|
||||
```
|
||||
|
||||
* Creating a new empty Bir repository
|
||||
@ -195,10 +256,18 @@ bir init
|
||||
|
||||
### blame
|
||||
|
||||
```
|
||||
bir blame {file} {remote}
|
||||
```
|
||||
|
||||
### clean
|
||||
|
||||
### gc
|
||||
|
||||
```
|
||||
bir gc abc
|
||||
```
|
||||
|
||||
### fsck
|
||||
|
||||
### check
|
||||
@ -211,13 +280,32 @@ bir init
|
||||
bir remote add {remote name}
|
||||
```
|
||||
|
||||
```
|
||||
bir remote add abc protocol://user:pw|{}@host:port/directory[::password=encryption_password|{}::duplicate_count=1::exclude=::include=::]
|
||||
bir remote add wedos_disk_100gb_backup user:pw@host:port/directory::password=123::duplicate_count=2
|
||||
bir remote add abc user:pw|{}@host:port/directory::password=encryption_password|{}::duplicate_count={1, 0 is default}::compression_level={0-9,5 is default}
|
||||
```
|
||||
|
||||
{} placeholders means, that user will be asked in console (to avoid the password to be in console history)
|
||||
|
||||
### remote remove {remote name}
|
||||
|
||||
```
|
||||
bir remote remove abc
|
||||
```
|
||||
|
||||
### bir commit
|
||||
|
||||
```
|
||||
bir commit [-m "{message}"]
|
||||
```
|
||||
|
||||
### bir push {remote name}
|
||||
### bir mirror {remote name}
|
||||
|
||||
```
|
||||
bir mirror abc def ghi [-m message -t TAG]
|
||||
bir mirror @all
|
||||
```
|
||||
|
||||
### bir fetch
|
||||
|
||||
@ -229,7 +317,18 @@ bir commit [-m "{message}"]
|
||||
|
||||
### bir prune
|
||||
|
||||
```
|
||||
bir prune origin --since 2021-10-04
|
||||
bir prune abc --since "2 months ago" | 10 … does not delete anything, only marks objects to be deleted
|
||||
```
|
||||
|
||||
### verify
|
||||
|
||||
```
|
||||
bir verify abc
|
||||
```
|
||||
|
||||
### repack
|
||||
|
||||
## Todo
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user