hash-hunter 0.1.1

Find files with specified hashes
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82

# hash-hunter

[![Crates.io](https://img.shields.io/crates/v/hash-hunter.svg)](https://crates.io/crates/hash-hunter)
[![Documentation](https://docs.rs/hash-hunter/badge.svg)](https://docs.rs/hash-hunter)
[![CI](https://github.com/Data-Forge-Solutions/hash-hunter/actions/workflows/CI.yml/badge.svg)](https://github.com/Data-Forge-Solutions/hash-hunter/actions)
[![License](https://img.shields.io/crates/l/hash-hunter)](LICENSE)
[![GitHub](https://img.shields.io/github/stars/Data-Forge-Solutions/hash-hunter?style=social)](https://github.com/Data-Forge-Solutions/hash-hunter)

hash-hunter is a Rust CLI and library for locating files by cryptographic hash.
It supports common algorithms, optional name matching to avoid unnecessary
hashing, and batch searches for multiple targets.

## Features

- Search directories for a target hash with optional file name filtering.
- Batch mode for multiple hashes and hash/name pairs.
- Multiple hashing algorithms (for example, SHA-256 and SHA3-256).
- Results can be streamed to stdout or written to a file.
- Library API for embedding search logic in other applications.

## Installation

Install from crates.io:

```bash
cargo install hash-hunter
```

## Usage

Search a directory for a SHA-256 hash (default):

```bash
hash-hunter --dir ./data --hash <hex-hash>
```

Provide a file name to shortcut hashing when possible:

```bash
hash-hunter --dir ./data --hash <hex-hash> --name report.pdf
```

Use a different algorithm:

```bash
hash-hunter --dir ./data --algo sha3-256 --hash <hex-hash>
```

Batch mode (one target per line):

```
# batch.txt
<hash1> report.pdf
<hash2>
```

```bash
hash-hunter --dir ./data --algo sha256 --batch batch.txt
```

Write results to a text file:

```bash
hash-hunter --dir ./data --hash <hex-hash> --output results.txt
```

## Output

Results are written to stdout and optionally to `--output`. Matches are printed
as `match: <path> (name)` and missing targets are printed as
`missing: <hash> (name)`. The summary includes total checked files plus any
unchecked files that failed to hash.

## Library usage

The core logic is available as a library via `hash_hunter::search` for
applications that need to embed the search behavior directly.

## Notes

- Hash inputs must be hexadecimal without a leading prefix.
- File name filtering is an optimization and does not replace hash validation.