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.4.tar.gz (4.4 kB view details)

Uploaded Source

Built Distribution

contswi-0.1.4-py3-none-any.whl (5.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: contswi-0.1.4.tar.gz
  • Upload date:
  • Size: 4.4 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.4.tar.gz
Algorithm Hash digest
SHA256 a10b18ebf06c8b1729ec0bb47c1f7b0344e98b9ccb02c28aac88f105cb74d3da
MD5 39af439ef34ffd21689a014e21b4f15f
BLAKE2b-256 5d749d44793a85541984a2f85f0917b5d524aaf4a37285661fc0dc680cd798a8

See more details on using hashes here.

File details

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

File metadata

  • Download URL: contswi-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 5.0 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.4-py3-none-any.whl
Algorithm Hash digest
SHA256 f03ba2e46df75b35ca8a68549431a5634e204b632ef4b34cce19fb8dc1017b9b
MD5 9fade308b66d9b6fedda0dcf5a457722
BLAKE2b-256 16f41ef0f9eebe31db9489a3935f326ee8389f0fcacdba14352f41d1c7cfb5ba

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