Skip to content

Commit 042a8b2

Browse files
ritwik-gclaude
andcommitted
Recommend standalone installation and disable plugin completion
- Update README to recommend standalone CLI installation over helm plugin - Add note about completion limitations for helm plugin - Disable auto-completion options when running as helm plugin - Standalone installation provides better shell completion support 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent ea9250a commit 042a8b2

File tree

3 files changed

+27
-16
lines changed

3 files changed

+27
-16
lines changed

README.md

Lines changed: 20 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -13,44 +13,48 @@ A Helm plugin that helps manage Helm value configurations across different deplo
1313

1414
## Installation
1515

16-
### As a Helm Plugin (Recommended)
16+
### As a Standalone CLI Tool (Recommended)
1717

18-
Install the plugin using the Helm plugin manager:
18+
Install directly with pip:
1919

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

24-
Or install from source:
24+
Or with uv:
2525

2626
```bash
27-
git clone https://github.com/Zipstack/helm-values-manager
28-
helm plugin install ./helm-values-manager
27+
uv add helm-values-manager
2928
```
3029

31-
### As a Standalone CLI Tool
32-
33-
Install directly with pip:
30+
Or install from source:
3431

3532
```bash
36-
pip install helm-values-manager
33+
git clone https://github.com/Zipstack/helm-values-manager
34+
cd helm-values-manager
35+
uv install
36+
# CLI will be available as: uv run helm-values-manager
3737
```
3838

39-
Or with uv:
39+
The standalone installation provides better shell completion support and is easier to manage.
40+
41+
### As a Helm Plugin
42+
43+
Install the plugin using the Helm plugin manager:
4044

4145
```bash
42-
uv add helm-values-manager
46+
helm plugin install https://github.com/Zipstack/helm-values-manager
4347
```
4448

4549
Or install from source:
4650

4751
```bash
4852
git clone https://github.com/Zipstack/helm-values-manager
49-
cd helm-values-manager
50-
uv install
51-
# CLI will be available as: uv run helm-values-manager
53+
helm plugin install ./helm-values-manager
5254
```
5355

56+
**Note**: The helm plugin installation has limited shell completion support due to the plugin wrapper architecture.
57+
5458
## Quick Start
5559

5660
### Vendor Workflow (Chart Publisher)
@@ -92,7 +96,7 @@ uv install
9296

9397
## Command Reference
9498

95-
> **Note**: Replace `helm values-manager` with `helm-values-manager` when using the standalone CLI installation.
99+
> **Note**: Use `helm-values-manager` for standalone installation or `helm values-manager` for helm plugin installation.
96100
97101
| Command | Description |
98102
|---------|-------------|

guide/idea phase2.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44
- Updating schema or schema migration. Cases like default value change / path change / deletion etc.
55
- value from multiple options (eg: value should be one of [a,b,c])
66
- Nice to have: completion based on resources in json files.
7+
- Nice to have: completion for plugin
8+
- Nice to have: publish as pip installable bin
79

810
bugs
911
- While using `helm-values-manager values init` or `helm-values-manager values set` what is the difference between n/skip both seems to do same functionality

helm_values_manager/cli.py

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,19 @@
1+
import os
12
import typer
23
from rich.console import Console
34

45
from helm_values_manager import __version__
56
from helm_values_manager.commands.init import init_command
67
from helm_values_manager.commands import schema, values, validate, generate
78

9+
# Detect if running as helm plugin
10+
is_helm_plugin = os.environ.get("HELM_PLUGIN_DIR") is not None
11+
812
app = typer.Typer(
913
name="helm-values-manager",
1014
help="Manage Helm value configurations across multiple environments",
1115
no_args_is_help=True,
16+
add_completion=not is_helm_plugin, # Disable completion for helm plugin
1217
)
1318
console = Console()
1419

0 commit comments

Comments
 (0)