rfgrep 0.2.0

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

RFGREP(1)                                                User Commands                                               RFGREP(1)

NAME
       rfgrep  - A powerful command-line utility for recursively searching and listing files with advanced filtering capabili‐
       ties

SYNOPSIS
       rfgrep [OPTIONS] [PATH] COMMAND [COMMAND_OPTIONS]

DESCRIPTION
       rfgrep is a high-performance file search and listing utility written in Rust. It provides advanced search  capabilities
       including  regex  patterns, plain text matching, and whole-word searches. The tool features parallel processing, memory
       mapping for large files, and comprehensive filtering options.

FEATURES
       Advanced Search
              Regex, plain text, and whole-word matching with context lines

       File Listing
              Detailed/simple output formats with extension statistics

       Performance
              Parallel processing with memory mapping for large files

       Filtering
              Extension, size, and binary file filtering

       Utilities
              Clipboard copy, dry-run mode, and progress indicators

GLOBAL OPTIONS
       -v, --verbose
              Enable verbose logging output

       --log FILE
              Write logs to specified file

       --dry-run
              Preview files without processing (useful for testing)

       --max-size SIZE
              Skip files larger than specified MB

       --skip-binary
              Skip binary files (improves performance)

       -h, --help
              Print help information

       -V, --version
              Print version information

COMMANDS
       search Search for patterns in files with advanced filtering

       interactive
              Interactive search mode with real-time filtering

       list   List files with detailed information and statistics

       completions
              Generate shell completion scripts

       help   Print help for a specific command

EXAMPLES
       Search for "HashMap" in Rust files:
              rfgrep search HashMap --extensions rs

       List all Markdown files under 1MB:
              rfgrep list --extensions md --max-size 1

       Search with regex and copy to clipboard:
              rfgrep search fn\s+\w+\s*\( regex --copy

       Recursive search with word boundaries:
              rfgrep search test word --recursive --extensions rs

PERFORMANCE TIPS
       Use --skip-binary
              to avoid unnecessary file checks

       Limit scope
              with --extensions and --max-size

       Use --dry-run first
              to preview files

       Enable --recursive
              for deep directory traversal

ENVIRONMENT
       RFGREP_CONFIG
              Path to configuration file (optional)

       RFGREP_LOG_LEVEL
              Set logging level (debug, info, warn, error)

FILES
       ~/.config/rfgrep/config.toml
              User configuration file

       ~/.cache/rfgrep/
              Cache directory for compiled regex patterns

EXIT STATUS
       0      Success

       1      General error

       2      Invalid arguments

       3      File processing error

BUGS
       Report bugs to: https://github.com/kh3rld/rfgrep/issues

AUTHOR
       Written by the rfgrep development team.

COPYRIGHT
       Copyright © 2025 rfgrep contributors. License GPLv3+: GNU GPL version 3 or later <https://gnu.org/licenses/gpl.html>.

SEE ALSO
       grep(1), ripgrep(1), find(1)

NOTES
       This man page documents rfgrep version 0.1.1. For the most up-to-date information, visit  https://github.com/kh3rld/rf‐
       grep

rfgrep v0.1.1                                             August 2025                                                RFGREP(1)