
# korrect: The kubectl/helm version managing shim

A CLI tool to manage (and optionally fetch) multiple different versions of kubectl by providing a shim layer on top of kubectl. Based on the current k8s context, the correct kubectl version will automatically be invoked. Correct Kubetctl. Korrect.

Witness the miracle of never again needlessly being admonished: `version difference between client (1.31) and server (1.29) exceeds the supported minor version skew of +/-1`

[![Release](https://gitlab.com/cromulentbanana/korrect)](https://gitlab.com/cromulentbanana/korrect/releases)
[![Crates.io](https://img.shields.io/crates/v/korrect.svg)](https://crates.io/crates/korrect)
[![Crates.io Total Downloads](https://img.shields.io/crates/d/korrect)](https://crates.io/crates/korrect)
![MIT License](https://img.shields.io/crates/l/korrect)
[![CI](https://gitlab.com/cromulentbanana/korrect/badges/main/pipeline.svg)](https://gitlab.com/cromulentbanana/korrect)
[![Package Status](https://repology.org/badge/vertical-allrepos/korrect.svg?exclude_unsupported=1)](https://repology.org/project/korrect/versions)

## Features

- Easy installation with automatic setup of required directories and symlinks
- Optional automated download of kubectl, or keep it entirely manual.
- Shell completion support for various shells (bash, zsh, fish)
- Low performance overhead via caching based on kubeconfig content
- Supports common kubectl aliases (`k` and `kubectl`)
- Can uninstall itself: Satisfaction guaranteed or just call `korrect uninstall`.

## Installation

### From Source

```bash
git clone https://gitlab.com/cromulentbanana/korrect.git
cd korrect
cargo install --path .
```

### Using Cargo

```bash
cargo install korrect
```

### Download binaries from gitlab release

1. Visit https://gitlab.com/cromulentbanana/korrect/-/releases
2. Download korrect and korrect-shim and place into the same directory (of your choice) in your shell's path

## Quick Start

1. Install korrect (with default configuration):
```bash
korrect setup
```

Note that various setup options can be used to e.g. choose whether to also manage helm, choose the download mode or version matching strategy. See `korrect setup --help` for details.

2. Add the korrect bin directory to your PATH:
```bash
export PATH="$HOME/.korrect/bin:$PATH"
```

3. Start using kubectl as normal - korrect will automatically intercept and process your commands.

## Usage

### Basic Commands

```bash
# Set up korrect
korrect setup

# List installed components
korrect list

# View the configuration
korrect config

# Generate shell completions (replace `zsh` with your shell)
korrect completions zsh
```

### Setup Options

The setup command supports several flags to customize installation:

```bash
# Force installation (overwrite existing files)
korrect setup --force

# Uninstall korrect
korrect uninstall
```


### Directory Structure

After installation, korrect creates the following directory structure:

```
~/
├──.cache/korrect/     # The contents of the active kubeconfig are hashed to reference
├                      # the version-specific kubectl belonging to it 
├──.config/korrect/    
├   └── config.toml    
├                      
└──.korrect/bin/
    ├── k              # Symlink to korrect-shim
    ├── kubectl        # Symlink to korrect-shim
    ├── helm           # Symlink to korrect-shim
    ├── kubectl-vA.B.C # Binary auto-downloaded by kubectl-shim or placed here by you
    └── kubectl-vX.Y.Z # Binary auto-downloaded or kubectl-shim or placed here by you
```

## Configuration

Configuration is written at setup time into `~/.config/korrect/config.toml`.

## Shell Completion

korrect supports shell completions for various shells. To enable completions:

```bash
# For bash
korrect completions bash > ~/.local/share/bash-completion/completions/korrect

# For zsh
korrect completions zsh > ~/.zfunc/_korrect

# For fish
korrect completions fish > ~/.config/fish/completions/korrect.fish
```

Remember to source your shell's completion file or restart your shell.

## 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/AmazingFeature`)
3. Commit your changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request

## Acknowledgments

- Inspired by the volta.sh the Hassle-free javascript tool manager
- Built with [clap-rs](https://github.com/clap-rs/clap) for argument parsing, shell completion
