myaidev-method 0.0.1 → 0.0.2

package/USER_GUIDE.md

@@ -0,0 +1,755 @@
+# MyAIDev Method - User Guide
+
+> **🎯 Complete guide to customizing and using your AI CLI agents**
+
+This guide covers everything you need to know about using, customizing, and extending the MyAIDev Method package after installation.
+
+## 📋 Table of Contents
+
+- [Quick Start](#quick-start)
+- [Understanding the Structure](#understanding-the-structure)
+- [Customizing Agents](#customizing-agents)
+- [Managing Commands](#managing-commands)
+- [WordPress Integration](#wordpress-integration)
+- [SSH Configuration](#ssh-configuration)
+- [Agent Management](#agent-management)
+- [Troubleshooting](#troubleshooting)
+- [Advanced Usage](#advanced-usage)
+- [Best Practices](#best-practices)
+
+## 🚀 Quick Start
+
+After installing with `npx myaidev-method init --claude`, you'll have a `.claude` folder in your project:
+
+```
+.claude/
+├── commands/           # Slash commands
+├── agents/            # AI agent definitions
+├── mcp/              # MCP integrations
+└── CLAUDE.md         # Project configuration
+```
+
+### Immediate Usage
+
+```bash
+# Create professional content
+/myai-content-writer "10 Best Remote Work Tips"
+
+# WordPress administration
+/myai-wordpress-admin health-check
+
+# Manage agents and settings
+/myai-configure agents --list
+```
+
+## 🏗️ Understanding the Structure
+
+### Commands Directory (`.claude/commands/`)
+
+Contains slash commands that appear in your Claude Code interface:
+
+- `myai-content-writer.md` - Content creation command
+- `myai-wordpress-admin.md` - WordPress administration
+- `myai-wordpress-publish.md` - WordPress publishing
+- `myai-configure.md` - Configuration management
+
+### Agents Directory (`.claude/agents/`)
+
+Contains AI agent definitions with specialized prompts:
+
+- `content-writer.md` - Professional content creator
+- `wordpress-admin.md` - WordPress administrator
+
+### File Format
+
+All commands and agents use Markdown with YAML frontmatter:
+
+```markdown
+---
+name: agent-name
+description: Brief description
+tools: Read, Write, Edit, WebSearch, WebFetch, Task
+---
+
+# Agent prompt content goes here...
+```
+
+## 🎨 Customizing Agents
+
+### Method 1: Direct File Editing
+
+**For immediate customization in your current project:**
+
+```bash
+# Edit the content writer agent
+nano .claude/agents/content-writer.md
+# or
+code .claude/agents/content-writer.md
+
+# Restart Claude Code to load changes
+```
+
+### Method 2: Replace with Custom File
+
+**If you have a complete custom prompt file:**
+
+```bash
+# Always backup first
+cp .claude/agents/content-writer.md .claude/agents/content-writer.md.backup
+
+# Replace with your custom file
+cp your-custom-prompt.md .claude/agents/content-writer.md
+
+# Restart Claude Code
+```
+
+### Method 3: Using Configuration Commands
+
+**Safe editing with built-in tools:**
+
+```bash
+# Create backup before editing
+/myai-configure agents --backup content-writer
+
+# Edit the agent
+/myai-configure agents --edit content-writer
+
+# Validate changes
+/myai-configure agents --validate content-writer
+```
+
+### Method 4: Update Source for All Future Installations
+
+**To modify the default prompt for new installations:**
+
+1. **Update the source template**:
+   ```bash
+   # Edit the template file
+   nano src/templates/claude/agents/content-writer.md
+   ```
+
+2. **Publish update**:
+   ```bash
+   # Bump version
+   npm version patch  # 0.0.1 → 0.0.2
+   
+   # Publish
+   npm publish
+   ```
+
+## ✏️ Agent Customization Examples
+
+### Example 1: Technical Documentation Writer
+
+```markdown
+---
+name: content-writer
+description: Technical documentation specialist for developer content
+tools: Read, Write, Edit, WebSearch, WebFetch, Task, Grep, Glob
+---
+
+You are a technical documentation writer specializing in developer-focused content.
+
+## Writing Style
+- Use clear, concise technical language
+- Include code examples where appropriate
+- Structure content for easy scanning by developers
+- Focus on practical implementation details
+
+## Custom Requirements
+- Always include code snippets when relevant
+- Add "Prerequisites" section for technical tutorials
+- Include "Troubleshooting" sections
+- Reference official documentation sources
+
+## Output Format
+Create content with:
+- Step-by-step instructions
+- Code examples with syntax highlighting
+- API reference links
+- Common pitfalls and solutions
+```
+
+### Example 2: Marketing Content Writer
+
+```markdown
+---
+name: content-writer
+description: Marketing content specialist focused on conversion
+tools: Read, Write, Edit, WebSearch, WebFetch, Task
+---
+
+You are a marketing content writer specializing in conversion-focused copy.
+
+## Brand Voice
+- Conversational and approachable
+- Benefits-focused messaging
+- Strong calls-to-action
+- Customer pain point awareness
+
+## Content Types
+- Landing page copy
+- Email marketing content
+- Social media posts
+- Product descriptions
+
+## SEO Focus
+- High-converting keywords
+- Local SEO optimization
+- Featured snippet targeting
+- User intent matching
+```
+
+### Example 3: Industry-Specific Writer
+
+```markdown
+---
+name: content-writer
+description: Healthcare content writer with medical expertise
+tools: Read, Write, Edit, WebSearch, WebFetch, Task
+---
+
+You are a healthcare content writer with deep medical knowledge.
+
+## Compliance Requirements
+- HIPAA compliance awareness
+- Medical accuracy verification
+- Proper medical terminology
+- Citation of peer-reviewed sources
+
+## Content Guidelines
+- Patient-friendly language
+- Evidence-based information
+- Professional medical tone
+- Accessibility considerations
+```
+
+## ⚙️ Managing Commands
+
+### Viewing Available Commands
+
+```bash
+# List all commands
+/myai-configure agents --list
+
+# Show command details
+ls -la .claude/commands/
+
+# View specific command
+cat .claude/commands/myai-content-writer.md
+```
+
+### Customizing Commands
+
+Edit command files to modify behavior:
+
+```bash
+# Edit content writer command
+nano .claude/commands/myai-content-writer.md
+```
+
+**Example command customization:**
+
+```markdown
+---
+name: myai-content-writer
+description: Create technical blog posts with code examples
+tools: Read, Write, Edit, WebSearch, WebFetch, Task, Grep, Glob
+---
+
+Create technical blog posts based on the topic: $ARGUMENTS
+
+## Requirements
+- Include practical code examples
+- Add "Prerequisites" section
+- Provide GitHub repository links
+- Include troubleshooting section
+
+## Output Format
+Save as markdown with:
+- Technical accuracy
+- Step-by-step tutorials
+- Copy-paste ready code
+- Real-world applications
+```
+
+### Creating New Commands
+
+1. **Create new command file**:
+   ```bash
+   nano .claude/commands/myai-code-reviewer.md
+   ```
+
+2. **Add command definition**:
+   ```markdown
+   ---
+   name: myai-code-reviewer
+   description: Professional code review and analysis
+   tools: Read, Write, Edit, Grep, Glob, Task
+   ---
+   
+   Review the code specified in $ARGUMENTS and provide:
+   - Security analysis
+   - Performance recommendations
+   - Best practice suggestions
+   - Refactoring opportunities
+   ```
+
+3. **Restart Claude Code** to load the new command
+
+## 🔌 WordPress Integration
+
+### Initial Setup
+
+1. **Create environment file**:
+   ```bash
+   cp .env.example .env
+   ```
+
+2. **Configure WordPress credentials**:
+   ```bash
+   # Edit .env file
+   WORDPRESS_URL=https://your-site.com
+   WORDPRESS_USERNAME=your-username
+   WORDPRESS_APP_PASSWORD=your-app-password
+   ```
+
+3. **Create Application Password**:
+   - Go to WordPress Admin → Users → Your Profile
+   - Find "Application Passwords" section
+   - Enter name and click "Add New"
+   - Copy the generated password
+
+### WordPress Commands
+
+```bash
+# Test connection
+/myai-wordpress-admin health-check
+
+# Security operations
+/myai-wordpress-admin security-scan
+/myai-wordpress-admin malware-check
+/myai-wordpress-admin user-audit
+
+# Performance optimization
+/myai-wordpress-admin speed-test --detailed
+/myai-wordpress-admin database-optimize
+/myai-wordpress-admin cache-setup
+
+# Content management
+/myai-wordpress-publish "article.md" --status draft
+/myai-content-writer "Blog Post Title" --publish_to_wordpress true
+```
+
+### WordPress Configuration Options
+
+```bash
+# Configure WordPress settings
+/myai-configure wordpress
+
+# Set default publishing options
+/myai-configure defaults
+```
+
+## 💻 SSH Configuration
+
+### Setup Options
+
+#### Option 1: Use Existing SSH Keys (Recommended)
+
+If you already have SSH configured:
+
+```bash
+# Test existing SSH
+ssh user@your-server
+
+# Use in WordPress admin (automatic)
+/myai-wordpress-admin security-scan
+```
+
+#### Option 2: Specify SSH Details
+
+```bash
+# Add to .env file
+SSH_HOST=your-server-ip
+SSH_USERNAME=your-ssh-username
+SSH_KEY_PATH=/path/to/private/key
+WORDPRESS_PATH=/var/www/html
+```
+
+#### Option 3: SSH Config File
+
+Configure in `~/.ssh/config`:
+
+```
+Host wordpress-server
+    HostName your-server-ip
+    User your-username
+    IdentityFile ~/.ssh/your-key
+    Port 22
+```
+
+Then set: `SSH_HOST=wordpress-server`
+
+### SSH-Enabled Operations
+
+When SSH is available:
+
+```bash
+# Server-level security
+/myai-wordpress-admin file-permissions
+/myai-wordpress-admin malware-check
+
+# Performance monitoring
+/myai-wordpress-admin resource-monitor
+/myai-wordpress-admin error-analysis
+
+# Backup operations
+/myai-wordpress-admin backup-create
+/myai-wordpress-admin backup-verify
+```
+
+## 🛠️ Agent Management
+
+### Using Configuration Commands
+
+```bash
+# List all agents
+/myai-configure agents --list
+
+# Check agent status
+/myai-configure agents --status
+
+# Validate specific agent
+/myai-configure agents --validate content-writer
+
+# Create backup
+/myai-configure agents --backup wordpress-admin
+
+# Edit agent safely
+/myai-configure agents --edit content-writer
+
+# Restore from backup
+/myai-configure agents --restore content-writer
+
+# Show agent tools
+/myai-configure agents --tools wordpress-admin
+```
+
+### Manual Agent Management
+
+```bash
+# View agent details
+cat .claude/agents/content-writer.md
+
+# List all agents
+ls -la .claude/agents/
+
+# Check modification dates
+ls -lt .claude/agents/
+
+# Create manual backup
+cp .claude/agents/content-writer.md backups/content-writer-$(date +%Y%m%d).md
+```
+
+### Agent Validation
+
+Before using modified agents:
+
+1. **Check YAML syntax**:
+   ```bash
+   head -10 .claude/agents/content-writer.md
+   ```
+
+2. **Validate required fields**:
+   - `name`: Agent identifier
+   - `description`: Brief description
+   - `tools`: Available tools list
+
+3. **Test functionality**:
+   ```bash
+   /myai-configure agents --validate content-writer
+   ```
+
+## 🔍 Troubleshooting
+
+### Common Issues
+
+#### Commands Not Appearing
+
+**Problem**: Custom commands don't show in `/` menu.
+
+**Solutions**:
+```bash
+# Check file location
+ls .claude/commands/
+
+# Verify YAML syntax
+head -5 .claude/commands/myai-content-writer.md
+
+# Check file permissions
+chmod 644 .claude/commands/*.md
+
+# Restart Claude Code
+```
+
+#### WordPress Connection Issues
+
+**Problem**: Cannot connect to WordPress.
+
+**Solutions**:
+```bash
+# Test WordPress API manually
+curl -u "username:app-password" "https://your-site.com/wp-json/wp/v2/users/me"
+
+# Check environment variables
+cat .env
+
+# Verify WordPress settings
+/myai-configure wordpress
+```
+
+#### SSH Authentication Problems
+
+**Problem**: SSH operations fail.
+
+**Solutions**:
+```bash
+# Test SSH manually
+ssh user@your-server
+
+# Check SSH configuration
+cat ~/.ssh/config
+
+# Verify key permissions
+chmod 600 ~/.ssh/id_rsa
+```
+
+#### Agent Not Working
+
+**Problem**: Agent behavior doesn't match expectations.
+
+**Solutions**:
+```bash
+# Check agent file
+cat .claude/agents/content-writer.md
+
+# Validate YAML frontmatter
+/myai-configure agents --validate content-writer
+
+# Restart Claude Code
+```
+
+### Debug Mode
+
+Enable detailed logging:
+
+```bash
+# Add to .env file
+DEBUG=true
+VERBOSE_LOGGING=true
+```
+
+### Log Files
+
+Check logs for errors:
+
+```bash
+# View recent errors
+tail -f ~/.claude/logs/errors.log
+
+# Check command execution
+tail -f ~/.claude/logs/commands.log
+```
+
+## 🚀 Advanced Usage
+
+### Creating Custom Agent Workflows
+
+**Multi-step content creation:**
+
+```bash
+# 1. Research and outline
+/myai-content-writer "Topic Research" --research_only true
+
+# 2. Create content
+/myai-content-writer "Full Article" --outline_from research.md
+
+# 3. WordPress optimization
+/myai-wordpress-admin seo-analyze --content article.md
+
+# 4. Publish
+/myai-wordpress-publish article.md --status publish
+```
+
+### Batch Operations
+
+**Process multiple files:**
+
+```bash
+# Create multiple articles
+for topic in "Topic 1" "Topic 2" "Topic 3"; do
+  /myai-content-writer "$topic" --auto_save true
+done
+
+# Batch WordPress health checks
+/myai-wordpress-admin health-check --comprehensive --schedule daily
+```
+
+### Integration with CI/CD
+
+**Automated content workflows:**
+
+```bash
+# In your CI/CD pipeline
+npx myaidev-method init --claude
+/myai-content-writer "Weekly Newsletter" --template newsletter.md
+/myai-wordpress-publish newsletter.md --schedule "next monday"
+```
+
+### Custom Environment Configurations
+
+**Development vs Production:**
+
+```bash
+# .env.development
+WORDPRESS_URL=https://staging.yoursite.com
+DEBUG=true
+
+# .env.production  
+WORDPRESS_URL=https://yoursite.com
+DEBUG=false
+```
+
+## ✨ Best Practices
+
+### Agent Customization
+
+1. **Always backup before editing**:
+   ```bash
+   /myai-configure agents --backup content-writer
+   ```
+
+2. **Test in development first**:
+   ```bash
+   # Test with sample content
+   /myai-content-writer "Test Article" --draft_mode true
+   ```
+
+3. **Version control your customizations**:
+   ```bash
+   git add .claude/
+   git commit -m "Customize content writer for technical docs"
+   ```
+
+4. **Document your changes**:
+   ```bash
+   # Add comments to your agent files
+   echo "# Custom modifications for technical content" >> .claude/agents/content-writer.md
+   ```
+
+### Security
+
+1. **Secure your .env file**:
+   ```bash
+   chmod 600 .env
+   echo ".env" >> .gitignore
+   ```
+
+2. **Use strong WordPress Application Passwords**
+
+3. **Limit SSH access**:
+   ```bash
+   # Use specific SSH keys
+   SSH_KEY_PATH=/path/to/dedicated/key
+   ```
+
+4. **Regular security audits**:
+   ```bash
+   /myai-wordpress-admin security-scan --comprehensive
+   ```
+
+### Performance
+
+1. **Monitor resource usage**:
+   ```bash
+   /myai-wordpress-admin resource-monitor
+   ```
+
+2. **Regular maintenance**:
+   ```bash
+   /myai-wordpress-admin database-optimize --weekly
+   ```
+
+3. **Cache optimization**:
+   ```bash
+   /myai-wordpress-admin cache-setup --type redis
+   ```
+
+### Content Quality
+
+1. **Consistent style guides**:
+   - Define brand voice in agent prompts
+   - Include specific formatting requirements
+   - Add industry-specific terminology
+
+2. **Quality checks**:
+   ```bash
+   # Validate content before publishing
+   /myai-configure agents --validate content-writer
+   ```
+
+3. **A/B testing**:
+   - Create multiple agent variants
+   - Test different approaches
+   - Measure engagement metrics
+
+### Collaboration
+
+1. **Team configurations**:
+   ```bash
+   # Share agent configurations
+   git add .claude/agents/
+   git commit -m "Team content writer configuration"
+   ```
+
+2. **Documentation**:
+   ```bash
+   # Document custom workflows
+   echo "## Team Workflow" >> .claude/CLAUDE.md
+   ```
+
+3. **Code reviews for agent changes**:
+   - Review prompt modifications
+   - Test agent behavior
+   - Validate output quality
+
+## 📚 Additional Resources
+
+### Learning More
+
+- **Claude Code Documentation**: Official Claude Code docs
+- **WordPress REST API**: https://developer.wordpress.org/rest-api/
+- **Markdown Guide**: https://www.markdownguide.org/
+- **YAML Syntax**: https://yaml.org/spec/
+
+### Community
+
+- **GitHub Issues**: Report bugs and request features
+- **Discussions**: Share configurations and tips
+- **Examples**: Browse community agent configurations
+
+### Support
+
+If you encounter issues:
+
+1. **Check this guide** for troubleshooting steps
+2. **Review error logs** for specific issues
+3. **Test components individually** (WordPress, SSH, agents)
+4. **Create GitHub issues** for bugs or feature requests
+
+---
+
+**Happy customizing!** 🚀
+
+Remember: The power of MyAIDev Method lies in its customizability. Don't hesitate to experiment with different agent configurations to find what works best for your workflow.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "myaidev-method",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "AI CLI tools package with custom subagents and MCP integrations for Claude Code, Gemini CLI, and more",
   "main": "src/index.js",
   "bin": {
@@ -50,6 +50,7 @@
     "bin/",
     "src/",
     "README.md",
+    "USER_GUIDE.md",
     "LICENSE",
     ".env.example"
   ],