Merge pull request #5 from functional-team/feat/sea-binaries

add single executable apps

Author: npohle

.gitignore

@@ -67,3 +67,9 @@ test.json
 bfg-1.14.0.jar
 crawled.json
 test copy.json
+.build/bundle.js
+.build/bundle.js.LICENSE.txt
+src/.DS_Store
+.DS_Store
+.gitignore
+.gitignore

README.md

@@ -1,68 +1,58 @@
 # kalypso-cli
 
-## Overview
-kalypso-cli is a command line tool to crawl resources in your Azure subscription and store it as local JSON file.
-This output can be used to visualise your resources in the [Kalypso UI](https://kalypso.tools/).
-The UI is running locally in your browser. There is no backend or other service and thus no data transfer whatsoever happening with your data. Everything stays on your local computer. 
-Kalypso-cli is designed to crawl all kinds of resources from your subscription(s). As of 2024 the main focus of development lies on discovery of Azure Data Explorer (ADX) resources like tables, functions and policies.
+Discover Azure resources [querying](https://aka.ms/AzureResourceGraph-QueryLanguage) Azure Resource Graph, crawl additional info and store everything into a local JSON file, which can be used with https://kalypso.tools  
 
-## Installation
+Support currently limited to resource type `microsoft.kusto/clusters`
 
-### Prerequisites
+The CLI expects you to be authenticated in Azure already. This typically achieved with running `az login` before.
 
-- [npm and node.js](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) are installed
-- [azure cli](https://learn.microsoft.com/en-us/cli/azure/install-azure-cli) is installed 
 
+## Install the latest precompiled binary
 
- you just clone the repo and run:
+```sh
+curl -fsSL https://raw.githubusercontent.com/functional-team/kalypso-cli/refs/heads/main/dist/install.sh | sh
+```
 
-   ```shell
-   npm install
-   ```
- 
+## Usage
 
-## Documentation
+### Command line utility
 
-### Quickstart
-Starting a crawl run is as simple as:
+```sh
+Usage: kalypso-cli crawl [options]
 
-   ```shell
-   #authenticate to your azure subscription(s)
-   az login
+Crawl Azure Resources
 
-   #run crawler
-   npm run crawl
-   ```
+Options:
+  -o|--output-path [string]     path to output file, default is set in configuration (default: "crawled.json")
+  -q|--az-graph-query [string]  Use Resource Graph Query to specify scope of the crawl
+  -k|--az-kusto-uri [string]    Use Kusto Cluster URI to crawl specific Cluster only
+  -h, --help                    display help for command
+```
 
-The crawl command supports two parameters:
+### Examples
 
-* `--output-path`: file path for where the output JSON is getting stored. Defaults to ./crawled.json
-* `--azure-query`: A KQL query that narrows down what resources should be crawled. Please refer to https://aka.ms/AzureResourceGraph-QueryLanguage for a reference.
+Using the precompiled binaries:
 
-### Example
+```sh
+az login
+kalypso-cli crawl --output-path "resources.json" --az-graph-query "type == 'microsoft.kusto/clusters' and resourceGroup contains 'dev'"
+```
 
-   ```shell
-   az login
-   ```
-This command opens a browser window to authenticate with your Azure subscription. After sucessful authentication, you should be seeing details about your Azure subscription starting with:
-   ```shell
-   [
-  {
-    "cloudName": "AzureCloud",
-    "homeTenantId": ...
-   ```
+Cloning the repo and using an existing node.js installation
 
+```sh
+npm install
+az login
+npx ts-node ./src/index.ts crawl --output-path "resources.json" --az-graph-query "type == 'microsoft.kusto/clusters' and resourceGroup contains 'dev'"
+```
 
-Now, crawling can be initiated by 
+## Developer guide 
 
-   ```shell
-   npm run crawl 
-   ```
-The command output should now look like this:
-   ```shell
-SCAN KUSTO CLUSTER : https://myawesomecluster.westeurope.kusto.windows.net
-SCAN KUSTO DATABASE: myawesomedatabase: 45 Schemas. 63 Update Policies. 45 Tables. 143 Functions. 20 Materialized Views. 1 External Tables.
-...
-   ```
+### Build precompiled binaries (experimental)
 
+   We use https://github.com/james-pre/xsea to ease the creation of single executable apps for all major platforms:
 
+   ```shell
+   npm install --global xsea
+   sudo npm run build && sudo npm run package 
+   ```

package.json

@@ -27,12 +27,13 @@
   },
   "scripts": {
     "build": "webpack",
+    "package": "xsea .build/bundle.js --verbose --clean -o dist/kalypso-cli -t darwin-arm64 -t linux-x64 -t win-x64 && gzip -v dist/kalypso-cli-darwin-arm64 && gzip -v dist/kalypso-cli-linux-x64 && gzip -v dist/kalypso-cli-win-x64.exe",
     "commit": "git-cz",
     "format:check": "prettier --list-different '{src,__mocks__,bin}/**/*.ts'",
     "format:write": "prettier --write '{src,__mocks__,bin}/**/*.ts'",
     "start:help": "ts-node ./src/index.ts -h",
     "start": "ts-node ./src/index.ts",
-    "crawl": "ts-node ./src/index.ts crawl -q \"Resources | where type contains 'microsoft.kusto/clusters' and name contains 'dev' | project id, name, type, location, subscriptionId, resourceGroup, properties\" -o crawled.json",
+    "crawlkusto": "ts-node ./src/index.ts crawl -q \"Resources | where type contains 'microsoft.kusto/clusters' and name contains 'dev' | project id, name, type, location, subscriptionId, resourceGroup, properties\" -o test.json",
     "demo": "ts-node ./src/index.ts crawl -k \"https://help.kusto.windows.net/\"",
     "test": "jest",
     "bump-version": "rjp package.json version $VERSION",
@@ -89,5 +90,10 @@
     "ts-node": "^10.2.1",
     "typescript": "^4.9.5",
     "webpack-cli": "^5.1.4"
+  },
+  "overrides": {
+    "[email protected]": {
+      "whatwg-url": "14.x"
+    }
   }
 }

sea-config.json

@@ -0,0 +1,5 @@
+{
+    "main": ".build/bundle.js",
+    "output": ".build/sea-prep.blob",
+    "disableExperimentalSEAWarning": true
+  }

src/commands/crawl/command.ts

@@ -1,5 +1,6 @@
 import { Command } from 'commander';
 import { Options } from './options';
+import { kalypsoPrint } from '../../lib/kalypso-logo-print';
 import { ResourceGraphClient } from "@azure/arm-resourcegraph";
 import { AzureKustoClusterScanner } from '../../lib/azure/AzureKustoClusterScanner';
 import  * as fs from 'fs';
@@ -24,15 +25,18 @@ export function CrawlCommand(): Command {
 
 async function action(options: Options) {
 
+  kalypsoPrint(`\nAZURE GRAPH QUERY: ${options.azGraphQuery} \nLOCAL OUTPUT PATH: ${options.outputPath}\n` )
+
   let startTime = new Date();
 
   let azureresources:any = {};
   const creds = new DefaultAzureCredential();
 
   if (options.azGraphQuery) {
     const client = new ResourceGraphClient(creds, {})
-    const graphresources = await client.resources({query: options.azGraphQuery})
-  
+    const graphresources = await client.resources({query: "resources | where "+options.azGraphQuery})
+    console.log(`NUMBER OF RESOURCES FOUND IN AZURE GRAPH: ${graphresources.count}`);
+
     for (const resource of graphresources.data) {
       if (resource.type=="microsoft.kusto/clusters") {
         const kustoclusters = await AzureKustoClusterScanner(resource);

src/lib/kalypso-logo-print.ts

@@ -0,0 +1,20 @@
+import boxen from "boxen";
+import chalk from "chalk";
+
+const header = 
+'____  __.      .__                              _________                      .__                \n' +
+'|    |/ _|____  |  | ___.__.______  __________   \\_   ___ \\____________ __  _  _|  |   ___________ \n' +
+'|      < \\__  \\ |  |<   |  |\\____ \\/  ___/  _ \\  /    \\  \\/\\_  __ \\__  \\\ \\/ \\/ /  | _/ __ \\_  __ \\ \n' +
+'|    |  \\ / __ \\|  |_\\___  ||  |_> >___ (  <_> ) \\     \\____|  | \\// __ \\\     /|  |_\\  ___/|  | \\/ \n' +
+'|____|__ (____  /____/ ____||   __/____  >____/   \\______  /|__|  (____  /\\/\\_/ |____/\\___  >__|   \n' +
+'        \\/    \\/     \\/     |__|       \\/                \\/            \\/                 \\/       \n';
+
+
+export function kalypsoPrint(content: string) {
+  console.log(boxen(chalk.yellowBright(header) + content, {
+    padding: 1,
+    margin: 1,
+    borderStyle: 'round'
+  }))
+
+}

webpack.config.js

@@ -0,0 +1,24 @@
+// webpack.config.js
+const path = require('path');
+
+module.exports = {
+  target: 'node',
+  entry: './src/index.ts',
+  module: {
+    rules: [
+      {
+        test: /\.tsx?$/,
+        use: 'ts-loader',
+        exclude: /node_modules/,
+      },
+    ],
+  },
+  resolve: {
+    extensions: ['.tsx', '.ts', '.js'],
+  },
+  output: {
+    filename: 'bundle.js',
+    path: path.resolve(__dirname, '.build'),
+  },
+  mode: "production",
+};