Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
PsychedelicShayna authored Sep 14, 2024
1 parent ba65830 commit 2dbcd14
Showing 1 changed file with 11 additions and 6 deletions.
17 changes: 11 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,6 @@ The SHA2 family and MD5 is also supported but that's only there for compatibilit
## Usage

```
A CLI frontend to jwalk for blazingly fast filesystem traversal!
Usage: jw [OPTIONS] [directories]...
Arguments:
Expand All @@ -41,19 +39,26 @@ Options:
Display results in realtime, rather than collecting first and displaying later.
This will result in a significant drop in performance due to the constant terminal output.
-c, --checksum [<algorithm>]
-c, --csum
Output an index containing the hash of every file using the specified algorithm.
It is highly recommended you stick with xxh3, as it is significantly more performant,
and directly suited for this use case. SHA2/MD5 are only provided for compatibility.
Uses the default algorithm. To specify one use --calgo. Note: specifying --calgo makes this redundant.
-C, --calgo <algorithm>
Performs --csum but with the specified hashing algorithm.
Using xxh3 is the recommended choice. Unless you have a reason to use something else,
stick with the default. SHA2 and MD5 are provided for compatibility with other tools
and existing data. If you're only using jw, you stand to gain a large increase in
performance by using xxh3.
[default: xxh3]
[possible values: xxh3, sha224, sha256, sha384, sha512, md5]
-t, --threads <count>
The number of threads to use to hash files in parallel.
[default: 1]
-C, --diff <file1> <file2>...
-D, --diff <file1> <file2>...
Validate hashes from two or more files containing output from `jw --checksum`
The first file will be treated as the "correct" one; any discrepant hashes
in the subseqeunt files will be reported. If entries from the first file are
Expand Down

0 comments on commit 2dbcd14

Please sign in to comment.