ccguide
v1.0.0
Published
Interactive step-by-step guidance system for Claude Code with user feedback loops and educational focus
Maintainers
Readme
SuperClaude /guideme Command
Interactive step-by-step guidance system for Claude Code with user feedback loops and educational focus.
What is /guideme?
The /guideme command transforms Claude Code into an interactive tutor that provides step-by-step guidance for complex tasks. Instead of giving you all instructions at once, it:
- 🎯 Presents one step at a time with clear context
- 👀 Waits for your output before proceeding
- 🔍 Analyzes your results to determine the next step
- 🛠️ Provides troubleshooting based on actual errors
- 📋 Tracks progress through multi-step processes
- 🎓 Teaches methodology not just commands
Perfect for system administration, development workflows, and learning new technologies.
Installation
Quick Install with npx (Recommended)
npx ccguideThat's it! The command will:
- ✅ Check for Claude Code installation
- 📁 Create the necessary directory structure
- 📋 Install all SuperClaude framework files
- 🎯 Install the
/guidemecommand - 🎉 Make it available immediately in Claude Code
Alternative Installation Methods
Manual Install Script
- Clone or download this repository
- Run the installation script:
./install.sh - Restart Claude Code (if needed)
- Type
/in Claude Code to seeguidemein the suggestions
Manual Install
If you prefer manual installation:
- Copy the
.claudedirectory contents to your~/.claude/directory - Ensure the directory structure matches:
~/.claude/ ├── commands/sc/guideme.md ├── CLAUDE.md ├── COMMANDS.md ├── PERSONAS.md ├── ORCHESTRATOR.md └── [other framework files]
Usage
Basic Usage
/sc:guideme "docker setup"
/sc:guideme "configure nginx reverse proxy"
/sc:guideme "git workflow setup"With Flags
# Detailed explanations and learning material
/sc:guideme "kubernetes deployment" --detailed
# Quick commands for experienced users
/sc:guideme "database migration" --fast
# Resume from a specific step
/sc:guideme "ssl certificate setup" --resume step3
# List available guided tasks
/sc:guideme --listHow It Works
- You request guidance:
/sc:guideme "setup docker containers" - Claude presents Step 1 with context and explanation
- You run the command and share the output
- Claude analyzes your results and provides Step 2
- Process continues until task completion
- Troubleshooting happens in real-time based on your actual errors
Example Session
You: /sc:guideme "docker container setup" --detailed
Claude: Let's set up Docker containers step by step.
**Step 1**: First, let me check your current Docker installation.
Please run this command and share the output:
```bash
docker --versionYou: docker --version Docker version 24.0.6, build ed223bc
Claude: Great! Docker is installed and up to date.
Step 2: Now let's check if Docker daemon is running:
docker info[Session continues with interactive guidance...]
## Features
- **🎓 Educational Focus**: Mentor persona activated for learning-oriented guidance
- **🔄 Interactive Loops**: Real-time feedback and course correction
- **📊 Progress Tracking**: TodoWrite integration for complex processes
- **🎯 Error Recovery**: Troubleshooting based on actual user output
- **⚡ Flexible Modes**: Fast commands or detailed explanations
- **🔧 Framework Integration**: Full SuperClaude framework support
## SuperClaude Framework
This command is part of the SuperClaude framework, which provides:
- **Intelligent Personas**: Specialized AI behavior patterns
- **MCP Integration**: Enhanced capabilities through Model Context Protocol
- **Advanced Routing**: Smart command detection and optimization
- **Quality Gates**: Built-in validation and best practices
## Requirements
- Claude Code (latest version)
- Bash shell (for installation script)
- Basic command line knowledge
## Troubleshooting
### Command not appearing in suggestions
- Restart Claude Code
- Check that files are in `~/.claude/commands/sc/guideme.md`
- Verify file permissions
### Framework conflicts
- If you have existing `.claude` files, the installer will skip duplicates
- Manually merge configurations if needed
### Need help?
Use the command itself! `/sc:guideme "troubleshoot guideme installation"`
## Contributing
This is part of the SuperClaude framework. Contributions welcome for:
- New guided task templates
- Framework improvements
- Documentation enhancements
- Bug fixes and optimizations
## License
Open source - feel free to modify and distribute.
---
**Happy Learning!** 🚀
The `/guideme` command transforms complex technical tasks into interactive learning experiences. Perfect for system administration, development workflows, and mastering new technologies.