kcompass

Compass

Quickly Pinpoint Errors in your Kubernetes Deployment

About

Compass helps you pinpoint your errors by asking simple (Y/N) questions. It helps execute kubectl debugging commands at every step to increase visibility. Questions start at the Pod level and and end at the Ingress level or until error is isolated.

Compass is meant to be a helpful checklist and not a monitoring/logging framework. It doesn’t fix your specific Pod issues (though I wish), it just outputs more expressive error messages than “CrashLoopBackOff”.

Features

✔️ Simple (Y/N) Questions ➕ Step by Step Visibility

✔️ Checkpoints for Error Isolation

✔️ Works on the Pod level all the way up to the Ingress level

Service Level

Ingress Level

✅ Debug Checklist First, 😭 Search Overload Later

(Y/N) Questions based on this awesome troubleshooting guide by LearnK8s.io

Installation

To install via npm:

npm install kcompass

How to Use

One Command

kcompass debug <pod-name>

Code Snippet

if (await pod.isRunContainerError()) {
  console.log(colors.green(`The issue is likely to be with Mounting Volumes`));
}

Highlights

🚀 FAST - debugs from Pod level to Ingress level in seconds, not hours

🔎 Visible - auto-runs kubectl commands at major steps giving you eyes on the process

🚦 Lazy-Friendly - Simple (Y/N) Questions, Color Highlights (Red / Green)

📄 Lightweight - No bulk files, just the essentials

🎯 Predictable - Navigation follows this popular troubleshooting guide

Contributors

Contributors Welcome!

Huge Thanks to the Kubernetes Open Source Community for the Support.

If you found this interesting or helpful at all, feel free to drop a 🌟 star 🌟 on this project to show your support!

Got a suggestion, issue or feedback? Shoot me an email at [e-mail] and I'll respond within the day.