Added more details for flags action input in README

SecureStackCo · Dec 2, 2021 · a9e1075 · a9e1075
1 parent bb1881b
commit a9e1075
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -19,6 +19,10 @@ jobs:
           flags: '--dom -r'
 ```
 
+NOTE - to understand possible values for the action input `flags`, run the SecureStack cli locally:
+
+`$ bloodhound-cli recon --help`
+
 ## Getting your SecureStack API Key
 
 1. Log in to [SecureStack](https://app.securestack.com) and go to the Profile -> GENERATE KEY screen.

diff --git a/action.yml b/action.yml
@@ -11,7 +11,7 @@ inputs:
     description: 'Severities lower than this value will be reported in the workflow console but will not cause an error for the action; value should be one of: critical | high | medium | low'
     required: true
   flags:
-    description: 'Optional flags for the bloodhound-cli recon command'
+    description: 'Optional flags for the bloodhound-cli recon command.  Run bloodhound-cli recon --help for more details.'
     required: false
     default: ''
 runs: