kge - Kubernetes Events Viewer

A simple yet powerful CLI tool for viewing and monitoring Kubernetes events with a focus on readability and ease of use. kge provides an intuitive interface to quickly diagnose issues.

Table of Contents

• kge - Kubernetes Events Viewer
  • Table of Contents
  • Features
  • Installation
  • Usage
    • Interactive Mode
    • Basic Usage
    • Viewing Events for Any Resource Type
    • Shell Completion
  • Examples
  • Known Issues
  • Contributing
  • License

Features

• 🔍 View events for specific pods
• 👻 Find missing pods because of missing serviceAccounts or volumes
• 📊 View all events in a namespace
• ⚠️ Filter to show only non-normal events
• 🖱️ Interactive pod selection
• 🎨 Color-coded output
• ⌨️ Shell completion support (zsh)
• 🔄 View events for any Kubernetes resource type (Pods, Deployments, CRDs, etc.)

Installation

A brew formula is a WIP. Until then, use pipx. Which can be installed with brew install pipx Pipx is like brew, only for python.

# Install using pipx (recommended)
pipx install kge-kubectl-get-events

# Or install using pip, but not as easy
pip install kge-kubectl-get-events

Usage

Interactive Mode

Run without arguments for interactive pod selection:

kge

Basic Usage

View events for a specific pod:

kge <pod-name>

View events in all namespaces:

kge -A

View events in a specific namespace:

kge -n <namespace>

Viewing Events for Any Resource Type

View events for a specific resource type:

kge -k <kind> <resource-name>

Check a different namespace than your current context:

kge -n kubecost

TODO:View only non-normal events:

kge -e

Combine flags to view all non-normal events in the current namespace:

kge -ea

Shell Completion

Enable zsh completion:

source <(kge --completion=zsh)

Completion features:

• Tab completion for namespaces after -n
• Tab completion for pods after -n <namespace>
• Tab completion for kinds after -k
• Tab completion for resources of a specific kind after -k <kind>

Examples

View non-normal events for all pods in a namespace:

kge -ea

View events for a specific pod in a specific namespace:

kge -n my-namespace my-pod

View events for a Deployment:

kge -k Deployment my-deployment

Known Issues

• Not all arguments work together. For example, kge -e -k Deployment will not work. For complex queries, use kge -a to see all events and filter with grep or another tool.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request. For major changes, please open an issue first to discuss what you would like to change.

1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add some amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

License

This project is licensed under the MIT License - see the LICENSE file for details.