This commit is contained in:
82
README.md
82
README.md
@@ -22,10 +22,10 @@ pip uninstall metalcheck-cli
|
|||||||
|
|
||||||
You can configure the base URL for the Metal Check API by creating a configuration file at `~/.config/metalcheck.conf`:
|
You can configure the base URL for the Metal Check API by creating a configuration file at `~/.config/metalcheck.conf`:
|
||||||
|
|
||||||
```plaintext
|
```plaintext
|
||||||
[DEFAULT]
|
[DEFAULT]
|
||||||
base_url = http://localhost:8000
|
base_url = http://localhost:8000
|
||||||
```
|
```
|
||||||
|
|
||||||
If no configuration is provided, the CLI defaults to `http://localhost:8000`.
|
If no configuration is provided, the CLI defaults to `http://localhost:8000`.
|
||||||
|
|
||||||
@@ -33,71 +33,69 @@ If no configuration is provided, the CLI defaults to `http://localhost:8000`.
|
|||||||
|
|
||||||
General Command Structure
|
General Command Structure
|
||||||
|
|
||||||
```plaintext
|
```plaintext
|
||||||
Usage: metalcheck [OPTIONS] COMMAND [ARGS]...
|
Usage: metalcheck [OPTIONS] COMMAND [ARGS]...
|
||||||
|
|
||||||
Options:
|
Options:
|
||||||
--base-url TEXT Set the base URL for the Metal Check API (default: http://localhost:8000)
|
--base-url TEXT Set the base URL for the Metal Check API (default: http://localhost:8000)
|
||||||
--help Show this message and exit.
|
--help Show this message and exit.
|
||||||
|
|
||||||
Commands:
|
Commands:
|
||||||
export Export Metal Check data in the specified format (yaml or json)
|
export Export Metal Check data in the specified format (yaml or json)
|
||||||
k8s Commands for managing Kubernetes Nodes
|
k8s Commands for managing Kubernetes Nodes
|
||||||
metal Commands for managing Metal Nodes
|
metal Commands for managing Metal Nodes
|
||||||
visual Displays the visual dashboard with Metal Nodes, Virtual Machines, and Kubernetes Nodes
|
visual Displays the visual dashboard with Metal Nodes, Virtual Machines, and Kubernetes Nodes
|
||||||
vm Commands for managing Virtual Machines
|
vm Commands for managing Virtual Machines
|
||||||
```
|
```
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
1. List Metal Nodes
|
1. List Metal Nodes
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
metalcheck metal list
|
metalcheck metal list
|
||||||
```
|
```
|
||||||
|
|
||||||
2. Add a new Metal Node
|
2. Add a new Metal Node
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
metalcheck metal add
|
metalcheck metal add
|
||||||
```
|
```
|
||||||
|
|
||||||
3. Delete a Metal Node
|
3. Delete a Metal Node
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
metalcheck metal delete
|
metalcheck metal delete
|
||||||
```
|
```
|
||||||
|
|
||||||
4. List Kubernetes Nodes
|
4. List Kubernetes Nodes
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
metalcheck k8s list
|
metalcheck k8s list
|
||||||
```
|
```
|
||||||
|
|
||||||
5. Analyze Kubernetes Cluster
|
5. Analyze Kubernetes Cluster
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
metalcheck k8s think
|
metalcheck k8s think
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
6. Export Data
|
6. Export Data
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
metalcheck export --format yaml exported-data.yaml
|
metalcheck export --format yaml exported-data.yaml
|
||||||
```
|
```
|
||||||
|
|
||||||
7. Visual Dashboard
|
7. Visual Dashboard
|
||||||
|
|
||||||
Run the interactive dashboard to visualize Metal Nodes, Virtual Machines, and Kubernetes Nodes:
|
Run the interactive dashboard to visualize Metal Nodes, Virtual Machines, and Kubernetes Nodes:
|
||||||
|
|
||||||
|
```shell
|
||||||
```shell
|
metalcheck visual
|
||||||
metalcheck visual
|
```
|
||||||
```
|
|
||||||
|
|
||||||
Run visual with the AI summary for Kubernetes cluster:
|
Run visual with the AI summary for Kubernetes cluster:
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
metalcheck visual --summary
|
metalcheck visual --summary
|
||||||
```
|
```
|
||||||
|
|||||||
Reference in New Issue
Block a user