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:

(back to top)

Getting Started

Usage

Show

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

Run

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

Installation

Nix Flake

1. Add repo to flake.nix

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

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

2. Add to systemPackages

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

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

• Auth via kubeconfig
• AUR package
• Nixpkgs package
• Nix Flake
• More displayed info
• CNI used (currently only detection for Cilium, Calico, WeaveNet and Flannel)
• CRI used
• Storage Solution used

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)