rfgrep 0.1.0

Recursive file grep utility with advanced filtering - search, list, and analyze text files with regex support
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
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138

# rfgrep  

A command-line utility for recursively searching and listing files with advanced filtering capabilities. Built in Rust.

[![CI](https://github.com/kh3rld/rfgrep/actions/workflows/ci.yml/badge.svg)](https://github.com/kh3rld/rfgrep/actions/workflows/ci.yml)

## Features

- **Advanced Search**
  - Regex, plain text, and whole-word matching
  - Recursive directory traversal
  - Binary file detection
  - Extension filtering
  - Size limits

- **File Listing**
  - Detailed/simple output formats
  - Extension statistics
  - Size filtering
  - Hidden file handling

- **Utilities**
  - Clipboard copy support
  - Dry-run mode
  - Logging to file
  - Progress indicators

## Installation

### From Source

```bash
git clone https://github.com/kh3rld/rfgrep.git
cd rfgrep
cargo install --path .
```

### Via Cargo

```bash
cargo install rfgrep
```

## Usage

### Basic Search

```bash
rfgrep search "pattern"
```

### Search with Options

```bash
rfgrep search "pattern" \
    --mode regex \
    --extensions rs,toml \
    --max-size 5 \
    --skip-binary \
    --copy
```

### File Listing

```bash
# Simple list
rfgrep list

# Detailed view
rfgrep list --long --recursive

# With filters
rfgrep list --extensions rs,toml --max-size 10 --show-hidden
```

## Command Reference

### Global Options

| Option       | Description                     |
|--------------|---------------------------------|
| `--log PATH` | Write logs to specified file    |
| `--path DIR` | Base directory (default: `.`)   |

### Search Command

| Option            | Description                          |
|-------------------|--------------------------------------|
| `--mode MODE`     | Search mode: regex/text/word         |
| `--extensions EXT`| Comma-separated file extensions      |
| `--max-size MB`   | Skip files larger than specified MB  |
| `--skip-binary`   | Skip binary files                   |
| `--dry-run`       | Preview files without processing     |
| `--copy`          | Copy results to clipboard           |

### List Command

| Option            | Description                          |
|-------------------|--------------------------------------|
| `--extensions EXT`| Comma-separated file extensions      |
| `--long`          | Detailed output format              |
| `--recursive`     | Recursive directory traversal       |
| `--show-hidden`   | Include hidden files/directories    |
| `--max-size MB`   | Skip files larger than specified MB  |
| `--skip-binary`   | Skip binary files                   |

## Examples

1. Find all Rust files containing "HashMap":

```bash
rfgrep search "HashMap" --extensions rs
```

2. List all Markdown files under 1MB:

```bash
rfgrep list --extensions md --max-size 1
```

3. Search with regex and copy to clipboard:

```bash
rfgrep search "fn\s+\w+\s*\(" --mode regex --copy
```

## Performance Tips

- Use `--skip-binary` to avoid unnecessary file checks
- Limit scope with `--extensions` and `--max-size`
- For large directories, `--dry-run` first to preview

## Contributing

Contributions are welcome! Please open an issue or PR for any:
- Bug reports
- Feature requests
- Performance improvements