myaidev-method 0.2.23 → 0.2.24-2

package/src/templates/docs/deployment-guide.md

@@ -0,0 +1,336 @@
+# Deployment Guide
+
+A guide to deploying and managing MyAIDev Method workflows in various environments.
+
+## Overview
+
+This guide covers installing, configuring, and maintaining MyAIDev Method in development and production environments.
+
+## Installation Methods
+
+### Quick Install (Recommended)
+
+```bash
+# Install and initialize in one step
+npx myaidev-method@latest init --claude
+
+# Add specific workflow
+npx myaidev-method@latest content --claude
+```
+
+### Global Install
+
+```bash
+# Install globally
+npm install -g myaidev-method
+
+# Initialize project
+myaidev-method init --claude
+```
+
+### Project Dependency
+
+```bash
+# Add to project
+npm install myaidev-method
+
+# Run via npx
+npx myaidev-method init --claude
+```
+
+## Workflow Installation
+
+### Available Workflows
+
+| Workflow | Purpose | Dependencies |
+|----------|---------|--------------|
+| `core` | Base configuration | None |
+| `content` | Content creation | core |
+| `visual` | Image/video generation | core |
+| `publish-wordpress` | WordPress publishing | core |
+| `development` | Dev tools | core |
+| `security-pentest` | Penetration testing | core |
+| `security-audit` | Security auditing | core |
+
+### Installing Multiple Workflows
+
+```bash
+# Install several workflows
+npx myaidev-method content --claude
+npx myaidev-method visual --claude
+npx myaidev-method publish-wordpress --claude
+```
+
+### Interactive Installation
+
+```bash
+# Choose workflows interactively
+npx myaidev-method install --interactive
+```
+
+## Configuration
+
+### Environment Variables
+
+Create a `.env` file in your project root:
+
+```env
+# General Settings
+CLI_TYPE=claude
+LOG_LEVEL=INFO
+
+# Content Settings
+DEFAULT_WORD_COUNT=1500
+DEFAULT_TONE=professional
+CONTENT_OUTPUT_DIR=./content
+
+# WordPress Settings
+WORDPRESS_URL=https://your-site.com
+WORDPRESS_USERNAME=your-username
+WORDPRESS_APP_PASSWORD=your-app-password
+WORDPRESS_DEFAULT_STATUS=draft
+
+# OpenStack Settings (if using)
+OS_AUTH_URL=https://your-openstack.com/v3
+OS_USERNAME=your-username
+OS_PASSWORD=your-password
+OS_PROJECT_NAME=your-project
+
+# Visual Generation (if using)
+GOOGLE_AI_API_KEY=your-key
+REPLICATE_API_TOKEN=your-token
+```
+
+### Configuration Wizard
+
+```bash
+# Run interactive configuration
+/myai-configure
+```
+
+### Per-Workflow Configuration
+
+Configuration files are stored in `.claude/config/`:
+
+```
+.claude/
+├── config/
+│   ├── wordpress.json
+│   ├── openstack.json
+│   └── content.json
+├── agents/
+└── commands/
+```
+
+## Directory Structure
+
+After installation, your project will have:
+
+```
+your-project/
+├── .claude/
+│   ├── CLAUDE.md           # Project instructions
+│   ├── agents/             # AI agent definitions
+│   │   ├── content-writer.md
+│   │   ├── wordpress-admin.md
+│   │   └── ...
+│   ├── commands/           # Slash commands
+│   │   ├── myai-content-writer.md
+│   │   ├── myai-wordpress-publish.md
+│   │   └── ...
+│   └── config/             # Configuration files
+├── .env                    # Environment variables
+└── content/                # Generated content
+```
+
+## CLI Type Support
+
+### Claude Code (Default)
+
+```bash
+npx myaidev-method init --claude
+```
+
+Files installed to `.claude/` directory.
+
+### Gemini CLI
+
+```bash
+npx myaidev-method init --gemini
+```
+
+Files installed to `.gemini/` directory.
+
+### Codex CLI
+
+```bash
+npx myaidev-method init --codex
+```
+
+Files installed to `.codex/` directory.
+
+## Updating
+
+### Update Package
+
+```bash
+# Update to latest version
+npm update myaidev-method
+
+# Or reinstall
+npx myaidev-method@latest init --claude
+```
+
+### Update Workflows
+
+```bash
+# Reinstall with force to update agents/commands
+npx myaidev-method content --claude --force
+```
+
+## Team Deployment
+
+### Shared Configuration
+
+1. Commit `.claude/` directory to git
+2. Add `.env` to `.gitignore`
+3. Create `.env.example` template
+
+### Team Setup
+
+```bash
+# Clone project
+git clone your-repo
+
+# Install dependencies
+npm install
+
+# Copy environment template
+cp .env.example .env
+
+# Configure credentials
+/myai-configure
+```
+
+## CI/CD Integration
+
+### GitHub Actions Example
+
+```yaml
+name: Content Publishing
+
+on:
+  push:
+    paths:
+      - 'content/**'
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+
+      - name: Install dependencies
+        run: npm install
+
+      - name: Publish content
+        env:
+          WORDPRESS_URL: ${{ secrets.WORDPRESS_URL }}
+          WORDPRESS_USERNAME: ${{ secrets.WORDPRESS_USERNAME }}
+          WORDPRESS_APP_PASSWORD: ${{ secrets.WORDPRESS_APP_PASSWORD }}
+        run: npx myaidev-method publish-batch ./content/
+```
+
+## Troubleshooting
+
+### Common Issues
+
+**Command not found:**
+```bash
+# Ensure Claude Code is active
+# Commands run inside Claude Code, not terminal
+```
+
+**Missing credentials:**
+```bash
+# Check .env file exists
+cat .env
+
+# Reconfigure
+/myai-configure
+```
+
+**Workflow not working:**
+```bash
+# Reinstall workflow
+npx myaidev-method content --claude --force
+```
+
+### Debug Mode
+
+```bash
+# Enable verbose logging
+LOG_LEVEL=DEBUG /myai-content-writer "Topic"
+```
+
+### Health Check
+
+```bash
+# WordPress connection
+/myai-configure wordpress
+# Then test connection option
+
+# OpenStack connection
+/myai-configure openstack
+# Then verify credentials
+```
+
+## Security Considerations
+
+### Credential Management
+
+1. **Never commit credentials** - Use `.env` and `.gitignore`
+2. **Use application passwords** - Not main passwords
+3. **Rotate regularly** - Update credentials periodically
+4. **Limit permissions** - Use least-privilege accounts
+
+### Secure Deployment
+
+```bash
+# Set restrictive permissions
+chmod 600 .env
+
+# Verify gitignore
+grep ".env" .gitignore
+```
+
+## Uninstalling
+
+### Remove from Project
+
+```bash
+# Remove .claude directory
+rm -rf .claude/
+
+# Remove from package.json
+npm uninstall myaidev-method
+```
+
+### Selective Removal
+
+```bash
+# Remove specific workflow components
+rm .claude/agents/content-writer.md
+rm .claude/commands/myai-content-writer.md
+```
+
+## Related Documentation
+
+- [Content Creation Guide](content-creation-guide.md)
+- [WordPress Publishing Guide](wordpress-publishing-guide.md)
+- [Visual Generation Guide](visual-generation-guide.md)

