Skip to content

Commit 4cc10a2

Browse files
ritwik-gclaude
andcommitted
Add shell completion documentation and update repository URLs
- Add comprehensive shell completion setup instructions - Document completion for both Helm plugin and standalone modes - Support for bash, zsh, fish, and PowerShell - Update all GitHub URLs to Zipstack/helm-values-manager 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent 62a865d commit 4cc10a2

File tree

1 file changed

+52
-4
lines changed

1 file changed

+52
-4
lines changed

README.md

Lines changed: 52 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,13 +18,13 @@ A Helm plugin that helps manage Helm value configurations across different deplo
1818
Install the plugin using the Helm plugin manager:
1919

2020
```bash
21-
helm plugin install https://github.com/yourusername/helm-values-manager
21+
helm plugin install https://github.com/Zipstack/helm-values-manager
2222
```
2323

2424
Or install from source:
2525

2626
```bash
27-
git clone https://github.com/yourusername/helm-values-manager
27+
git clone https://github.com/Zipstack/helm-values-manager
2828
helm plugin install ./helm-values-manager
2929
```
3030

@@ -45,7 +45,7 @@ uv add helm-values-manager
4545
Or install from source:
4646

4747
```bash
48-
git clone https://github.com/yourusername/helm-values-manager
48+
git clone https://github.com/Zipstack/helm-values-manager
4949
cd helm-values-manager
5050
uv install
5151
# CLI will be available as: uv run helm-values-manager
@@ -127,6 +127,54 @@ All commands support these options:
127127
- `--schema PATH`: Path to schema.json (default: ./schema.json)
128128
- `--values PATH`: Base path for values files (default: ./values-{env}.json)
129129

130+
## Shell Completion
131+
132+
The CLI supports shell completion for enhanced productivity.
133+
134+
### Setup
135+
136+
**For Helm Plugin Installation:**
137+
```bash
138+
# Install completion for your shell (bash, zsh, fish, powershell)
139+
helm values-manager --install-completion zsh
140+
141+
# Restart your shell or source the configuration
142+
source ~/.zshrc # for zsh
143+
source ~/.bashrc # for bash
144+
```
145+
146+
**For Standalone Installation:**
147+
```bash
148+
# Install completion for your shell
149+
helm-values-manager --install-completion zsh
150+
151+
# Restart your shell or source the configuration
152+
source ~/.zshrc # for zsh
153+
source ~/.bashrc # for bash
154+
```
155+
156+
### Usage
157+
158+
After setup, you can use tab completion:
159+
```bash
160+
# Tab completion for commands
161+
helm values-manager <TAB><TAB>
162+
163+
# Tab completion for subcommands
164+
helm values-manager schema <TAB><TAB>
165+
helm values-manager values <TAB><TAB>
166+
167+
# Show available completion script (without installing)
168+
helm values-manager --show-completion zsh
169+
```
170+
171+
### Supported Shells
172+
173+
- **bash**: Most common Linux/macOS shell
174+
- **zsh**: Default macOS shell (macOS 10.15+)
175+
- **fish**: Modern shell with advanced features
176+
- **PowerShell**: Windows PowerShell and PowerShell Core
177+
130178
## File Structure
131179

132180
```
@@ -260,7 +308,7 @@ This plugin is written in Python and uses:
260308
### Building from Source
261309

262310
```bash
263-
git clone https://github.com/yourusername/helm-values-manager
311+
git clone https://github.com/Zipstack/helm-values-manager
264312
cd helm-values-manager
265313
uv install
266314
uv run pytest # Run tests

0 commit comments

Comments
 (0)