updaing readme and fixing a small profile issue.

Author: dtylman

README.md

@@ -14,16 +14,98 @@ Lists all resources in a AWS account.
 
 * Runs a single operation
 
+* CLI Support
+
+## Overview 
+
+AWSRetriever scans sets of predefined `AWS` APIs, saved in "profile" files.
+
+Profiles are `json` based files, holding a (potentially) very long list of operations to run. AWSRetriever is shipped with a `default.profile.js`, that holds a generic wide-variety of calls. 
+
+The profile is scanned when choosing "Full Scan" from the side-bar menu, or using the command-line parameter `-p` (combined with  `-r`)
+
+Profiles can be saved & loaded. The default profile loaded is defined in the configuration file.
+
+A typical use-case is to define and test profiles for various AWS resources views and then use the CLI to periodically retrieve the items from AWS.
+
+### Command-line interface
+
+To export all items provided in my `ec2.profile.js`, and save them in `object.json`, use the following switches:
+
+```PS
+>AWSRetriever.exe -r -p ec2.profile.js -o objects.json
+AWS Retriever
+Using profile: 'ec2.profile.js'
+Writing to 'objects.json'
+Queueing from 'default' profile...1825 operations queued.
+Scanning...
+```
+
+To export all items to `myobjects.json` using the default profile and settings:
+```PS
+>AWSRetriever.exe -r -o myobjects.json
+AWS Retriever
+Using profile: 'default.profile.js'
+Writing to 'myobjects.json'
+Queueing from 'default' profile...1825 operations queued.
+Scanning...
+EC2 DescribeInternetGateways ap-northeast-1: 1 items retrieved
+EC2 DescribeInternetGateways ap-south-1: 1 items retrieved
+EC2 DescribeInternetGateways ap-northeast-2: 1 items retrieved
+EC2 DescribeInternetGateways ca-central-1: 1 items retrieved
+.
+.
+.
+```
+
+The resulting `myobjects.json` file, holds a JSON array with the following structure:
+```json
+[
+{ "Type" : "InternetGateway", // the type of the object listed
+  "Service" : "EC2", // the service it was retrieved from
+  "Region" : "ap-northeast-2", // the region
+  "Source" : { //the object itself, will change according to the object
+  "Attachments": [
+    {
+      "State": {
+        "Value": "available"
+      },
+      "VpcId": "vpc-e2e9f18a"
+    }
+  ],
+  "InternetGatewayId": "igw-0562ad6d",
+  "OwnerId": "000000000000",
+  "Tags": []
+}}
+,
+.
+.
+.
+```
+
+### Profile Record 
+
+Each profile record holds:
+```json
+ {
+    "ServiceName": "EC2", // AWS service to execute
+    "Name": "DescribeInternetGateways", // Specific API to execute
+    "Regions": "ap-northeast-1 ap-northeast-2 ap-south-1 ap-southeast-1 ap-southeast-2 ca-central-1 eu-central-1 eu-north-1 eu-west-1 eu-west-2 eu-west-3 sa-east-1 us-east-1 us-east-2 us-west-1 us-west-2", // a list of regions to call 
+    "Enabled": true, // if false, this API is skipped
+    "PageSize": 18 // if this API supports paging, this value will be the page size for each request.
+  },
+```
+
 ## Download & Run
 
 Download [the latest](https://github.com/dtylman/AWSRetriever/releases/) for Windows or Linux.
 
 ### Windows
 
-1. (Requires .NET 4.5)
+1. Requires `.NET`
 1. Create a folder `AWSRetriever`
 1. Unzip to folder.
-1. Run `AWSRetriver.exe`
+1. Run `AWSRetriever.exe`
 
 ### Linux / Ubuntu
 
@@ -48,14 +130,13 @@ mono AWSRetriver.exe
 
 ### Profile Editor
 
-![profile-editor](./doc/profile-editor1.PNG)
+![profile-editor](./doc/profile-editor.PNG)
 
-### Lanching a specific API
+### Launching a specific API
 
 ![single-operation](./doc/single-operation.PNG)
 
-
 ### Thanks
 
-* [Modern UI Done RIght](https://github.com/NickAcPT/ModernUIDoneRight)
+* [Modern UI Done Right](https://github.com/NickAcPT/ModernUIDoneRight)
 * [Icons8](https://icons8.com/license/)

Retriever/ConsoleScanner.cs

@@ -18,8 +18,9 @@ public class ConsoleScanner
         private AWSCredentials creds;
 
 
-        public void Scan(string outputFile)
+        public void Scan(string outputFile, string profile)
         {
+            Console.WriteLine(String.Format("Using profile: '{0}'", profile));
             Console.WriteLine(String.Format("Writing to '{0}'", outputFile));
             swout = new StreamWriter(outputFile);
             swout.WriteLine("[");
@@ -38,7 +39,7 @@ public void Scan(string outputFile)
                     throw new ApplicationException(String.Format("No credentials provided. Edit in configuration file: '{0}'",
                         Configuration.Instance.ConfigFileName));
                 }                
-                this.profile = Profile.Load(Configuration.Instance.Profile);
+                this.profile = Profile.Load(profile);
                 QueueOperations();
                 Console.WriteLine("Scanning...");
                 this.scanner.Scan();               
@@ -57,15 +58,22 @@ private void Progress_ProgressChanged(object sender, OperationResult e)
                 e.Operation.ServiceName, e.Operation.Name, e.Operation.Region.SystemName, e.ResultText()));
             if (!e.IsError())
             {
-                foreach (CloudObject cobo in e.Operation.CollectedObjects)
-                {
-                    swout.WriteLine("" +
-                        "  {" +
-                        "  \"Type\" : \"" + cobo.TypeName + "\",");
-                    swout.WriteLine(
-                            "  \"Source\" : " + cobo.Source + ",},");
-
+                var iter = e.Operation.CollectedObjects.GetEnumerator();
+                do
+                {                    
+                    CloudObject cobo = iter.Current;
+                    if (cobo == null)
+                    {
+                        continue;
+                    }                    
+                    swout.WriteLine("{ \"Type\" : \"" + cobo.TypeName + "\",");
+                    swout.WriteLine("  \"Service\" : \"" + cobo.Service+ "\",");
+                    swout.WriteLine("  \"Region\" : \"" + cobo.Region+ "\",");
+                    swout.WriteLine("  \"Source\" : " + cobo.Source + "}");
+                    swout.WriteLine(",");
                 }
+                while (iter.MoveNext());
+                
                 swout.Flush();
             }
         }

Retriever/Program.cs

@@ -58,6 +58,15 @@ static void Main()
             {
                 AppMain(consoleAttached);
             }
+            catch (Exception ex)
+            {
+                var debug = Environment.GetEnvironmentVariable("AWSRetriever_DEBUG");
+                if (!string.IsNullOrEmpty(debug))
+                {
+                    Console.WriteLine(ex);
+                }
+                Console.WriteLine(ex.Message);
+            }
             finally
             {
                 if (consoleAttached)
@@ -72,7 +81,7 @@ private static void AppMain(bool consoleAttached)
         {
             if (consoleAttached)
             {
-                Console.WriteLine("AWS Retriver");
+                Console.WriteLine("AWS Retriever");
             }
             FluentCommandLineParser<ProgramArgs> p = new FluentCommandLineParser<ProgramArgs>();
             p.Setup(arg => arg.RunNow).As('r', "run").SetDefault(false).WithDescription("Run now");
@@ -98,7 +107,12 @@ private static void AppMain(bool consoleAttached)
             if (p.Object.RunNow)
             {
                 ConsoleScanner cs = new ConsoleScanner();
-                cs.Scan(p.Object.OutFile);
+                string profile = p.Object.ProfileFile;
+                if (string.IsNullOrEmpty(profile))
+                {
+                    profile = Configuration.Instance.Profile;
+                }
+                cs.Scan(p.Object.OutFile,profile);
             }
             else
             {

Retriever/Retriever.csproj

@@ -30,7 +30,7 @@
     <ProductName>AWSRetriever</ProductName>
     <PublisherName>AWSRetriever</PublisherName>
     <OpenBrowserOnPublish>false</OpenBrowserOnPublish>
-    <ApplicationRevision>7</ApplicationRevision>
+    <ApplicationRevision>8</ApplicationRevision>
     <ApplicationVersion>0.1.0.%2a</ApplicationVersion>
     <UseApplicationTrust>false</UseApplicationTrust>
     <CreateDesktopShortcut>true</CreateDesktopShortcut>