myaidev-method 0.0.1

package/README.md

@@ -0,0 +1,744 @@
+# MyAIDev Method
+
+> **🚀 The easiest way to supercharge your AI CLI with professional agents and WordPress integration**
+
+A comprehensive package for AI CLI tools (Claude Code, Gemini CLI, Codex CLI) that provides custom subagents and MCP integrations for enhanced development workflows. **Zero setup required** - just run one command and start creating professional content!
+
+**✨ What makes this special:**
+- **Instant setup**: One `npx` command and you're ready
+- **Professional agents**: Content writer and WordPress admin out-of-the-box
+- **Claude Code native**: Follows official standards for maximum compatibility
+- **No dependencies**: Works standalone, WordPress integration is optional
+
+## 📋 Table of Contents
+
+- [Features](#features)
+- [Installation](#installation)
+- [Quick Start](#quick-start)
+- [Available Agents](#available-agents)
+- [Slash Commands](#slash-commands)
+- [Configuration](#configuration)
+- [WordPress Integration](#wordpress-integration)
+- [SSH Integration](#ssh-integration)
+- [Customizing Agents](#customizing-agents)
+- [Project Structure](#project-structure)
+- [Environment Variables](#environment-variables)
+- [Examples](#examples)
+- [Troubleshooting](#troubleshooting)
+- [Contributing](#contributing)
+- [License](#license)
+
+## ✨ Features
+
+- 🤖 **Custom Subagents**: Pre-configured AI agents in Markdown format with YAML frontmatter
+- 📝 **Content Writer Agent**: Professional content creation with SEO optimization
+- 🔐 **WordPress Admin Agent**: Site administration, security analysis, and performance optimization
+- 🔌 **WordPress MCP Integration**: Direct publishing and administration via REST API
+- 💻 **SSH Integration**: Server-level operations for advanced WordPress administration
+- 🎯 **Slash Commands**: Easy-to-use Markdown-based commands for Claude Code
+- 🚀 **Multi-CLI Support**: Works with Claude Code, Gemini CLI, and Codex CLI
+- ✅ **Standards Compliant**: Follows Claude Code's official `.claude/` folder structure
+
+## 🚀 Installation
+
+[![npm version](https://badge.fury.io/js/myaidev-method.svg)](https://www.npmjs.com/package/myaidev-method)
+[![npm downloads](https://img.shields.io/npm/dt/myaidev-method.svg)](https://www.npmjs.com/package/myaidev-method)
+
+### ⚡ One-Command Installation
+
+**No setup required!** Install and configure in your project directory with a single command:
+
+```bash
+# For Claude Code (most popular)
+npx myaidev-method init --claude
+
+# For Gemini CLI
+npx myaidev-method init --gemini
+
+# For Codex CLI
+npx myaidev-method init --codex
+
+# Interactive setup (prompts for CLI choice)
+npx myaidev-method init
+```
+
+**That's it!** No authentication, no complex setup, no additional configuration needed.
+
+### Requirements
+
+- Node.js >= 18.0.0
+- Claude Code >= 1.0.0 (for Claude features)
+- WordPress site with REST API enabled (optional, for WordPress features)
+- SSH access to server (optional, for advanced WordPress admin features)
+
+> **Note**: WordPress and SSH are completely optional. You can use the content writer agent without any external dependencies!
+
+## 🏃‍♂️ Quick Start
+
+1. **Install and configure** (one command):
+   ```bash
+   npx myaidev-method init --claude
+   ```
+
+2. **Start using immediately**:
+   ```bash
+   # Create professional content
+   /myai-content-writer "10 Tips for Remote Work"
+   
+   # Configure settings (optional)
+   /myai-configure agents
+   ```
+
+3. **Add WordPress integration** (optional):
+   ```bash
+   cp .env.example .env
+   # Edit .env with your WordPress credentials
+   /myai-wordpress-admin health-check
+   ```
+
+## 🤖 Available Agents
+
+### Content Writer Agent
+**File:** `.claude/agents/content-writer.md`
+
+Professional content writer specializing in creating high-quality, engaging, and SEO-optimized content.
+
+**Capabilities:**
+- SEO-optimized article creation
+- Research and fact-checking
+- Markdown formatting with frontmatter
+- WordPress-ready content structure
+- Multiple tone and audience support
+- Keyword optimization
+
+### WordPress Admin Agent
+**File:** `.claude/agents/wordpress-admin.md`
+
+WordPress administrator for comprehensive site management, security, performance, and health analysis.
+
+**Capabilities:**
+- **Security:** Vulnerability scanning, malware detection, user auditing
+- **Performance:** Speed optimization, database cleanup, caching setup
+- **Health:** Site monitoring, error analysis, backup verification
+- **Administration:** User/plugin/theme management, content cleanup
+
+## 🎯 Slash Commands
+
+### `/myai-content-writer`
+Create professional, SEO-optimized content.
+
+```bash
+# Basic usage
+/myai-content-writer "Best Practices for Remote Work"
+
+# With parameters
+/myai-content-writer "AI in Healthcare" --word_count 1500 --tone technical --audience "healthcare professionals"
+
+# With WordPress publishing
+/myai-content-writer "Summer Garden Tips" --publish_to_wordpress true
+```
+
+**Parameters:**
+- `topic` (required): Content topic or title
+- `word_count`: Target word count (default: 800)
+- `tone`: professional, casual, technical, conversational, academic
+- `audience`: Target reader demographic
+- `seo_keywords`: Array of keywords for optimization
+- `publish_to_wordpress`: Auto-publish as draft (true/false)
+
+### `/myai-wordpress-admin`
+Comprehensive WordPress site administration.
+
+```bash
+# Security operations
+/myai-wordpress-admin security-scan
+/myai-wordpress-admin malware-check
+/myai-wordpress-admin user-audit --role administrator
+/myai-wordpress-admin ssl-check
+/myai-wordpress-admin file-permissions
+
+# Performance operations
+/myai-wordpress-admin speed-test --detailed
+/myai-wordpress-admin database-optimize --cleanup-revisions
+/myai-wordpress-admin cache-setup --type redis
+/myai-wordpress-admin image-optimize
+/myai-wordpress-admin resource-monitor
+
+# Health operations
+/myai-wordpress-admin health-check --comprehensive
+/myai-wordpress-admin error-analysis --last-24h
+/myai-wordpress-admin uptime-check --setup-monitoring
+/myai-wordpress-admin backup-verify
+/myai-wordpress-admin update-check
+
+# Administrative operations
+/myai-wordpress-admin user-manage --list-admins
+/myai-wordpress-admin plugin-manage --update-all --check-security
+/myai-wordpress-admin content-cleanup --remove-spam --optimize-db
+/myai-wordpress-admin settings-optimize --performance-focus
+/myai-wordpress-admin staging-deploy
+```
+
+### `/myai-wordpress-publish`
+Publish existing markdown content to WordPress.
+
+```bash
+# Publish as draft (default)
+/myai-wordpress-publish "content/article.md"
+
+# Publish immediately
+/myai-wordpress-publish "blog-post.md" --status publish
+
+# Publish with specific status
+/myai-wordpress-publish "draft-post.md" --status pending
+```
+
+### `/myai-configure`
+Configure MyAI Method settings.
+
+```bash
+# WordPress setup
+/myai-configure wordpress
+
+# Default content settings
+/myai-configure defaults
+
+# Agent management
+/myai-configure agents
+```
+
+## ⚙️ Configuration
+
+After installation for Claude Code, the package creates a `.claude` directory following official standards:
+
+```
+.claude/
+├── commands/           # Custom slash commands
+├── agents/            # Agent definitions  
+├── mcp/              # MCP server configurations
+└── CLAUDE.md         # Project configuration file
+```
+
+## 🔌 WordPress Integration
+
+### Setup WordPress Connection
+
+1. **Create Application Password** in WordPress:
+   - Go to WordPress Admin → Users → Your Profile
+   - Find "Application Passwords" section
+   - Enter a name for the application and click "Add New"
+   - Copy the generated password
+
+2. **Configure environment variables**:
+   ```bash
+   WORDPRESS_URL=https://your-wordpress-site.com
+   WORDPRESS_USERNAME=your-username
+   WORDPRESS_APP_PASSWORD=generated-password
+   ```
+
+3. **Test the connection**:
+   ```bash
+   /myai-wordpress-admin health-check
+   ```
+
+### WordPress MCP Features
+
+- **Content Publishing**: Direct post creation and updates
+- **Media Management**: Upload and organize media files
+- **User Administration**: Manage users and roles
+- **Plugin/Theme Management**: Install, update, activate/deactivate
+- **Database Operations**: Optimization and cleanup
+- **Security Scanning**: Vulnerability and malware detection
+
+## 💻 SSH Integration
+
+SSH integration enables advanced server-level WordPress administration. Claude Code can seamlessly use your existing SSH configuration.
+
+### SSH Setup Options
+
+#### Option 1: Use Existing SSH Keys (Recommended)
+If you already have SSH keys configured:
+
+```bash
+# Claude Code will automatically use your SSH configuration
+ssh user@your-server  # If this works, you're ready!
+
+# Use in commands
+/myai-wordpress-admin security-scan  # Will use SSH when available
+```
+
+#### Option 2: Specify SSH Details
+For specific configurations, set environment variables:
+
+```bash
+SSH_HOST=your-server-ip
+SSH_USERNAME=your-ssh-username
+SSH_KEY_PATH=/home/user/.ssh/id_rsa  # Optional: specific key path
+WORDPRESS_PATH=/var/www/html         # Optional: WordPress installation path
+```
+
+#### 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 use: `SSH_HOST=wordpress-server`
+
+### SSH-Enabled Operations
+
+When SSH access is available, the WordPress admin agent can perform:
+
+- **File System Analysis**: Permission audits, malware scanning
+- **Server Monitoring**: Resource usage, log analysis
+- **Database Direct Access**: Advanced optimization operations  
+- **Backup Operations**: Full site and database backups
+- **Security Hardening**: File permission fixes, configuration updates
+- **Performance Tuning**: Web server configuration, caching setup
+
+### Security Considerations
+
+- Use SSH keys instead of passwords when possible
+- Limit SSH access to trusted IP addresses
+- Regular audit of SSH access logs
+- Use dedicated SSH users with minimal required permissions
+- Keep SSH keys secure and rotated regularly
+
+## 🎨 Customizing Agents
+
+You can customize agent behavior by editing their Markdown files after installation.
+
+### Editing Agent Prompts
+
+1. **Locate the agent file**:
+   ```bash
+   # Content writer agent
+   .claude/agents/content-writer.md
+   
+   # WordPress admin agent  
+   .claude/agents/wordpress-admin.md
+   ```
+
+2. **Edit the agent configuration**:
+   ```markdown
+   ---
+   name: content-writer
+   description: Your custom description
+   tools: Read, Write, Edit, WebSearch, WebFetch, Task
+   ---
+   
+   Your custom agent prompt goes here...
+   
+   ## Custom Instructions
+   - Add your specific requirements
+   - Modify the writing style
+   - Add industry-specific knowledge
+   ```
+
+3. **Restart Claude Code** to load the changes
+
+### Customization Examples
+
+#### Modify Content Writer for Technical Documentation
+```markdown
+---
+name: content-writer
+description: Technical documentation writer specializing in 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
+```
+
+#### Customize WordPress Admin for Specific Hosting
+```markdown
+---
+name: wordpress-admin
+description: WordPress administrator specialized for managed hosting environments
+tools: Read, Write, Edit, Bash, WebSearch, WebFetch, Task
+---
+
+You are a WordPress administrator with expertise in managed hosting environments.
+
+## Hosting-Specific Considerations
+- Work within managed hosting limitations
+- Use hosting-specific performance tools
+- Account for caching layer configurations
+- Follow hosting provider security guidelines
+
+## Custom Security Protocols
+- Always check with hosting provider before server changes
+- Use hosting control panel APIs when available
+- Implement hosting-recommended security measures
+```
+
+### Agent Prompt Structure
+
+Each agent file should follow this structure:
+
+```markdown
+---
+# YAML frontmatter with agent configuration
+name: agent-name
+description: Brief description of agent capabilities
+tools: List, of, available, tools
+---
+
+# Agent prompt content in Markdown
+
+## Role Definition
+Clear description of the agent's role and expertise.
+
+## Core Capabilities
+List of main capabilities and areas of expertise.
+
+## Process Workflow
+Step-by-step process the agent should follow.
+
+## Output Format
+Specification of expected output format.
+
+## Guidelines and Constraints
+Important guidelines, safety measures, and constraints.
+```
+
+### Best Practices for Agent Customization
+
+1. **Preserve YAML frontmatter**: Always keep the header configuration intact
+2. **Test thoroughly**: Test customizations in a development environment first  
+3. **Version control**: Keep track of your customizations using git
+4. **Document changes**: Add comments explaining your customizations
+5. **Backup originals**: Keep copies of original agent files before modification
+6. **Validate tools**: Ensure all tools listed in frontmatter are actually needed
+
+### Sharing Custom Agents
+
+You can share your custom agents by:
+
+1. **Creating a fork** of the repository with your customizations
+2. **Exporting agent files** and sharing them with your team
+3. **Contributing back** useful customizations to the main project
+
+## 📁 Project Structure
+
+```
+.claude/
+├── commands/                    # Slash commands (Markdown files)
+│   ├── myai-content-writer.md       # Content creation command
+│   ├── myai-wordpress-admin.md      # WordPress admin command  
+│   ├── myai-wordpress-publish.md    # WordPress publishing command
+│   └── myai-configure.md           # Configuration command
+├── agents/                     # Agent definitions (Markdown with YAML)
+│   ├── content-writer.md           # Content writer agent
+│   └── wordpress-admin.md          # WordPress admin agent
+├── mcp/                        # MCP integrations
+│   └── wordpress-server.js         # WordPress MCP server
+└── CLAUDE.md                   # Project configuration
+
+# Additional files created
+.env.example                    # Environment variables template
+.env                           # Your environment configuration (not in git)
+```
+
+This structure follows Claude Code's official standards for maximum compatibility.
+
+## 🔧 Environment Variables
+
+### Required for WordPress Features
+
+```bash
+# WordPress Connection (Required)
+WORDPRESS_URL=https://your-wordpress-site.com
+WORDPRESS_USERNAME=your-admin-username  
+WORDPRESS_APP_PASSWORD=your-application-password
+```
+
+### Optional SSH Configuration
+
+```bash
+# SSH Access (Optional - use existing SSH config if not specified)
+SSH_HOST=your-server-ip-or-hostname
+SSH_USERNAME=your-ssh-username
+SSH_KEY_PATH=/path/to/private/key
+SSH_PORT=22
+
+# WordPress Server Configuration (Optional)
+WORDPRESS_PATH=/var/www/html
+```
+
+### Optional Content Defaults
+
+```bash
+# Content Writer Defaults (Optional)
+DEFAULT_WORD_COUNT=800
+DEFAULT_POST_STATUS=draft
+DEFAULT_TONE=professional
+DEFAULT_AUDIENCE=general
+```
+
+### Environment File Setup
+
+1. **Copy the example file**:
+   ```bash
+   cp .env.example .env
+   ```
+
+2. **Edit with your values**:
+   ```bash
+   nano .env  # or your preferred editor
+   ```
+
+3. **Secure the file**:
+   ```bash
+   chmod 600 .env  # Restrict access to owner only
+   ```
+
+## 💡 Examples
+
+### Content Creation Workflow
+
+```bash
+# Create SEO-optimized blog post
+/myai-content-writer "10 Essential WordPress Security Tips" --word_count 1200 --seo_keywords "wordpress security,website protection,wp security tips"
+
+# Create technical documentation  
+/myai-content-writer "API Integration Guide" --tone technical --audience developers --word_count 1500
+
+# Create and publish to WordPress
+/myai-content-writer "Summer Marketing Strategies" --publish_to_wordpress true --tone professional
+```
+
+### WordPress Administration Workflow
+
+```bash
+# Daily health check routine
+/myai-wordpress-admin health-check --comprehensive
+
+# Security audit workflow
+/myai-wordpress-admin security-scan
+/myai-wordpress-admin user-audit
+/myai-wordpress-admin malware-check
+/myai-wordpress-admin ssl-check
+
+# Performance optimization workflow  
+/myai-wordpress-admin speed-test --detailed
+/myai-wordpress-admin database-optimize
+/myai-wordpress-admin cache-setup
+/myai-wordpress-admin image-optimize
+
+# Maintenance workflow
+/myai-wordpress-admin update-check
+/myai-wordpress-admin plugin-manage --update-all --check-security
+/myai-wordpress-admin content-cleanup --remove-spam
+/myai-wordpress-admin backup-verify
+```
+
+### Content Publishing Workflow
+
+```bash
+# Create content locally
+/myai-content-writer "Guide to Remote Team Management" --word_count 1000
+
+# Review and edit the generated content
+# (Content is saved as markdown file)
+
+# Publish to WordPress
+/myai-wordpress-publish "guide-to-remote-team-management.md" --status draft
+
+# Or publish immediately
+/myai-wordpress-publish "guide-to-remote-team-management.md" --status publish
+```
+
+## 🔍 Troubleshooting
+
+### Common Issues and Solutions
+
+#### Commands Not Appearing in Claude Code
+
+**Problem**: Custom slash commands don't appear in the `/` menu.
+
+**Solutions**:
+1. Ensure files are in `.claude/commands/` (not `.myaidev/`)
+2. Verify YAML frontmatter is valid
+3. Restart Claude Code
+4. Check file permissions (`chmod 644 .claude/commands/*.md`)
+
+#### WordPress Connection Issues
+
+**Problem**: Cannot connect to WordPress site.
+
+**Solutions**:
+1. **Verify credentials**:
+   ```bash
+   # Test WordPress REST API manually
+   curl -u "username:app-password" "https://your-site.com/wp-json/wp/v2/users/me"
+   ```
+
+2. **Check WordPress settings**:
+   - Ensure REST API is enabled
+   - Verify Application Password is created correctly
+   - Check if site has HTTPS enabled
+
+3. **Firewall/Security**:
+   - Whitelist your IP address
+   - Temporarily disable security plugins for testing
+   - Check hosting provider restrictions
+
+#### SSH Connection Problems
+
+**Problem**: SSH operations fail or timeout.
+
+**Solutions**:
+1. **Test SSH manually**:
+   ```bash
+   ssh user@your-server
+   ```
+
+2. **Check SSH configuration**:
+   ```bash
+   # Verify SSH config
+   cat ~/.ssh/config
+   
+   # Check key permissions
+   chmod 600 ~/.ssh/id_rsa
+   chmod 644 ~/.ssh/id_rsa.pub
+   ```
+
+3. **Server-side checks**:
+   - Verify SSH daemon is running
+   - Check firewall rules (port 22)
+   - Confirm user has necessary permissions
+
+#### Agent Not Working as Expected
+
+**Problem**: Agent behavior doesn't match expectations.
+
+**Solutions**:
+1. **Check agent file**:
+   ```bash
+   # Verify agent file exists and has correct format
+   cat .claude/agents/content-writer.md
+   ```
+
+2. **Validate YAML frontmatter**:
+   - Ensure proper YAML syntax
+   - Verify all required fields are present
+   - Check tool permissions
+
+3. **Clear Claude Code cache**:
+   - Restart Claude Code
+   - Clear browser cache if using web interface
+
+#### Performance Issues
+
+**Problem**: Operations are slow or timeout.
+
+**Solutions**:
+1. **Optimize WordPress database**:
+   ```bash
+   /myai-wordpress-admin database-optimize
+   ```
+
+2. **Check server resources**:
+   ```bash
+   /myai-wordpress-admin resource-monitor
+   ```
+
+3. **Review error logs**:
+   ```bash
+   /myai-wordpress-admin error-analysis
+   ```
+
+### Debug Mode
+
+Enable debug mode for detailed error information:
+
+```bash
+# Add to your .env file
+DEBUG=true
+VERBOSE_LOGGING=true
+```
+
+### Getting Help
+
+1. **Check the logs**: Look for error messages in Claude Code output
+2. **Test components individually**: Verify WordPress, SSH, and MCP connections separately
+3. **Consult documentation**: Review Claude Code official documentation
+4. **Community support**: Join Claude Code community forums
+5. **GitHub issues**: Report bugs and request features on the repository
+
+## 🤝 Contributing
+
+We welcome contributions to improve MyAIDev Method!
+
+### How to Contribute
+
+1. **Fork the repository**
+2. **Create a feature branch**: `git checkout -b feature/new-agent`
+3. **Make your changes** 
+4. **Test thoroughly**
+5. **Submit a pull request**
+
+### Contribution Ideas
+
+- **New agents**: Create agents for different domains (code review, documentation, etc.)
+- **Additional CLI support**: Add support for more AI CLI tools
+- **Enhanced integrations**: Add support for other CMSs or platforms  
+- **Documentation improvements**: Help improve guides and examples
+- **Bug fixes**: Fix issues and improve reliability
+
+### Development Setup
+
+```bash
+# Clone the repository
+git clone https://github.com/myaione/myaidev-method.git
+cd myaidev-method
+
+# Install dependencies
+npm install
+
+# Test locally without publishing
+npm pack
+cd /path/to/test-project
+npm install /path/to/myaidev-method-0.0.1.tgz
+npx myaidev-method init --claude
+
+# Or link for development
+npm link
+cd /path/to/test-project
+npm link myaidev-method
+npx myaidev-method init --claude
+```
+
+## 📄 License
+
+MIT License - see [LICENSE](LICENSE) file for details.
+
+## 🙏 Acknowledgments
+
+- **Anthropic** for Claude Code and the standards we follow
+- **WordPress** for the robust REST API
+- **Community contributors** who help improve this package
+
+---
+
+**Author**: Samuel Mukoti <samuelm@openmy.ai>
+
+For questions, issues, or feature requests, please visit the [GitHub repository](https://github.com/myaione/myaidev-method).