Merge remote-tracking branch 'upstream/main' into structures

Samsung · Nov 7, 2022 · 0e36719 · 0e36719
2 parents ab563ba + 4d59bda
commit 0e36719
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 5 deletions.
diff --git a/credsweeper/__main__.py b/credsweeper/__main__.py
@@ -8,7 +8,7 @@
 
 from credsweeper import __version__, CREDSWEEPER_DIR
 from credsweeper.app import CredSweeper
-from credsweeper.common.constants import ThresholdPreset
+from credsweeper.common.constants import ThresholdPreset, Severity, RuleType
 from credsweeper.file_handler.files_provider import FilesProvider
 from credsweeper.file_handler.patch_provider import PatchProvider
 from credsweeper.file_handler.text_provider import TextProvider
@@ -101,7 +101,9 @@ def get_arguments() -> Namespace:
                        metavar="PATH")
     parser.add_argument("--rules",
                         nargs="?",
-                        help="path of rule config file (default: credsweeper/rules/config.yaml)",
+                        help="path of rule config file (default: credsweeper/rules/config.yaml). "
+                        f"severity:{[i.value for i in Severity]} "
+                        f"type:{[i.value for i in RuleType]}",
                         default=None,
                         dest="rule_path",
                         metavar="PATH")
@@ -181,7 +183,8 @@ def get_arguments() -> Namespace:
                         metavar="PATH")
     parser.add_argument("--log",
                         "-l",
-                        help="provide logging level. Example --log debug, (default: 'warning')",
+                        help=f"provide logging level of {list(Logger.LEVELS.keys())}"
+                        f"(default: 'warning', case insensitive)",
                         default="warning",
                         dest="log",
                         metavar="LOG_LEVEL",

diff --git a/docs/source/guide.rst b/docs/source/guide.rst
@@ -27,7 +27,7 @@ Get all argument list:
                             exporting default config to file (default: config.json)
       --export_log_config [PATH]
                             exporting default logger config to file (default: log.yaml)
-      --rules [PATH]        path of rule config file (default: credsweeper/rules/config.yaml)
+      --rules [PATH]        path of rule config file (default: credsweeper/rules/config.yaml). severity:['critical', 'high', 'medium', 'low', 'info'] type:['keyword', 'pattern', 'pem_key']
       --config [PATH]       use custom config (default: built-in)
       --log_config [PATH]   use custom log config (default: built-in)
       --denylist PATH       path to a plain text file with lines or secrets to ignore
@@ -45,7 +45,7 @@ Get all argument list:
       --save-json [PATH]    save result to json file (default: output.json)
       --save-xlsx [PATH]    save result to xlsx file (default: output.xlsx)
       --log LOG_LEVEL, -l LOG_LEVEL
-                            provide logging level. Example --log debug, (default: 'warning')
+                            provide logging level of ['DEBUG', 'INFO', 'WARN', 'WARNING', 'ERROR', 'FATAL', 'CRITICAL', 'SILENCE'](default: 'warning', case insensitive)
       --size_limit SIZE_LIMIT
                             set size limit of files that for scanning (eg. 1GB / 10MiB / 1000)
       --banner              show version and crc32 sum of CredSweeper files at start