readme.md in aws_recon-0.2.28 vs readme.md in aws_recon-0.2.29
- old
+ new
@@ -52,17 +52,17 @@
To run locally, first install the gem:
```
$ gem install aws_recon
-Fetching aws_recon-0.2.26.gem
+Fetching aws_recon-0.2.28.gem
Fetching aws-sdk-3.0.1.gem
Fetching parallel-1.20.1.gem
...
Successfully installed aws-sdk-3.0.1
Successfully installed parallel-1.20.1
-Successfully installed aws_recon-0.2.26
+Successfully installed aws_recon-0.2.28
```
Or add it to your Gemfile using `bundle`:
```
@@ -70,11 +70,11 @@
Fetching gem metadata from https://rubygems.org/
Resolving dependencies...
...
Using aws-sdk 3.0.1
Using parallel-1.20.1
-Using aws_recon 0.2.26
+Using aws_recon 0.2.28
```
## Usage
AWS Recon will leverage any AWS credentials (see [requirements](#requirements)) currently available to the environment it runs in. If you are collecting from multiple accounts, you may want to leverage something like [aws-vault](https://github.com/99designs/aws-vault) to manage different credentials.
@@ -163,14 +163,17 @@
```
$ AWS_PROFILE=<profile> aws_recon --services S3,EC2 --regions global,us-east-1,us-east-2
```
-Example [OpenCSPM](https://github.com/OpenCSPM/opencspm) formatted output.
+Example [OpenCSPM](https://github.com/OpenCSPM/opencspm) formatted (NDJSON) output.
```
-$ AWS_PROFILE=<profile> aws_recon -s S3,EC2 -r global,us-east-1,us-east-2 -f custom > output.json
+$ AWS_PROFILE=<profile> aws_recon -j \
+ -s S3,EC2 \
+ -r global,us-east-1,us-east-2 \
+ -f custom > output.json
```
#### Errors
API exceptions related to permissions are silently ignored in most cases. These errors are usually due to one of these cases:
@@ -220,10 +223,10 @@
Most users will want to limit collection to relevant services and regions. Running without any exclusions will attempt to collect all resources from all regions enabled for the account.
```
$ aws_recon -h
-AWS Recon - AWS Inventory Collector (0.2.26)
+AWS Recon - AWS Inventory Collector (0.2.28)
Usage: aws_recon [options]
-r, --regions [REGIONS] Regions to scan, separated by comma (default: all)
-n, --not-regions [REGIONS] Regions to skip, separated by comma (default: none)
-s, --services [SERVICES] Services to scan, separated by comma (default: all)