mirror of
https://github.com/kevinveenbirkenbach/directory-content-scanner.git
synced 2024-09-08 03:03:10 +02:00
Updated README.md
This commit is contained in:
parent
68aa8628e1
commit
c950a42ca9
12
README.md
12
README.md
@ -36,6 +36,16 @@ To show the help page execute:
|
||||
python3 scan.py /path/to/directory --help
|
||||
```
|
||||
|
||||
- `paths`: List of files or directories to scan. This is a positional argument.
|
||||
- `--file-types`: Filter by file types (e.g., `.txt`, `.log`). Only files with these extensions will be processed.
|
||||
- `--ignore-file-strings`: Ignore files and folders containing these strings. Useful for excluding specific files or directories.
|
||||
- `--ignore-hidden`: Ignore hidden directories and files (those starting with a dot).
|
||||
- `-v`, `--verbose`: Enable verbose mode. This will print additional information about skipped files.
|
||||
- `--no-comments`: Remove comments from the displayed content based on file type. Comments in supported file types (Python, JS, C, CPP, H) will be stripped.
|
||||
- `--compress`: Compress code (for supported file types). The content will be displayed in compressed form.
|
||||
- `--path-contains`: Display files whose paths contain one of these strings. Useful for narrowing down the scan to specific parts of the directory structure.
|
||||
- `--content-contains`: Display files containing one of these strings in their content. The file's content will be checked, and only matching files will be shown.
|
||||
|
||||
## ⚠️ Caution
|
||||
|
||||
Exercise caution when scanning directories with large files. The script may produce extensive output. Always assess the data volume before executing the script.
|
||||
@ -56,4 +66,4 @@ This project is licensed under the GNU Affero General Public License v3.0. The c
|
||||
|
||||
## 🙏 Acknowledgements
|
||||
|
||||
Special thanks to OpenAI's ChatGPT model for assistance. Dive deeper into the creation process [here](https://chat.openai.com/share/71e9bc9e-d34a-4b03-bf68-4f9e994d156a) and [here](https://chat.openai.com/share/3fc66009-ff4e-425e-a4a3-fc703534885d).
|
||||
Special thanks to OpenAI's ChatGPT model for assistance. Dive deeper into the creation process [here](https://chat.openai.com/share/71e9bc9e-d34a-4b03-bf68-4f9e994d156a), [here](https://chat.openai.com/share/3fc66009-ff4e-425e-a4a3-fc703534885d) and [here](https://chatgpt.com/share/d08724c6-8f65-4b24-9828-e0f895bd1e1d).
|
||||
|
Loading…
Reference in New Issue
Block a user