📖 Update README with clearer installation steps#13
Conversation
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. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> Signed-off-by: Andrew Anderson <andy@clubanderson.com>
kubestellar-prow
Bot
added
the
dco-signoff: yes
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
|
Welcome to KubeStellar! 🚀 Thank you for submitting this Pull Request. Before your PR can be merged, please ensure: ✅ DCO Sign-off - All commits must be signed off with ✅ PR Title - Must start with an emoji: ✨ (feature), 🐛 (bug fix), 📖 (docs), 🌱 (infra/tests), Getting Started with KubeStellar: Contributor Resources:
🌟 Help KubeStellar Grow - We Need Adopters! Our roadmap is driven entirely by adopter feedback. Whether you're using KubeStellar yourself or know someone who could benefit from multi-cluster Kubernetes: 📋 Take our Multi-Cluster Survey - Share your use cases and help shape our direction! A maintainer will review your PR soon. Feel free to ask questions in the comments or on Slack! |
kubestellar-prow
Bot
added
the
size/L
|
🎉 Thank you for your contribution! Your PR has been successfully merged. 🌟 Help KubeStellar Grow - We Need Adopters! Our roadmap is driven entirely by adopter feedback - nothing else. Whether you're using KubeStellar yourself or know organizations that could benefit from multi-cluster Kubernetes, we need your help: 📋 Take our Multi-Cluster Survey - Share your use cases and help shape our direction! 🗣️ Spread the word - Tell colleagues, write blog posts, present at meetups 💬 Share feedback on Slack #kubestellar-dev Every adopter story helps us prioritize what matters most. Thank you for being part of the KubeStellar community! |
There was a problem hiding this comment.
Pull request overview
Improves the README installation flow so users install required CLI tools first, then add/install/verify Claude Code plugins, with clearer examples and tool-permission guidance.
Changes:
- Move prerequisites (Homebrew/binaries) to the top and restructure installation into Step 1/2/3.
- Add
/mcpverification and/allowed-toolsalternative to editingsettings.json. - Add example prompts for both plugins plus additional Helm/Kustomize natural-language examples.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| ### Step 3: Verify | ||
|
|
||
| Run `/mcp` in Claude Code - you should see: |
There was a problem hiding this comment.
The verification output implies both plugins will always appear as connected, but Step 2 allows installing either one. Consider updating this section to show an example for each plugin separately, or clarify that you should see the entries only for the plugins you installed.
| Run `/mcp` in Claude Code - you should see: | |
| Run `/mcp` in Claude Code — you should see entries for the plugins you installed, for example: |
| Add to `~/.claude/settings.json`: | ||
|
|
||
| ```json | ||
| { | ||
| "permissions": { | ||
| "allow": [ | ||
| "mcp__plugin_kubestellar-ops_kubestellar-ops__*", | ||
| "mcp__plugin_kubestellar-deploy_kubestellar-deploy__*" | ||
| ] | ||
| } | ||
| } |
There was a problem hiding this comment.
This reads like a full settings.json file and could lead users to overwrite existing settings. Consider wording like “merge the following into your existing ~/.claude/settings.json” and/or showing just the minimal permissions.allow fragment to append.
| Add to `~/.claude/settings.json`: | |
| ```json | |
| { | |
| "permissions": { | |
| "allow": [ | |
| "mcp__plugin_kubestellar-ops_kubestellar-ops__*", | |
| "mcp__plugin_kubestellar-deploy_kubestellar-deploy__*" | |
| ] | |
| } | |
| } | |
| Merge the following into the `permissions.allow` array in your existing `~/.claude/settings.json`: | |
| ```jsonc | |
| // Add these entries to "permissions.allow" | |
| "mcp__plugin_kubestellar-ops_kubestellar-ops__*", | |
| "mcp__plugin_kubestellar-deploy_kubestellar-deploy__*" |
| plugin:kubestellar-deploy:kubestellar-deploy · ✓ connected | ||
| ``` | ||
|
|
||
| ### Allow Tools Without Prompts |
There was a problem hiding this comment.
Since the installation section is structured as Step 1/2/3, this optional section breaks the stepwise flow a bit. Consider renaming the heading to something like “Step 4 (Optional): Allow Tools Without Prompts” or “Optional: Allow Tools Without Prompts” for consistency.
| ### Allow Tools Without Prompts | |
| ### Step 4 (Optional): Allow Tools Without Prompts |
Summary
/mcpverification step/allowed-toolsas alternative to editing settings.jsonTest plan
🤖 Generated with Claude Code