Skip to content

Peek is a fast, multi-threaded file search tool that recursively scans directories, filtering by filename, extension, and content. Ideal for developers or anyone working with large codebases, it provides efficient searches with customizable filters for name, text, and file types. Quick and easy file searching!

License

Notifications You must be signed in to change notification settings

0xhex0rc1st/Peek-Fast-Recursive-File-Search-with-Filters

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Peek: Fast, Recursive File Search with Filters

Peek is a fast, multi-threaded file search tool designed to help you quickly find files and content across large directories. Whether you're a developer or just dealing with a lot of files, Peek offers powerful search options to find exactly what you need in no time.

🚀 Features

  • Super-fast searches using multi-threading.
  • Recursive directory search to explore subdirectories.
  • Search by file name, extension, or content.
  • Case-insensitive search option for easier matching.
  • Customizable thread count to speed up searches.
  • Simple to use with a clean, easy-to-understand interface.

🔧 Installation

  1. Clone the repository to your local machine:

    git clone https://github.com/0xhex0rc1st/Peek-Fast-Recursive-File-Search-with-Filters.git
  2. Build the project using your preferred build system (e.g., CMake).

🧾 Usage

Run Peek with the following command:

./peek [OPTIONS]

Main Options:

  • -p <path> or --path <path> Specifies the directory path to search. Default is the current directory (.).

  • -n <name> or --name <name> Search for files with a specific base name (without the file extension).

  • --ext <extension> Filter by file extension (e.g., .cpp, .txt).

  • -t <text> or --text <text> Search for files containing a specific text string inside them.

  • -i or --ignore-case Makes the search case-insensitive.

  • -T <threads> or --threads <threads> Use multiple threads to speed up the search (1-5 threads recommended).

  • -h or --help Display the help message with all available options.

🔍 Examples

  • Search for a file by name:

    ./peek --name myfile
  • Search for a specific text inside files:

    ./peek --text "TODO"
  • Search using multiple threads:

    ./peek --threads 4 --path /my/project --name config
  • See all available options:

    ./peek --help

💡 Tips

  • Want faster results? Try using more threads (-T <number>) to speed up searches in large directories.
  • Looking for a specific file? Use the --name option to find a file based on its base name.

📄 License

MIT License - see the LICENSE file for more information.

About

Peek is a fast, multi-threaded file search tool that recursively scans directories, filtering by filename, extension, and content. Ideal for developers or anyone working with large codebases, it provides efficient searches with customizable filters for name, text, and file types. Quick and easy file searching!

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages