mirror of
https://ak-git.vectorsigma.ru/terghalin/metalcheck-cli.git
synced 2025-10-26 07:25:51 +09:00
chore(app): README.md formatting
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`:
|
||||
|
||||
```plaintext
|
||||
[DEFAULT]
|
||||
base_url = http://localhost:8000
|
||||
```
|
||||
```plaintext
|
||||
[DEFAULT]
|
||||
base_url = 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
|
||||
|
||||
```plaintext
|
||||
Usage: metalcheck [OPTIONS] COMMAND [ARGS]...
|
||||
```plaintext
|
||||
Usage: metalcheck [OPTIONS] COMMAND [ARGS]...
|
||||
|
||||
Options:
|
||||
--base-url TEXT Set the base URL for the Metal Check API (default: http://localhost:8000)
|
||||
--help Show this message and exit.
|
||||
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
|
||||
```
|
||||
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
|
||||
```
|
||||
```shell
|
||||
metalcheck metal list
|
||||
```
|
||||
|
||||
2. Add a new Metal Node
|
||||
|
||||
```shell
|
||||
metalcheck metal add
|
||||
```
|
||||
```shell
|
||||
metalcheck metal add
|
||||
```
|
||||
|
||||
3. Delete a Metal Node
|
||||
|
||||
```shell
|
||||
metalcheck metal delete
|
||||
```
|
||||
```shell
|
||||
metalcheck metal delete
|
||||
```
|
||||
|
||||
4. List Kubernetes Nodes
|
||||
|
||||
```shell
|
||||
metalcheck k8s list
|
||||
```
|
||||
```shell
|
||||
metalcheck k8s list
|
||||
```
|
||||
|
||||
5. Analyze Kubernetes Cluster
|
||||
|
||||
```shell
|
||||
metalcheck k8s think
|
||||
```
|
||||
|
||||
```shell
|
||||
metalcheck k8s think
|
||||
```
|
||||
|
||||
6. Export Data
|
||||
|
||||
```shell
|
||||
metalcheck export --format yaml exported-data.yaml
|
||||
```
|
||||
```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
|
||||
```
|
||||
```shell
|
||||
metalcheck visual
|
||||
```
|
||||
|
||||
Run visual with the AI summary for Kubernetes cluster:
|
||||
|
||||
```shell
|
||||
metalcheck visual --summary
|
||||
```
|
||||
```shell
|
||||
metalcheck visual --summary
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user