Kubefetch

A neofetch-inspired CLI that displays stats about your Kubernetes☸️ cluster

Table of Contents

1. Getting Started
   • Usage
   • Installation
2. Roadmap
3. Contributing
4. License
5. Contact
6. Acknowledgments

Kubefetch in Action:

Docker CLI

Binary

Nix Flake

(back to top)

Getting Started

Usage

Docker

Run it with a single kubeconfig file: Use --network host for VPNs like Cloudflare Warp

docker run --network host -v "$KUBECONFIG:/config.yaml" ghcr.io/andrewthomaslee/kubefetch -kubeconfig /config.yaml

Nix Flake

Auto uses $KUBECONFIG if already set

nix run "https://flakehub.com/f/andrewthomaslee/kubefetch/*"

Installation

Nix Flake

1. Add repo to flake.nix

{
  inputs.kubefetch.url = "https://flakehub.com/f/andrewthomaslee/kubefetch/0.9.*";

  outputs = { self, kubefetch }: {
    # Use in your outputs
  };
}

2. Add to systemPackages

{
  environment.systemPackages = [
    inputs.kubefetch.packages.${pkgs.stdenv.hostPlatform.system}.default
  ];
}

OCI Container

The flake also exposes an oci-kubefetch output with the binary in a minimal OCI image, for use with the Docker CLI or in OCI environments like Kubernetes.

nix build "https://flakehub.com/f/andrewthomaslee/kubefetch/*"#oci-kubefetch
docker load < result

Make

1. With make Clone the repo

git clone https://github.com/andrewthomaslee/kubefetch
cd kubefetch

2. Build and install the binary

make build
sudo make install

3. To uninstall, run:

sudo make uninstall
make clean

(back to top)

Roadmap

• Rolling SemVer Releases
• OCI Artifact
• Binary Cache ( FlakeHub )
• Nix Flake
• Auth via kubeconfig
• CNI used (currently only detection for Cilium, Calico, WeaveNet and Flannel)
• CRI used
• Storage Solutions used
• More displayed info
• AUR package
• Nixpkgs package

Feel free to open an issue if your Kubernetes distro or some other aspect does not get recognized!

See the open issues for a full list of proposed features (and known issues).

(back to top)

License

Distributed under the GNU GPL v3 License. See LICENSE.txt for more information.

(back to top)

Contact

Project Link: https://github.com/andrewthomaslee/kubefetch

(back to top)

Acknowledgments

• k8s@home
• kubefetch

(back to top)