Package Exports
- myaidev-method
- myaidev-method/src/index.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (myaidev-method) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
MyAIDev Method
๐ A comprehensive development framework for AI-assisted software development with systematic workflows and multi-platform publishing!
The MyAIDev Method is a complete development framework for AI CLI tools (Claude Code, Gemini CLI, Codex CLI) featuring the SPARC methodology for systematic software development, inspired by GitHub Spec-Kit patterns for agentic software development.
๐ What makes this special:
Comprehensive Development Framework:
- SPARC Methodology: 5-phase systematic development workflow (Specification โ Pseudocode โ Architecture โ Refinement โ Completion)
- Development Agents: Architect, Coder, Tester, Reviewer, Documenter - complete coverage from design to deployment
- Quality-First: Built-in security (OWASP Top 10), testing (80%+ coverage), and code review standards
- Spec-Kit Inspired: Proven patterns for agentic software development based on GitHub's Spec-Kit framework
Multi-Platform Publishing & Deployment:
- CMS Publishing: WordPress, PayloadCMS with full content management
- Static Site Generators: Docusaurus, Mintlify, Astro with git-based workflows
- Deployment: Coolify self-hosted PaaS orchestration
- Infrastructure: RamNode.com optimized deployment patterns
Professional Tooling:
- Instant setup: One
npxcommand and you're ready - Claude Code native: Follows official standards for maximum compatibility
- Zero dependencies: Core features work standalone, optional MCP integrations available
- Production-ready: SOLID principles, Clean Code, comprehensive testing built-in
๐ Table of Contents
- Features
- Installation
- Quick Start
- Updating
- Developer Use Cases
- SPARC Development Workflow
- Development Agents
- Content & Publishing Agents
- Visual Content Generation
- Slash Commands
- MCP Server Integration
- Configuration
- WordPress Integration
- SSH Integration
- Customizing Agents
- Project Structure
- Environment Variables
- Examples
- Troubleshooting
- Contributing
- License
โจ Features
๐๏ธ Development Framework (SPARC Methodology)
- Systematic Workflow: 5-phase SPARC methodology (Specification โ Pseudocode โ Architecture โ Refinement โ Completion)
- Development Agents: Complete suite of specialized agents for the full development lifecycle
- ๐๏ธ Architect: System design, API specifications, data modeling, technology selection
- ๐ป Coder: Feature implementation, refactoring, SOLID principles, Clean Code
- ๐งช Tester: Unit/integration testing, 80%+ coverage, quality gates
- ๐๏ธ Reviewer: Code quality, security (OWASP Top 10), performance analysis
- ๐ Documenter: API docs, user guides, architecture documentation
- Spec-Kit Patterns: Proven agentic development patterns inspired by GitHub Spec-Kit
- Quality Standards: Built-in security, testing, code review, and documentation standards
- File-Based Workflow: Sequential agent coordination with
.myaidev-method/sparc/outputs
๐ Content & Publishing
- Content Writer Agent: Professional SEO-optimized content creation with optional AI-generated visuals
- Multi-Platform Publishing: WordPress, PayloadCMS, Docusaurus, Mintlify, Astro
- Git-Based Workflows: Automated publishing for static site generators
- WordPress Admin Agent: Security, performance, health monitoring, and administration
๐จ Visual Content Generation (New in v0.2.14!)
- AI-Powered Image Generation: Google Gemini 2.5 Flash, Imagen 3, OpenAI DALL-E 3
- AI-Powered Video Generation: Google Veo 2 (up to 8 seconds, 720p)
- Multi-Platform Support: Works with Claude Code, Gemini CLI, and Codex CLI
- Budget Management: Daily/monthly limits, cost tracking, and warnings
- Smart Service Selection: Automatic service selection based on content type
- Content Integration: Generate images during content creation with
--with-imagesflag - Cost-Effective: Starting at $0.02/image (Gemini Flash)
- Organized Storage: Automatic file organization by date in
content-assets/
๐ Deployment & Infrastructure
- Coolify Integration: Self-hosted PaaS deployment and orchestration
- RamNode Optimized: Deployment patterns optimized for RamNode.com infrastructure
- SSH Integration: Server-level operations for advanced administration
- MCP Server Integration: Optional advanced features with SPARC Orchestrator, Chrome DevTools, and WordPress MCP servers
๐ ๏ธ Development Tools
- Slash Commands: Easy-to-use Markdown-based commands for Claude Code
- Custom Subagents: Pre-configured AI agents following Claude Code 2.0 standards
- Standards Compliant: Full compatibility with Claude Code, Gemini CLI, Codex CLI
- Zero Dependencies: Core features work standalone, optional MCP integrations
๐ Installation
โก One-Command Installation
No setup required! Install and configure in your project directory with a single command:
# For Claude Code (most popular)
npx myaidev-method@latest init --claude
# For Gemini CLI
npx myaidev-method@latest init --gemini
# For Codex CLI
npx myaidev-method@latest init --codex
# Interactive setup (prompts for CLI choice)
npx myaidev-method@latest initThat's it! No complex setup.
Requirements
- Node.js >= 20.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
Install and configure (one command):
npx myaidev-method@latest init --claudeStart using immediately:
# Create professional content /myai-content-writer "10 Tips for Remote Work" # Configure settings (optional) /myai-configure agents
Add WordPress integration (optional):
cp .env.example .env # Edit .env with your WordPress credentials /myai-wordpress-admin health-check
๐ Updating
Keep your MyAIDev Method installation up to date with the latest features and bug fixes:
# Interactive update (recommended) - prompts for conflicts
npx myaidev-method@latest update --claude
# Force update - overwrites all files
npx myaidev-method@latest update --claude --force
# Preview changes without updating
npx myaidev-method@latest update --claude --dry-runThe update command:
- โ Detects your current version
- โ Updates commands, agents, scripts, and documentation
- โ Preserves your customizations (interactive conflict resolution)
- โ Creates automatic backups before updating
- โ Installs updated dependencies
See USER_GUIDE.md - Updating Section for detailed update instructions and best practices.
๐ก Developer Use Cases
New! See real-world scenarios demonstrating how MyAIDev Method supercharges development workflows:
๐ DEVELOPER_USE_CASES.md - Comprehensive guide featuring:
- Full-Stack SaaS Development: Build production-ready apps in days instead of weeks
- Microservices Refactoring: Zero-downtime migrations with systematic strategies
- Technical Content Pipeline: 4x content output with multi-platform publishing
- Database Migrations: Safe migrations with rollback capabilities
- Team Collaboration: Automated code reviews and knowledge bases
- ROI Analysis: Real productivity metrics and time savings
Examples with Time Savings:
- Full-stack feature: 120 hours โ 24 hours (80% faster)
- Technical blog post: 12 hours โ 2-3 hours (75% faster)
- Code review: 45 minutes โ 10 minutes (78% faster)
- Developer onboarding: 2 weeks โ 2 days (90% faster)
Each use case includes:
- Traditional vs MyAIDev approach comparison
- Complete code examples and commands
- Quantified time savings and quality improvements
- Integration patterns and best practices
๐ Content Creation for Marketers
New! Discover how marketers and content creators can leverage MyAIDev Method for efficient, high-quality content production:
๐ CONTENT_CREATION_GUIDE.md - Complete marketing workflow guide featuring:
- 4-Phase Content Pipeline: Ideation โ Generation โ Publishing โ Optimization
- AI Content Generation: Professional blog posts, tutorials, case studies, and technical content
- Multi-Platform Publishing: WordPress, PayloadCMS, LinkedIn, email newsletters in one workflow
- Hub-and-Spoke Distribution: Single content piece adapted for multiple channels
- SEO Optimization: Keyword research, LSI integration, meta descriptions
- Where AI Excels vs Human Input: Clear guidance on AI capabilities and limitations
- 8 Common Pitfalls: Detailed explanations and solutions to avoid content marketing mistakes
Examples with Time Savings:
- Blog post (2,500 words): 12 hours โ 2-3 hours (75% faster)
- Technical tutorial series: 40 hours โ 8 hours (80% faster)
- Multi-platform distribution: 6 hours โ 30 minutes (92% faster)
- SEO research and optimization: 4 hours โ 45 minutes (81% faster)
Content Templates Included:
- Long-form educational blog posts
- Technical tutorials with code examples
- Product announcements and release notes
- Case studies with metrics and results
- LinkedIn thought leadership articles
- Email newsletters
๐๏ธ SPARC Development Workflow
The MyAIDev Method implements the SPARC methodology - a systematic 5-phase approach to software development inspired by GitHub Spec-Kit patterns for agentic software development.
What is SPARC?
SPARC stands for:
- Specification - Define requirements and system boundaries
- Pseudocode - Plan implementation approach
- Architecture - Design system structure, APIs, and data models
- Refinement - Implement, test, and review code quality
- Completion - Document and deliver production-ready software
The 5 Phases
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
โ SPARC Workflow: Systematic Software Development โ
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
Phase 1: ๐๏ธ ARCHITECTURE
โโ Agent: dev-architect
โโ Output: .myaidev-method/sparc/architecture.md
โโ Deliverables:
โ โโ System design with Mermaid diagrams
โ โโ API specifications (REST/GraphQL/gRPC)
โ โโ Data models and schemas
โ โโ Technology stack recommendations
โ โโ Security and scalability planning
โโ Command: /myai-dev-architect "Design authentication system"
Phase 2: ๐ป IMPLEMENTATION
โโ Agent: dev-coder
โโ Output: .myaidev-method/sparc/code-output/
โโ Standards: SOLID, Clean Code, DRY/KISS/YAGNI
โโ Features:
โ โโ Production-ready code implementation
โ โโ Security best practices (OWASP Top 10)
โ โโ Error handling and input validation
โ โโ Inline documentation (JSDoc, etc.)
โโ Command: /myai-dev-code "Implement JWT authentication"
Phase 3: ๐งช TESTING
โโ Agent: dev-tester
โโ Output: .myaidev-method/sparc/test-results/
โโ Coverage: 80%+ critical paths, 60%+ overall
โโ Deliverables:
โ โโ Unit test suites
โ โโ Integration tests
โ โโ Coverage reports
โ โโ Quality gate validation
โโ Command: /myai-dev-test "Test authentication module"
Phase 4: ๐๏ธ REVIEW
โโ Agent: dev-reviewer
โโ Output: .myaidev-method/sparc/review-report.md
โโ Analysis:
โ โโ Code quality and complexity
โ โโ Security audit (OWASP Top 10)
โ โโ Performance optimization
โ โโ Best practices compliance
โ โโ Technical debt assessment
โโ Command: /myai-dev-review "Review authentication implementation"
Phase 5: ๐ DOCUMENTATION
โโ Agent: dev-documenter
โโ Output: .myaidev-method/sparc/documentation/
โโ Deliverables:
โ โโ API reference (OpenAPI/Swagger)
โ โโ User guides and tutorials
โ โโ Architecture documentation
โ โโ Code examples and snippets
โโ Command: /myai-dev-docs "Document authentication API"Complete Workflow Execution
Run the entire SPARC workflow with a single command:
# Slash command (in Claude Code)
/myai-sparc-workflow "Build user authentication system with JWT"
# CLI command
npx myaidev-method sparc "Build user authentication system with JWT"
# With technology preferences
npx myaidev-method sparc "Build e-commerce checkout" --tech-stack "react,node,stripe,postgres"Workflow Output Structure
.myaidev-method/
โโโ sparc/
โ โโโ architecture.md # Phase 1: System design
โ โโโ code-output/ # Phase 2: Implementation
โ โ โโโ src/
โ โ โโโ tests/
โ โ โโโ ...
โ โโโ test-results/ # Phase 3: Testing
โ โ โโโ unit/
โ โ โโโ integration/
โ โ โโโ coverage-report.md
โ โโโ review-report.md # Phase 4: Code review
โ โโโ documentation/ # Phase 5: Documentation
โ โโโ api/
โ โโโ user-guide/
โ โโโ architecture/
โโโ tasks/ # Task tracking
โโโ workflows/ # Workflow execution logsQuality Standards
Every SPARC workflow enforces:
- Code Quality: SOLID principles, Clean Code, maintainability metrics
- Security: OWASP Top 10 compliance, vulnerability scanning
- Testing: 80%+ critical path coverage, integration tests
- Performance: Algorithm complexity analysis, optimization recommendations
- Documentation: Complete API docs, user guides, architecture specs
GitHub Spec-Kit Inspiration
This framework is inspired by GitHub's Spec-Kit patterns for agentic software development:
- Systematic Approach: Structured phases with clear deliverables
- Quality Gates: Validation at each phase transition
- Agent Specialization: Dedicated agents with specific expertise
- File-Based Coordination: Agents communicate through well-defined outputs
- Reproducible Workflows: Consistent results across projects
Individual Phase Commands
You can also run individual phases:
# Slash commands (in Claude Code)
/myai-dev-architect "Design real-time chat app"
/myai-dev-code "Implement WebSocket server"
/myai-dev-test "Test chat functionality" --integration
/myai-dev-review "Review chat implementation" --security
/myai-dev-docs "Document chat API"
# CLI commands
npx myaidev-method dev:architect "Design microservices architecture"
npx myaidev-method dev:code "Implement user service" --test-driven
npx myaidev-method dev:test "Test user service" --coverage
npx myaidev-method dev:review "Security audit for user service"
npx myaidev-method dev:docs "Document user service API"๐ค Development Agents
Complete Development Lifecycle Coverage
The MyAIDev Method provides specialized agents for every phase of the development lifecycle:
๐๏ธ Architecture Agent
File: .claude/agents/dev-architect.md
Phase: Architecture (SPARC Phase 1)
System architect specializing in scalable design, API specifications, and technology selection.
Capabilities:
- High-level system architecture with Mermaid diagrams
- API contract definitions (REST, GraphQL, gRPC)
- Data modeling and schema design
- Technology stack recommendations
- Security architecture planning
- Scalability and performance planning
Output: .myaidev-method/sparc/architecture.md
๐ป Implementation Agent (Coder)
File: .claude/agents/dev-coder.md
Phase: Implementation (SPARC Phase 2)
Production code implementer following SOLID principles and Clean Code practices.
Capabilities:
- Feature implementation from architecture specs
- Code refactoring and optimization
- SOLID principles application
- Security best practices (OWASP Top 10)
- Error handling and input validation
- Inline documentation (JSDoc, Sphinx, etc.)
Output: .myaidev-method/sparc/code-output/
Quality Standards:
- 80%+ test coverage target
- SOLID, DRY, KISS, YAGNI principles
- Security-first implementation
- Comprehensive error handling
๐งช Testing Agent
File: .claude/agents/dev-tester.md
Phase: Testing (SPARC Phase 3)
Comprehensive testing specialist with TDD workflow support.
Capabilities:
- Unit test creation (AAA pattern)
- Integration test development
- Coverage analysis and reporting
- Quality gate validation
- Test-Driven Development (TDD) workflow
- Multiple framework support (Jest, Mocha, Pytest, etc.)
Output: .myaidev-method/sparc/test-results/
Coverage Standards:
- 80%+ for critical paths
- 60%+ overall coverage
- Pre-commit, pre-merge, pre-deployment gates
๐๏ธ Code Review Agent
File: .claude/agents/dev-reviewer.md
Phase: Review (SPARC Phase 4)
Code quality and security analyst with comprehensive review capabilities.
Capabilities:
- Code quality metrics and complexity analysis
- Security audit (OWASP Top 10 compliance)
- Performance review and optimization
- Best practices validation (SOLID, framework standards)
- Technical debt assessment with priority scoring
- Code smell and anti-pattern detection
Output: .myaidev-method/sparc/review-report.md
Review Standards:
- Code quality: Complexity, readability, maintainability
- Security: OWASP Top 10, vulnerability patterns
- Performance: Algorithm complexity, resource management
- Best practices: Framework standards, design patterns
๐ Documentation Agent
File: .claude/agents/dev-documenter.md
Phase: Documentation (SPARC Phase 5)
Technical documentation specialist for APIs, user guides, and architecture docs.
Capabilities:
- API reference generation (OpenAPI/Swagger)
- User guide and tutorial creation
- Architecture documentation
- Code example generation and testing
- Multiple format support (Markdown, HTML, reStructuredText)
- Inline code documentation (JSDoc, Sphinx, etc.)
Output: .myaidev-method/sparc/documentation/
Documentation Standards:
- Clarity: Simple language, clear examples, visual aids
- Completeness: All public APIs documented
- Accuracy: Tested code examples, synchronized with code
- Accessibility: Multiple formats, searchable, well-organized
๐ Content & Publishing 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
PayloadCMS Publishing Agent
File: .claude/agents/payloadcms-publish.md
Publish markdown content to PayloadCMS headless CMS with Lexical rich text conversion.
Capabilities:
- Markdown to Lexical conversion
- JWT authentication
- Draft and published workflows
- Custom collections support
- Document updates
Docusaurus Publishing Agent
File: .claude/agents/docusaurus-publish.md
Git-based publishing for Docusaurus documentation sites.
Capabilities:
- Docs, blog, and pages support
- Automatic frontmatter transformation
- Sidebar configuration
- Git commit and push automation
Mintlify Publishing Agent
File: .claude/agents/mintlify-publish.md
Git-based publishing for Mintlify documentation with automatic navigation.
Capabilities:
- MDX transformation
- mint.json navigation updates
- Icon and metadata support
- Git workflow automation
Astro Publishing Agent
File: .claude/agents/astro-publish.md
Git-based publishing for Astro sites with content collections support.
Capabilities:
- Content collections publishing
- Schema-validated frontmatter
- pubDate transformation
- Draft/published workflow
Deployment Agent
Coolify Deployment Agent
File: .claude/agents/coolify-deploy.md
Self-hosted PaaS deployment for applications.
Capabilities:
- Application deployment
- Health monitoring
- Resource management
- Multi-environment support
๐จ Visual Content Generation
New in v0.2.14! Generate AI-powered images and videos for your content using Google AI (Gemini, Imagen, Veo) and OpenAI (DALL-E) services.
Features
- Image Generation: Google Gemini 2.5 Flash ($0.02), Imagen 3 ($0.03), DALL-E 3 ($0.04-0.12)
- Video Generation: Google Veo 2 ($0.10 for up to 8 seconds, 720p)
- Multi-Platform: Works with Claude Code, Gemini CLI, and Codex CLI
- Budget Management: Daily/monthly limits, cost tracking, and warnings
- Smart Organization: Automatic file storage by date in
content-assets/ - Content Integration: Generate images during content creation with
--with-imagesflag
Setup
Configure Visual APIs (one-time setup):
# Claude Code /myai-configure visual # Gemini CLI / Codex CLI npm run configure:visual
Follow the interactive wizard to set up:
- Google AI API key (for Gemini, Imagen, Veo)
- OpenAI API key (for DALL-E)
- Default service preference
- Daily and monthly budget limits
Usage
Claude Code
# Generate a hero image
/myai-generate-visual "Modern developer workspace with dual monitors"
# Generate with specific service
/myai-generate-visual "AI concept illustration" --service dalle --type illustration
# Generate diagram
/myai-generate-visual "Microservices architecture" --type diagram --service gemini
# Create content with images
/myai-content-writer "Best Practices for Remote Work" --with-imagesGemini CLI / Codex CLI
# Generate a hero image
npm run generate-visual "Modern developer workspace"
# Generate with options
npm run generate-visual "System architecture" -- --type=diagram --service=gemini
# Configure visual APIs
npm run configure:visualService Comparison
| Service | Speed | Cost | Quality | Best For |
|---|---|---|---|---|
| Gemini 2.5 Flash | โกโกโก | $0.02 | Good | Quick hero images, diagrams, high volume |
| Imagen 3 | โกโก | $0.03 | Excellent | Premium hero images, high-quality visuals |
| DALL-E 3 | โกโก | $0.04-0.12 | Excellent | Creative illustrations, detailed designs |
| Veo 2 | โก | $0.10 | Good | Product demos, short videos |
Image Types
hero- Article header images (recommended: 1792x1024)illustration- Abstract concepts and metaphorsdiagram- Technical workflows and architecturescreenshot- UI mockups and interface designsvideo- Product demos and tutorials (Veo 2 only)
Budget Management
The system automatically tracks costs and enforces budget limits:
- Daily Budget: Configurable limit (default: $5.00)
- Monthly Budget: Configurable limit (default: $50.00)
- Warning Threshold: Alert at 80% usage
- Usage Tracking: Stored in
.visual-usage-stats.json
File Organization
Generated files are automatically organized by date:
content-assets/
โโโ images/
โ โโโ 2025-11-19/
โ โโโ hero-workspace-123456.png
โ โโโ diagram-architecture-234567.png
โโโ videos/
โโโ 2025-11-19/
โโโ video-demo-345678.mp4Documentation
For comprehensive documentation, see:
- VISUAL_CONTENT_GENERATION_GUIDE.md - Complete user guide
- VISUAL_GENERATION_FILE_ORGANIZATION.md - File structure details
- CONTENT_CREATION_GUIDE.md - Content workflow integration
๐ฏ Slash Commands
/myai-content-writer
Create professional, SEO-optimized content with optional AI-generated visuals.
# Basic usage
/myai-content-writer "Best Practices for Remote Work"
# With AI-generated images (new!)
/myai-content-writer "Best Practices for Remote Work" --with-images
# With parameters
/myai-content-writer "AI in Healthcare" --word_count 1500 --tone technical --audience "healthcare professionals"
# With images and specific service
/myai-content-writer "Microservices Guide" --with-images --service gemini
# With WordPress publishing
/myai-content-writer "Summer Garden Tips" --publish_to_wordpress trueParameters:
topic(required): Content topic or titleword_count: Target word count (default: 800)tone: professional, casual, technical, conversational, academicaudience: Target reader demographicseo_keywords: Array of keywords for optimizationpublish_to_wordpress: Auto-publish as draft (true/false)--with-images: Generate AI-powered images (new!)--service: Preferred image service (gemini, imagen, dalle)
/myai-generate-visual
Generate AI-powered images and videos for content.
# Generate a hero image (auto-selects best service)
/myai-generate-visual "Modern developer workspace with dual monitors"
# Generate with specific service
/myai-generate-visual "AI concept illustration" --service dalle --type illustration
# Generate diagram
/myai-generate-visual "Microservices architecture" --type diagram --service gemini
# Generate HD image
/myai-generate-visual "Product mockup" --quality hd --size 1792x1024
# Generate video (Veo 2)
/myai-generate-visual "Product demo walkthrough" --type video --service veoParameters:
prompt(required): Description of the image/video to generate--type: Image type (hero, illustration, diagram, screenshot, video)--service: Preferred service (gemini, imagen, dalle, veo)--quality: Quality level (standard, hd)--size: Image dimensions (1024x1024, 1792x1024, 1024x1792)
Prerequisites: Run /myai-configure visual first to set up API keys and budgets.
/myai-wordpress-admin
Comprehensive WordPress site administration.
# 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-deployPublishing Commands
/myai-wordpress-publish
Publish markdown content to WordPress.
/myai-wordpress-publish "article.md" --status draft
/myai-wordpress-publish "article.md" --status published/myai-payloadcms-publish
Publish markdown content to PayloadCMS.
/myai-payloadcms-publish "article.md" --collection posts
/myai-payloadcms-publish "article.md" --status published --id 12345/myai-docusaurus-publish
Publish markdown content to Docusaurus.
/myai-docusaurus-publish "guide.md"
/myai-docusaurus-publish "post.md" --type blog/myai-mintlify-publish
Publish markdown content to Mintlify.
/myai-mintlify-publish "guide.mdx"
/myai-mintlify-publish "api-ref.md" --nav-section "API Reference"/myai-astro-publish
Publish markdown content to Astro.
/myai-astro-publish "article.md" --collection blog
/myai-astro-publish "page.md" --pagesDeployment Commands
/myai-coolify-deploy
Deploy applications to Coolify.
/myai-coolify-deployConfiguration
/myai-configure
Configure MyAI Method settings.
/myai-configureComprehensive Guide
For detailed publishing workflows and platform-specific guides, see PUBLISHING_GUIDE.md
๐ง MCP Server Integration
MyAIDev Method includes three optional MCP (Model Context Protocol) servers for advanced orchestration, testing, and WordPress integration.
Available MCP Servers
1. SPARC Orchestrator - Workflow automation for the 5-phase SPARC methodology
sparc_orchestrate- Orchestrate complete 5-phase workflowssparc_status- Get workflow execution statussparc_phase_execute- Execute single SPARC phasessparc_workflow_history- View workflow historysparc_task_results- Get detailed workflow results
2. Chrome DevTools MCP - Browser automation and testing (chrome-devtools-mcp)
cdp_connect- Connect to Chrome DevTools Protocolcdp_navigate- Browser navigationcdp_screenshot- Visual testing with screenshotscdp_evaluate- Execute JavaScript in browsercdp_network_monitor- Monitor network requestscdp_console_logs- Capture console logs
3. WordPress MCP - Enhanced WordPress operations with session management
- Session management and memory persistence
- Health monitoring and site statistics
- Batch publishing operations
- Enhanced WordPress REST API integration
Setup MCP Servers
Add to Claude Code MCP settings:
# SPARC Orchestrator
claude mcp add myaidev-sparc npx myaidev-sparc-orchestrator
# Chrome DevTools (requires separate installation)
npm install -g chrome-devtools-mcp
claude mcp add chrome-devtools npx chrome-devtools-mcp
# WordPress MCP
claude mcp add myaidev-wordpress npx myaidev-mcp-serverUsage Example
// Orchestrate complete SPARC workflow
mcp__myaidev_sparc__sparc_orchestrate({
task: "Build user authentication system",
strategy: "sequential",
phases: ["architecture", "implementation", "testing", "review", "documentation"],
options: {
techStack: "nextjs,payloadcms,mongodb",
testFramework: "jest",
focusSecurity: true
}
})For detailed MCP setup and usage, see MCP_INTEGRATION.md
โ๏ธ 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
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
Configure environment variables:
WORDPRESS_URL=https://your-wordpress-site.com WORDPRESS_USERNAME=your-username WORDPRESS_APP_PASSWORD=generated-password
Test the connection:
/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:
# 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 availableOption 2: Specify SSH Details
For specific configurations, set environment variables:
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 pathOption 3: SSH Config File
Configure in ~/.ssh/config:
Host wordpress-server
HostName your-server-ip
User your-username
IdentityFile ~/.ssh/your-key
Port 22Then 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.
Content Writer Custom Rules (Recommended)
The content-writer agent supports custom content generation rules via a content-rules.md file. This is the recommended approach for customizing content creation without modifying the agent itself.
Quick Start:
# Copy the example template
cp content-rules.example.md content-rules.md
# Edit with your preferences
nano content-rules.mdWhat you can customize:
- Brand voice and tone
- Writing style preferences
- Formatting guidelines
- SEO requirements
- Required/optional content elements
- Topics to avoid
- Company-specific terminology
Example content-rules.md:
# Content Generation Rules
## Brand Voice
- Use conversational, friendly tone
- Avoid jargon unless explaining technical concepts
## Formatting Preferences
- Keep paragraphs under 3 sentences
- Use numbered lists for sequential steps
## SEO Guidelines
- Target keyword density: 1-2%
- Include FAQ section for articles over 1000 words
## Required Elements
- Author bio at the end
- Call-to-action in conclusionBenefits:
- โ No agent modification required
- โ Preserves agent updates when upgrading
- โ Easy to version control
- โ Project-specific customization
- โ Agent continues working if file doesn't exist
Editing Agent Prompts
For deeper customization, you can edit agent files directly:
Locate the agent file:
# Content writer agent .claude/agents/content-writer.md # WordPress admin agent .claude/agents/wordpress-admin.md
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
Restart Claude Code to load the changes
Customization Examples
Modify Content Writer for Technical Documentation
---
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 sourcesCustomize WordPress Admin for Specific Hosting
---
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 measuresAgent Prompt Structure
Each agent file should follow this structure:
---
# 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
- Preserve YAML frontmatter: Always keep the header configuration intact
- Test thoroughly: Test customizations in a development environment first
- Version control: Keep track of your customizations using git
- Document changes: Add comments explaining your customizations
- Backup originals: Keep copies of original agent files before modification
- Validate tools: Ensure all tools listed in frontmatter are actually needed
Sharing Custom Agents
You can share your custom agents by:
- Creating a fork of the repository with your customizations
- Exporting agent files and sharing them with your team
- 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
# WordPress Connection (Required)
WORDPRESS_URL=https://your-wordpress-site.com
WORDPRESS_USERNAME=your-admin-username
WORDPRESS_APP_PASSWORD=your-application-passwordOptional SSH Configuration
# 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/htmlOptional Content Defaults
# Content Writer Defaults (Optional)
DEFAULT_WORD_COUNT=800
DEFAULT_POST_STATUS=draft
DEFAULT_TONE=professional
DEFAULT_AUDIENCE=generalEnvironment File Setup
Copy the example file:
cp .env.example .envEdit with your values:
nano .env # or your preferred editor
Secure the file:
chmod 600 .env # Restrict access to owner only
๐ก Examples
Content Creation Workflow
# 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 professionalWordPress Administration Workflow
# 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-verifyContent Publishing Workflow
# 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:
- Ensure files are in
.claude/commands/(not.myaidev/) - Verify YAML frontmatter is valid
- Restart Claude Code
- Check file permissions (
chmod 644 .claude/commands/*.md)
WordPress Connection Issues
Problem: Cannot connect to WordPress site.
Solutions:
Verify credentials:
# Test WordPress REST API manually curl -u "username:app-password" "https://your-site.com/wp-json/wp/v2/users/me"
Check WordPress settings:
- Ensure REST API is enabled
- Verify Application Password is created correctly
- Check if site has HTTPS enabled
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:
Test SSH manually:
ssh user@your-serverCheck SSH configuration:
# Verify SSH config cat ~/.ssh/config # Check key permissions chmod 600 ~/.ssh/id_rsa chmod 644 ~/.ssh/id_rsa.pub
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:
Check agent file:
# Verify agent file exists and has correct format cat .claude/agents/content-writer.md
Validate YAML frontmatter:
- Ensure proper YAML syntax
- Verify all required fields are present
- Check tool permissions
Clear Claude Code cache:
- Restart Claude Code
- Clear browser cache if using web interface
Performance Issues
Problem: Operations are slow or timeout.
Solutions:
Optimize WordPress database:
/myai-wordpress-admin database-optimize
Check server resources:
/myai-wordpress-admin resource-monitor
Review error logs:
/myai-wordpress-admin error-analysis
Debug Mode
Enable debug mode for detailed error information:
# Add to your .env file
DEBUG=true
VERBOSE_LOGGING=trueGetting Help
- Check the logs: Look for error messages in Claude Code output
- Test components individually: Verify WordPress, SSH, and MCP connections separately
- Consult documentation: Review Claude Code official documentation
- Community support: Join Claude Code community forums
- GitHub issues: Report bugs and request features on the repository
๐ค Contributing
We welcome contributions to improve MyAIDev Method!
How to Contribute
- Fork the repository
- Create a feature branch:
git checkout -b feature/new-agent - Make your changes
- Test thoroughly
- 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
# 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@latest init --claude
# Or link for development
npm link
cd /path/to/test-project
npm link myaidev-method
npx myaidev-method@latest init --claude๐ License
MIT License - see 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.