AI-powered WordPress content management with PraisonAI integration and production-ready features

These details have not been verified by PyPI

Project links

Project description

PraisonAI WPcli

AI-powered WordPress CLI tool for content management with precision editing capabilities.

Features

🎉 NEW in v1.1.0: Production-Ready AI Integration!

AI-powered content generation with PraisonAI framework!

# Install with AI features
pip install praisonaiwp[ai]

# Set your OpenAI API key
export OPENAI_API_KEY="sk-..."

# Generate content
praisonaiwp ai generate "AI Trends 2025"

# Generate and auto-publish
praisonaiwp ai generate "AI Trends" \
  --title "The Future of AI" \
  --auto-publish \
  --status publish

AI Features:

✅ PraisonAI Integration - Multi-agent content generation
✅ Production-Ready - API validation, retry logic, cost tracking
✅ Cost-Effective - Default gpt-4o-mini (~$0.0005 per 500-word post)
✅ Quality Control - Content validation, length checks, structure validation
✅ Auto-Publish - Direct WordPress publishing with one command
✅ Rate Limiting - Prevents API errors
✅ 58 Tests - 100% passing, production-ready

See PRAISONAI.md for complete AI documentation.

🚀 NEW in v1.0.13: Universal WP-CLI Access!

ALL 1000+ WP-CLI commands now supported via the generic wp() method!

from praisonaiwp import SSHManager, WPClient

ssh = SSHManager('example.com', 'username')
client = WPClient(ssh, '/var/www/html')

# Use ANY WP-CLI command!
client.wp('cache', 'flush')
client.wp('db', 'export', 'backup.sql')
client.wp('plugin', 'install', 'akismet')
posts = client.wp('post', 'list', status='publish', format='json')

See GENERIC_WP_METHOD.md for complete documentation.

Core Features

🚀 Universal WP-CLI - Direct access to ALL WP-CLI commands via wp() method
🎯 Convenience Methods - 48 wrapper methods with IDE autocomplete for common operations
⚡ Fast - Auto-parallel mode for bulk operations (10x faster)
🔒 Safe - Auto-backup, preview mode, dry-run capabilities
🌐 Multi-Server - Manage multiple WordPress installations
📝 Smart - Auto JSON parsing, underscore-to-hyphen conversion

All Supported Features

📝 Post Management (6 methods)

create_post() - Create posts with metadata
update_post() - Update post fields
list_posts() - List with WP_Query filters
get_post() - Get post details
delete_post() - Delete posts (trash/force)
post_exists() - Check post existence

🏷️ Post Meta (4 methods)

get_post_meta() - Get meta values
set_post_meta() - Add meta fields
update_post_meta() - Update meta
delete_post_meta() - Remove meta

👥 User Management (9 methods)

list_users() - List all users
get_user() - Get user details
create_user() - Create new user
update_user() - Update user fields
delete_user() - Delete user (with reassign)
get_user_meta() - Get user meta
set_user_meta() - Set user meta
update_user_meta() - Update user meta
delete_user_meta() - Delete user meta

⚙️ Option Management (3 methods)

get_option() - Get option value
set_option() - Set option value
delete_option() - Delete option

🔌 Plugin Management (3 methods)

list_plugins() - List all plugins
activate_plugin() - Activate plugin
deactivate_plugin() - Deactivate plugin

🎨 Theme Management (2 methods)

list_themes() - List all themes
activate_theme() - Activate theme

📷 Media Management (1 method)

import_media() - Import media with metadata

💬 Comment Management (6 methods)

list_comments() - List comments
get_comment() - Get comment details
create_comment() - Create comment
update_comment() - Update comment
delete_comment() - Delete comment
approve_comment() - Approve comment

🗄️ Cache Management (2 methods)

flush_cache() - Flush object cache
get_cache_type() - Get cache type

⏱️ Transient Management (3 methods)

get_transient() - Get transient value
set_transient() - Set transient with expiration
delete_transient() - Delete transient

🧭 Menu Management (4 methods)

list_menus() - List navigation menus
create_menu() - Create new menu
delete_menu() - Delete menu
add_menu_item() - Add menu item

🌐 Core Commands (2 methods)

get_core_version() - Get WordPress version
core_is_installed() - Check installation

💾 Database (2 methods)

db_query() - Execute SQL query
search_replace() - Search and replace in database

🚀 Plus UNLIMITED via `wp()` Method!

Use ANY WP-CLI command directly:

# Database operations
client.wp('db', 'export', 'backup.sql')
client.wp('db', 'import', 'backup.sql')
client.wp('db', 'optimize')

# Plugin operations
client.wp('plugin', 'install', 'akismet')
client.wp('plugin', 'update', '--all')

# Theme operations
client.wp('theme', 'install', 'twentytwentyfour')

# Cron management
client.wp('cron', 'event', 'list', format='json')
client.wp('cron', 'event', 'run', 'wp_version_check')

# Core management
client.wp('core', 'update')
client.wp('core', 'verify-checksums')

# Media operations
client.wp('media', 'regenerate', '--yes')

# Export/Import
client.wp('export', author='admin')
client.wp('import', 'content.xml')

