@infrascan/cli 0.2.1 → 0.2.3

package/README.md

@@ -2,3 +2,47 @@
 
 The Infrascan CLI is a thin wrapper around the Infrascan SDK which outputs its state to the local file system.
 
+The Infrascan CLI exposes two commands: scan and graph. A scan will read in all of the information that it can from your AWS account, and write it to your local file system. You can then run the graph command to take that scan output and convert it into an infrastructure diagram. 
+
+## Prerequisite
+
+Infrascan requires read access to your AWS account to generate its graphs. Read access can be given by specifying a profile in your [AWS credentials file](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-files.html), or by using the [default credential provider chain](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/setting-credentials-node.html) and providing a role to assume.
+
+## Quickstart
+
+### Scan
+
+To run a scan command, we first need to create the config file. The config file will tell the CLI which regions to scan, and how to authenticate with AWS. The config file format is:
+
+```json
+[
+  {
+    "regions": ["eu-west-1", "us-east-1"],
+    "profile": "infrascan-read-access-staging"
+  },
+  {
+    "regions": ["eu-west-1"],
+    "roleToAssume": "arn:aws:iam::000000000000:role/InfrascanReadOnlyRolePreProd"
+  }
+]
+```
+
+The scan command takes our config file and an output directory as arguments. The output directory is where all of the state generated during the scan will be written. This will be used by our graph command to produce an infrastructure diagram.
+
+```sh
+infrascan scan -c config.json -o ./state
+```
+
+The state directory should contain JSON files in the format of: `<AccountID>-<Region>-<Service>-<FunctionCalled>.json`.
+
+### Graph
+
+To convert the scan output into a graph, we run the graph command passing the scan output directory as our input:
+
+```sh
+infrascan graph --input ./state
+```
+
+The graph output will be saved to a `graph.json` file in the state directory. The graph file contains an array of JSON objects representing the Nodes and Edges of the graph. This is formatted to be used with [cytoscape](https://js.cytoscape.org/), however it can be translated into any graphing library (Note: the graphs usually require on being able to create parent-child relationships)
+
+You can view your graph by pasting the contents of your `graph.json` file into: [render.infrascan.io](https://render.infrascan.io).

package/dist/index.mjs

@@ -36,10 +36,10 @@ var GraphCmd = class extends CommandLineAction {
   }
   onDefineParameters() {
     this._outputDirectory = this.defineStringParameter({
-      parameterLongName: "--output",
-      parameterShortName: "-o",
-      argumentName: "PATH_TO_STATE_OUTPUT",
-      description: "Location to read scan output from. This should be the same as the directory given to the scan command.",
+      parameterLongName: "--input",
+      parameterShortName: "-i",
+      argumentName: "PATH_TO_STATE",
+      description: "Location to read scan state from. This should be the same as the directory given to the scan command.",
       defaultValue: "./state"
     });
   }
@@ -104,7 +104,9 @@ function resolveCredentials(profile, roleToAssume) {
       }
     });
   }
-  throw new Error();
+  throw new Error(
+    "An error occurred while resolving credentials for Infrascan \u2014 no profile or role given."
+  );
 }
 var ScanCmd = class extends CommandLineAction2 {
   constructor(infrascanClient) {

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@infrascan/cli",
-  "version": "0.2.1",
+  "version": "0.2.3",
   "description": "Thin command line wrapper around the infrascan sdk",
-  "main": "dist/index.js",
+  "main": "dist/index.mjs",
   "scripts": {
     "build": "rm -rf dist ; tsup",
     "lint": "tsc --noEmit ; eslint .",
@@ -20,26 +20,32 @@
     "target": "node18"
   },
   "bin": {
-    "infrascan": "dist/index.js"
+    "infrascan": "./dist/index.mjs"
   },
   "files": [
     "dist"
   ],
   "types": "dist/index.d.ts",
-  "keywords": [],
+  "keywords": [
+    "AWS",
+    "Infrastructure Diagram",
+    "Infrastructure Graph",
+    "Cloud Infrastructure",
+    "CLI"
+  ],
   "author": "Liam Farrelly <liam@l3f7.dev> (https://whoisli.am/)",
   "license": "MPL-2.0",
   "dependencies": {
     "@aws-sdk/credential-providers": "3.428.0",
-    "@infrascan/aws": "^0.2.0",
-    "@infrascan/fs-connector": "^0.2.0",
-    "@infrascan/sdk": "^0.2.0",
+    "@infrascan/aws": "^0.3.0",
+    "@infrascan/fs-connector": "^0.2.2",
+    "@infrascan/sdk": "^0.2.2",
     "@rushstack/ts-command-line": "^4.15.2",
     "minimatch": "^6.1.6"
   },
   "devDependencies": {
     "@aws-sdk/types": "3.428.0",
-    "@infrascan/shared-types": "^0.2.0",
+    "@infrascan/shared-types": "^0.2.2",
     "ts-node": "^10.9.1",
     "typescript": "^5.1.3"
   }