Skip to content

Quick Start Guide

Get up and running with K8s Inventory CLI in minutes.

Installation

pipx install k8s-datamodel

Via pip

pip install k8s-datamodel

Development Installation

git clone https://github.com/brun-s/k8s-datamodel.git
cd k8s-datamodel
uv sync
uv run k8s-datamodel --help

Prerequisites

  • Kubernetes cluster access
  • Valid kubeconfig file
  • Python 3.10 or higher

First Steps

1. Test Cluster Connection

k8s-datamodel cluster test-connection

2. Get Cluster Information

k8s-datamodel cluster info

3. View Cluster Summary

k8s-datamodel cluster summary

Common Commands

List All CRDs

k8s-datamodel crd list

Find Operators

k8s-datamodel operators list

Export Complete Inventory

k8s-datamodel cluster export --file inventory.json --output json

Output Formats

K8s Inventory CLI supports multiple output formats:

  • Table (default): Human-readable grid format
  • Rich: Enhanced terminal output with colors
  • JSON: Machine-readable format
  • YAML: Structured format for both humans and machines

Example with different formats: 

k8s-datamodel crd list --output table
k8s-datamodel crd list --output json
k8s-datamodel crd list --output yaml
k8s-datamodel crd list --output rich

Next Steps