Skip to content

Commit

Permalink
Small updates to README, src files
Browse files Browse the repository at this point in the history
  • Loading branch information
Ian Gillespie authored and Ian Gillespie committed Dec 9, 2022
1 parent 452c696 commit 84a8769
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 8 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,10 @@ export SPLUNK_REPORT_TIMEOUT=<int_value>
## Additional Notes
Currently, the CLI color output does not work in a Windows environment.

If you get a message about a missing DLL on Windows, you will need to install the Visual Studio redistributable
package found here: https://www.microsoft.com/en-us/download/details.aspx?id=52685
If you get a message about a missing DLL on Windows, you will need to install the Visual Studio redistributable package found here: https://www.microsoft.com/en-us/download/details.aspx?id=52685

## Quirks / Bugs / Gotchas
When using `--included_tags` ensure that you use `=` and not a space. So `--included_tags=cloud,jquery` will work, but `--included_tags cloud,jquery` will not.

## Options
```
Expand All @@ -55,9 +57,7 @@ OPTIONS:
By default this will generat an HTML file. If set to false then the report will be generated as JSON. Only
applicable is 'generate_file' flag is set to true.
-t, --included_tags <included_tags>...
Multiple tags allowed i.e. -t=foo,bar etc. All tags provided here
https://dev.splunk.com/enterprise/reference/appinspect/appinspecttagreference/ can now be passed in as
options i.e. -t=cloud,jquery.
Multiple tags allowed i.e. --included_tags=foo,bar etc. All tags provided here https://dev.splunk.com/enterprise/reference/appinspect/appinspecttagreference/.
-p, --password <SPLUNK_PASSWORD>
Provide your splunk.com / SplunkAnswers / Splunkbase password. Can also be set as an env var
SPLUNK_PASSWORD.
Expand All @@ -82,7 +82,7 @@ Optionally, if you store your SPLUNK_PASSWORD, SPLUNK_USERNAME, and REPORT_PATH
v 0.2.1
- Clap updated to v4.0.18
- Note: Tags must be provided as a comma delimited list:
`-t=<tag1>,<tagN>`
`-t=<tag1>,<tagN> or --included_tags=<tag1>,<tagN>`
- Reqwest update to v0.11
- Added `private_victoria` and `private_classic` tags

Expand Down
2 changes: 1 addition & 1 deletion src/cli.rs
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ pub fn build_cli() -> Command {
.long("included_tags")
.required(true)
.use_value_delimiter(true)
.help("Multiple tags allowed i.e. -t=foo,bar etc. All tags provided here https://dev.splunk.com/enterprise/reference/appinspect/appinspecttagreference/ can now be passed in as options i.e. -t jquery -t cloud.")
.help("Multiple tags allowed i.e. --included_tags=foo,bar etc. All tags provided here https://dev.splunk.com/enterprise/reference/appinspect/appinspecttagreference/ can now be passed in as options i.e. -t jquery -t cloud.")
)
.arg(Arg::new("generate_file")
.long("generate_file")
Expand Down
2 changes: 1 addition & 1 deletion src/main.rs
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ fn submit_app(
let res: serde_json::Value = request_build;

if res["message"]
== "File type not allowed. Files must be [\'gz\', \'tgz\', \'zip\', \'spl\', \'tar\']"
== "File type not allowed. Files must be [\'gz\', \'tgz\', \'zip\', \'spl\', \'tar\']"
{
return Err(Box::new(CustomError(res["message"].to_string())));
}
Expand Down

0 comments on commit 84a8769

Please sign in to comment.