kevinveenbirkenbach/directory-content-scanner
1
0
Fork 0
mirror of https://github.com/kevinveenbirkenbach/directory-content-scanner.git synced 2024-11-21 20:41:04 +01:00
Code Issues Packages Projects Releases Wiki Activity
2 Commits 1 Branch 0 Tags 69 KiB
Python 100%
05be0e33aa
Go to file
Kevin Veen-Birkenbach 05be0e33aa
Create README.md
2023-09-02 16:59:06 +02:00
LICENSE Initial commit 2023-09-02 16:35:30 +02:00
README.md Create README.md 2023-09-02 16:59:06 +02:00

README.md

Directory Content Scanner

Directory Content Scanner is a tool designed for the recursive scanning of directories, providing outputs for both file paths and their associated content. This tool is especially handy for rapid content exploration and debugging within nested file structures.

Getting Started

Prerequisites

  • Bash shell (commonly available on Linux and macOS)

Installation

  1. Clone this repository:

    git clone https://github.com/kevinveenbirkenbach/directory-content-scanner.git

  2. Navigate to the cloned directory:

    cd directory-content-scanner

  3. Make the script executable:

    chmod +x scan.sh

Usage

Run the script with a directory as its argument:

./scan.sh /path/to/directory

This will print each file's path followed by its content, separated by equal signs for clarity.

Warning

Use this tool responsibly. If some of the target directory files are extensive, the script might produce a vast output. Always be aware of the volume of data you're dealing with before executing the script.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Author

Kevin Veen-Birkenbach

License

This project is licensed under the GNU Affero General Public License v3.0. The full license text is available in the LICENSE file of this repository.

Acknowledgement

These scripts were created with the assistance of OpenAI's ChatGPT model. You can learn more about how they were created here.