Skip to main content

A simple kubectl context switcher cli tool

Project description

contswi - Kubernetes Context Switcher

contswi is a simple but effective command-line tool designed for Linux environments to quickly switch between different Kubernetes contexts. By leveraging kubectl, this tool allows users to select and change their active context using an intuitive menu-driven interface, navigable with arrow keys.

Features

  • Quickly view all available Kubernetes contexts.
  • Highlight the current active context.
  • Easily switch between contexts using an interactive, arrow-key driven menu.
  • Clean, responsive, and simple interface that fits into any Kubernetes workflow.

Requirements

Before using contswi, ensure you have the following set up:

  1. kubectl: The Kubernetes command-line tool must be installed and properly configured on your system. This application interacts directly with kubectl to retrieve and set contexts.

  2. Pre-configured Kubernetes Contexts: You must have one or more Kubernetes contexts already set up in your kubeconfig. If you don't have any contexts configured, refer to the Kubernetes context documentation to set them up.

Installation

You can install the contswi tool in two ways: directly from the source code or via pip.

1. Installing from Source

  1. Clone the repository:

    git clone https://github.com/yourusername/contswi.git
    cd contswi
    
  2. Install the tool:

    After cloning the repository, you can install the tool locally with pip:

    pip install .
    

2. Installing via pip

To install the tool directly from PyPI, simply run:

pip install contswi

Usage

Once installed, you can use the contswi tool to interactively switch Kubernetes contexts.

Run the tool

contswi

Key Bindings

  • Up Arrow (): Move the selection upwards.
  • Down Arrow (): Move the selection downwards.
  • Enter: Select the highlighted context and switch to it.
  • Ctrl+C: Exit the program at any time.

Example

  1. Running contswi will present a list of your Kubernetes contexts:

      dev-cluster  
    > prod-cluster <  
      staging-cluster  
    
  2. Use the arrow keys to navigate through the contexts and press Enter to switch.

  3. The tool will execute the equivalent of:

    kubectl config use-context <selected_context>
    
  4. You will see the selected context become the active one.

Error Handling

If you encounter any errors or issues with the program (e.g., no configured contexts), the tool will handle it gracefully, providing helpful error messages.

License

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

Contributing

Feel free to submit issues, feature requests, or pull requests to improve the functionality of this tool. Contributions are always welcome!


Author

Gabor Puskas
GitHub
LinkedIn


contswi is designed to make Kubernetes context management fast and simple, enhancing the experience for developers and DevOps engineers working across multiple clusters and environments.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

contswi-0.1.1.tar.gz (4.3 kB view details)

Uploaded Source

Built Distribution

contswi-0.1.1-py3-none-any.whl (4.9 kB view details)

Uploaded Python 3

File details

Details for the file contswi-0.1.1.tar.gz.

File metadata

  • Download URL: contswi-0.1.1.tar.gz
  • Upload date:
  • Size: 4.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.7.17

File hashes

Hashes for contswi-0.1.1.tar.gz
Algorithm Hash digest
SHA256 cd30179a53a9dc78a8ba55f878fd9bce6033c4a6d6f93a94c98d985c17401ff2
MD5 520e538eba2cd40b380ceee55da55ef2
BLAKE2b-256 9f5493ceb3ec6ab2b8c564874c9bab2952ddc7d3d4f05ec8ff08104ef079b29a

See more details on using hashes here.

File details

Details for the file contswi-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: contswi-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 4.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.7.17

File hashes

Hashes for contswi-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 c8752c1a67935fed8f9d3b6dad777e6e796f492224a26f49719acdf496c5636a
MD5 826163b72aef33955162d81af8b24bd8
BLAKE2b-256 b38a1e0424027fb31fb8692582e46442be25380952bf1604192be7ceb864e659

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page