kge-kubectl-get-events


Namekge-kubectl-get-events JSON
Version 0.11.4 PyPI version JSON
download
home_pageNone
SummaryKubernetes utility for viewing pod and failed replicaset events
upload_time2025-07-29 03:23:31
maintainerNone
docs_urlNone
authorNone
requires_python<4.0,>=3.11
licenseMIT
keywords kubernetes troubleshooting kubectl events pod replicaset failed event
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # kge - Kubernetes Events Viewer

[![Python Version](https://img.shields.io/badge/python-3.11%2B-blue)](https://www.python.org/downloads/)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![PyPI](https://img.shields.io/pypi/v/kge-kubectl-get-events)](https://pypi.org/project/kge-kubectl-get-events/)

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](#kge---kubernetes-events-viewer)
  - [Table of Contents](#table-of-contents)
  - [Features](#features)
  - [Installation](#installation)
  - [Usage](#usage)
    - [Interactive Mode](#interactive-mode)
    - [Basic Usage](#basic-usage)
    - [Viewing Events for Any Resource Type](#viewing-events-for-any-resource-type)
    - [Shell Completion](#shell-completion)
  - [Examples](#examples)
  - [Known Issues](#known-issues)
  - [Contributing](#contributing)
  - [License](#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.

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

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

## Usage

### Interactive Mode

Run without arguments for interactive pod selection:

```bash
kge
```

### Basic Usage

View events for a specific pod:

```bash
kge <pod-name>
```

View events in all namespaces:

```bash
kge -A
```



View events in a specific namespace:

```bash
kge -n <namespace>
```

### Viewing Events for Any Resource Type

View events for a specific resource type:

```bash
kge -k <kind> <resource-name>
```

Check a different namespace than your current context:

```bash
kge -n kubecost
```

TODO:View only non-normal events:

```bash
kge -e
```

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

```bash
kge -ea
```

### Shell Completion

Enable zsh completion:

```bash
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:

```bash
kge -ea
```

View events for a specific pod in a specific namespace:

```bash
kge -n my-namespace my-pod
```

View events for a Deployment:

```bash
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](LICENSE) file for details.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "kge-kubectl-get-events",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<4.0,>=3.11",
    "maintainer_email": null,
    "keywords": "kubernetes, troubleshooting, kubectl, events, pod, replicaset, failed, event",
    "author": null,
    "author_email": "Jesse Goodier <31039225+jessegoodier@users.noreply.github.com>",
    "download_url": "https://files.pythonhosted.org/packages/d2/e6/c668ff93bf6a1121722d8e061582fa17ef8f4345f40ee7c9d016e6272f29/kge_kubectl_get_events-0.11.4.tar.gz",
    "platform": null,
    "description": "# kge - Kubernetes Events Viewer\n\n[![Python Version](https://img.shields.io/badge/python-3.11%2B-blue)](https://www.python.org/downloads/)\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n[![PyPI](https://img.shields.io/pypi/v/kge-kubectl-get-events)](https://pypi.org/project/kge-kubectl-get-events/)\n\nA 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.\n\n## Table of Contents\n\n- [kge - Kubernetes Events Viewer](#kge---kubernetes-events-viewer)\n  - [Table of Contents](#table-of-contents)\n  - [Features](#features)\n  - [Installation](#installation)\n  - [Usage](#usage)\n    - [Interactive Mode](#interactive-mode)\n    - [Basic Usage](#basic-usage)\n    - [Viewing Events for Any Resource Type](#viewing-events-for-any-resource-type)\n    - [Shell Completion](#shell-completion)\n  - [Examples](#examples)\n  - [Known Issues](#known-issues)\n  - [Contributing](#contributing)\n  - [License](#license)\n\n## Features\n\n- \ud83d\udd0d View events for specific pods\n- \ud83d\udc7b Find missing pods because of missing serviceAccounts or volumes\n- \ud83d\udcca View all events in a namespace\n- \u26a0\ufe0f Filter to show only non-normal events\n- \ud83d\uddb1\ufe0f Interactive pod selection\n- \ud83c\udfa8 Color-coded output\n- \u2328\ufe0f Shell completion support (zsh)\n- \ud83d\udd04 View events for any Kubernetes resource type (Pods, Deployments, CRDs, etc.)\n\n## Installation\n\nA brew formula is a WIP. Until then, use pipx. Which can be installed with `brew install pipx`\nPipx is like brew, only for python.\n\n```bash\n# Install using pipx (recommended)\npipx install kge-kubectl-get-events\n```\n\n```bash\n# Or install using pip, but not as easy\npip install kge-kubectl-get-events\n```\n\n## Usage\n\n### Interactive Mode\n\nRun without arguments for interactive pod selection:\n\n```bash\nkge\n```\n\n### Basic Usage\n\nView events for a specific pod:\n\n```bash\nkge <pod-name>\n```\n\nView events in all namespaces:\n\n```bash\nkge -A\n```\n\n\n\nView events in a specific namespace:\n\n```bash\nkge -n <namespace>\n```\n\n### Viewing Events for Any Resource Type\n\nView events for a specific resource type:\n\n```bash\nkge -k <kind> <resource-name>\n```\n\nCheck a different namespace than your current context:\n\n```bash\nkge -n kubecost\n```\n\nTODO:View only non-normal events:\n\n```bash\nkge -e\n```\n\nCombine flags to view all non-normal events in the current namespace:\n\n```bash\nkge -ea\n```\n\n### Shell Completion\n\nEnable zsh completion:\n\n```bash\nsource <(kge --completion=zsh)\n```\n\nCompletion features:\n\n- Tab completion for namespaces after `-n`\n- Tab completion for pods after `-n <namespace>`\n- Tab completion for kinds after `-k`\n- Tab completion for resources of a specific kind after `-k <kind>`\n\n## Examples\n\nView non-normal events for all pods in a namespace:\n\n```bash\nkge -ea\n```\n\nView events for a specific pod in a specific namespace:\n\n```bash\nkge -n my-namespace my-pod\n```\n\nView events for a Deployment:\n\n```bash\nkge -k Deployment my-deployment\n```\n\n## Known Issues\n\n- 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.\n\n## Contributing\n\nContributions 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.\n\n1. Fork the repository\n2. Create your feature branch (`git checkout -b feature/amazing-feature`)\n3. Commit your changes (`git commit -m 'Add some amazing feature'`)\n4. Push to the branch (`git push origin feature/amazing-feature`)\n5. Open a Pull Request\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Kubernetes utility for viewing pod and failed replicaset events",
    "version": "0.11.4",
    "project_urls": {
        "Bug Tracker": "https://github.com/jessegoodier/kge/issues",
        "Documentation": "https://github.com/jessegoodier/kge/blob/main/README.md",
        "Homepage": "https://github.com/jessegoodier/kge",
        "Repository": "https://github.com/jessegoodier/kge"
    },
    "split_keywords": [
        "kubernetes",
        " troubleshooting",
        " kubectl",
        " events",
        " pod",
        " replicaset",
        " failed",
        " event"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "ab72a98a9139a06a5c4ec80130e46b021eba442f0bba023d92038ad9d717b5fa",
                "md5": "7e83848db30610be090f331b4ee5f2df",
                "sha256": "03001e9e996c54439168900c998c8e93c7ccdd2aff5aa2bb7c933c58fb8e4be6"
            },
            "downloads": -1,
            "filename": "kge_kubectl_get_events-0.11.4-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "7e83848db30610be090f331b4ee5f2df",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.11",
            "size": 15589,
            "upload_time": "2025-07-29T03:23:30",
            "upload_time_iso_8601": "2025-07-29T03:23:30.238451Z",
            "url": "https://files.pythonhosted.org/packages/ab/72/a98a9139a06a5c4ec80130e46b021eba442f0bba023d92038ad9d717b5fa/kge_kubectl_get_events-0.11.4-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "d2e6c668ff93bf6a1121722d8e061582fa17ef8f4345f40ee7c9d016e6272f29",
                "md5": "77571a72fb0e4488d86a649851a69cab",
                "sha256": "8691c25b99c2259ea112e439fbcc33ce9f40d76204cd40a8d60a4dd150c7ed5b"
            },
            "downloads": -1,
            "filename": "kge_kubectl_get_events-0.11.4.tar.gz",
            "has_sig": false,
            "md5_digest": "77571a72fb0e4488d86a649851a69cab",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.11",
            "size": 18226,
            "upload_time": "2025-07-29T03:23:31",
            "upload_time_iso_8601": "2025-07-29T03:23:31.483504Z",
            "url": "https://files.pythonhosted.org/packages/d2/e6/c668ff93bf6a1121722d8e061582fa17ef8f4345f40ee7c9d016e6272f29/kge_kubectl_get_events-0.11.4.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-07-29 03:23:31",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "jessegoodier",
    "github_project": "kge",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "kge-kubectl-get-events"
}
        
Elapsed time: 2.89505s