YAML for Theme Kit CLI

View as Markdown

Execute Shopify Theme Kit CLI commands with integration-based authentication.

YAML parameters for Theme Kit CLI

PARAMETERS

integrationrequiredstring

Shopify integration (SHOPIFY)

execute_commandsrequiredstring[]

List of shell commands to execute.

typerequiredstring

Value: SHOPIFY_THEMEKIT_CLI

actionrequiredstring

Unique identifier for the action within the pipeline.

themestring

The name of the Shopify theme

shellstring enum

Shell to use for executing commands: BASH (default), SH, or ZSH.

Allowed enum:

SH,

BASH,

POWERSHELL

setup_commandsstring[]

Commands to run before the main commands (e.g., for installing dependencies).

trigger_timestring enum

Specifies when the action should be executed.

Allowed enum:

ON_EVERY_EXECUTION,

ON_SUCCESS,

ON_FAILURE,

ON_BACK_TO_SUCCESS,

ON_WARNING,

ON_WAIT_FOR_APPROVE,

ON_TERMINATE

loopstring[]

The list of variables for dynamic action execution. The action runs once for each value.

run_only_on_first_failureboolean

Defines whether the action should be executed on each failure. Restricted to and required if the trigger_time is ON_FAILURE.

disabledboolean

When set to true the action is disabled. By default it is set to false.

timeoutinteger

The timeout in seconds.

ignore_errorsboolean

If set to true the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions.

retry_intervalinteger

Delay time between auto retries in seconds.

retry_countinteger

Number of retries if the action fails.

run_nextstring enum

Defines whether the action should run in parallel with the next one.

Allowed enum:

WAIT_ON_SUCCESS,

IN_SOFT_PARALLEL,

IN_HARD_PARALLEL

trigger_conditionsTriggerConditionYaml[]

The list of trigger conditions to meet so that the action can be triggered.

variablesVariableYaml[]

The list of variables you can use in the action.

Last modified on Jul 31, 2025

Terraform CLI Transfer

YAML examples for Theme Kit CLI

Shopify Theme Kit CLI

yaml
  - action: "Shopify theme"
    type: "SHOPIFY_THEMEKIT_CLI"
    setup_commands:
      - "apt-get update && apt-get -y install git"
    execute_commands:
      - "theme deploy"
    shell: "SH"
    integration: "my_integration"
    theme: "my_shopify_theme"