Merge pull request #15 from kaytu-io/fix/updating-readme

fix: updated readme

.vscode/launch.json

@@ -24,6 +24,19 @@
                 "--app_endpoint=https:",
                 "--apikey=key"
             ]
+        },
+        {
+            "name": "benchmarks",
+            "type": "go",
+            "request": "launch",
+            "mode": "auto",
+            "program": "${workspaceFolder}/main.go",
+            "args": [
+                "get",
+                "benchmarks",
+                "--page-size=1",
+                "--page-number=1"
+            ]
         }
     ]
 }

README.md

@@ -2,15 +2,62 @@
 
 CLI for opengovernance
 
+![Root Command GIF](./tapes/gif/root.gif)
+
 ## List of Commands
 
-- configure
-- get benchmarks
-- get compliance-summary-for-benchmark 
-- get compliance-summary-for-integration
-- get controls 
-- get jobs
-- get job-details
+- [configure](#configure)
+- [get]()
+    - [benchmarks](#benchmarks)
+    - compliance-summary-for-benchmark 
+    - compliance-summary-for-integration
+    - controls 
+    - jobs
+    - job-details
 - run compliance
 - run discovery
 
+## Configure
+
+Configuration for checkctl
+
+![Configure Command GIF](./tapes/gif/configure.gif)
+
+Interactive mode:
+```
+checkctl configure 
+```
+Non-interactive mode:
+```
+checktl configure --api-key <<api-key>> --app-endpoint https://path.to.app.endpoint --output json
+```
+
+## get 
+
+### benchmarks
+
+Get a list of benchmarks
+
+![Get Benchmarks Command GIF](./tapes/gif/getbenchmarks.gif)
+
+Available flags:
+
+| Flag | Description | Default
+|----- | ----------- | -------
+|`--page-size` | Defines page size of response | 25
+|`--page-number` | Defines page number of response| 1
+|`--show-only-root` | Show only root benchmarks | true
+|`--include-findings-summary` | Include findings summary in response | false
+
+### controls
+
+Get a list of controls 
+
+![Get Controls Command GIF](./tapes/gif/getcontrols.gif)
+
+Available flags:
+
+| Flag | Description | Default
+|----- | ----------- | -------
+|`--page-size` | Defines page size of response | 25
+|`--page-number` | Defines page number of response| 1

tapes/configure.tape

@@ -0,0 +1,19 @@
+Set Shell zsh
+Sleep 1.5s
+Type "checkctl configure"
+Enter
+Escape
+Sleep 1.5s
+Type "<<api-key>>"
+Sleep 500ms
+Enter
+Sleep 1s
+Type "<<api-endpoint>>"
+Enter
+Sleep 1s
+Type "<<utilization-endpoint>>"
+Sleep 500ms
+Enter
+Sleep 500ms
+Enter
+

tapes/getbenchmark.tape

@@ -0,0 +1,18 @@
+Set Shell zsh
+Sleep 1.5s
+Type "checkctl get "
+Sleep 1s
+Type "benchmarks "
+Sleep 500ms
+Type "--page-size "
+Sleep 500ms
+Type "1 --page"
+Sleep 500ms
+Type "-number "
+Sleep 1s
+Type "1"
+Sleep 500ms
+Enter
+Sleep 28s
+Ctrl+D
+

tapes/getcontrols.tape

@@ -0,0 +1,10 @@
+Set Shell zsh
+Sleep 500ms
+Type "checkctl get controls --page-number 1 "
+Sleep 500ms
+Type "--page-size 1"
+Sleep 2s
+Enter
+Sleep 3.5s
+Ctrl+D
+

tapes/root.tape

@@ -0,0 +1,16 @@
+Set Shell zsh
+Sleep 1s
+Type "checkctl "
+Sleep 500ms
+Type "| less"
+Sleep 500ms
+Enter
+Sleep 3s
+Enter
+Sleep 2s
+Enter 34
+Sleep 1.5s
+Type "q"
+Sleep 1.5s
+Ctrl+D
+