@infrascan/cli 0.5.0 → 0.7.0

package/README.md

@@ -2,7 +2,7 @@
 
 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. 
+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
 
@@ -10,6 +10,28 @@ Infrascan requires read access to your AWS account to generate its graphs. Read
 
 ## Quickstart
 
+### Fastest Possible
+
+Run a scan:
+
+```sh
+infrascan scan --region us-east-1
+```
+
+Generate a graph
+
+```sh
+infrascan graph
+```
+
+View it in browser:
+
+```sh
+infrascan render --browser
+```
+
+Or paste it into [render.infrascan.io](https://render.infrascan.io)
+
 ### 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:
@@ -45,4 +67,4 @@ 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).
+You can view your graph by pasting the contents of your `graph.json` file into: [render.infrascan.io](https://render.infrascan.io).

package/dist/commands/graph.mjs

@@ -5,9 +5,8 @@ import {
   CommandLineAction
 } from "@rushstack/ts-command-line";
 import buildFsConnector from "@infrascan/fs-connector";
-import {
-  serializeGraph
-} from "@infrascan/cytoscape-serializer";
+import { serializeGraph as serializeVisualGraph } from "@infrascan/cytoscape-serializer";
+import { serializeGraph as serializeInformationalGraph } from "@infrascan/informational-serializer";
 function readScanMetadata(outputPath) {
   const scanMetadata = readFileSync(
     join(resolve(outputPath), "metadata.json"),
@@ -22,6 +21,9 @@ function writeGraphOutput(outputPath, graphState) {
   );
 }
 var GraphCmd = class extends CommandLineAction {
+  _outputDirectory;
+  _serializer;
+  infrascanClient;
   constructor(infrascanClient) {
     super({
       actionName: "graph",
@@ -38,6 +40,12 @@ var GraphCmd = class extends CommandLineAction {
       description: "Location to read scan state from. This should be the same as the directory given to the scan command.",
       defaultValue: "./state"
     });
+    this._serializer = this.defineChoiceParameter({
+      required: false,
+      parameterLongName: "--serializer",
+      description: "Choice of graph serializer. Visual will output a cytoscape compatible graph intended for visual consumption. Informational will preserve the maximum amount of structured data to explore in other formats.",
+      alternatives: ["visual", "informational"]
+    });
   }
   async onExecute() {
     const scanMetadata = readScanMetadata(
@@ -52,6 +60,7 @@ var GraphCmd = class extends CommandLineAction {
         nServicesScanned += 1;
       }
     });
+    const serializeGraph = this._serializer.value === "informational" ? serializeInformationalGraph : serializeVisualGraph;
     const graphData = await this.infrascanClient.generateGraph(scanMetadata, connector, serializeGraph);
     console.log(
       `Graph Complete. Found resources in ${nServicesScanned} services.`

package/dist/commands/render.mjs

@@ -68,7 +68,10 @@ var RenderCmd = class extends CommandLineAction {
     try {
       return readFileSync(this.#graphPath.value, "utf8");
     } catch (err) {
-      console.error(`Failed to read graph data from: ${this.#graphPath.value}`);
+      const errMessage = err instanceof Error && "message" in err ? err.message : "unknown error occurred";
+      console.error(
+        `Failed to read graph data from: ${this.#graphPath.value}. ${errMessage}`
+      );
       return null;
     }
   }

package/dist/commands/scan.mjs

@@ -56,6 +56,10 @@ function resolveCredentialProvider(profile, roleToAssume) {
   return (region) => fromNodeProviderChain({ clientConfig: { region } });
 }
 var ScanCmd = class extends CommandLineAction {
+  _config;
+  infrascanClient;
+  _outputDirectory;
+  _regions;
   constructor(infrascanClient) {
     super({
       actionName: "scan",

package/dist/index.mjs

@@ -12,9 +12,8 @@ import {
   CommandLineAction
 } from "@rushstack/ts-command-line";
 import buildFsConnector from "@infrascan/fs-connector";
-import {
-  serializeGraph
-} from "@infrascan/cytoscape-serializer";
+import { serializeGraph as serializeVisualGraph } from "@infrascan/cytoscape-serializer";
+import { serializeGraph as serializeInformationalGraph } from "@infrascan/informational-serializer";
 function readScanMetadata(outputPath) {
   const scanMetadata = readFileSync(
     join(resolve(outputPath), "metadata.json"),
@@ -29,6 +28,9 @@ function writeGraphOutput(outputPath, graphState) {
   );
 }
 var GraphCmd = class extends CommandLineAction {
+  _outputDirectory;
+  _serializer;
+  infrascanClient;
   constructor(infrascanClient) {
     super({
       actionName: "graph",
@@ -45,6 +47,12 @@ var GraphCmd = class extends CommandLineAction {
       description: "Location to read scan state from. This should be the same as the directory given to the scan command.",
       defaultValue: "./state"
     });
+    this._serializer = this.defineChoiceParameter({
+      required: false,
+      parameterLongName: "--serializer",
+      description: "Choice of graph serializer. Visual will output a cytoscape compatible graph intended for visual consumption. Informational will preserve the maximum amount of structured data to explore in other formats.",
+      alternatives: ["visual", "informational"]
+    });
   }
   async onExecute() {
     const scanMetadata = readScanMetadata(
@@ -59,6 +67,7 @@ var GraphCmd = class extends CommandLineAction {
         nServicesScanned += 1;
       }
     });
+    const serializeGraph = this._serializer.value === "informational" ? serializeInformationalGraph : serializeVisualGraph;
     const graphData = await this.infrascanClient.generateGraph(scanMetadata, connector, serializeGraph);
     console.log(
       `Graph Complete. Found resources in ${nServicesScanned} services.`
@@ -137,7 +146,10 @@ var RenderCmd = class extends CommandLineAction2 {
     try {
       return readFileSync2(this.#graphPath.value, "utf8");
     } catch (err) {
-      console.error(`Failed to read graph data from: ${this.#graphPath.value}`);
+      const errMessage = err instanceof Error && "message" in err ? err.message : "unknown error occurred";
+      console.error(
+        `Failed to read graph data from: ${this.#graphPath.value}. ${errMessage}`
+      );
       return null;
     }
   }
@@ -201,6 +213,10 @@ function resolveCredentialProvider(profile, roleToAssume) {
   return (region) => fromNodeProviderChain({ clientConfig: { region } });
 }
 var ScanCmd = class extends CommandLineAction3 {
+  _config;
+  infrascanClient;
+  _outputDirectory;
+  _regions;
   constructor(infrascanClient) {
     super({
       actionName: "scan",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@infrascan/cli",
-  "version": "0.5.0",
+  "version": "0.7.0",
   "description": "Thin command line wrapper around the infrascan sdk",
   "main": "dist/index.mjs",
   "scripts": {
@@ -26,10 +26,11 @@
   "license": "MPL-2.0",
   "dependencies": {
     "@aws-sdk/credential-providers": "3.624.0",
-    "@infrascan/aws": "^0.4.1",
-    "@infrascan/cytoscape-serializer": "^0.2.1",
-    "@infrascan/fs-connector": "^0.2.2",
-    "@infrascan/sdk": "^0.4.2",
+    "@infrascan/aws": "^0.5.4",
+    "@infrascan/cytoscape-serializer": "^0.3.4",
+    "@infrascan/fs-connector": "^0.3.0",
+    "@infrascan/informational-serializer": "^0.2.0",
+    "@infrascan/sdk": "^0.6.0",
     "@rushstack/ts-command-line": "^4.15.2",
     "@smithy/shared-ini-file-loader": "^2.2.2",
     "ejs": "^3.1.9",
@@ -38,10 +39,10 @@
   },
   "devDependencies": {
     "@aws-sdk/types": "3.609.0",
-    "@infrascan/shared-types": "^0.5.1",
+    "@infrascan/shared-types": "^0.7.0",
     "@smithy/types": "^2.4.0",
     "@types/ejs": "^3.1.5",
     "ts-node": "^10.9.1",
-    "typescript": "^5.1.3"
+    "typescript": "^5.4.5"
   }
 }