parent
565415c0bc
commit
98bd3b2370
15
README.md
15
README.md
@ -24,12 +24,19 @@ chkbit is a tool that ensures the safety of your files by checking if their *dat
|
|||||||
|
|
||||||
Remember to always maintain multiple backups for comprehensive data protection.
|
Remember to always maintain multiple backups for comprehensive data protection.
|
||||||
|
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
|
- Install via [Homebrew](https://formulae.brew.sh/formula/chkbit) for macOS and Linux:
|
||||||
|
```
|
||||||
|
brew install chkbit
|
||||||
|
```
|
||||||
- Download for [Linux, macOS or Windows](https://github.com/laktak/chkbit-py/releases).
|
- Download for [Linux, macOS or Windows](https://github.com/laktak/chkbit-py/releases).
|
||||||
- Get it with [pipx](https://pipx.pypa.io/latest/installation/): `pipx install chkbit`
|
- Get it with [pipx](https://pipx.pypa.io/latest/installation/)
|
||||||
|
```
|
||||||
|
pipx install chkbit
|
||||||
|
```
|
||||||
|
|
||||||
[Homebrew](https://brew.sh) is delayed until we reach their `>=75` stars rule.
|
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
@ -87,6 +94,7 @@ Status codes:
|
|||||||
|
|
||||||
chkbit is set to use only 5 workers by default so it will not slow your system to a crawl. You can specify a higher number to make it a lot faster if the IO throughput can also keep up.
|
chkbit is set to use only 5 workers by default so it will not slow your system to a crawl. You can specify a higher number to make it a lot faster if the IO throughput can also keep up.
|
||||||
|
|
||||||
|
|
||||||
## Repair
|
## Repair
|
||||||
|
|
||||||
chkbit is designed to detect "damage". To repair your files you need to think ahead:
|
chkbit is designed to detect "damage". To repair your files you need to think ahead:
|
||||||
@ -96,6 +104,7 @@ chkbit is designed to detect "damage". To repair your files you need to think ah
|
|||||||
- run chkbit *after* a backup on the backup media (readonly)
|
- run chkbit *after* a backup on the backup media (readonly)
|
||||||
- in case of any issues, *restore* from a checked backup medium.
|
- in case of any issues, *restore* from a checked backup medium.
|
||||||
|
|
||||||
|
|
||||||
## Ignore files
|
## Ignore files
|
||||||
|
|
||||||
Add a `.chkbitignore` file containing the names of the files/directories you wish to ignore
|
Add a `.chkbitignore` file containing the names of the files/directories you wish to ignore
|
||||||
@ -111,6 +120,7 @@ Add a `.chkbitignore` file containing the names of the files/directories you wis
|
|||||||
- you can use `path/sub/name` to ignore a file/directory in a sub path
|
- you can use `path/sub/name` to ignore a file/directory in a sub path
|
||||||
- hidden files (starting with a `.`) are ignored by default
|
- hidden files (starting with a `.`) are ignored by default
|
||||||
|
|
||||||
|
|
||||||
## FAQ
|
## FAQ
|
||||||
|
|
||||||
### Should I run `chkbit` on my whole drive?
|
### Should I run `chkbit` on my whole drive?
|
||||||
@ -208,6 +218,7 @@ error: detected 1 file with damage!
|
|||||||
|
|
||||||
`DMG` indicates damage.
|
`DMG` indicates damage.
|
||||||
|
|
||||||
|
|
||||||
## Development
|
## Development
|
||||||
|
|
||||||
With pipenv (install with `pipx install pipenv`):
|
With pipenv (install with `pipx install pipenv`):
|
||||||
|
Loading…
x
Reference in New Issue
Block a user