WP CLI with YAML

YAML parameters for WP CLI

Name Type Description
action Required String The name of the action.
type Required String The type of the action. Should be set to WP_CLI.
integration Required String The ID of the integration.
execute_commands Required String[] The commands that will be executed.
version Required String The version of the WordPress CLI.
shell String The name of the shell that will be used to execute commands. Can be one of SH (default) or BASH.
setup_commands String[] The command that will be executed only on the first run.
config String The WP CLI config set as text.
env_key String The WP CLI config set as asset.

YAML example for WP CLI

yaml
actions: - action: "Run WordPress CLI" type: "WP_CLI" trigger_time: "ON_EVERY_EXECUTION" shell: "SH" setup_commands: - "apt-get update && apt-get -y install git" execute_commands: - "wp admin" integration: "my_integration" version: "cli" config: "@staging:\n ssh: wpcli@staging.wp-cli.org"

Last modified on Mar 4, 2025