Skip to content

Commit 23e4e04

Browse files
clubandersonclaude
andauthored
📖 Update README with clearer installation steps (#13)
Move prerequisites (Homebrew install) to the top so users install CLI tools before adding the marketplace. Add Step 1/2/3 structure, /mcp verification, /allowed-tools alternative, and example usage sections for both plugins. Add Helm/Kustomize natural language examples. Signed-off-by: Andrew Anderson <andy@clubanderson.com> Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
1 parent a146f84 commit 23e4e04

1 file changed

Lines changed: 74 additions & 26 deletions

File tree

README.md

Lines changed: 74 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,61 @@
22

33
Official Claude Code plugin marketplace for [KubeStellar](https://kubestellar.io) - multi-cluster Kubernetes management tools.
44

5+
## Prerequisites
6+
7+
Install the CLI tools via Homebrew **before** adding the plugins:
8+
9+
```bash
10+
brew tap kubestellar/tap
11+
brew install kubestellar-ops kubestellar-deploy
12+
```
13+
14+
Or download binaries from [GitHub Releases](https://github.com/kubestellar/kubestellar-mcp/releases).
15+
516
## Installation
617

7-
Add the KubeStellar marketplace to Claude Code:
18+
### Step 1: Add the KubeStellar Marketplace
19+
20+
In Claude Code, run:
821

922
```
1023
/plugin marketplace add kubestellar/claude-plugins
1124
```
1225

13-
Then go to `/plugin`**Discover** tab → Install **kubestellar-ops** and/or **kubestellar-deploy**.
26+
### Step 2: Install the Plugins
27+
28+
Go to `/plugin`**Discover** tab → Install **kubestellar-ops** and/or **kubestellar-deploy**.
29+
30+
### Step 3: Verify
31+
32+
Run `/mcp` in Claude Code - you should see:
33+
34+
```
35+
plugin:kubestellar-ops:kubestellar-ops · ✓ connected
36+
plugin:kubestellar-deploy:kubestellar-deploy · ✓ connected
37+
```
38+
39+
### Allow Tools Without Prompts
40+
41+
Add to `~/.claude/settings.json`:
42+
43+
```json
44+
{
45+
"permissions": {
46+
"allow": [
47+
"mcp__plugin_kubestellar-ops_kubestellar-ops__*",
48+
"mcp__plugin_kubestellar-deploy_kubestellar-deploy__*"
49+
]
50+
}
51+
}
52+
```
53+
54+
Or run in Claude Code:
55+
56+
```
57+
/allowed-tools add mcp__plugin_kubestellar-ops_kubestellar-ops__*
58+
/allowed-tools add mcp__plugin_kubestellar-deploy_kubestellar-deploy__*
59+
```
1460

1561
## Updating
1662

@@ -53,7 +99,7 @@ kubestellar-ops --version
5399
kubestellar-deploy --version
54100
```
55101

56-
### Uninstalling
102+
## Uninstalling
57103

58104
To remove a plugin from Claude Code:
59105

@@ -75,12 +121,22 @@ brew uninstall kubestellar-ops kubestellar-deploy
75121
brew untap kubestellar/tap
76122
```
77123

124+
---
125+
78126
## Plugins
79127

80128
### kubestellar-ops
81129

82130
Multi-cluster Kubernetes diagnostics, RBAC analysis, and security checks.
83131

132+
#### Example Usage
133+
134+
- "List my Kubernetes clusters"
135+
- "Find pods with issues across all clusters"
136+
- "Check for security misconfigurations"
137+
- "What permissions does the admin service account have?"
138+
- "Show me warning events in kube-system"
139+
84140
#### Skills
85141

86142
| Skill | Description |
@@ -158,10 +214,20 @@ Multi-cluster Kubernetes diagnostics, RBAC analysis, and security checks.
158214
| `trigger_openshift_upgrade` | Initiate OpenShift upgrade |
159215
| `get_upgrade_status` | Monitor upgrade progress |
160216

217+
---
218+
161219
### kubestellar-deploy
162220

163221
App-centric multi-cluster deployment and operations with GitOps support.
164222

223+
#### Example Usage
224+
225+
- "Where is nginx running?"
226+
- "Get logs from my api service"
227+
- "Deploy my ML model to clusters with GPUs"
228+
- "Are my clusters in sync with git?"
229+
- "Scale my app to 5 replicas across all clusters"
230+
165231
#### Skills
166232

167233
| Skill | Description |
@@ -217,7 +283,9 @@ App-centric multi-cluster deployment and operations with GitOps support.
217283
| `kustomize_apply` | Build and apply kustomize output |
218284
| `kustomize_delete` | Build and delete kustomize resources |
219285

220-
### Natural Language Usage
286+
---
287+
288+
## Natural Language Usage
221289

222290
Once installed, ask questions like:
223291
- "List my Kubernetes clusters"
@@ -229,28 +297,8 @@ Once installed, ask questions like:
229297
- "What's the status of nginx across all clusters?"
230298
- "Deploy this manifest to clusters with GPUs"
231299
- "Check for drift from my git repo"
232-
233-
### Allow Tools Without Prompts
234-
235-
Add to `~/.claude/settings.json`:
236-
```json
237-
{
238-
"permissions": {
239-
"allow": [
240-
"mcp__plugin_kubestellar-ops_kubestellar-ops__*",
241-
"mcp__plugin_kubestellar-deploy_kubestellar-deploy__*"
242-
]
243-
}
244-
}
245-
```
246-
247-
### Prerequisites
248-
249-
Install kubestellar-ops and kubestellar-deploy via Homebrew:
250-
```bash
251-
brew tap kubestellar/tap
252-
brew install kubestellar-ops kubestellar-deploy
253-
```
300+
- "Install nginx-ingress with Helm across all clusters"
301+
- "Apply kustomize overlay to production"
254302

255303
## About KubeStellar
256304

0 commit comments

Comments
 (0)