# ANY WP-CLI command works!

Total: 48 convenience methods + 1000+ commands via wp() 🎉

Previous Updates (v1.0.2)

🔑 SSH Config Support - Use ~/.ssh/config host aliases for simplified connection management
🔧 WP-CLI Auto-Installer - One-command WP-CLI installation with automatic OS detection (Ubuntu, Debian, CentOS, RHEL, Fedora, Alpine, macOS)
🔍 WordPress Auto-Detection - Automatically find WordPress installations on your server with multiple search strategies
⚡ UV Package Manager - 10-100x faster dependency management with modern tooling
🛡️ Enhanced Error Handling - Helpful error messages with installation instructions and troubleshooting
📊 Installation Verification - Automatic checks for WP-CLI and WordPress validity on startup

Installation

Using pip (Recommended)

# Core only (WordPress management)
pip install praisonaiwp

# With AI features (recommended)
pip install praisonaiwp[ai]

# With development tools
pip install praisonaiwp[dev]

# Everything
pip install praisonaiwp[all]

Using uv (10x faster!)

# Install uv if you haven't already
curl -LsSf https://astral.sh/uv/install.sh | sh

# Clone and install
git clone https://github.com/MervinPraison/PraisonAI-WPcli.git
cd PraisonAI-WPcli
uv sync

# Run commands
uv run praisonaiwp init

From source

git clone https://github.com/MervinPraison/PraisonAI-WPcli.git
cd PraisonAI-WPcli
pip install -e ".[ai]"  # With AI features

Quick Start

1. Initialize Configuration

praisonaiwp init

💡 Pro Tips:

Use SSH config alias (e.g., wp-prod) - connection details loaded automatically!
Press Enter for WordPress path - auto-detection will find it for you
PHP binary is auto-detected, or specify for Plesk: /opt/plesk/php/8.3/bin/php

🔑 SSH Config Support:

PraisonAIWP automatically reads from ~/.ssh/config. If you have multiple hosts configured:

# ~/.ssh/config
Host wp-prod
    HostName production.example.com
    User prod_user
    IdentityFile ~/.ssh/id_prod

Host wp-staging
    HostName staging.example.com
    User staging_user
    IdentityFile ~/.ssh/id_staging

Host wp-dev
    HostName localhost
    User dev_user
    Port 2222
    IdentityFile ~/.ssh/id_dev

Just enter the host alias (e.g., wp-prod, wp-staging, or wp-dev) when prompted for hostname, and PraisonAIWP will automatically load all connection details from your SSH config!

Choosing Between Multiple Configs:

Each host alias is independent

Use --server flag to specify which server to use:

praisonaiwp create "Post" --server production
praisonaiwp create "Post" --server staging

Configure multiple servers in ~/.praisonaiwp/config.yaml:

servers:
  # Method 1: Using ssh_host (recommended)
  production:
    ssh_host: wp-prod  # Reference SSH config host
    wp_path: /var/www/html
    wp_cli: /usr/local/bin/wp
  
  # Method 2: Direct specification (traditional)
  staging:
    hostname: staging.example.com
    username: staging_user
    key_file: ~/.ssh/id_staging
    port: 22
    wp_path: /var/www/staging
    wp_cli: /usr/local/bin/wp
  
  # Method 3: Mix both (direct values override ssh_host)
  dev:
    ssh_host: wp-dev
    username: custom_user  # Override SSH config username
    wp_path: /var/www/dev
    wp_cli: /usr/local/bin/wp

New in v1.0.5: Use ssh_host to reference SSH config hosts! Connection details (hostname, username, key_file, port) are automatically loaded from ~/.ssh/config. You can also specify connection details directly (traditional method) or mix both approaches - direct values always take precedence.

This will prompt you for:

Server hostname - Can be IP, hostname, or SSH config alias (e.g., wp-prod)
SSH username - Auto-loaded from SSH config if using alias
SSH key path - Auto-loaded from SSH config if using alias
WordPress path - Press Enter to auto-detect, or specify manually
PHP binary - Auto-detected, or specify custom path

2. Auto-Install WP-CLI (Optional)

If WP-CLI is not installed on your server:

# Automatically detect OS and install WP-CLI
praisonaiwp install-wp-cli -y

# Install with dependencies (curl, php)
praisonaiwp install-wp-cli --install-deps -y

# Custom installation path
praisonaiwp install-wp-cli --install-path /usr/bin/wp

# For Plesk servers
praisonaiwp install-wp-cli --php-bin /opt/plesk/php/8.3/bin/php -y

Supported Operating Systems:

✅ Ubuntu (18.04, 20.04, 22.04, 24.04)
✅ Debian (9, 10, 11, 12)
✅ CentOS (7, 8, 9)
✅ RHEL (7, 8, 9)
✅ Fedora (35+)
✅ Alpine Linux
✅ macOS (with Homebrew)

What it does:

Detects your server's operating system
Downloads WP-CLI from official source
Tests the download
Makes it executable
Installs to system path
Verifies installation
Updates your config automatically

3. Auto-Detect WordPress (Optional)

