Fix mentions of --file since it is --input now

Author: Kinnaird McQuade

README.md

@@ -141,7 +141,7 @@ This will generate a file in your current directory titled `exclusions.yml`.
 Now when you run the `scan` command, you can use the exclusions file like this:
 
 ```bash
-cloudsplaining scan --exclusions-file exclusions.yml --file examples/files/example.json --output examples/files/
+cloudsplaining scan --exclusions-file exclusions.yml --input examples/files/example.json --output examples/files/
 ```
 
 For more information on the structure of the exclusions file, see [Filtering False Positives](#filtering-false-positives)
@@ -153,7 +153,7 @@ Now that we've downloaded the account authorization file, we can scan *all* of t
 Run the following command:
 
 ```bash
-cloudsplaining scan --exclusions-file exclusions.yml --file examples/files/example.json --output examples/files/
+cloudsplaining scan --exclusions-file exclusions.yml --input examples/files/example.json --output examples/files/
 ```
 
 It will create an HTML report like [this](https://opensource.salesforce.com/cloudsplaining/):
@@ -243,7 +243,7 @@ exclude-actions:
 Now when you run the `scan` command, you can use the exclusions file like this:
 
 ```bash
-cloudsplaining scan --exclusions-file exclusions.yml --file examples/files/example.json --output examples/files/
+cloudsplaining scan --exclusions-file exclusions.yml --input examples/files/example.json --output examples/files/
 ```
 
 
@@ -252,7 +252,7 @@ cloudsplaining scan --exclusions-file exclusions.yml --file examples/files/examp
 You can also scan a single policy file to identify risks instead of an entire account.
 
 ```bash
-cloudsplaining scan-policy-file --file examples/policies/explicit-actions.json
+cloudsplaining scan-policy-file --input examples/policies/explicit-actions.json
 ```
 
 The output will include a finding description and a list of the IAM actions that do not leverage resource constraints.
@@ -283,13 +283,13 @@ cloudsplaining download --profile someprofile
 cloudsplaining download --profile all
 
 # Scan Authorization details
-cloudsplaining scan --file default.json
+cloudsplaining scan --input default.json
 # Scan Authorization details with custom exclusions
-cloudsplaining scan --file default.json --exclusions-file exclusions.yml
+cloudsplaining scan --input default.json --exclusions-file exclusions.yml
 
 # Scan Policy Files
-cloudsplaining scan-policy-file --file examples/policies/wildcards.json
-cloudsplaining scan-policy-file --file examples/policies/wildcards.json  --exclusions-file examples/example-exclusions.yml
+cloudsplaining scan-policy-file --input examples/policies/wildcards.json
+cloudsplaining scan-policy-file --input examples/policies/wildcards.json  --exclusions-file examples/example-exclusions.yml
 ```
 
 ## FAQ

cloudsplaining/command/create_exclusions_file.py

@@ -46,4 +46,4 @@ def create_exclusions_file(output_file):
     )
     print("\tcloudsplaining download")
     print("You can use this with the scan command as shown below: ")
-    print("\tcloudsplaining scan --exclusions-file exclusions.yml --file default.json")
+    print("\tcloudsplaining scan --exclusions-file exclusions.yml --input default.json")

cloudsplaining/command/expand_policy.py

@@ -20,16 +20,17 @@
     short_help="Expand the * Actions in IAM policy files to improve readability"
 )
 @click.option(
-    "--file",
+    "--input",
     type=click.Path(exists=True),
     required=True,
     help="Path to the JSON policy file.",
 )
 @click_log.simple_verbosity_option(logger)
-def expand_policy(file):
+def expand_policy(input):  # pylint: disable=redefined-builtin
     """
     Expand the * Actions in IAM policy files to improve readability
     """
+    file = input
     with open(file) as json_file:
         logger.debug(f"Opening {file}")
         data = json.load(json_file)

cloudsplaining/command/scan_policy_file.py

@@ -29,7 +29,7 @@
     short_help="Scan a single policy file to identify identify missing resource constraints."
 )
 @click.option(
-    "--file",
+    "--input",
     type=click.Path(exists=True),
     required=True,
     help="Path of to the IAM policy file.",
@@ -50,9 +50,9 @@
     " (Resource Exposure, Privilege Escalation, Data Exfiltration). This can help with prioritization.",
 )
 @click_log.simple_verbosity_option(logger)
-def scan_policy_file(file, exclusions_file, high_priority_only):
+def scan_policy_file(input, exclusions_file, high_priority_only):  # pylint: disable=redefined-builtin
     """Scan a single policy file to identify missing resource constraints."""
-
+    file = input
     # Get the exclusions configuration
     with open(exclusions_file, "r") as yaml_file:
         try:

cloudsplaining/output/templates/guidance/2-triage-guidance.md

@@ -35,7 +35,7 @@ To recap: you've followed these steps to generate this report:
   <ul><li><code>cloudsplaining create-exclusions-file --output-file exclusions.yml</code></li></ul>
 <li>Generated the report</li>
   <ul>
-    <li><code>cloudsplaining scan --file default-account-details.json --exclusions-file exclusions.yml</code></li>
+    <li><code>cloudsplaining scan --input default-account-details.json --exclusions-file exclusions.yml</code></li>
     <li>This generates three files: (1) The single-file HTML report, (2) The triage CSV worksheet, and (3) The raw JSON data file</li>
   </ul>
 </ul>
@@ -149,7 +149,7 @@ Add whatever values you want to the above depending on your organization's conte
 * Now, run the scan to generate a *new* Cloudsplaining report  that considers your exclusions criteria. This way, you are working with a report version that consists of True Positives only.
 
 ```bash
-cloudsplaining scan --file default.json --exclusions-file exclusions.yml
+cloudsplaining scan --input default.json --exclusions-file exclusions.yml
 ```
 
 You can now proceed to the Remediation stage.

cloudsplaining/output/templates/guidance/4-validation.md

@@ -13,7 +13,7 @@ After you've rewritten your IAM policy, we suggest two options for validating th
 
 You can validate that your remediated policy passes Cloudsplaining by running the following command:
 
-```cloudsplaining scan-policy-file --file policy.json --exclusions-file exclusions.yml```
+```cloudsplaining scan-policy-file --input policy.json --exclusions-file exclusions.yml```
 
 When there are no more results, it passes!
 

docs/index.md

@@ -59,7 +59,7 @@ Now when you run the `scan` command, you can use the exclusions file like this:
 
 ```bash
 cloudsplaining scan --exclusions-file exclusions.yml \
-    --file examples/files/example.json \
+    --input examples/files/example.json \
     --output examples/files/
 ```
 
@@ -73,6 +73,6 @@ Run the following command:
 
 ```bash
 cloudsplaining scan --exclusions-file exclusions.yml \
-    --file examples/files/example.json \
+    --input examples/files/example.json \
     --output examples/files/
 ```

docs/report/triage.md

@@ -29,7 +29,7 @@ To recap: you've followed these steps to generate this report:
 * Generated your custom exclusions file
     - `cloudsplaining create-exclusions-file --output-file exclusions.yml`
 * Scanned the Account authorization details
-    - `cloudsplaining scan --file default-account-details.json --exclusions-file exclusions.yml`
+    - `cloudsplaining scan --input default-account-details.json --exclusions-file exclusions.yml`
     - This generates three files: (1) The single-file HTML report, (2) The triage CSV worksheet, and (3) The raw JSON data file
 
 ## Triaging workflow

docs/report/validation.md

@@ -10,7 +10,7 @@ Leveraging [Parliament](https://github.com/duo-labs/parliament/) by Duo-Labs, co
 
 You can validate that your remediated policy passes Cloudsplaining by running the following command:
 
-```cloudsplaining scan-policy-file --file policy.json --exclusions-file exclusions.yml```
+```cloudsplaining scan-policy-file --input policy.json --exclusions-file exclusions.yml```
 
 When there are no more results, it passes!
 

docs/user-guide/create-exclusions-file.md

@@ -15,5 +15,5 @@ This will generate a file in your current directory titled `exclusions.yml`.
 Now when you run the `scan` command, you can use the exclusions file like this:
 
 ```bash
-cloudsplaining scan --exclusions-file exclusions.yml --file examples/files/example.json --output examples/files/
+cloudsplaining scan --exclusions-file exclusions.yml --input examples/files/example.json --output examples/files/
 ```