scanit 0.2.5

A fast file scanner utility that uses regex patterns to find files in your filesystem.
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
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123

# scanit 🔍

[![Rust](https://img.shields.io/badge/rust-stable-brightgreen.svg)](https://www.rust-lang.org/)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

A command-line utility that recursively searches directories for files matching regex patterns.

Notably this is my first RUST cli and first time using git

## 🚀 Features

- Unix and Windows Compatible
- Recursive directory scanning
- Regex pattern matching
- Hidden file support
- Cross-platform compatibility (Unix and Windows)
- Current directory search option

## ⚙️ Installation

```bash
cargo install scanit
```

## 📝 Changelog

### version=[0.2.5]

Changed underlying structure to better enable use as a library.
Mostly, this means that now the find files returns an Iterator, which allows the collect method(or iteration)

Added a case-insensitivity option.

Increased performance again, roughly about 30% on my limited tests

Lowered Rust Version required to 1.74.1 for people on older Rust versions.

### version=[0.2.1]

#### Changes

- Fixed working directory commandline options

### version=[0.2.0]

#### Fixed

- Reduced redundant conversion errors when scanning restricted paths
- Improved error handling for kernel-protected directories
- Optimized path traversal logic
- Fixed README.md
- Added new CLI argument for including dirs in searching, defaults to off

#### Changed

- Improved performance when handling permission denied errors

## 🔧 Dependencies

| Dependency | Version | Description |
|:-----------|:--------|:------------|
| [regex](https://crates.io/crates/regex) | 1.11.1 | Regular expression pattern matching |
| [clap](https://crates.io/crates/clap) | 4.4 | Command line argument parsing |
| [jwalk](https://crates.io/crates/jwalk) | 0.8.1 | Fast parallel directory traversal |

Special thanks to:

jwalk - For the excellent parallel directory traversal

regex - For the powerful regex engine

clap - For the robust CLI argument parsing

## Examples

## Find Rust files in /usr

scanit '\.rs$' -d /usr

## Find PNG files from current directory

scanit '\.png$' -c

(or equivalently, scanit '\.png$' --current-directory)

## Find JavaScript test files

scanit '^/.*test.*\.js$'

## Find hidden git files

scanit -a '\.git'

## Search all dirs and file names for a pattern eg zshrc

scanit zshrc -a -i

(or equivalently, scanit zshrc --show-hidden --include-dirs)

## Search case insensitively

scanit PYTHON -e  
(or equivalently, --case-insensitive)
(e is for everything)

## Usage Instructions

Usage: scanit [OPTIONS] <PATTERN>

Arguments: <PATTERN>
          Regex pattern to match files (e.g. \\.rs$)

### Options

| Option | Description | Default |
|:-------|:-----------|:--------|
| `-d, --directory <DIR>` | Starting directory | `/` (Unix), `C:/` (Windows) |
| `-c, --current-directory` | Use current directory | - |
| `-a, --show-hidden` | Show hidden files | - |
| `-h, --help` | Show help | - |
| `-v, --version` | Show version | - |
| `-i, --include-dirs` | Include directories in search pattern | - |
| `-e, --case-insensitive` | Does case insensitive searching | defaults to on|