package/src/templates/docs/visual-generation-guide.md

@@ -0,0 +1,248 @@
+# Visual Generation Guide
+
+A guide to generating visual content (images, diagrams, videos) with the MyAIDev Method.
+
+## Overview
+
+The visual content generation workflow integrates with multiple AI image and video generation services to create professional visuals for your content.
+
+## Prerequisites
+
+- Visual workflow installed (`npx myaidev-method visual --claude`)
+- API keys for at least one visual generation service
+
+## Supported Services
+
+### Image Generation
+
+| Service | Best For | API Required |
+|---------|----------|--------------|
+| Gemini | General images, diagrams | Google AI API |
+| Imagen | High-quality photographs | Google Cloud |
+| FLUX | Creative, artistic images | Replicate/fal.ai |
+
+### Video Generation
+
+| Service | Best For | API Required |
+|---------|----------|--------------|
+| Veo | Professional video content | Google AI API |
+
+## Configuration
+
+### Setting Up API Keys
+
+Add to your `.env` file:
+
+```env
+# Google AI (Gemini, Imagen, Veo)
+GOOGLE_AI_API_KEY=your-google-ai-key
+
+# Replicate (FLUX)
+REPLICATE_API_TOKEN=your-replicate-token
+
+# fal.ai (FLUX alternative)
+FAL_KEY=your-fal-key
+```
+
+## Generating Images
+
+### Basic Usage
+
+```bash
+/myai-generate-visual "A modern office workspace with natural lighting" --type image
+```
+
+### With Options
+
+```bash
+/myai-generate-visual "Product photography of a smartphone" \
+  --type image \
+  --service imagen \
+  --aspect-ratio 1:1 \
+  --style photorealistic
+```
+
+### Image Options
+
+| Option | Description | Values |
+|--------|-------------|--------|
+| `--service` | Generation service | gemini, imagen, flux |
+| `--aspect-ratio` | Output ratio | 1:1, 16:9, 4:3, 9:16 |
+| `--style` | Visual style | photorealistic, artistic, diagram |
+| `--output` | Output filename | Custom filename |
+
+## Generating Diagrams
+
+### Technical Diagrams
+
+```bash
+/myai-generate-visual "System architecture diagram showing microservices" \
+  --type diagram \
+  --format mermaid
+```
+
+### Flowcharts
+
+```bash
+/myai-generate-visual "User authentication flow" \
+  --type flowchart \
+  --format svg
+```
+
+### Diagram Types
+
+- Architecture diagrams
+- Flowcharts
+- Sequence diagrams
+- Entity relationship diagrams
+- Mind maps
+- Organizational charts
+
+## Generating Videos
+
+### Basic Video
+
+```bash
+/myai-generate-visual "A timelapse of clouds moving across a mountain landscape" \
+  --type video \
+  --duration 10
+```
+
+### Video Options
+
+| Option | Description | Values |
+|--------|-------------|--------|
+| `--duration` | Video length | 5-60 seconds |
+| `--resolution` | Output quality | 720p, 1080p |
+| `--fps` | Frame rate | 24, 30, 60 |
+
+## Prompt Engineering
+
+### Effective Image Prompts
+
+**Good:**
+```
+Professional headshot of a business executive,
+soft studio lighting, neutral background,
+sharp focus, high resolution
+```
+
+**Less Effective:**
+```
+Person photo
+```
+
+### Key Elements
+
+1. **Subject** - What is the main focus?
+2. **Style** - Photorealistic? Illustration? Diagram?
+3. **Composition** - Close-up? Wide shot? Angle?
+4. **Lighting** - Natural? Studio? Dramatic?
+5. **Quality** - Resolution, detail level
+6. **Mood** - Professional? Casual? Energetic?
+
+## Integration with Content
+
+### Automatic Image Generation
+
+When writing content, request images inline:
+
+```markdown
+## Introduction
+
+[Generate: Hero image showing AI-assisted content creation]
+
+The future of content creation...
+```
+
+### Batch Generation
+
+```bash
+# Generate all images for an article
+/myai-generate-visual --from-content ./content/my-article.md
+```
+
+## Best Practices
+
+### For Blog Posts
+
+- Hero images: 16:9 ratio, high quality
+- In-article images: Relevant, not stock-looking
+- Diagrams: Clear, labeled, consistent style
+
+### For Social Media
+
+- Square images (1:1) for Instagram
+- Wide images (16:9) for Twitter/X
+- Vertical (9:16) for Stories/Reels
+
+### For Documentation
+
+- Diagrams: SVG or PNG with transparent background
+- Screenshots: Annotated, cropped appropriately
+- Icons: Consistent style throughout
+
+## Troubleshooting
+
+### Generation Failed
+
+**Symptoms:** API error or timeout
+
+**Solutions:**
+1. Check API key validity
+2. Verify service is available
+3. Simplify prompt
+4. Try different service
+
+### Poor Quality Output
+
+**Symptoms:** Blurry, wrong subject, artifacts
+
+**Solutions:**
+1. Be more specific in prompt
+2. Add style keywords
+3. Try different aspect ratio
+4. Use higher quality service
+
+### Content Policy Violations
+
+**Symptoms:** Request rejected
+
+**Solutions:**
+1. Review content policies
+2. Rephrase prompt
+3. Avoid restricted content
+
+## API Reference
+
+### VisualGenerator
+
+```javascript
+import { VisualGenerator } from 'myaidev-method';
+
+const generator = new VisualGenerator();
+
+// Generate image
+const image = await generator.generateImage({
+  prompt: 'Description of image',
+  service: 'imagen',
+  aspectRatio: '16:9'
+});
+
+// Generate diagram
+const diagram = await generator.generateDiagram({
+  prompt: 'System architecture',
+  format: 'mermaid'
+});
+
+// Generate video
+const video = await generator.generateVideo({
+  prompt: 'Video description',
+  duration: 10
+});
+```
+
+## Related Documentation
+
+- [Content Creation Guide](content-creation-guide.md)
+- [WordPress Publishing Guide](wordpress-publishing-guide.md)