Documentation

Getting Started with RemoteWP

Install the plugin and connect your AI agent — Claude, Cursor, Gemini, or ChatGPT — to your WordPress site via a secure REST API. No SSH, no FTP, no server configuration required.

⏱ Setup time: under 5 minutes

Download the RemoteWP Plugin

Download the RemoteWP plugin ZIP from remotewp.dev. The Free version is available immediately with no account required. Pro and Agency plans include a license key sent to your email after purchase.

💡 Free plan: Read-only access (list files, read contents, view site info) — perfect for testing before upgrading.

Upload and Activate in WordPress

Log into your WordPress admin dashboard. Go to Plugins → Add New → Upload Plugin. Select the remotewp.zip file, click Install Now, then Activate Plugin.

# WordPress admin navigation path:
Dashboard → Plugins → Add New → Upload Plugin
# Select ZIP → Install Now → Activate

Copy Your Unique API Token

After activation, go to Settings → RemoteWP in your WordPress admin. Your unique API token is displayed here. Copy it — this is your secure authentication key. Tokens are SHA-256 hashed and auto-expire after a configurable period (6h to 7 days).

🔐 Security note: Treat your API token like a password. Rotate it from the settings panel if you suspect it has been exposed. Expired tokens automatically become invalid.

Connect Your AI Agent

Open your AI agent and provide two pieces of information: your WordPress site URL and your API token. The agent uses these to authenticate all API requests. Below are example configurations for popular AI tools.

# Example: Claude / Cursor / Gemini system prompt addition

WordPress Site URL: https://yoursite.com
RemoteWP Token:    RW-your-token-here

# All API requests use this header:
X-RemoteWP-Token: RW-your-token-here

Test the Connection

Ask your AI agent to list the files in your WordPress theme directory. A successful response confirms the bridge is active and authentication is working.

# Test request — ask your AI agent:
"List the files in wp-content/themes/"

# What the AI sends under the hood:
GET /wp-json/remotewp/v1/list?path=wp-content/themes
X-RemoteWP-Token: RW-your-token-here

# Expected response: JSON array of directory contents

API Endpoint Reference

All endpoints are under /wp-json/remotewp/v1/ and require the X-RemoteWP-Token header.

Method	Endpoint	Description	Plan
GET	`/info`	Site info: WP version, active theme, plugin count	Free
GET	`/list?path=...`	List files and subdirectories in a path	Free
GET	`/read?path=...`	Read the contents of a file	Free
GET	`/plugins`	List all installed plugins and their status	Free
POST	`/write`	Write or update a file's content	Pro
POST	`/delete`	Delete a file from the filesystem	Pro
POST	`/mkdir`	Create a new directory	Pro
POST	`/search`	Search file contents by keyword across directories	Pro
POST	`/plugin/activate`	Activate an installed WordPress plugin	Pro
POST	`/plugin/deactivate`	Deactivate a WordPress plugin	Pro
GET	`/skill`	Built-in AI skill endpoint — returns integration instructions for AI agents	Pro

Ready to unlock full write access?

Upgrade to Developer Pro for full read/write automation, plugin management, and the Agent Skill Pack. Up to 10 WordPress sites for $79/year.

Get Developer Pro — $79/yr See All Plans