WP CLI with YAML

YAML parameters for WP CLI

NameTypeDescription
action
Required
StringThe name of the action.
type
Required
StringThe type of the action. Should be set to WP_CLI.
integration_hash
Required
StringThe ID of the integration.
execute_commands
Required
String[]The commands that will be executed.
version
Required
StringThe version of the WordPress CLI.
shellStringThe name of the shell that will be used to execute commands. Can be one of SH (default) or BASH.
setup_commandsString[]The command that will be executed only on the first run.
configStringThe WP CLI config set as text.
env_keyStringThe WP CLI config set as asset.

YAML example for WP CLI

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_hash: "5ddb7c180fb38be67bd78a88a"
  version: "cli"
  config: "@staging:\n  ssh: wpcli@staging.wp-cli.org"

Last modified on June 15, 2023

Questions?

Not sure how to configure a pipeline for your process? Reach out on the live-chat or contact support

Get Started

Sign up for free and deploy your project in less than 10 minutes.