diff --git a/README.md b/README.md index 20b913e..d67ce5e 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,30 @@ # secret-scan -This is a wrapper for Gittyleaks to add recursiveness and better output control. +This is a small wrapper for Gittyleaks to add recursiveness and better output control. + +I wrote this because I had a need to scan multiple Git repositories w/ Gittyleaks. This script will iterate through the target directory, assuming each nested directory is a Git repo, and run GL on them. The output will then be written to the output directory, with the following format: \/\_secrets.txt + + If you couldn't tell, it requires [Gittyleaks](https://github.com/kootenpv/gittyleaks) to be installed. + +## Usage +#### ./secretScan.sh \ \ + +- ./secretScan.sh /repositories /repositories/secrets +
+ +### Assumed Directory Structure +>-> repositories/
+----> repo1
+----> repo2
+----> repo3 +
+ +### Example Output Structure +#### With command arguments: ./secretScan.sh /repositories /repositories/secrets +>-> repositories/
+----> repo1
+----> repo2
+----> repo3
+----> secrets/
+-------> repo1_secrets.txt
+-------> repo2_secrets.txt
+-------> repo3_secrets.txt