khelp 0.1.15

A tool for managing kubernetes contexts
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138

# khelp(er)

A command-line tool for managing Kubernetes contexts.

## Overview

khelp simplifies working with kubeconfig files by providing intuitive commands to list, switch, import, export, and manage Kubernetes contexts.

## Installation

### Quick Install

**Linux / macOS:**
```bash
curl -fsSL https://files.stvnksslr.com/khelp/install.sh | bash
```

**Windows (PowerShell):**
```powershell
irm https://files.stvnksslr.com/khelp/install.ps1 | iex
```

### From Source

```bash
git clone https://github.com/stvnksslr/khelp.git
cd khelp
cargo build --release
```

The binary will be available at `target/release/khelp`.

### With Self-Update Feature

```bash
cargo build --release --features self_update
```

## Platform Support

- Linux
- macOS
- Windows

## Commands

| Command | Description |
|---------|-------------|
| `list` | List all available contexts (current context marked with *) |
| `current` | Display details about the active context |
| `switch [name]` | Switch to a different context (interactive if no name given) |
| `edit [name]` | Edit a context configuration in your default editor |
| `export [names...]` | Export one or more contexts to stdout in YAML format |
| `delete [name]` | Delete a context and its orphaned cluster/user (supports --force) |
| `cleanup` | Remove orphaned clusters and users not referenced by any context |
| `rename <old> <new>` | Rename an existing context |
| `add <file>` | Import contexts from an external kubeconfig file |
| `completions [shell]` | Generate shell completions (bash, zsh, fish, powershell, elvish) |
| `update` | Check for and apply updates (requires self_update feature) |

## Usage Examples

List all contexts:
```bash
khelp list
```

Switch to a context interactively:
```bash
khelp switch
```

Switch to a specific context:
```bash
khelp switch my-cluster
```

Import contexts from another kubeconfig:
```bash
khelp add ~/Downloads/new-cluster.yaml
```

Import with automatic rename for conflicts:
```bash
khelp add ~/Downloads/cluster.yaml --rename
```

Export a context for backup:
```bash
khelp export my-cluster > my-cluster-backup.yaml
```

Export multiple contexts at once:
```bash
khelp export dev-cluster staging-cluster prod-cluster > all-clusters.yaml
```

Delete a context (automatically removes orphaned cluster/user):
```bash
khelp delete old-cluster
```

Clean up any orphaned clusters and users:
```bash
khelp cleanup
```

Install shell completions:
```bash
khelp completions --install
```

## Shell Completions

Generate completions for your shell:

```bash
# Bash
khelp completions bash >> ~/.bash_completion.d/khelp

# Zsh
khelp completions zsh > ~/.zfunc/_khelp

# Fish
khelp completions fish > ~/.config/fish/completions/khelp.fish

# PowerShell (add to $PROFILE)
khelp completions powershell >> $PROFILE
```

Or use automatic installation:
```bash
khelp completions --install
```

## License

MIT