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:

pip install -e .

Uninstallation

To remove the tool:

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:

[DEFAULT]
base_url = http://localhost:8000

If no configuration is provided, the CLI defaults to http://localhost:8000.

Usage

General Command Structure

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.

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

List Metal Nodes

metalcheck metal list

Add a new Metal Node

metalcheck metal add

Delete a Metal Node

metalcheck metal delete

List Kubernetes Nodes

metalcheck k8s list

Analyze Kubernetes Cluster

metalcheck k8s think

Export Data

metalcheck export --format yaml exported-data.yaml

Visual Dashboard

Run the interactive dashboard to visualize Metal Nodes, Virtual Machines, and Kubernetes Nodes:

metalcheck visual

Run visual with the AI summary for Kubernetes cluster:

metalcheck visual --summary