theme console
command

Starts the Shopify Liquid REPL (read-eval-print loop) tool. This tool provides an interactive terminal interface for evaluating Liquid code and exploring Liquid objects, filters, and tags using real store data.

You can also provide context to the console using a URL, as some Liquid objects are context-specific

Anchor to flagsFlags

The following flags are available for the theme console command:

Anchor to --no-color --no-color env: SHOPIFY_FLAG_NO_COLOR: Disable color output.
Anchor to --password <value> --password <value> string env: SHOPIFY_CLI_THEME_TOKEN: Password generated from the Theme Access app.
Anchor to --path <value> --path <value> string env: SHOPIFY_FLAG_PATH: The path where you want to run the command. Defaults to the current working directory.
Anchor to --store-password <value> --store-password <value> string env: SHOPIFY_FLAG_STORE_PASSWORD: The password for storefronts with password protection.
Anchor to --url <value> --url <value> string env: SHOPIFY_FLAG_URL: The url to be used as context
Anchor to --verbose --verbose env: SHOPIFY_FLAG_VERBOSE: Increase the verbosity of the output.
Anchor to -e, --environment <value> -e, --environment <value> string env: SHOPIFY_FLAG_ENVIRONMENT: The environment to apply to the current command.
Anchor to -s, --store <value> -s, --store <value> string env: SHOPIFY_FLAG_STORE: Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).

themeconsole

--no-color
Disable color output.
```
""
```
--password <value>
Password generated from the Theme Access app.
```
string
```
--path <value>
The path where you want to run the command. Defaults to the current working directory.
```
string
```
--store-password <value>
The password for storefronts with password protection.
```
string
```
--url <value>
The url to be used as context
```
string
```
--verbose
Increase the verbosity of the output.
```
""
```
-e, --environment <value>
The environment to apply to the current command.
```
string
```
-s, --store <value>
Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).
```
string
```

export interface themeconsole {
  /**
   * The environment to apply to the current command.
   * @environment SHOPIFY_FLAG_ENVIRONMENT
   */
  '-e, --environment <value>'?: string

  /**
   * Disable color output.
   * @environment SHOPIFY_FLAG_NO_COLOR
   */
  '--no-color'?: ''

  /**
   * Password generated from the Theme Access app.
   * @environment SHOPIFY_CLI_THEME_TOKEN
   */
  '--password <value>'?: string

  /**
   * The path where you want to run the command. Defaults to the current working directory.
   * @environment SHOPIFY_FLAG_PATH
   */
  '--path <value>'?: string

  /**
   * Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).
   * @environment SHOPIFY_FLAG_STORE
   */
  '-s, --store <value>'?: string

  /**
   * The password for storefronts with password protection.
   * @environment SHOPIFY_FLAG_STORE_PASSWORD
   */
  '--store-password <value>'?: string

  /**
   * The url to be used as context
   * @environment SHOPIFY_FLAG_URL
   */
  '--url <value>'?: string

  /**
   * Increase the verbosity of the output.
   * @environment SHOPIFY_FLAG_VERBOSE
   */
  '--verbose'?: ''
}

Was this section helpful?

Theme console

shopify theme console

shopify theme console --url /products/classic-leather-jacket

theme consolecommand

Anchor to flagsFlags

themeconsole

examples

theme console

theme console

theme console
command