README
¶
bitrat
Lightning-fast, multi-algorithm file checksums.
Overview
bitrat is a command-line tool to quickly calculate checksums for nested file hierarchies, such that subsequent changes to those files can be easily detected, with the goal of identifying files corrupted by bitrot or other unexpected change. It supports multiple hashing algorithms and provides a fast and efficient way to ensure the integrity of your files.
Features
- Cross-platform compatibility (macOS, Linux, FreeBSD, Windows).
- Supports a wide range of hashing algorithms including BLAKE3, BLAKE2, SHA3, SHA2, and more (
bitrat list-algorithms). - Supports HMAC for added security (
bitrat --hmac my-secret). - Exploits multi-core systems with fast, parallel processing pipelines.
Installation
Go
go install github.com/isometry/bitrat@latest
Homebrew
brew install isometry/tap/bitrat
Usage
bitrat
Future
In future, the tool should be extended to support:
- support direct verification of checksums in a file (
--check). - support storage of file checksums in extended attributes to streamline the detection of changes.
- support client/server mode to support locally-stateless centralisation of integrity checks.
Documentation
¶
Overview ¶
Copyright © 2019 Robin Breathe <[email protected]>
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Source Files
Directories