This script allows you to search all text-based files in a directory for a given string.
- Supports both simple string matching and regular expressions
- Recursive search with a specified depth level
- Customizable file extensions to search
- Search within a specific date range
- File size limit option
- Clone the repository or download the script files.
git clone https://github.com/dfirsec/string_searcher.git
- Navigate to the project directory:
cd string_searcher
- Install the dependencies using poetry:
pip install poetry
poetry install
- Create the virtual environment
poetry shell
- Run using the following commands:
python string_searcher.py <directory> <search_term> [--maxdepth <depth>] [-e <extensions>] [--maxline <num>] [--size-limit <size>] [--start-date <start_date>] [--end-date <end_date>]
<directory>: The directory to search in.
<search_term>: The string to search for.
--maxdepth <depth>: The maximum depth to recurse into subdirectories. Default is 1. Use '--depth -1' for all subdirectories.
-e <extensions>: The file extensions to search within. Provide a comma-separated list. Default extensions include: .bat, .cfg, .csv, .css, .html, .ini, .js, .log, .md, .ps1, .py, .sh, .txt, .xml, .yaml, .yml.
--maxline <num>: The maximum line length to display. Default is 1000. Adjust if line is truncated.
--start-date <start_date>: The start date for modification date filtering. Use format YYYY-MM-DD.
--end-date <end_date>`: The end date for modification date filtering. Use format YYYY-MM-DD.
--size-limit <size>: The maximum file size to consider in kilobytes.
rich: For rich console output.
This script is licensed under the MIT License. Feel free to modify and use it according to your needs.
The script utilizes the rich library for enhanced console output.
The banner text used in the script is courtesy of Manytools.
The text file extension list is courtesy of File-Extensions.