mirror of
https://github.com/SuperClaude-Org/SuperClaude_Framework.git
synced 2025-12-29 16:16:08 +00:00
docs: Transform documentation to emphasize simplicity and auto-activation
Update all Docs/ guides to lead with "just start using it" approach while keeping comprehensive information available. Key changes: - Add prominent "Simple Truth" and "Just Start Here" sections - Emphasize intelligent routing and auto-activation throughout - Reframe detailed guides as optional curiosity rather than required study - Use casual, humble developer tone with emojis for clarity - Transform "learn first" to "discover through use" messaging - Make auto-expert selection and flag activation prominent - Remove any marketing language in favor of honest, straightforward content Files updated: superclaude-user-guide.md, commands-guide.md, flags-guide.md, personas-guide.md, installation-guide.md 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
@@ -1,28 +1,63 @@
|
||||
# SuperClaude Flags User Guide 🏁
|
||||
|
||||
## 🤖 Most Flags Activate Automatically - Don't Stress About It!
|
||||
|
||||
**The honest truth**: You don't need to memorize these flags. SuperClaude automatically adds the right ones based on what you're doing!
|
||||
|
||||
**Here's what actually happens:**
|
||||
- You type `/analyze auth.js`
|
||||
- SuperClaude detects it's security-related code
|
||||
- **Automatically adds** `--persona-security`, `--focus security`, `--validate`
|
||||
- You get expert security analysis without managing any flags
|
||||
|
||||
**When might you manually use flags?**
|
||||
- You want to **override** what SuperClaude picked (rare)
|
||||
- You're **curious** about specific aspects (`--focus performance`)
|
||||
- You want to **experiment** with different approaches
|
||||
|
||||
**Bottom line**: Just use basic commands and let the auto-activation work. These flags are here when you want them, not because you need them. 🎯
|
||||
|
||||
---
|
||||
|
||||
## 🚀 Just Try These (No Flag Knowledge Required)
|
||||
|
||||
```bash
|
||||
# These work great with zero flag knowledge:
|
||||
/analyze src/ # Auto-picks the right analysis flags
|
||||
/build # Auto-optimizes based on your project
|
||||
/improve messy-code.js # Auto-activates quality and safety flags
|
||||
/troubleshoot "weird error" # Auto-activates debugging and analysis flags
|
||||
```
|
||||
|
||||
**See? No flags needed.** Everything below is for when you get curious about what's happening behind the scenes.
|
||||
|
||||
---
|
||||
|
||||
A practical guide to SuperClaude's flag system. Flags are like command-line options that change how SuperClaude behaves - think of them as superpowers for your commands.
|
||||
|
||||
## What Are Flags? 🤔
|
||||
|
||||
**Flags are modifiers** that change how SuperClaude processes your requests. They come after commands and start with `--`.
|
||||
|
||||
**Basic syntax**:
|
||||
**Basic syntax** (but you usually don't need to know this):
|
||||
```bash
|
||||
/command --flag-name
|
||||
/command --flag-name value
|
||||
/command --flag-name value
|
||||
/analyze src/ --focus security --depth deep
|
||||
```
|
||||
|
||||
**Two ways flags work**:
|
||||
1. **Manual** - You add them explicitly: `/analyze --think --focus security`
|
||||
2. **Auto-activation** - SuperClaude adds them based on context (this happens a lot!)
|
||||
**How flags actually work in practice**:
|
||||
1. **Auto-activation** - SuperClaude adds them based on context (this is the main way! 🎯)
|
||||
2. **Manual override** - You can add them explicitly if you want different behavior
|
||||
|
||||
**Why use flags?**
|
||||
**Why flags exist** (mostly automatic benefits):
|
||||
- Get better, more focused results
|
||||
- Control SuperClaude's thinking depth
|
||||
- Enable special capabilities (MCP servers)
|
||||
- Optimize for speed or detail
|
||||
- Direct attention to specific areas
|
||||
- Auto-enable the right thinking depth
|
||||
- Connect to special capabilities when useful
|
||||
- Optimize for speed or detail based on your task
|
||||
- Direct attention to what you're actually working on
|
||||
|
||||
**The key point**: SuperClaude handles flag selection intelligently so you don't have to think about it! 🧠
|
||||
|
||||
## Flag Categories 📂
|
||||
|
||||
@@ -457,19 +492,19 @@ SuperClaude automatically adds flags based on context. Here's when:
|
||||
|
||||
## Tips for Effective Flag Usage 💡
|
||||
|
||||
### Starting Out
|
||||
1. **Begin simple**: Try basic flags like `--think` and `--focus`
|
||||
2. **Watch auto-activation**: See what SuperClaude adds automatically
|
||||
3. **Use `--help`**: Many commands show available flags
|
||||
4. **Start safe**: Use `--safe-mode` and `--validate` for important work
|
||||
### Starting Out (The Honest Truth)
|
||||
1. **Just ignore flags at first** - Auto-activation handles 90% of cases perfectly
|
||||
2. **Watch what gets auto-activated** - You'll learn by seeing what SuperClaude picks
|
||||
3. **Use `--help` when curious** - Many commands show what flags are available
|
||||
4. **Trust the automation** - SuperClaude usually picks better than manual selection
|
||||
|
||||
### Getting Advanced
|
||||
1. **Learn combinations**: `--think --seq --c7` works great together
|
||||
2. **Understand auto-activation**: Know when flags get added automatically
|
||||
3. **Use personas**: They're like having specialists on your team
|
||||
4. **Optimize for your workflow**: Fast (`--uc --no-mcp`) vs thorough (`--think-hard --all-mcp`)
|
||||
### Getting Advanced (If You Want To)
|
||||
1. **Experiment with overrides** - Try `--persona-security` on non-security code for different perspectives
|
||||
2. **Learn the useful combos** - `--safe-mode --validate` for important stuff
|
||||
3. **Understand the performance trade-offs** - Fast (`--uc --no-mcp`) vs thorough (`--think-hard --all-mcp`)
|
||||
4. **Use flags for learning** - `--verbose` when you want to understand what's happening
|
||||
|
||||
### Performance Tips
|
||||
### Performance Tips (For Power Users)
|
||||
- **For speed**: `--uc --no-mcp --scope file`
|
||||
- **For thoroughness**: `--think-hard --all-mcp --delegate auto`
|
||||
- **For safety**: `--safe-mode --validate --preview`
|
||||
@@ -479,25 +514,30 @@ SuperClaude automatically adds flags based on context. Here's when:
|
||||
|
||||
## Final Notes 📝
|
||||
|
||||
**Remember:**
|
||||
- Flags make SuperClaude more powerful but also more complex
|
||||
- Start simple and add flags as you learn what they do
|
||||
- Auto-activation usually gets it right - trust it until you know better
|
||||
- `--safe-mode` and `--validate` are your friends for important work
|
||||
**The real truth about flags** 💯:
|
||||
- **Auto-activation is usually better** than manual flag selection
|
||||
- **You can ignore most of this guide** and just use basic commands
|
||||
- **Flags are here when you want them** - not because you need them
|
||||
- **Learning emerges naturally** through use, not through studying
|
||||
|
||||
**Still evolving:**
|
||||
- Some advanced flags (wave, delegation) are still experimental
|
||||
- Auto-activation keeps getting smarter
|
||||
- New flags and capabilities are added regularly
|
||||
**Don't feel overwhelmed** 🧘♂️:
|
||||
- SuperClaude is designed to work great without flag knowledge
|
||||
- The detailed info above is for curiosity, not necessity
|
||||
- Auto-activation keeps getting smarter based on usage patterns
|
||||
- You're not missing out by not memorizing flags
|
||||
|
||||
**When in doubt:**
|
||||
- Start with basic commands and see what auto-activates
|
||||
- Use `--safe-mode` for anything important
|
||||
- Check the commands guide for flag suggestions per command
|
||||
- GitHub issues are great for flag-related questions
|
||||
**When you actually need flags**:
|
||||
- Overriding auto-activation (rare)
|
||||
- Experimenting with different approaches (fun)
|
||||
- Optimizing for specific performance needs (advanced)
|
||||
- Learning about what happened (educational)
|
||||
|
||||
**Happy flagging!** 🚩 These flags can really supercharge your SuperClaude experience once you get the hang of them.
|
||||
**Start simple, stay simple** 🎯:
|
||||
- Use basic commands: `/analyze`, `/build`, `/improve`
|
||||
- Let auto-activation handle the complexity
|
||||
- Add manual flags only when you want to experiment
|
||||
- Trust that SuperClaude knows what it's doing
|
||||
|
||||
---
|
||||
|
||||
*Flags are like spices - a little goes a long way, and the right combination can make everything better! 🌶️*
|
||||
*Remember: Behind all this apparent complexity, SuperClaude is actually simple to use. Just start typing commands! 🚀*
|
||||
Reference in New Issue
Block a user