lookfor 1.1.0

Cross-Platform file finder
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

# lookfor

A cross-platform command line utility to find and highlight files that match a pattern.

## Installation

- From [crates.io](https://crates.io/crates/lookfor): `cargo install lookfor`
- From [GitHub](https://github.com/DarkCeptor44/lookfor): `cargo install --git https://github.com/DarkCeptor44/lookfor`
- Manually (after cloning the repo locally): `cargo install --path .`
- From [releases](https://github.com/DarkCeptor44/lookfor/releases/latest).

## Usage

![usage](usage.png)

```sh
$ lookfor -h
Cross-Platform file finder

Usage: lookfor [OPTIONS] <PATTERN>

Arguments:
  <PATTERN>  Pattern to search for

Options:
      --in <PATH>       Path to search in [default: .]
      --color <COLOR>   Color of the highlighted text (off for no color) [default: blue]
  -I, --case-sensitive  Case sensitive search
  -h, --help            Print help
  -V, --version         Print version
```

## Todo

- Add support for regular expressions.

## Benchmarks

The benchmarks were performed on different machines at the root of the repository after running both `cargo build` and `cargo build -r`, to find anything with `clap` in the target directory.

- Machine A: `AMD64, 32GB RAM, Ryzen 7 3800X`
- Machine B: `ARM64, 1GB RAM, Orange Pi Zero2`

### Windows

Ran on Machine A (Windows 10):

| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|:---|---:|---:|---:|---:|
| `lookfor clap` | 44.8 ± 1.5 | 43.4 | 53.1 | 1.00 |
| `dir /s /b *clap*` | 75.4 ± 1.7 | 73.2 | 79.7 | 1.68 ± 0.07 |
| `findstr /s /m /c:clap *` | 694.5 ± 4.8 | 686.8 | 702.2 | 15.51 ± 0.52 |

### Linux

Ran on Machine A (WSL2 Debian 12):

| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|:---|---:|---:|---:|---:|
| `lookfor clap` | 167.4 ± 7.7 | 160.6 | 187.3 | 1.00 |
| `find . -iname "*clap*"` | 271.9 ± 13.3 | 250.0 | 283.1 | 1.62 ± 0.11 |

Ran on Machine B (Debian 12):

| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|:---|---:|---:|---:|---:|
| `lookfor clap` | 14.0 ± 0.2 | 13.5 | 14.6 | 1.06 ± 0.04 |
| `find . -iname "*clap*"` | 13.2 ± 0.4 | 12.6 | 15.0 | 1.00 |

## License

This project is licensed under the terms of the [GNU General Public License](LICENSE) v3.0.