KosmoKrator

productivity

WP Engine CLI for AI Agents

Use the WP Engine CLI from KosmoKrator to call WP Engine tools headlessly, return JSON, inspect schemas, and automate workflows from coding agents, scripts, and CI.

WP Engine CLI Setup

WP Engine can be configured headlessly with `kosmokrator integrations:configure wp-engine`.

Install, configure, and verify
# Install KosmoKrator first if it is not available on PATH.
curl -fsSL https://raw.githubusercontent.com/OpenCompanyApp/kosmokrator/main/install.sh | bash

# Configure and verify this integration.
kosmokrator integrations:configure wp-engine --set access_token="$WP_ENGINE_ACCESS_TOKEN" --enable --read allow --write ask --json
kosmokrator integrations:doctor wp-engine --json
kosmokrator integrations:status --json

Credentials

Authentication type: Bearer token bearer_token. Configure credentials once, then reuse the same stored profile from scripts, coding CLIs, Lua, and MCP.

KeyEnv varTypeRequiredLabel
access_token WP_ENGINE_ACCESS_TOKEN Secret secret yes API Token
url WP_ENGINE_URL URL url no API Base URL

Command Patterns

The generic command is stable across every integration. The provider shortcut is shorter for humans.

Generic CLI call
kosmo integrations:call wp-engine.wp_engine_list_sites '{"limit":1,"page":1}' --json
Provider shortcut
kosmo integrations:wp-engine wp_engine_list_sites '{"limit":1,"page":1}' --json

Discovery

These commands return structured output for coding agents that need to inspect capabilities before choosing a function.

Discovery commands
kosmo integrations:docs wp-engine --json
kosmo integrations:docs wp-engine.wp_engine_list_sites --json
kosmo integrations:schema wp-engine.wp_engine_list_sites --json
kosmo integrations:search "WP Engine" --json
kosmo integrations:list --json

Automation Contexts

The same configured command surface works in these environments. The command does not change unless the host wrapper, credentials, or permissions change.

CLI Functions

Every function below can be called headlessly. Commands are highlighted, copyable, and scroll horizontally when payloads are long.

wp-engine.wp_engine_list_sites

List WP Engine sites. Supports pagination with limit and page parameters.

Read read
Parameters
limit, page
Generic call
kosmo integrations:call wp-engine.wp_engine_list_sites '{"limit":1,"page":1}' --json
Shortcut
kosmo integrations:wp-engine wp_engine_list_sites '{"limit":1,"page":1}' --json

wp-engine.wp_engine_get_site

Get details for a specific WP Engine site by ID.

Read read
Parameters
id
Generic call
kosmo integrations:call wp-engine.wp_engine_get_site '{"id":"example_id"}' --json
Shortcut
kosmo integrations:wp-engine wp_engine_get_site '{"id":"example_id"}' --json

wp-engine.wp_engine_list_installs

List WP Engine installs. Supports pagination with limit and page parameters.

Read read
Parameters
limit, page
Generic call
kosmo integrations:call wp-engine.wp_engine_list_installs '{"limit":1,"page":1}' --json
Shortcut
kosmo integrations:wp-engine wp_engine_list_installs '{"limit":1,"page":1}' --json

wp-engine.wp_engine_get_install

Get details for a specific WP Engine install by ID.

Read read
Parameters
id
Generic call
kosmo integrations:call wp-engine.wp_engine_get_install '{"id":"example_id"}' --json
Shortcut
kosmo integrations:wp-engine wp_engine_get_install '{"id":"example_id"}' --json

wp-engine.wp_engine_list_domains

List domains across WP Engine installs. Supports pagination with limit and page parameters.

Read read
Parameters
limit, page
Generic call
kosmo integrations:call wp-engine.wp_engine_list_domains '{"limit":1,"page":1}' --json
Shortcut
kosmo integrations:wp-engine wp_engine_list_domains '{"limit":1,"page":1}' --json

wp-engine.wp_engine_list_users

List WP Engine users. Supports pagination with limit and page parameters.

Read read
Parameters
limit, page
Generic call
kosmo integrations:call wp-engine.wp_engine_list_users '{"limit":1,"page":1}' --json
Shortcut
kosmo integrations:wp-engine wp_engine_list_users '{"limit":1,"page":1}' --json

wp-engine.wp_engine_get_current_user

Get the profile of the currently authenticated WP Engine user. Useful for verifying credentials and displaying account information.

Read read
Parameters
none
Generic call
kosmo integrations:call wp-engine.wp_engine_get_current_user '{}' --json
Shortcut
kosmo integrations:wp-engine wp_engine_get_current_user '{}' --json

Function Schemas

Use these parameter tables when building CLI payloads without calling integrations:schema first.

wp-engine.wp_engine_list_sites 2 parameters
Schema command
kosmo integrations:schema wp-engine.wp_engine_list_sites --json
ParameterTypeRequiredDescription
limit integer no Number of sites per page (default: 100).
page integer no Page number for pagination (1-indexed, default: 1).
wp-engine.wp_engine_get_site 1 parameters
Schema command
kosmo integrations:schema wp-engine.wp_engine_get_site --json
ParameterTypeRequiredDescription
id string yes The site ID.
wp-engine.wp_engine_list_installs 2 parameters
Schema command
kosmo integrations:schema wp-engine.wp_engine_list_installs --json
ParameterTypeRequiredDescription
limit integer no Number of installs per page (default: 100).
page integer no Page number for pagination (1-indexed, default: 1).
wp-engine.wp_engine_get_install 1 parameters
Schema command
kosmo integrations:schema wp-engine.wp_engine_get_install --json
ParameterTypeRequiredDescription
id string yes The install ID.
wp-engine.wp_engine_list_domains 2 parameters
Schema command
kosmo integrations:schema wp-engine.wp_engine_list_domains --json
ParameterTypeRequiredDescription
limit integer no Number of domains per page (default: 100).
page integer no Page number for pagination (1-indexed, default: 1).
wp-engine.wp_engine_list_users 2 parameters
Schema command
kosmo integrations:schema wp-engine.wp_engine_list_users --json
ParameterTypeRequiredDescription
limit integer no Number of users per page (default: 100).
page integer no Page number for pagination (1-indexed, default: 1).
wp-engine.wp_engine_get_current_user 0 parameters
Schema command
kosmo integrations:schema wp-engine.wp_engine_get_current_user --json
ParameterTypeRequiredDescription
No parameters.

Permissions

Headless calls still follow the integration read/write permission policy. Configure read/write defaults with integrations:configure. Add --force only for trusted automation that should bypass that policy.