update(app): refactor commands

README.md

@@ -1,31 +1,103 @@
-# metalcheck-cli
+# MetalCheck CLI
 
-CLI tool for managing and visualizing Metal Check data"
+**MetalCheck** CLI is a command-line tool for managing and visualizing Metal Check data, including physical nodes, virtual machines, and Kubernetes clusters.
 
 # Installation
 
+Install the tool locally using pip:
+
 ```shell
 pip install -e .
 ```
 
 ## Uninstallation
 
+To remove the tool:
+
 ```shell
 pip uninstall metalcheck-cli
 ```
 
+# Configuration
+
+You can configure the base URL for the Metal Check API by creating a configuration file at `~/.config/metalcheck.conf`:
+    
+    ```plaintext
+    [DEFAULT]
+    base_url = http://localhost:8000
+    ```
+
+If no configuration is provided, the CLI defaults to `http://localhost:8000`.
+
 # Usage
 
-```plaintext
-Usage: metalcheck [OPTIONS] COMMAND [ARGS]...
+General Command Structure
 
-Options:
-  --help  Show help message
+    ```plaintext
+    Usage: metalcheck [OPTIONS] COMMAND [ARGS]...
 
-Commands:
-  export  Export Metal Check data in the specified format (yaml or json).
-  k8s     Commands for managing Kubernetes Nodes.
-  metal   Commands for managing Metal Nodes.
-  visual  Displays the visual dashboard with Metal Nodes, Virtual...
-  vm      Commands for managing Virtual Machines.
-```
+    Options:
+    --base-url TEXT  Set the base URL for the Metal Check API (default: http://localhost:8000)
+    --help           Show this message and exit.
+
+    Commands:
+    export  Export Metal Check data in the specified format (yaml or json)
+    k8s     Commands for managing Kubernetes Nodes
+    metal   Commands for managing Metal Nodes
+    visual  Displays the visual dashboard with Metal Nodes, Virtual Machines, and Kubernetes Nodes
+    vm      Commands for managing Virtual Machines
+    ```
+
+## Examples
+
+1. List Metal Nodes
+    
+    ```shell
+    metalcheck metal list
+    ```
+
+2. Add a new Metal Node
+    
+    ```shell
+    metalcheck metal add
+    ```
+
+3. Delete a Metal Node
+    
+    ```shell
+    metalcheck metal delete
+    ```
+
+4. List Kubernetes Nodes
+        
+    ```shell
+    metalcheck k8s list
+    ```
+
+5. Analyze Kubernetes Cluster
+            
+    ```shell
+    metalcheck k8s think
+    ```
+
+
+6. Export Data
+
+    ```shell
+    metalcheck export --format yaml exported-data.yaml
+    ```
+
+7. Visual Dashboard
+
+Run the interactive dashboard to visualize Metal Nodes, Virtual Machines, and Kubernetes Nodes:
+
+
+    ```shell
+    metalcheck visual
+    ```
+
+Run visual with the AI summary for Kubernetes cluster:
+
+    ```shell
+    metalcheck visual --summary
+    ```