If you don't know your WordPress installation path:

# Find all WordPress installations
praisonaiwp find-wordpress

# Interactive selection from multiple installations
praisonaiwp find-wordpress --interactive

# Find and update config automatically
praisonaiwp find-wordpress --update-config

# Find on different server
praisonaiwp find-wordpress --server staging

Search Strategies:

Searches for wp-config.php in common directories
Checks predefined paths (/var/www/html, /var/www/vhosts/*/httpdocs, etc.)
Verifies each installation (wp-config, wp-content, wp-includes)
Extracts WordPress version
Interactive selection for multiple installations

Example Output:

✓ Found 2 WordPress installation(s)

┏━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━┓
┃ # ┃ Path                                ┃ Version ┃ Components              ┃
┡━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━┩
│ 1 │ /var/www/html                       │ 6.4.2   │ config, content, includes│
│ 2 │ /var/www/vhosts/example.com/httpdocs│ 6.3.1   │ config, content, includes│
└───┴─────────────────────────────────────┴─────────┴─────────────────────────┘

4. Create Posts

# Single post
praisonaiwp create "My Post Title" --content "Post content here"

# With author (NEW in v1.0.14)
praisonaiwp create "My Post" --content "Content" --author praison
praisonaiwp create "My Post" --content "Content" --author 1  # By user ID

# With categories
praisonaiwp create "My Post" --content "Hello" --category "Tech,AI"

# From file (auto-detects JSON/YAML/CSV)
praisonaiwp create posts.json

# Create 100 posts (automatically uses parallel mode!)
praisonaiwp create 100_posts.json

5. Update Posts

# Find and replace text
praisonaiwp update 123 "old text" "new text"

# Update specific line only
praisonaiwp update 123 "old text" "new text" --line 10

# Update 2nd occurrence only
praisonaiwp update 123 "old text" "new text" --nth 2

# Preview changes first
praisonaiwp update 123 "old text" "new text" --preview

# Update post fields directly (NEW in v1.0.14)
praisonaiwp update 123 --post-content "Full new content"
praisonaiwp update 123 --post-title "New Title"
praisonaiwp update 123 --post-status draft

# Update categories
praisonaiwp update 123 --category "Tech,AI"

6. Find Text

# Find in specific post
praisonaiwp find "search text" 123

# Find across all posts
praisonaiwp find "search text"

# Find in pages
praisonaiwp find "search text" --type page

7. List Posts

# List all posts
praisonaiwp list

# Search posts (NEW in v1.0.14)
praisonaiwp list --search "Pricing"
praisonaiwp list -s "keyword"

# List pages
praisonaiwp list --type page

# List drafts
praisonaiwp list --status draft

# Limit results
praisonaiwp list --limit 10

8. Manage Categories

# List all categories
praisonaiwp category list

# Search for categories
praisonaiwp category search "Technology"

# List categories for a specific post
praisonaiwp category list 123

# Set categories (replace all)
praisonaiwp category set 123 --category "Tech,AI"

# Add categories (append)
praisonaiwp category add 123 --category "Python"

# Remove categories
praisonaiwp category remove 123 --category "Uncategorized"

# Create post with categories
praisonaiwp create "My Post" --content "Hello" --category "Tech,AI"

# Update post categories
praisonaiwp update 123 --category "Tech,Python"

9. AI Content Generation (NEW in v1.1.0)

# Set your OpenAI API key (required)
export OPENAI_API_KEY="sk-..."

# Generate content (creates draft)
praisonaiwp ai generate "AI Trends 2025"

# Generate with custom title
praisonaiwp ai generate "AI Trends" --title "The Future of AI"

# Generate and auto-publish
praisonaiwp ai generate "AI Trends" \
  --title "The Future of AI" \
  --auto-publish \
  --status publish

# Verbose mode (see generation details)
praisonaiwp ai generate "AI Trends" --verbose

# Use different server
praisonaiwp ai generate "AI Trends" --server production

AI Features:

Powered by PraisonAI multi-agent framework
Default model: gpt-4o-mini (cost-effective)
Automatic content validation
Cost tracking
Retry logic with exponential backoff
Rate limiting to prevent API errors

Programmatic Usage:

from praisonaiwp.ai.integration import PraisonAIWPIntegration
from praisonaiwp.core.ssh_manager import SSHManager
from praisonaiwp.core.wp_client import WPClient

# Setup
ssh = SSHManager(hostname="example.com", username="user", key_file="~/.ssh/id_rsa")
wp_client = WPClient(ssh=ssh, wp_path="/var/www/html")

# Create AI integration
integration = PraisonAIWPIntegration(wp_client)

# Generate content
result = integration.generate(
    topic="AI Trends 2025",
    title="The Future of AI",
    auto_publish=True
)

print(f"Post ID: {result['post_id']}")
print(f"Cost: ${result['cost']:.6f}")
print(f"Duration: {result['duration']:.2f}s")

See PRAISONAI.md for complete AI documentation.

AI Production Features

The AI integration includes enterprise-grade production features:

1. API Key Validation

Validates OpenAI API key on initialization
Clear error messages with setup instructions
Format checking (must start with 'sk-')

2. Content Validation

Length checks: Minimum 100 chars, maximum 10,000 chars (configurable)
Paragraph structure: Requires at least 2 paragraph breaks
Placeholder detection: Detects [INSERT], TODO, PLACEHOLDER text
Skip option: Use skip_validation=True to bypass

3. Cost Tracking

Per-generation tracking: Track cost for each post
Cumulative tracking: Total cost across all generations
Model-specific pricing: Accurate pricing for gpt-4o-mini, gpt-4o, etc.
Cost estimation: See estimated cost before generation

Example:

# Get cost summary
summary = integration.get_cost_summary()
print(f"Total cost: ${summary['total_cost']:.6f}")
print(f"Average cost: ${summary['average_cost']:.6f}")

4. Retry Logic with Exponential Backoff

Automatic retries: 3 attempts on failure
Exponential backoff: 1s, 2s, 4s delays
Smart error handling: Distinguishes temporary vs permanent errors
Configurable: Adjust max retries and delays

5. Rate Limiting

Default limits: 10 requests per 60 seconds
Automatic waiting: Waits when limit reached
Configurable: Adjust limits per your needs
Can be disabled: For unlimited usage

Example:

integration = PraisonAIWPIntegration(
    wp_client,
    enable_rate_limiting=True,
    max_requests=10,
    time_window=60
)

6. Structured Logging

Generation metrics: Duration, cost, word count
Progress tracking: Real-time generation status
Error logging: Detailed error messages
Verbose mode: Use --verbose flag for details

7. Enhanced Result Metadata

Every generation returns comprehensive metadata:

{
    'content': str,           # Generated content
    'post_id': int,           # WordPress post ID (if published)
    'cost': float,            # Estimated cost in USD
    'duration': float,        # Generation time in seconds
    'model': str,             # Model used (e.g., 'gpt-4o-mini')
    'metadata': {
        'topic': str,         # Original topic
        'title': str,         # Post title
        'length': int,        # Content length in chars
        'word_count': int     # Word count
    }
}

Cost Comparison

Model	Speed	Cost/500 words	Quality	Best For
gpt-4o-mini	2-3s	$0.0005	Good	Most use cases ✅
gpt-4o	5-8s	$0.011	Excellent	Premium content
gpt-3.5-turbo	1-2s	$0.0003	Fair	High volume

Configuration Options

integration = PraisonAIWPIntegration(
    wp_client,
    
    # Model settings
    model='gpt-4o-mini',           # Default model
    verbose=0,                      # Verbosity (0-2)
    status='draft',                 # Default post status
    
    # Content validation
    validate_content=True,          # Enable validation
    min_length=100,                 # Min chars
    max_length=10000,               # Max chars
    
    # Rate limiting
    enable_rate_limiting=True,      # Enable limiter
    max_requests=10,                # Max requests
    time_window=60,                 # Time window (seconds)
)

Test Coverage

58 tests - 100% passing
Test categories: API validation, content validation, cost tracking, rate limiting, retry logic, integration, WordPress tools, CLI commands
Production-ready: All edge cases covered

See PRAISONAI.md for detailed production features documentation.

Complete CLI Reference

`praisonaiwp create` - Create Posts

All Options:

praisonaiwp create [TITLE_OR_FILE] [OPTIONS]

Options:
  --content TEXT          Post content
  --status TEXT           Post status (publish, draft, private)
  --type TEXT             Post type (post, page)
  --category TEXT         Comma-separated category names/slugs
  --category-id TEXT      Comma-separated category IDs
  --author TEXT           Post author (user ID or login)
  --excerpt TEXT          Post excerpt
  --date TEXT             Post date (YYYY-MM-DD HH:MM:SS)
  --tags TEXT             Comma-separated tag names or IDs
  --meta TEXT             Post meta in JSON format: {"key":"value"}
  --comment-status TEXT   Comment status (open, closed)
  --convert-to-blocks     Auto-convert HTML to Gutenberg blocks (NEW in v1.0.17)
  --server TEXT           Server name from config

Examples:

# Basic post
praisonaiwp create "My Post" --content "Content here"

# With author and categories
praisonaiwp create "My Post" \
  --content "Full content" \
  --status publish \
  --author praison \
  --category "Tech,AI"

# With custom meta data (NEW in v1.0.15)
praisonaiwp create "My Post" \
  --content "Content" \
  --meta '{"custom_field":"value","price":"99.99"}'

# With excerpt and tags
praisonaiwp create "My Post" \
  --content "Full content" \
  --excerpt "Short summary" \
  --tags "python,wordpress,automation"

# With custom date and comment status
praisonaiwp create "My Post" \
  --content "Content" \
  --date "2024-01-15 10:30:00" \
  --comment-status closed

# All options combined
praisonaiwp create "My Post" \
  --content "Full content" \
  --status publish \
  --type post \
  --category "Tech,AI" \
  --author praison \
  --excerpt "Summary" \
  --date "2024-01-15 10:00:00" \
  --tags "python,ai" \
  --meta '{"views":"0","featured":"yes"}' \
  --comment-status open \
  --server production

# From file
praisonaiwp create posts.json

# Auto-convert HTML to Gutenberg blocks (NEW in v1.0.17)
praisonaiwp create "My Post" \
  --content "<h2>Title</h2><p>Content with <strong>HTML</strong></p>" \
  --convert-to-blocks

`praisonaiwp update` - Update Posts

All Options:

praisonaiwp update POST_ID [FIND_TEXT] [REPLACE_TEXT] [OPTIONS]

Options:
  --line INTEGER         Update specific line number
  --nth INTEGER          Update nth occurrence
  --preview              Preview changes without applying
  --category TEXT        Comma-separated category names/slugs
  --category-id TEXT     Comma-separated category IDs
  --post-content TEXT    Replace entire post content
  --post-title TEXT      Update post title
  --post-status TEXT     Update post status (publish, draft, private)
  --post-excerpt TEXT    Update post excerpt
  --post-author TEXT     Update post author (user ID or login)
  --post-date TEXT       Update post date (YYYY-MM-DD HH:MM:SS)
  --tags TEXT            Update tags (comma-separated)
  --meta TEXT            Update post meta in JSON format
  --comment-status TEXT  Update comment status (open, closed)
  --convert-to-blocks    Auto-convert HTML to Gutenberg blocks (NEW in v1.0.17)
  --server TEXT          Server name from config

Examples:

# Find and replace
praisonaiwp update 123 "old text" "new text"

# Update specific line
praisonaiwp update 123 "old" "new" --line 10

# Update nth occurrence
praisonaiwp update 123 "old" "new" --nth 2

# Preview first
praisonaiwp update 123 "old" "new" --preview

# Update post fields directly
praisonaiwp update 123 --post-content "New full content"
praisonaiwp update 123 --post-title "New Title"
praisonaiwp update 123 --post-status draft

# Update excerpt and tags (NEW in v1.0.16)
praisonaiwp update 123 --post-excerpt "New summary"
praisonaiwp update 123 --tags "python,wordpress,automation"

# Update author and date
praisonaiwp update 123 --post-author praison
praisonaiwp update 123 --post-date "2024-01-15 10:00:00"

# Update custom meta
praisonaiwp update 123 --meta '{"views":"1000","featured":"yes"}'

# Update comment status
praisonaiwp update 123 --comment-status closed

# Update categories
praisonaiwp update 123 --category "Tech,AI"

# Combine multiple updates
praisonaiwp update 123 \
  --post-title "Updated Title" \
  --post-excerpt "New excerpt" \
  --tags "python,ai" \
  --meta '{"updated":"yes"}' \
  --comment-status open

# Update content with HTML to blocks conversion (NEW in v1.0.17)
praisonaiwp update 123 \
  --post-content "<h2>New Title</h2><p>Updated content</p>" \
  --convert-to-blocks

`praisonaiwp list` - List Posts

All Options:

praisonaiwp list [OPTIONS]

Options:
  --type TEXT         Post type (post, page, all)
  --status TEXT       Post status (publish, draft, all)
  --limit INTEGER     Limit number of results
  -s, --search TEXT   Search posts by title/content
  --server TEXT       Server name from config

Examples:

# List all posts
praisonaiwp list

# Search (single word)
praisonaiwp list --search "Pricing"
praisonaiwp list -s "keyword"

# Search with spaces (use quotes)
praisonaiwp list --search "Test Post"

# List pages
praisonaiwp list --type page

# List drafts
praisonaiwp list --status draft

# Limit results
praisonaiwp list --limit 10

# Combine filters
praisonaiwp list --type post --status publish --limit 20

`praisonaiwp find` - Search Text

All Options:

praisonaiwp find PATTERN [POST_ID] [OPTIONS]

Options:
  --type TEXT    Post type to search
  --server TEXT  Server name from config

Examples:

# Find in specific post
praisonaiwp find "search text" 123

# Find across all posts
praisonaiwp find "search text"

# Find in pages
praisonaiwp find "search text" --type page

`praisonaiwp category` - Manage Categories

Subcommands:

list - List categories (all or for specific post)
search - Search for categories by name
set - Set post categories (replace all existing)
add - Add categories to post (append)
remove - Remove categories from post

Examples:

# List all categories
praisonaiwp category list

# Search categories
praisonaiwp category search "Technology"

# List categories for a post
praisonaiwp category list 123

# Set categories (replace all)
praisonaiwp category set 123 --category "Tech,AI"
praisonaiwp category set 123 --category-id "1,2,3"

# Add categories (append)
praisonaiwp category add 123 --category "Python"

# Remove categories
praisonaiwp category remove 123 --category "Uncategorized"

`praisonaiwp ai` - AI Content Generation (NEW in v1.1.0)

Subcommand:

praisonaiwp ai generate TOPIC [OPTIONS]

Options:

Options:
  --title TEXT           Post title (defaults to topic)
  --status TEXT          Post status (draft/publish/private)
  --type TEXT            Post type (post, page)
  --category TEXT        Comma-separated category names or slugs
  --category-id TEXT     Comma-separated category IDs
  --author TEXT          Post author (user ID or login)
  --excerpt TEXT         Post excerpt
  --date TEXT            Post date (YYYY-MM-DD HH:MM:SS)
  --tags TEXT            Comma-separated tag names or IDs
  --meta TEXT            Post meta in JSON format: {"key":"value"}
  --comment-status TEXT  Comment status (open, closed)
  --auto-publish         Automatically publish to WordPress
  --verbose              Verbose output
  --server TEXT          Server name from config

Examples:

# Basic generation (creates draft)
praisonaiwp ai generate "AI Trends 2025"

# With custom title
praisonaiwp ai generate "AI Trends" --title "The Future of AI"

# Auto-publish as draft
praisonaiwp ai generate "AI Trends" \
  --title "The Future of AI" \
  --auto-publish

# Auto-publish as published post
praisonaiwp ai generate "AI Trends" \
  --title "The Future of AI" \
  --auto-publish \
  --status publish

# With categories and tags
praisonaiwp ai generate "AI Trends" \
  --category "Technology,AI" \
  --tags "artificial-intelligence,machine-learning" \
  --auto-publish

# With author and excerpt
praisonaiwp ai generate "AI Trends" \
  --author praison \
  --excerpt "Discover the latest AI trends" \
  --auto-publish

# With custom meta fields
praisonaiwp ai generate "AI Trends" \
  --meta '{"featured":"yes","views":"0"}' \
  --auto-publish

# All options combined
praisonaiwp ai generate "AI Trends 2025" \
  --title "The Future of AI" \
  --status publish \
  --type post \
  --category "Technology,AI" \
  --author praison \
  --excerpt "Comprehensive AI trends analysis" \
  --date "2024-01-15 10:00:00" \
  --tags "ai,tech,trends" \
  --meta '{"featured":"yes"}' \
  --comment-status open \
  --auto-publish \
  --verbose

# Verbose mode (shows generation details, cost, duration)
praisonaiwp ai generate "AI Trends" --verbose

# Use specific server
praisonaiwp ai generate "AI Trends" --server production

Requirements:

OpenAI API key: export OPENAI_API_KEY="sk-..."
AI features installed: pip install praisonaiwp[ai]

Features:

Default model: gpt-4o-mini (~$0.0005 per 500-word post)
Automatic content validation
Cost tracking and estimation
Retry logic (3 attempts with exponential backoff)
Rate limiting (10 requests/60s by default)
Production-ready error handling

See PRAISONAI.md for complete AI documentation.

Important Notes for AI Agents

⚠️ Quoting Rules:

Always quote arguments with spaces: --search "multi word"
Single words don't need quotes: --search keyword
Category names with commas: --category "Tech,AI,Python"

✅ Correct Usage:

praisonaiwp list --search "Test Post"
praisonaiwp create "My Title" --content "My content"
praisonaiwp update 123 --post-title "New Title"
praisonaiwp ai generate "AI Trends" --title "The Future"

❌ Incorrect Usage:

praisonaiwp list --search Test Post  # ERROR: Too many positional arguments
praisonaiwp create My Title --content My content  # ERROR: Ambiguous
praisonaiwp ai generate AI Trends --title The Future  # ERROR: Needs quotes

🔧 All Available Options Summary:

Command	Key Options
`create`	`--content`, `--status`, `--type`, `--category`, `--category-id`, `--author`, `--excerpt`, `--date`, `--tags`, `--meta`, `--comment-status`, `--convert-to-blocks`, `--server`
`update`	`--line`, `--nth`, `--preview`, `--category`, `--category-id`, `--post-content`, `--post-title`, `--post-status`, `--post-excerpt`, `--post-author`, `--post-date`, `--tags`, `--meta`, `--comment-status`, `--convert-to-blocks`, `--server`
`list`	`--type`, `--status`, `--limit`, `-s/--search`, `--server`
`find`	`--type`, `--server`
`category`	Subcommands: `list`, `search`, `set`, `add`, `remove` with `--category`, `--category-id`
`ai generate`	`--title`, `--status`, `--type`, `--category`, `--category-id`, `--author`, `--excerpt`, `--date`, `--tags`, `--meta`, `--comment-status`, `--auto-publish`, `--verbose`, `--server`

File Formats

JSON Format

[
  {
    "title": "Post Title",
    "content": "<p>Post content</p>",
    "status": "publish",
    "type": "post"
  }
]

YAML Format

- title: Post Title
  content: <p>Post content</p>
  status: publish
  type: post

CSV Format

title,content,status,type
"Post Title","<p>Post content</p>",publish,post

Configuration

Configuration is stored in ~/.praisonaiwp/config.yaml:

version: "1.0"
default_server: default

servers:
  default:
    hostname: example.com
    username: user
    key_file: ~/.ssh/id_ed25519
    port: 22
    wp_path: /var/www/html
    php_bin: /opt/plesk/php/8.3/bin/php
    wp_cli: /usr/local/bin/wp

settings:
  auto_backup: true
  parallel_threshold: 10
  parallel_workers: 10
  ssh_timeout: 30
  log_level: INFO

Advanced Usage

Line-Specific Replacement

When the same text appears multiple times but you only want to replace it at a specific line:

# Replace only at line 10
praisonaiwp update 123 "Welcome" "My Website" --line 10

Occurrence-Specific Replacement

Replace only the 1st, 2nd, or nth occurrence:

# Replace only the 2nd occurrence
praisonaiwp update 123 "Welcome" "My Website" --nth 2

Bulk Operations

Create 100 posts in ~8 seconds (vs 50+ seconds sequential):

# Automatically uses parallel mode for files with >10 posts
praisonaiwp create 100_posts.json

Troubleshooting

SSH Connection Issues

# Test SSH connection manually
ssh -i ~/.ssh/id_ed25519 user@hostname

# Fix key permissions
chmod 600 ~/.ssh/id_ed25519
chmod 600 ~/.ssh/config

WP-CLI Not Found

# Install WP-CLI automatically
praisonaiwp install-wp-cli -y

# Or check WP-CLI path manually
ssh user@hostname "which wp"

PHP MySQL Extension Missing

# Use Plesk PHP binary (edit config.yaml)
php_bin: /opt/plesk/php/8.3/bin/php

WordPress Path Not Found

# Auto-detect WordPress installation
praisonaiwp find-wordpress --update-config

AI Features Issues

API Key Not Set

Error: OPENAI_API_KEY not set.

Solution:

export OPENAI_API_KEY="sk-..."
# Add to ~/.bashrc or ~/.zshrc for persistence

AI Features Not Available

Error: AI features not available.
Install with: pip install 'praisonaiwp[ai]'

Solution:

pip install --upgrade praisonaiwp[ai]

Content Validation Failed

Error: Content validation failed:
  - Content too short: 50 chars (minimum: 100)

Solutions:

# Option 1: Skip validation
praisonaiwp ai generate "Topic" --skip-validation

# Option 2: Adjust in code
integration = PraisonAIWPIntegration(wp_client, min_length=50)

Rate Limit Reached

WARNING: Rate limit reached (10 requests/60s). Waiting 15.3s...

Solutions:

# Increase limits
integration = PraisonAIWPIntegration(
    wp_client,
    max_requests=20,
    time_window=60
)

# Or disable rate limiting
integration = PraisonAIWPIntegration(
    wp_client,
    enable_rate_limiting=False
)

Generation Failed After Retries

Error: Failed after 3 attempts: Connection timeout

Solutions:

Check internet connection
Verify OpenAI API status
Try again later
Check API key validity

Documentation

Core Documentation

README.md - This file (main documentation)
ARCHITECTURE.md - Technical architecture and design
TESTING.md - Testing guide and best practices
CHANGELOG.md - Version history and changes

AI Features (NEW in v1.1.0)

PRAISONAI.md - Complete AI integration guide
AI_DOCUMENTATION.md - Quick AI navigation
RELEASE_NOTES_v1.1.0.md - v1.1.0 release notes

Development

# Clone repository
git clone https://github.com/MervinPraison/PraisonAI-WPcli.git
cd PraisonAI-WPcli

# Install in development mode
pip install -e ".[dev]"

# Run tests
pytest

# Run with coverage
pytest --cov=praisonaiwp

# Format code
black praisonaiwp/

# Lint
flake8 praisonaiwp/

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

MIT License - see LICENSE file for details.

Author

Praison

Project details

These details have not been verified by PyPI

Project links

Release history Release notifications | RSS feed

1.11.9

Mar 26, 2026

1.11.8

Mar 24, 2026

1.11.7

Mar 11, 2026

1.11.6

Mar 10, 2026

1.11.5

Mar 6, 2026

1.11.4

Mar 5, 2026

1.11.3

Mar 1, 2026

1.11.2

Mar 1, 2026

1.11.1

Feb 2, 2026

1.10.0

Jan 31, 2026

1.9.5

Jan 20, 2026

1.9.4

Jan 20, 2026

1.9.3

Jan 18, 2026

1.9.2

Jan 18, 2026

1.9.1

Dec 28, 2025

1.9.0

Dec 23, 2025

1.8.0

Dec 22, 2025

1.7.0

Dec 22, 2025

1.5.1

Dec 22, 2025

1.5.0

Dec 22, 2025

1.4.3

Dec 22, 2025

1.4.2

Dec 21, 2025

1.4.1

Dec 21, 2025

1.3.3

Dec 20, 2025

1.3.2

Dec 16, 2025

1.3.1

Dec 16, 2025

1.3.0

Dec 16, 2025

1.2.0

Dec 16, 2025

1.1.9

Dec 15, 2025

1.1.8

Dec 15, 2025

1.1.7

Dec 15, 2025

1.1.6

Dec 14, 2025

1.1.5

Dec 14, 2025

This version

1.1.4

Nov 20, 2025

1.1.3

Nov 19, 2025

1.1.2

Nov 19, 2025

1.1.1

Nov 19, 2025

1.1.0

Nov 19, 2025

1.0.23

Dec 14, 2025

1.0.22

Nov 19, 2025

1.0.21

Nov 19, 2025

1.0.20

Nov 19, 2025

1.0.19

Nov 19, 2025

1.0.18

Nov 19, 2025

1.0.17

Nov 19, 2025

1.0.16

Nov 19, 2025

1.0.15

Nov 18, 2025

1.0.14

Nov 18, 2025

1.0.13

Nov 17, 2025

1.0.12

Nov 17, 2025

1.0.10

Nov 17, 2025

1.0.8

Nov 17, 2025

1.0.5

Nov 17, 2025

1.0.4

Oct 26, 2025

1.0.3

Oct 25, 2025

1.0.2

Oct 25, 2025

1.0.1

Oct 25, 2025

1.0.0

Oct 25, 2025

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

praisonaiwp-1.1.4.tar.gz (125.3 kB view details)

Uploaded Nov 20, 2025 Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

praisonaiwp-1.1.4-py3-none-any.whl (71.9 kB view details)

Uploaded Nov 20, 2025 Python 3

File details

Details for the file praisonaiwp-1.1.4.tar.gz.

File metadata

Download URL: praisonaiwp-1.1.4.tar.gz
Upload date: Nov 20, 2025
Size: 125.3 kB
Tags: Source
Uploaded using Trusted Publishing? No
Uploaded via: uv/0.8.22

File hashes

Hashes for praisonaiwp-1.1.4.tar.gz
Algorithm	Hash digest
SHA256	`b03f06f97e31581f9cd6013fffacff377e146027404016078d7d282f1f6f5da9`
MD5	`7b7fd92cf5f8cdbfae69abf550cb8dd4`
BLAKE2b-256	`4ffdcc9646256654a8e7918b2d79f5910b109596608fb321a8cf82c76c5a83dc`

See more details on using hashes here.

File details

Details for the file praisonaiwp-1.1.4-py3-none-any.whl.

File metadata

Download URL: praisonaiwp-1.1.4-py3-none-any.whl
Upload date: Nov 20, 2025
Size: 71.9 kB
Tags: Python 3
Uploaded using Trusted Publishing? No
Uploaded via: uv/0.8.22

File hashes

Hashes for praisonaiwp-1.1.4-py3-none-any.whl
Algorithm	Hash digest
SHA256	`da993c6143f986df94fbfffe999ba89068efba213d061d1551c638a631ee329c`
MD5	`ce147b066d3808449d232c4123d98ce1`
BLAKE2b-256	`0a3417f3d202886f5dd0acb232ef4297d96d6405d8f1c168b0f2e5dd0fd4fd03`

See more details on using hashes here.

praisonaiwp 1.1.4

Navigation

Verified details

Maintainers

Unverified details

Project links

Meta

Classifiers

Project description

PraisonAI WPcli

Features

🎉 NEW in v1.1.0: Production-Ready AI Integration!

🚀 NEW in v1.0.13: Universal WP-CLI Access!

Core Features

All Supported Features

📝 Post Management (6 methods)

🏷️ Post Meta (4 methods)

📂 Category/Term Management (8 methods)

👥 User Management (9 methods)

⚙️ Option Management (3 methods)

🔌 Plugin Management (3 methods)

🎨 Theme Management (2 methods)

📷 Media Management (1 method)

💬 Comment Management (6 methods)

🗄️ Cache Management (2 methods)

⏱️ Transient Management (3 methods)

🧭 Menu Management (4 methods)

🌐 Core Commands (2 methods)

💾 Database (2 methods)

🚀 Plus UNLIMITED via wp() Method!

Previous Updates (v1.0.2)

Installation

Using pip (Recommended)

Using uv (10x faster!)

From source

Quick Start

1. Initialize Configuration

2. Auto-Install WP-CLI (Optional)

3. Auto-Detect WordPress (Optional)

4. Create Posts

5. Update Posts

6. Find Text

7. List Posts

8. Manage Categories

9. AI Content Generation (NEW in v1.1.0)

AI Production Features

1. API Key Validation

2. Content Validation

3. Cost Tracking

4. Retry Logic with Exponential Backoff

5. Rate Limiting

6. Structured Logging

7. Enhanced Result Metadata

Cost Comparison

Configuration Options

Test Coverage

Complete CLI Reference

praisonaiwp create - Create Posts

praisonaiwp update - Update Posts

praisonaiwp list - List Posts

praisonaiwp find - Search Text

praisonaiwp category - Manage Categories

praisonaiwp ai - AI Content Generation (NEW in v1.1.0)

Important Notes for AI Agents

File Formats

JSON Format

YAML Format

CSV Format

Configuration

Advanced Usage

Line-Specific Replacement

Occurrence-Specific Replacement

Bulk Operations

Troubleshooting

SSH Connection Issues

WP-CLI Not Found

PHP MySQL Extension Missing

WordPress Path Not Found

AI Features Issues

API Key Not Set

🚀 Plus UNLIMITED via `wp()` Method!

`praisonaiwp create` - Create Posts

`praisonaiwp update` - Update Posts

`praisonaiwp list` - List Posts

`praisonaiwp find` - Search Text

`praisonaiwp category` - Manage Categories

`praisonaiwp ai` - AI Content Generation (NEW in v1.1.0)