generated_docs_data.json

[
  {
    "name": "app build",
    "description": "This command executes the build script specified in the element's TOML file. You can specify a custom script in the file. To learn about configuration files in Shopify apps, refer to [App configuration](/docs/apps/tools/cli/configuration).\n\n  If you're building a [theme app extension](/docs/apps/online-store/theme-app-extensions), then running the `build` command runs [Theme Check](/docs/themes/tools/theme-check) against your extension to ensure that it's valid.",
    "overviewPreviewDescription": "Build the app, including extensions.",
    "type": "command",
    "isVisualComponent": false,
    "defaultExample": {
      "codeblock": {
        "tabs": [
          {
            "title": "app build",
            "code": "shopify app build [flags]",
            "language": "bash"
          }
        ],
        "title": "app build"
      }
    },
    "definitions": [
      {
        "title": "Flags",
        "description": "The following flags are available for the `app build` command:",
        "type": "appbuild",
        "typeDefinitions": {
          "appbuild": {
            "filePath": "docs-shopify.dev/commands/interfaces/app-build.interface.ts",
            "name": "appbuild",
            "description": "",
            "members": [
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-build.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--client-id <value>",
                "value": "string",
                "description": "The Client ID of your app.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_CLIENT_ID"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-build.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--no-color",
                "value": "\"\"",
                "description": "Disable color output.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_NO_COLOR"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-build.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--path <value>",
                "value": "string",
                "description": "The path to your app directory.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_PATH"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-build.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--reset",
                "value": "\"\"",
                "description": "Reset all your settings.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_RESET"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-build.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--skip-dependencies-installation",
                "value": "\"\"",
                "description": "Skips the installation of dependencies. Deprecated, use workspaces instead.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_SKIP_DEPENDENCIES_INSTALLATION"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-build.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--verbose",
                "value": "\"\"",
                "description": "Increase the verbosity of the output.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_VERBOSE"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-build.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-c, --config <value>",
                "value": "string",
                "description": "The name of the app configuration.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_APP_CONFIG"
              }
            ],
            "value": "export interface appbuild {\n  /**\n   * The Client ID of your app.\n   * @environment SHOPIFY_FLAG_CLIENT_ID\n   */\n  '--client-id <value>'?: string\n\n  /**\n   * The name of the app configuration.\n   * @environment SHOPIFY_FLAG_APP_CONFIG\n   */\n  '-c, --config <value>'?: string\n\n  /**\n   * Disable color output.\n   * @environment SHOPIFY_FLAG_NO_COLOR\n   */\n  '--no-color'?: ''\n\n  /**\n   * The path to your app directory.\n   * @environment SHOPIFY_FLAG_PATH\n   */\n  '--path <value>'?: string\n\n  /**\n   * Reset all your settings.\n   * @environment SHOPIFY_FLAG_RESET\n   */\n  '--reset'?: ''\n\n  /**\n   * Skips the installation of dependencies. Deprecated, use workspaces instead.\n   * @environment SHOPIFY_FLAG_SKIP_DEPENDENCIES_INSTALLATION\n   */\n  '--skip-dependencies-installation'?: ''\n\n  /**\n   * Increase the verbosity of the output.\n   * @environment SHOPIFY_FLAG_VERBOSE\n   */\n  '--verbose'?: ''\n}"
          }
        }
      }
    ],
    "category": "app",
    "related": []
  },
  {
    "name": "app bulk cancel",
    "description": "Cancels a running bulk operation by ID.",
    "overviewPreviewDescription": "Cancel a bulk operation.",
    "type": "command",
    "isVisualComponent": false,
    "defaultExample": {
      "codeblock": {
        "tabs": [
          {
            "title": "app bulk cancel",
            "code": "shopify app bulk cancel [flags]",
            "language": "bash"
          }
        ],
        "title": "app bulk cancel"
      }
    },
    "definitions": [
      {
        "title": "Flags",
        "description": "The following flags are available for the `app bulk cancel` command:",
        "type": "appbulkcancel",
        "typeDefinitions": {
          "appbulkcancel": {
            "filePath": "docs-shopify.dev/commands/interfaces/app-bulk-cancel.interface.ts",
            "name": "appbulkcancel",
            "description": "",
            "members": [
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-bulk-cancel.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--client-id <value>",
                "value": "string",
                "description": "The Client ID of your app.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_CLIENT_ID"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-bulk-cancel.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--id <value>",
                "value": "string",
                "description": "The bulk operation ID to cancel (numeric ID or full GID).",
                "environmentValue": "SHOPIFY_FLAG_ID"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-bulk-cancel.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--no-color",
                "value": "\"\"",
                "description": "Disable color output.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_NO_COLOR"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-bulk-cancel.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--path <value>",
                "value": "string",
                "description": "The path to your app directory.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_PATH"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-bulk-cancel.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--reset",
                "value": "\"\"",
                "description": "Reset all your settings.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_RESET"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-bulk-cancel.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--verbose",
                "value": "\"\"",
                "description": "Increase the verbosity of the output.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_VERBOSE"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-bulk-cancel.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-c, --config <value>",
                "value": "string",
                "description": "The name of the app configuration.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_APP_CONFIG"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-bulk-cancel.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-s, --store <value>",
                "value": "string",
                "description": "The store domain. Must be an existing dev store.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_STORE"
              }
            ],
            "value": "export interface appbulkcancel {\n  /**\n   * The Client ID of your app.\n   * @environment SHOPIFY_FLAG_CLIENT_ID\n   */\n  '--client-id <value>'?: string\n\n  /**\n   * The name of the app configuration.\n   * @environment SHOPIFY_FLAG_APP_CONFIG\n   */\n  '-c, --config <value>'?: string\n\n  /**\n   * The bulk operation ID to cancel (numeric ID or full GID).\n   * @environment SHOPIFY_FLAG_ID\n   */\n  '--id <value>': string\n\n  /**\n   * Disable color output.\n   * @environment SHOPIFY_FLAG_NO_COLOR\n   */\n  '--no-color'?: ''\n\n  /**\n   * The path to your app directory.\n   * @environment SHOPIFY_FLAG_PATH\n   */\n  '--path <value>'?: string\n\n  /**\n   * Reset all your settings.\n   * @environment SHOPIFY_FLAG_RESET\n   */\n  '--reset'?: ''\n\n  /**\n   * The store domain. Must be an existing dev store.\n   * @environment SHOPIFY_FLAG_STORE\n   */\n  '-s, --store <value>'?: string\n\n  /**\n   * Increase the verbosity of the output.\n   * @environment SHOPIFY_FLAG_VERBOSE\n   */\n  '--verbose'?: ''\n}"
          }
        }
      }
    ],
    "category": "app",
    "related": []
  },
  {
    "name": "app bulk execute",
    "description": "Executes an Admin API GraphQL query or mutation on the specified store, as a bulk operation. Mutations are only allowed on dev stores.\n\n  Bulk operations allow you to process large amounts of data asynchronously. Learn more about [bulk query operations](/docs/api/usage/bulk-operations/queries) and [bulk mutation operations](/docs/api/usage/bulk-operations/imports).\n\n  Use [`bulk status`](/docs/api/shopify-cli/app/app-bulk-status) to check the status of your bulk operations.",
    "overviewPreviewDescription": "Execute bulk operations.",
    "type": "command",
    "isVisualComponent": false,
    "defaultExample": {
      "codeblock": {
        "tabs": [
          {
            "title": "app bulk execute",
            "code": "shopify app bulk execute [flags]",
            "language": "bash"
          }
        ],
        "title": "app bulk execute"
      }
    },
    "definitions": [
      {
        "title": "Flags",
        "description": "The following flags are available for the `app bulk execute` command:",
        "type": "appbulkexecute",
        "typeDefinitions": {
          "appbulkexecute": {
            "filePath": "docs-shopify.dev/commands/interfaces/app-bulk-execute.interface.ts",
            "name": "appbulkexecute",
            "description": "",
            "members": [
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-bulk-execute.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--client-id <value>",
                "value": "string",
                "description": "The Client ID of your app.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_CLIENT_ID"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-bulk-execute.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--no-color",
                "value": "\"\"",
                "description": "Disable color output.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_NO_COLOR"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-bulk-execute.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--output-file <value>",
                "value": "string",
                "description": "The file path where results should be written if --watch is specified. If not specified, results will be written to STDOUT.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_OUTPUT_FILE"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-bulk-execute.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--path <value>",
                "value": "string",
                "description": "The path to your app directory.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_PATH"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-bulk-execute.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--query-file <value>",
                "value": "string",
                "description": "Path to a file containing the GraphQL query or mutation. Can't be used with --query.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_QUERY_FILE"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-bulk-execute.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--reset",
                "value": "\"\"",
                "description": "Reset all your settings.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_RESET"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-bulk-execute.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--variable-file <value>",
                "value": "string",
                "description": "Path to a file containing GraphQL variables in JSONL format (one JSON object per line). Can't be used with --variables.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_VARIABLE_FILE"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-bulk-execute.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--verbose",
                "value": "\"\"",
                "description": "Increase the verbosity of the output.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_VERBOSE"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-bulk-execute.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--version <value>",
                "value": "string",
                "description": "The API version to use for the bulk operation. If not specified, uses the latest stable version.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_VERSION"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-bulk-execute.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--watch",
                "value": "\"\"",
                "description": "Wait for bulk operation results before exiting. Defaults to false.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_WATCH"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-bulk-execute.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-c, --config <value>",
                "value": "string",
                "description": "The name of the app configuration.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_APP_CONFIG"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-bulk-execute.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-q, --query <value>",
                "value": "string",
                "description": "The GraphQL query or mutation to run as a bulk operation.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_QUERY"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-bulk-execute.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-s, --store <value>",
                "value": "string",
                "description": "The store domain. Must be an existing dev store.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_STORE"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-bulk-execute.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-v, --variables <value>",
                "value": "string",
                "description": "The values for any GraphQL variables in your mutation, in JSON format. Can be specified multiple times.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_VARIABLES"
              }
            ],
            "value": "export interface appbulkexecute {\n  /**\n   * The Client ID of your app.\n   * @environment SHOPIFY_FLAG_CLIENT_ID\n   */\n  '--client-id <value>'?: string\n\n  /**\n   * The name of the app configuration.\n   * @environment SHOPIFY_FLAG_APP_CONFIG\n   */\n  '-c, --config <value>'?: string\n\n  /**\n   * Disable color output.\n   * @environment SHOPIFY_FLAG_NO_COLOR\n   */\n  '--no-color'?: ''\n\n  /**\n   * The file path where results should be written if --watch is specified. If not specified, results will be written to STDOUT.\n   * @environment SHOPIFY_FLAG_OUTPUT_FILE\n   */\n  '--output-file <value>'?: string\n\n  /**\n   * The path to your app directory.\n   * @environment SHOPIFY_FLAG_PATH\n   */\n  '--path <value>'?: string\n\n  /**\n   * The GraphQL query or mutation to run as a bulk operation.\n   * @environment SHOPIFY_FLAG_QUERY\n   */\n  '-q, --query <value>'?: string\n\n  /**\n   * Path to a file containing the GraphQL query or mutation. Can't be used with --query.\n   * @environment SHOPIFY_FLAG_QUERY_FILE\n   */\n  '--query-file <value>'?: string\n\n  /**\n   * Reset all your settings.\n   * @environment SHOPIFY_FLAG_RESET\n   */\n  '--reset'?: ''\n\n  /**\n   * The store domain. Must be an existing dev store.\n   * @environment SHOPIFY_FLAG_STORE\n   */\n  '-s, --store <value>'?: string\n\n  /**\n   * Path to a file containing GraphQL variables in JSONL format (one JSON object per line). Can't be used with --variables.\n   * @environment SHOPIFY_FLAG_VARIABLE_FILE\n   */\n  '--variable-file <value>'?: string\n\n  /**\n   * The values for any GraphQL variables in your mutation, in JSON format. Can be specified multiple times.\n   * @environment SHOPIFY_FLAG_VARIABLES\n   */\n  '-v, --variables <value>'?: string\n\n  /**\n   * Increase the verbosity of the output.\n   * @environment SHOPIFY_FLAG_VERBOSE\n   */\n  '--verbose'?: ''\n\n  /**\n   * The API version to use for the bulk operation. If not specified, uses the latest stable version.\n   * @environment SHOPIFY_FLAG_VERSION\n   */\n  '--version <value>'?: string\n\n  /**\n   * Wait for bulk operation results before exiting. Defaults to false.\n   * @environment SHOPIFY_FLAG_WATCH\n   */\n  '--watch'?: ''\n}"
          }
        }
      }
    ],
    "category": "app",
    "related": []
  },
  {
    "name": "app bulk status",
    "description": "Check the status of a specific bulk operation by ID, or list all bulk operations belonging to this app on this store in the last 7 days.\n\n  Bulk operations allow you to process large amounts of data asynchronously. Learn more about [bulk query operations](/docs/api/usage/bulk-operations/queries) and [bulk mutation operations](/docs/api/usage/bulk-operations/imports).\n\n  Use [`bulk execute`](/docs/api/shopify-cli/app/app-bulk-execute) to start a new bulk operation.",
    "overviewPreviewDescription": "Check the status of bulk operations.",
    "type": "command",
    "isVisualComponent": false,
    "defaultExample": {
      "codeblock": {
        "tabs": [
          {
            "title": "app bulk status",
            "code": "shopify app bulk status [flags]",
            "language": "bash"
          }
        ],
        "title": "app bulk status"
      }
    },
    "definitions": [
      {
        "title": "Flags",
        "description": "The following flags are available for the `app bulk status` command:",
        "type": "appbulkstatus",
        "typeDefinitions": {
          "appbulkstatus": {
            "filePath": "docs-shopify.dev/commands/interfaces/app-bulk-status.interface.ts",
            "name": "appbulkstatus",
            "description": "",
            "members": [
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-bulk-status.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--client-id <value>",
                "value": "string",
                "description": "The Client ID of your app.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_CLIENT_ID"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-bulk-status.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--id <value>",
                "value": "string",
                "description": "The bulk operation ID (numeric ID or full GID). If not provided, lists all bulk operations belonging to this app on this store in the last 7 days.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_ID"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-bulk-status.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--no-color",
                "value": "\"\"",
                "description": "Disable color output.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_NO_COLOR"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-bulk-status.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--path <value>",
                "value": "string",
                "description": "The path to your app directory.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_PATH"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-bulk-status.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--reset",
                "value": "\"\"",
                "description": "Reset all your settings.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_RESET"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-bulk-status.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--verbose",
                "value": "\"\"",
                "description": "Increase the verbosity of the output.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_VERBOSE"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-bulk-status.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-c, --config <value>",
                "value": "string",
                "description": "The name of the app configuration.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_APP_CONFIG"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-bulk-status.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-s, --store <value>",
                "value": "string",
                "description": "The store domain. Must be an existing dev store.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_STORE"
              }
            ],
            "value": "export interface appbulkstatus {\n  /**\n   * The Client ID of your app.\n   * @environment SHOPIFY_FLAG_CLIENT_ID\n   */\n  '--client-id <value>'?: string\n\n  /**\n   * The name of the app configuration.\n   * @environment SHOPIFY_FLAG_APP_CONFIG\n   */\n  '-c, --config <value>'?: string\n\n  /**\n   * The bulk operation ID (numeric ID or full GID). If not provided, lists all bulk operations belonging to this app on this store in the last 7 days.\n   * @environment SHOPIFY_FLAG_ID\n   */\n  '--id <value>'?: string\n\n  /**\n   * Disable color output.\n   * @environment SHOPIFY_FLAG_NO_COLOR\n   */\n  '--no-color'?: ''\n\n  /**\n   * The path to your app directory.\n   * @environment SHOPIFY_FLAG_PATH\n   */\n  '--path <value>'?: string\n\n  /**\n   * Reset all your settings.\n   * @environment SHOPIFY_FLAG_RESET\n   */\n  '--reset'?: ''\n\n  /**\n   * The store domain. Must be an existing dev store.\n   * @environment SHOPIFY_FLAG_STORE\n   */\n  '-s, --store <value>'?: string\n\n  /**\n   * Increase the verbosity of the output.\n   * @environment SHOPIFY_FLAG_VERBOSE\n   */\n  '--verbose'?: ''\n}"
          }
        }
      }
    ],
    "category": "app",
    "related": []
  },
  {
    "name": "app config link",
    "description": "Pulls app configuration from the Developer Dashboard and creates or overwrites a configuration file. You can create a new app with this command to start with a default configuration file.\n\n  For more information on the format of the created TOML configuration file, refer to the [App configuration](/docs/apps/tools/cli/configuration) page.\n  ",
    "overviewPreviewDescription": "Fetch your app configuration from the Developer Dashboard.",
    "type": "command",
    "isVisualComponent": false,
    "defaultExample": {
      "codeblock": {
        "tabs": [
          {
            "title": "app config link",
            "code": "shopify app config link [flags]",
            "language": "bash"
          }
        ],
        "title": "app config link"
      }
    },
    "definitions": [
      {
        "title": "Flags",
        "description": "The following flags are available for the `app config link` command:",
        "type": "appconfiglink",
        "typeDefinitions": {
          "appconfiglink": {
            "filePath": "docs-shopify.dev/commands/interfaces/app-config-link.interface.ts",
            "name": "appconfiglink",
            "description": "",
            "members": [
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-config-link.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--client-id <value>",
                "value": "string",
                "description": "The Client ID of your app.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_CLIENT_ID"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-config-link.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--no-color",
                "value": "\"\"",
                "description": "Disable color output.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_NO_COLOR"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-config-link.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--path <value>",
                "value": "string",
                "description": "The path to your app directory.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_PATH"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-config-link.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--reset",
                "value": "\"\"",
                "description": "Reset all your settings.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_RESET"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-config-link.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--verbose",
                "value": "\"\"",
                "description": "Increase the verbosity of the output.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_VERBOSE"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-config-link.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-c, --config <value>",
                "value": "string",
                "description": "The name of the app configuration.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_APP_CONFIG"
              }
            ],
            "value": "export interface appconfiglink {\n  /**\n   * The Client ID of your app.\n   * @environment SHOPIFY_FLAG_CLIENT_ID\n   */\n  '--client-id <value>'?: string\n\n  /**\n   * The name of the app configuration.\n   * @environment SHOPIFY_FLAG_APP_CONFIG\n   */\n  '-c, --config <value>'?: string\n\n  /**\n   * Disable color output.\n   * @environment SHOPIFY_FLAG_NO_COLOR\n   */\n  '--no-color'?: ''\n\n  /**\n   * The path to your app directory.\n   * @environment SHOPIFY_FLAG_PATH\n   */\n  '--path <value>'?: string\n\n  /**\n   * Reset all your settings.\n   * @environment SHOPIFY_FLAG_RESET\n   */\n  '--reset'?: ''\n\n  /**\n   * Increase the verbosity of the output.\n   * @environment SHOPIFY_FLAG_VERBOSE\n   */\n  '--verbose'?: ''\n}"
          }
        }
      }
    ],
    "category": "app",
    "related": []
  },
  {
    "name": "app config pull",
    "description": "Pulls the latest configuration from the already-linked Shopify app and updates the selected configuration file.\n\nThis command reuses the existing linked app and organization and skips all interactive prompts. Use `--config` to target a specific configuration file, or omit it to use the default one.",
    "overviewPreviewDescription": "Refresh an already-linked app configuration without prompts.",
    "type": "command",
    "isVisualComponent": false,
    "defaultExample": {
      "codeblock": {
        "tabs": [
          {
            "title": "app config pull",
            "code": "shopify app config pull [flags]",
            "language": "bash"
          }
        ],
        "title": "app config pull"
      }
    },
    "definitions": [
      {
        "title": "Flags",
        "description": "The following flags are available for the `app config pull` command:",
        "type": "appconfigpull",
        "typeDefinitions": {
          "appconfigpull": {
            "filePath": "docs-shopify.dev/commands/interfaces/app-config-pull.interface.ts",
            "name": "appconfigpull",
            "description": "",
            "members": [
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-config-pull.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--client-id <value>",
                "value": "string",
                "description": "The Client ID of your app.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_CLIENT_ID"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-config-pull.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--no-color",
                "value": "\"\"",
                "description": "Disable color output.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_NO_COLOR"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-config-pull.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--path <value>",
                "value": "string",
                "description": "The path to your app directory.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_PATH"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-config-pull.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--reset",
                "value": "\"\"",
                "description": "Reset all your settings.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_RESET"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-config-pull.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--verbose",
                "value": "\"\"",
                "description": "Increase the verbosity of the output.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_VERBOSE"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-config-pull.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-c, --config <value>",
                "value": "string",
                "description": "The name of the app configuration.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_APP_CONFIG"
              }
            ],
            "value": "export interface appconfigpull {\n  /**\n   * The Client ID of your app.\n   * @environment SHOPIFY_FLAG_CLIENT_ID\n   */\n  '--client-id <value>'?: string\n\n  /**\n   * The name of the app configuration.\n   * @environment SHOPIFY_FLAG_APP_CONFIG\n   */\n  '-c, --config <value>'?: string\n\n  /**\n   * Disable color output.\n   * @environment SHOPIFY_FLAG_NO_COLOR\n   */\n  '--no-color'?: ''\n\n  /**\n   * The path to your app directory.\n   * @environment SHOPIFY_FLAG_PATH\n   */\n  '--path <value>'?: string\n\n  /**\n   * Reset all your settings.\n   * @environment SHOPIFY_FLAG_RESET\n   */\n  '--reset'?: ''\n\n  /**\n   * Increase the verbosity of the output.\n   * @environment SHOPIFY_FLAG_VERBOSE\n   */\n  '--verbose'?: ''\n}"
          }
        }
      }
    ],
    "category": "app",
    "related": []
  },
  {
    "name": "app config use",
    "description": "Sets default configuration when you run app-related CLI commands. If you omit the `config-name` parameter, then you'll be prompted to choose from the configuration files in your project.",
    "overviewPreviewDescription": "Activate an app configuration.",
    "type": "command",
    "isVisualComponent": false,
    "defaultExample": {
      "codeblock": {
        "tabs": [
          {
            "title": "app config use",
            "code": "shopify app config use [config] [flags]",
            "language": "bash"
          }
        ],
        "title": "app config use"
      }
    },
    "definitions": [
      {
        "title": "Flags",
        "description": "The following flags are available for the `app config use` command:",
        "type": "appconfiguse",
        "typeDefinitions": {
          "appconfiguse": {
            "filePath": "docs-shopify.dev/commands/interfaces/app-config-use.interface.ts",
            "name": "appconfiguse",
            "description": "",
            "members": [
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-config-use.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--client-id <value>",
                "value": "string",
                "description": "The Client ID of your app.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_CLIENT_ID"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-config-use.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--no-color",
                "value": "\"\"",
                "description": "Disable color output.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_NO_COLOR"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-config-use.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--path <value>",
                "value": "string",
                "description": "The path to your app directory.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_PATH"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-config-use.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--reset",
                "value": "\"\"",
                "description": "Reset all your settings.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_RESET"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-config-use.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--verbose",
                "value": "\"\"",
                "description": "Increase the verbosity of the output.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_VERBOSE"
              }
            ],
            "value": "export interface appconfiguse {\n  /**\n   * The Client ID of your app.\n   * @environment SHOPIFY_FLAG_CLIENT_ID\n   */\n  '--client-id <value>'?: string\n\n  /**\n   * Disable color output.\n   * @environment SHOPIFY_FLAG_NO_COLOR\n   */\n  '--no-color'?: ''\n\n  /**\n   * The path to your app directory.\n   * @environment SHOPIFY_FLAG_PATH\n   */\n  '--path <value>'?: string\n\n  /**\n   * Reset all your settings.\n   * @environment SHOPIFY_FLAG_RESET\n   */\n  '--reset'?: ''\n\n  /**\n   * Increase the verbosity of the output.\n   * @environment SHOPIFY_FLAG_VERBOSE\n   */\n  '--verbose'?: ''\n}"
          }
        }
      }
    ],
    "category": "app",
    "related": []
  },
  {
    "name": "app deploy",
    "description": "[Builds the app](/docs/api/shopify-cli/app/app-build), then deploys your app configuration and extensions.\n\n  This command creates an app version, which is a snapshot of your app configuration and all extensions. This version is then released to users.\n\n  This command doesn't deploy your [web app](/docs/apps/tools/cli/structure#web-components). You need to [deploy your web app](/docs/apps/deployment/web) to your own hosting solution.\n  ",
    "overviewPreviewDescription": "Deploy your Shopify app.",
    "type": "command",
    "isVisualComponent": false,
    "defaultExample": {
      "codeblock": {
        "tabs": [
          {
            "title": "app deploy",
            "code": "shopify app deploy [flags]",
            "language": "bash"
          }
        ],
        "title": "app deploy"
      }
    },
    "definitions": [
      {
        "title": "Flags",
        "description": "The following flags are available for the `app deploy` command:",
        "type": "appdeploy",
        "typeDefinitions": {
          "appdeploy": {
            "filePath": "docs-shopify.dev/commands/interfaces/app-deploy.interface.ts",
            "name": "appdeploy",
            "description": "",
            "members": [
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-deploy.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--allow-deletes",
                "value": "\"\"",
                "description": "Allows removing extensions and configuration without requiring user confirmation. For CI/CD environments, the recommended flag is --allow-updates.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_ALLOW_DELETES"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-deploy.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--allow-updates",
                "value": "\"\"",
                "description": "Allows adding and updating extensions and configuration without requiring user confirmation. Recommended option for CI/CD environments.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_ALLOW_UPDATES"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-deploy.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--client-id <value>",
                "value": "string",
                "description": "The Client ID of your app.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_CLIENT_ID"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-deploy.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--message <value>",
                "value": "string",
                "description": "Optional message that will be associated with this version. This is for internal use only and won't be available externally.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_MESSAGE"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-deploy.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--no-build",
                "value": "\"\"",
                "description": "Use with caution: Skips building any elements of the app that require building. You should ensure your app has been prepared in advance, such as by running `shopify app build` or by caching build artifacts.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_NO_BUILD"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-deploy.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--no-color",
                "value": "\"\"",
                "description": "Disable color output.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_NO_COLOR"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-deploy.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--no-release",
                "value": "\"\"",
                "description": "Creates a version but doesn't release it - it's not made available to merchants. With this flag, a user confirmation is not required.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_NO_RELEASE"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-deploy.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--path <value>",
                "value": "string",
                "description": "The path to your app directory.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_PATH"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-deploy.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--reset",
                "value": "\"\"",
                "description": "Reset all your settings.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_RESET"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-deploy.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--source-control-url <value>",
                "value": "string",
                "description": "URL associated with the new app version.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_SOURCE_CONTROL_URL"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-deploy.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--verbose",
                "value": "\"\"",
                "description": "Increase the verbosity of the output.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_VERBOSE"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-deploy.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--version <value>",
                "value": "string",
                "description": "Optional version tag that will be associated with this app version. If not provided, an auto-generated identifier will be generated for this app version.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_VERSION"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-deploy.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-c, --config <value>",
                "value": "string",
                "description": "The name of the app configuration.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_APP_CONFIG"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-deploy.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-f, --force",
                "value": "\"\"",
                "description": "Deploy without asking for confirmation. Equivalent to --allow-updates --allow-deletes. For CI/CD environments, the recommended flag is --allow-updates.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_FORCE"
              }
            ],
            "value": "export interface appdeploy {\n  /**\n   * Allows removing extensions and configuration without requiring user confirmation. For CI/CD environments, the recommended flag is --allow-updates.\n   * @environment SHOPIFY_FLAG_ALLOW_DELETES\n   */\n  '--allow-deletes'?: ''\n\n  /**\n   * Allows adding and updating extensions and configuration without requiring user confirmation. Recommended option for CI/CD environments.\n   * @environment SHOPIFY_FLAG_ALLOW_UPDATES\n   */\n  '--allow-updates'?: ''\n\n  /**\n   * The Client ID of your app.\n   * @environment SHOPIFY_FLAG_CLIENT_ID\n   */\n  '--client-id <value>'?: string\n\n  /**\n   * The name of the app configuration.\n   * @environment SHOPIFY_FLAG_APP_CONFIG\n   */\n  '-c, --config <value>'?: string\n\n  /**\n   * Deploy without asking for confirmation. Equivalent to --allow-updates --allow-deletes. For CI/CD environments, the recommended flag is --allow-updates.\n   * @environment SHOPIFY_FLAG_FORCE\n   */\n  '-f, --force'?: ''\n\n  /**\n   * Optional message that will be associated with this version. This is for internal use only and won't be available externally.\n   * @environment SHOPIFY_FLAG_MESSAGE\n   */\n  '--message <value>'?: string\n\n  /**\n   * Use with caution: Skips building any elements of the app that require building. You should ensure your app has been prepared in advance, such as by running `shopify app build` or by caching build artifacts.\n   * @environment SHOPIFY_FLAG_NO_BUILD\n   */\n  '--no-build'?: ''\n\n  /**\n   * Disable color output.\n   * @environment SHOPIFY_FLAG_NO_COLOR\n   */\n  '--no-color'?: ''\n\n  /**\n   * Creates a version but doesn't release it - it's not made available to merchants. With this flag, a user confirmation is not required.\n   * @environment SHOPIFY_FLAG_NO_RELEASE\n   */\n  '--no-release'?: ''\n\n  /**\n   * The path to your app directory.\n   * @environment SHOPIFY_FLAG_PATH\n   */\n  '--path <value>'?: string\n\n  /**\n   * Reset all your settings.\n   * @environment SHOPIFY_FLAG_RESET\n   */\n  '--reset'?: ''\n\n  /**\n   * URL associated with the new app version.\n   * @environment SHOPIFY_FLAG_SOURCE_CONTROL_URL\n   */\n  '--source-control-url <value>'?: string\n\n  /**\n   * Increase the verbosity of the output.\n   * @environment SHOPIFY_FLAG_VERBOSE\n   */\n  '--verbose'?: ''\n\n  /**\n   * Optional version tag that will be associated with this app version. If not provided, an auto-generated identifier will be generated for this app version.\n   * @environment SHOPIFY_FLAG_VERSION\n   */\n  '--version <value>'?: string\n}"
          }
        }
      }
    ],
    "category": "app",
    "related": []
  },
  {
    "name": "app dev clean",
    "description": "Stop the dev preview that was started with `shopify app dev`.\n\n  It restores the app's active version to the selected development store.\n  ",
    "overviewPreviewDescription": "Cleans up the dev preview from the selected store.",
    "type": "command",
    "isVisualComponent": false,
    "defaultExample": {
      "codeblock": {
        "tabs": [
          {
            "title": "app dev clean",
            "code": "shopify app dev clean [flags]",
            "language": "bash"
          }
        ],
        "title": "app dev clean"
      }
    },
    "definitions": [
      {
        "title": "Flags",
        "description": "The following flags are available for the `app dev clean` command:",
        "type": "appdevclean",
        "typeDefinitions": {
          "appdevclean": {
            "filePath": "docs-shopify.dev/commands/interfaces/app-dev-clean.interface.ts",
            "name": "appdevclean",
            "description": "",
            "members": [
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-dev-clean.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--client-id <value>",
                "value": "string",
                "description": "The Client ID of your app.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_CLIENT_ID"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-dev-clean.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--no-color",
                "value": "\"\"",
                "description": "Disable color output.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_NO_COLOR"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-dev-clean.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--path <value>",
                "value": "string",
                "description": "The path to your app directory.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_PATH"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-dev-clean.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--reset",
                "value": "\"\"",
                "description": "Reset all your settings.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_RESET"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-dev-clean.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--verbose",
                "value": "\"\"",
                "description": "Increase the verbosity of the output.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_VERBOSE"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-dev-clean.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-c, --config <value>",
                "value": "string",
                "description": "The name of the app configuration.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_APP_CONFIG"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-dev-clean.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-s, --store <value>",
                "value": "string",
                "description": "Store URL. Must be an existing development store.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_STORE"
              }
            ],
            "value": "export interface appdevclean {\n  /**\n   * The Client ID of your app.\n   * @environment SHOPIFY_FLAG_CLIENT_ID\n   */\n  '--client-id <value>'?: string\n\n  /**\n   * The name of the app configuration.\n   * @environment SHOPIFY_FLAG_APP_CONFIG\n   */\n  '-c, --config <value>'?: string\n\n  /**\n   * Disable color output.\n   * @environment SHOPIFY_FLAG_NO_COLOR\n   */\n  '--no-color'?: ''\n\n  /**\n   * The path to your app directory.\n   * @environment SHOPIFY_FLAG_PATH\n   */\n  '--path <value>'?: string\n\n  /**\n   * Reset all your settings.\n   * @environment SHOPIFY_FLAG_RESET\n   */\n  '--reset'?: ''\n\n  /**\n   * Store URL. Must be an existing development store.\n   * @environment SHOPIFY_FLAG_STORE\n   */\n  '-s, --store <value>'?: string\n\n  /**\n   * Increase the verbosity of the output.\n   * @environment SHOPIFY_FLAG_VERBOSE\n   */\n  '--verbose'?: ''\n}"
          }
        }
      }
    ],
    "category": "app",
    "related": []
  },
  {
    "name": "app dev",
    "description": "Builds and previews your app on a dev store, and watches for changes. [Read more about testing apps locally](/docs/apps/build/cli-for-apps/test-apps-locally).",
    "overviewPreviewDescription": "Run the app.",
    "type": "command",
    "isVisualComponent": false,
    "defaultExample": {
      "codeblock": {
        "tabs": [
          {
            "title": "app dev",
            "code": "shopify app dev [flags]",
            "language": "bash"
          }
        ],
        "title": "app dev"
      }
    },
    "definitions": [
      {
        "title": "Flags",
        "description": "The following flags are available for the `app dev` command:",
        "type": "appdev",
        "typeDefinitions": {
          "appdev": {
            "filePath": "docs-shopify.dev/commands/interfaces/app-dev.interface.ts",
            "name": "appdev",
            "description": "",
            "members": [
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-dev.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--checkout-cart-url <value>",
                "value": "string",
                "description": "Resource URL for checkout UI extension. Format: \"/cart/{productVariantID}:{productQuantity}\"",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_CHECKOUT_CART_URL"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-dev.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--client-id <value>",
                "value": "string",
                "description": "The Client ID of your app.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_CLIENT_ID"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-dev.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--localhost-port <value>",
                "value": "string",
                "description": "Port to use for localhost.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_LOCALHOST_PORT"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-dev.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--no-color",
                "value": "\"\"",
                "description": "Disable color output.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_NO_COLOR"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-dev.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--no-update",
                "value": "\"\"",
                "description": "Uses the app URL from the toml file instead an autogenerated URL for dev.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_NO_UPDATE"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-dev.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--notify <value>",
                "value": "string",
                "description": "The file path or URL. The file path is to a file that you want updated on idle. The URL path is where you want a webhook posted to report on file changes.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_NOTIFY"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-dev.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--path <value>",
                "value": "string",
                "description": "The path to your app directory.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_PATH"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-dev.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--reset",
                "value": "\"\"",
                "description": "Reset all your settings.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_RESET"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-dev.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--skip-dependencies-installation",
                "value": "\"\"",
                "description": "Skips the installation of dependencies. Deprecated, use workspaces instead.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_SKIP_DEPENDENCIES_INSTALLATION"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-dev.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--subscription-product-url <value>",
                "value": "string",
                "description": "Resource URL for subscription UI extension. Format: \"/products/{productId}\"",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_SUBSCRIPTION_PRODUCT_URL"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-dev.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--theme-app-extension-port <value>",
                "value": "string",
                "description": "Local port of the theme app extension development server.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_THEME_APP_EXTENSION_PORT"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-dev.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--tunnel-url <value>",
                "value": "string",
                "description": "Use a custom tunnel, it must be running before executing dev. Format: \"https://my-tunnel-url:port\".",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_TUNNEL_URL"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-dev.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--use-localhost",
                "value": "\"\"",
                "description": "Service entry point will listen to localhost. A tunnel won't be used. Will work for testing many app features, but not those that directly invoke your app (E.g: Webhooks)",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_USE_LOCALHOST"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-dev.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--verbose",
                "value": "\"\"",
                "description": "Increase the verbosity of the output.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_VERBOSE"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-dev.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-c, --config <value>",
                "value": "string",
                "description": "The name of the app configuration.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_APP_CONFIG"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-dev.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-s, --store <value>",
                "value": "string",
                "description": "Store URL. Must be an existing development or Shopify Plus sandbox store.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_STORE"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-dev.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-t, --theme <value>",
                "value": "string",
                "description": "Theme ID or name of the theme app extension host theme.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_THEME"
              }
            ],
            "value": "export interface appdev {\n  /**\n   * Resource URL for checkout UI extension. Format: \"/cart/{productVariantID}:{productQuantity}\"\n   * @environment SHOPIFY_FLAG_CHECKOUT_CART_URL\n   */\n  '--checkout-cart-url <value>'?: string\n\n  /**\n   * The Client ID of your app.\n   * @environment SHOPIFY_FLAG_CLIENT_ID\n   */\n  '--client-id <value>'?: string\n\n  /**\n   * The name of the app configuration.\n   * @environment SHOPIFY_FLAG_APP_CONFIG\n   */\n  '-c, --config <value>'?: string\n\n  /**\n   * Port to use for localhost.\n   * @environment SHOPIFY_FLAG_LOCALHOST_PORT\n   */\n  '--localhost-port <value>'?: string\n\n  /**\n   * Disable color output.\n   * @environment SHOPIFY_FLAG_NO_COLOR\n   */\n  '--no-color'?: ''\n\n  /**\n   * Uses the app URL from the toml file instead an autogenerated URL for dev.\n   * @environment SHOPIFY_FLAG_NO_UPDATE\n   */\n  '--no-update'?: ''\n\n  /**\n   * The file path or URL. The file path is to a file that you want updated on idle. The URL path is where you want a webhook posted to report on file changes.\n   * @environment SHOPIFY_FLAG_NOTIFY\n   */\n  '--notify <value>'?: string\n\n  /**\n   * The path to your app directory.\n   * @environment SHOPIFY_FLAG_PATH\n   */\n  '--path <value>'?: string\n\n  /**\n   * Reset all your settings.\n   * @environment SHOPIFY_FLAG_RESET\n   */\n  '--reset'?: ''\n\n  /**\n   * Skips the installation of dependencies. Deprecated, use workspaces instead.\n   * @environment SHOPIFY_FLAG_SKIP_DEPENDENCIES_INSTALLATION\n   */\n  '--skip-dependencies-installation'?: ''\n\n  /**\n   * Store URL. Must be an existing development or Shopify Plus sandbox store.\n   * @environment SHOPIFY_FLAG_STORE\n   */\n  '-s, --store <value>'?: string\n\n  /**\n   * Resource URL for subscription UI extension. Format: \"/products/{productId}\"\n   * @environment SHOPIFY_FLAG_SUBSCRIPTION_PRODUCT_URL\n   */\n  '--subscription-product-url <value>'?: string\n\n  /**\n   * Theme ID or name of the theme app extension host theme.\n   * @environment SHOPIFY_FLAG_THEME\n   */\n  '-t, --theme <value>'?: string\n\n  /**\n   * Local port of the theme app extension development server.\n   * @environment SHOPIFY_FLAG_THEME_APP_EXTENSION_PORT\n   */\n  '--theme-app-extension-port <value>'?: string\n\n  /**\n   * Use a custom tunnel, it must be running before executing dev. Format: \"https://my-tunnel-url:port\".\n   * @environment SHOPIFY_FLAG_TUNNEL_URL\n   */\n  '--tunnel-url <value>'?: string\n\n  /**\n   * Service entry point will listen to localhost. A tunnel won't be used. Will work for testing many app features, but not those that directly invoke your app (E.g: Webhooks)\n   * @environment SHOPIFY_FLAG_USE_LOCALHOST\n   */\n  '--use-localhost'?: ''\n\n  /**\n   * Increase the verbosity of the output.\n   * @environment SHOPIFY_FLAG_VERBOSE\n   */\n  '--verbose'?: ''\n}"
          }
        }
      }
    ],
    "category": "app",
    "related": []
  },
  {
    "name": "app env pull",
    "description": "Creates or updates an `.env` files that contains app and app extension environment variables.\n\n  When an existing `.env` file is updated, changes to the variables are displayed in the terminal output. Existing variables and commented variables are preserved.",
    "overviewPreviewDescription": "Pull app and extensions environment variables.",
    "type": "command",
    "isVisualComponent": false,
    "defaultExample": {
      "codeblock": {
        "tabs": [
          {
            "title": "app env pull",
            "code": "shopify app env pull [flags]",
            "language": "bash"
          }
        ],
        "title": "app env pull"
      }
    },
    "definitions": [
      {
        "title": "Flags",
        "description": "The following flags are available for the `app env pull` command:",
        "type": "appenvpull",
        "typeDefinitions": {
          "appenvpull": {
            "filePath": "docs-shopify.dev/commands/interfaces/app-env-pull.interface.ts",
            "name": "appenvpull",
            "description": "",
            "members": [
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-env-pull.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--client-id <value>",
                "value": "string",
                "description": "The Client ID of your app.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_CLIENT_ID"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-env-pull.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--env-file <value>",
                "value": "string",
                "description": "Specify an environment file to update if the update flag is set",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_ENV_FILE"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-env-pull.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--no-color",
                "value": "\"\"",
                "description": "Disable color output.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_NO_COLOR"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-env-pull.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--path <value>",
                "value": "string",
                "description": "The path to your app directory.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_PATH"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-env-pull.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--reset",
                "value": "\"\"",
                "description": "Reset all your settings.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_RESET"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-env-pull.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--verbose",
                "value": "\"\"",
                "description": "Increase the verbosity of the output.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_VERBOSE"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-env-pull.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-c, --config <value>",
                "value": "string",
                "description": "The name of the app configuration.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_APP_CONFIG"
              }
            ],
            "value": "export interface appenvpull {\n  /**\n   * The Client ID of your app.\n   * @environment SHOPIFY_FLAG_CLIENT_ID\n   */\n  '--client-id <value>'?: string\n\n  /**\n   * The name of the app configuration.\n   * @environment SHOPIFY_FLAG_APP_CONFIG\n   */\n  '-c, --config <value>'?: string\n\n  /**\n   * Specify an environment file to update if the update flag is set\n   * @environment SHOPIFY_FLAG_ENV_FILE\n   */\n  '--env-file <value>'?: string\n\n  /**\n   * Disable color output.\n   * @environment SHOPIFY_FLAG_NO_COLOR\n   */\n  '--no-color'?: ''\n\n  /**\n   * The path to your app directory.\n   * @environment SHOPIFY_FLAG_PATH\n   */\n  '--path <value>'?: string\n\n  /**\n   * Reset all your settings.\n   * @environment SHOPIFY_FLAG_RESET\n   */\n  '--reset'?: ''\n\n  /**\n   * Increase the verbosity of the output.\n   * @environment SHOPIFY_FLAG_VERBOSE\n   */\n  '--verbose'?: ''\n}"
          }
        }
      }
    ],
    "category": "app",
    "related": []
  },
  {
    "name": "app env show",
    "description": "Displays environment variables that can be used to deploy apps and app extensions.",
    "overviewPreviewDescription": "Display app and extensions environment variables.",
    "type": "command",
    "isVisualComponent": false,
    "defaultExample": {
      "codeblock": {
        "tabs": [
          {
            "title": "app env show",
            "code": "shopify app env show [flags]",
            "language": "bash"
          }
        ],
        "title": "app env show"
      }
    },
    "definitions": [
      {
        "title": "Flags",
        "description": "The following flags are available for the `app env show` command:",
        "type": "appenvshow",
        "typeDefinitions": {
          "appenvshow": {
            "filePath": "docs-shopify.dev/commands/interfaces/app-env-show.interface.ts",
            "name": "appenvshow",
            "description": "",
            "members": [
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-env-show.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--client-id <value>",
                "value": "string",
                "description": "The Client ID of your app.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_CLIENT_ID"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-env-show.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--no-color",
                "value": "\"\"",
                "description": "Disable color output.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_NO_COLOR"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-env-show.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--path <value>",
                "value": "string",
                "description": "The path to your app directory.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_PATH"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-env-show.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--reset",
                "value": "\"\"",
                "description": "Reset all your settings.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_RESET"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-env-show.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--verbose",
                "value": "\"\"",
                "description": "Increase the verbosity of the output.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_VERBOSE"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-env-show.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-c, --config <value>",
                "value": "string",
                "description": "The name of the app configuration.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_APP_CONFIG"
              }
            ],
            "value": "export interface appenvshow {\n  /**\n   * The Client ID of your app.\n   * @environment SHOPIFY_FLAG_CLIENT_ID\n   */\n  '--client-id <value>'?: string\n\n  /**\n   * The name of the app configuration.\n   * @environment SHOPIFY_FLAG_APP_CONFIG\n   */\n  '-c, --config <value>'?: string\n\n  /**\n   * Disable color output.\n   * @environment SHOPIFY_FLAG_NO_COLOR\n   */\n  '--no-color'?: ''\n\n  /**\n   * The path to your app directory.\n   * @environment SHOPIFY_FLAG_PATH\n   */\n  '--path <value>'?: string\n\n  /**\n   * Reset all your settings.\n   * @environment SHOPIFY_FLAG_RESET\n   */\n  '--reset'?: ''\n\n  /**\n   * Increase the verbosity of the output.\n   * @environment SHOPIFY_FLAG_VERBOSE\n   */\n  '--verbose'?: ''\n}"
          }
        }
      }
    ],
    "category": "app",
    "related": []
  },
  {
    "name": "app execute",
    "description": "Executes an Admin API GraphQL query or mutation on the specified store. Mutations are only allowed on dev stores.\n\n  For operations that process large amounts of data, use [`bulk execute`](/docs/api/shopify-cli/app/app-bulk-execute) instead.",
    "overviewPreviewDescription": "Execute GraphQL queries and mutations.",
    "type": "command",
    "isVisualComponent": false,
    "defaultExample": {
      "codeblock": {
        "tabs": [
          {
            "title": "app execute",
            "code": "shopify app execute [flags]",
            "language": "bash"
          }
        ],
        "title": "app execute"
      }
    },
    "definitions": [
      {
        "title": "Flags",
        "description": "The following flags are available for the `app execute` command:",
        "type": "appexecute",
        "typeDefinitions": {
          "appexecute": {
            "filePath": "docs-shopify.dev/commands/interfaces/app-execute.interface.ts",
            "name": "appexecute",
            "description": "",
            "members": [
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-execute.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--client-id <value>",
                "value": "string",
                "description": "The Client ID of your app.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_CLIENT_ID"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-execute.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--no-color",
                "value": "\"\"",
                "description": "Disable color output.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_NO_COLOR"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-execute.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--output-file <value>",
                "value": "string",
                "description": "The file name where results should be written, instead of STDOUT.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_OUTPUT_FILE"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-execute.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--path <value>",
                "value": "string",
                "description": "The path to your app directory.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_PATH"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-execute.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--query-file <value>",
                "value": "string",
                "description": "Path to a file containing the GraphQL query or mutation. Can't be used with --query.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_QUERY_FILE"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-execute.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--reset",
                "value": "\"\"",
                "description": "Reset all your settings.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_RESET"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-execute.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--variable-file <value>",
                "value": "string",
                "description": "Path to a file containing GraphQL variables in JSON format. Can't be used with --variables.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_VARIABLE_FILE"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-execute.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--verbose",
                "value": "\"\"",
                "description": "Increase the verbosity of the output.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_VERBOSE"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-execute.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--version <value>",
                "value": "string",
                "description": "The API version to use for the query or mutation. Defaults to the latest stable version.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_VERSION"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-execute.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-c, --config <value>",
                "value": "string",
                "description": "The name of the app configuration.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_APP_CONFIG"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-execute.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-q, --query <value>",
                "value": "string",
                "description": "The GraphQL query or mutation, as a string.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_QUERY"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-execute.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-s, --store <value>",
                "value": "string",
                "description": "The myshopify.com domain of the store to execute against. The app must be installed on the store. If not specified, you will be prompted to select a store.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_STORE"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-execute.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-v, --variables <value>",
                "value": "string",
                "description": "The values for any GraphQL variables in your query or mutation, in JSON format.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_VARIABLES"
              }
            ],
            "value": "export interface appexecute {\n  /**\n   * The Client ID of your app.\n   * @environment SHOPIFY_FLAG_CLIENT_ID\n   */\n  '--client-id <value>'?: string\n\n  /**\n   * The name of the app configuration.\n   * @environment SHOPIFY_FLAG_APP_CONFIG\n   */\n  '-c, --config <value>'?: string\n\n  /**\n   * Disable color output.\n   * @environment SHOPIFY_FLAG_NO_COLOR\n   */\n  '--no-color'?: ''\n\n  /**\n   * The file name where results should be written, instead of STDOUT.\n   * @environment SHOPIFY_FLAG_OUTPUT_FILE\n   */\n  '--output-file <value>'?: string\n\n  /**\n   * The path to your app directory.\n   * @environment SHOPIFY_FLAG_PATH\n   */\n  '--path <value>'?: string\n\n  /**\n   * The GraphQL query or mutation, as a string.\n   * @environment SHOPIFY_FLAG_QUERY\n   */\n  '-q, --query <value>'?: string\n\n  /**\n   * Path to a file containing the GraphQL query or mutation. Can't be used with --query.\n   * @environment SHOPIFY_FLAG_QUERY_FILE\n   */\n  '--query-file <value>'?: string\n\n  /**\n   * Reset all your settings.\n   * @environment SHOPIFY_FLAG_RESET\n   */\n  '--reset'?: ''\n\n  /**\n   * The myshopify.com domain of the store to execute against. The app must be installed on the store. If not specified, you will be prompted to select a store.\n   * @environment SHOPIFY_FLAG_STORE\n   */\n  '-s, --store <value>'?: string\n\n  /**\n   * Path to a file containing GraphQL variables in JSON format. Can't be used with --variables.\n   * @environment SHOPIFY_FLAG_VARIABLE_FILE\n   */\n  '--variable-file <value>'?: string\n\n  /**\n   * The values for any GraphQL variables in your query or mutation, in JSON format.\n   * @environment SHOPIFY_FLAG_VARIABLES\n   */\n  '-v, --variables <value>'?: string\n\n  /**\n   * Increase the verbosity of the output.\n   * @environment SHOPIFY_FLAG_VERBOSE\n   */\n  '--verbose'?: ''\n\n  /**\n   * The API version to use for the query or mutation. Defaults to the latest stable version.\n   * @environment SHOPIFY_FLAG_VERSION\n   */\n  '--version <value>'?: string\n}"
          }
        }
      }
    ],
    "category": "app",
    "related": []
  },
  {
    "name": "app function build",
    "description": "Compiles the function in your current directory to WebAssembly (Wasm) for testing purposes.",
    "overviewPreviewDescription": "Compile a function to wasm.",
    "type": "command",
    "isVisualComponent": false,
    "defaultExample": {
      "codeblock": {
        "tabs": [
          {
            "title": "app function build",
            "code": "shopify app function build [flags]",
            "language": "bash"
          }
        ],
        "title": "app function build"
      }
    },
    "definitions": [
      {
        "title": "Flags",
        "description": "The following flags are available for the `app function build` command:",
        "type": "appfunctionbuild",
        "typeDefinitions": {
          "appfunctionbuild": {
            "filePath": "docs-shopify.dev/commands/interfaces/app-function-build.interface.ts",
            "name": "appfunctionbuild",
            "description": "",
            "members": [
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-function-build.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--client-id <value>",
                "value": "string",
                "description": "The Client ID of your app.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_CLIENT_ID"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-function-build.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--no-color",
                "value": "\"\"",
                "description": "Disable color output.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_NO_COLOR"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-function-build.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--path <value>",
                "value": "string",
                "description": "The path to your function directory.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_PATH"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-function-build.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--reset",
                "value": "\"\"",
                "description": "Reset all your settings.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_RESET"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-function-build.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--verbose",
                "value": "\"\"",
                "description": "Increase the verbosity of the output.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_VERBOSE"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-function-build.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-c, --config <value>",
                "value": "string",
                "description": "The name of the app configuration.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_APP_CONFIG"
              }
            ],
            "value": "export interface appfunctionbuild {\n  /**\n   * The Client ID of your app.\n   * @environment SHOPIFY_FLAG_CLIENT_ID\n   */\n  '--client-id <value>'?: string\n\n  /**\n   * The name of the app configuration.\n   * @environment SHOPIFY_FLAG_APP_CONFIG\n   */\n  '-c, --config <value>'?: string\n\n  /**\n   * Disable color output.\n   * @environment SHOPIFY_FLAG_NO_COLOR\n   */\n  '--no-color'?: ''\n\n  /**\n   * The path to your function directory.\n   * @environment SHOPIFY_FLAG_PATH\n   */\n  '--path <value>'?: string\n\n  /**\n   * Reset all your settings.\n   * @environment SHOPIFY_FLAG_RESET\n   */\n  '--reset'?: ''\n\n  /**\n   * Increase the verbosity of the output.\n   * @environment SHOPIFY_FLAG_VERBOSE\n   */\n  '--verbose'?: ''\n}"
          }
        }
      }
    ],
    "category": "app",
    "related": []
  },
  {
    "name": "app function info",
    "description": "The information returned includes the following:\n\n  - The function handle\n  - The function name\n  - The function API version\n  - The targeting configuration\n  - The schema path\n  - The WASM path\n  - The function runner path",
    "overviewPreviewDescription": "Print basic information about your function.",
    "type": "command",
    "isVisualComponent": false,
    "defaultExample": {
      "codeblock": {
        "tabs": [
          {
            "title": "app function info",
            "code": "shopify app function info [flags]",
            "language": "bash"
          }
        ],
        "title": "app function info"
      }
    },
    "definitions": [
      {
        "title": "Flags",
        "description": "The following flags are available for the `app function info` command:",
        "type": "appfunctioninfo",
        "typeDefinitions": {
          "appfunctioninfo": {
            "filePath": "docs-shopify.dev/commands/interfaces/app-function-info.interface.ts",
            "name": "appfunctioninfo",
            "description": "",
            "members": [
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-function-info.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--client-id <value>",
                "value": "string",
                "description": "The Client ID of your app.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_CLIENT_ID"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-function-info.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--no-color",
                "value": "\"\"",
                "description": "Disable color output.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_NO_COLOR"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-function-info.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--path <value>",
                "value": "string",
                "description": "The path to your function directory.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_PATH"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-function-info.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--reset",
                "value": "\"\"",
                "description": "Reset all your settings.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_RESET"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-function-info.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--verbose",
                "value": "\"\"",
                "description": "Increase the verbosity of the output.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_VERBOSE"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-function-info.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-c, --config <value>",
                "value": "string",
                "description": "The name of the app configuration.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_APP_CONFIG"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-function-info.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-j, --json",
                "value": "\"\"",
                "description": "Output the result as JSON.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_JSON"
              }
            ],
            "value": "export interface appfunctioninfo {\n  /**\n   * The Client ID of your app.\n   * @environment SHOPIFY_FLAG_CLIENT_ID\n   */\n  '--client-id <value>'?: string\n\n  /**\n   * The name of the app configuration.\n   * @environment SHOPIFY_FLAG_APP_CONFIG\n   */\n  '-c, --config <value>'?: string\n\n  /**\n   * Output the result as JSON.\n   * @environment SHOPIFY_FLAG_JSON\n   */\n  '-j, --json'?: ''\n\n  /**\n   * Disable color output.\n   * @environment SHOPIFY_FLAG_NO_COLOR\n   */\n  '--no-color'?: ''\n\n  /**\n   * The path to your function directory.\n   * @environment SHOPIFY_FLAG_PATH\n   */\n  '--path <value>'?: string\n\n  /**\n   * Reset all your settings.\n   * @environment SHOPIFY_FLAG_RESET\n   */\n  '--reset'?: ''\n\n  /**\n   * Increase the verbosity of the output.\n   * @environment SHOPIFY_FLAG_VERBOSE\n   */\n  '--verbose'?: ''\n}"
          }
        }
      }
    ],
    "category": "app",
    "related": []
  },
  {
    "name": "app function replay",
    "description": "Runs the function from your current directory for [testing purposes](/docs/apps/functions/testing-and-debugging). To learn how you can monitor and debug functions when errors occur, refer to [Shopify Functions error handling](/docs/api/functions/errors).",
    "overviewPreviewDescription": "Replays a function run from an app log.",
    "type": "command",
    "isVisualComponent": false,
    "defaultExample": {
      "codeblock": {
        "tabs": [
          {
            "title": "app function replay",
            "code": "shopify app function replay [flags]",
            "language": "bash"
          }
        ],
        "title": "app function replay"
      }
    },
    "definitions": [
      {
        "title": "Flags",
        "description": "The following flags are available for the `app function replay` command:",
        "type": "appfunctionreplay",
        "typeDefinitions": {
          "appfunctionreplay": {
            "filePath": "docs-shopify.dev/commands/interfaces/app-function-replay.interface.ts",
            "name": "appfunctionreplay",
            "description": "",
            "members": [
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-function-replay.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--client-id <value>",
                "value": "string",
                "description": "The Client ID of your app.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_CLIENT_ID"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-function-replay.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--no-color",
                "value": "\"\"",
                "description": "Disable color output.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_NO_COLOR"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-function-replay.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--path <value>",
                "value": "string",
                "description": "The path to your function directory.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_PATH"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-function-replay.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--reset",
                "value": "\"\"",
                "description": "Reset all your settings.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_RESET"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-function-replay.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--verbose",
                "value": "\"\"",
                "description": "Increase the verbosity of the output.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_VERBOSE"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-function-replay.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-c, --config <value>",
                "value": "string",
                "description": "The name of the app configuration.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_APP_CONFIG"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-function-replay.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-j, --json",
                "value": "\"\"",
                "description": "Output the result as JSON.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_JSON"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-function-replay.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-l, --log <value>",
                "value": "string",
                "description": "Specifies a log identifier to replay instead of selecting from a list. The identifier is provided in the output of `shopify app dev` and is the suffix of the log file name.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_LOG"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-function-replay.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-w, --watch",
                "value": "\"\"",
                "description": "Re-run the function when the source code changes.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_WATCH"
              }
            ],
            "value": "export interface appfunctionreplay {\n  /**\n   * The Client ID of your app.\n   * @environment SHOPIFY_FLAG_CLIENT_ID\n   */\n  '--client-id <value>'?: string\n\n  /**\n   * The name of the app configuration.\n   * @environment SHOPIFY_FLAG_APP_CONFIG\n   */\n  '-c, --config <value>'?: string\n\n  /**\n   * Output the result as JSON.\n   * @environment SHOPIFY_FLAG_JSON\n   */\n  '-j, --json'?: ''\n\n  /**\n   * Specifies a log identifier to replay instead of selecting from a list. The identifier is provided in the output of `shopify app dev` and is the suffix of the log file name.\n   * @environment SHOPIFY_FLAG_LOG\n   */\n  '-l, --log <value>'?: string\n\n  /**\n   * Disable color output.\n   * @environment SHOPIFY_FLAG_NO_COLOR\n   */\n  '--no-color'?: ''\n\n  /**\n   * The path to your function directory.\n   * @environment SHOPIFY_FLAG_PATH\n   */\n  '--path <value>'?: string\n\n  /**\n   * Reset all your settings.\n   * @environment SHOPIFY_FLAG_RESET\n   */\n  '--reset'?: ''\n\n  /**\n   * Increase the verbosity of the output.\n   * @environment SHOPIFY_FLAG_VERBOSE\n   */\n  '--verbose'?: ''\n\n  /**\n   * Re-run the function when the source code changes.\n   * @environment SHOPIFY_FLAG_WATCH\n   */\n  '-w, --watch'?: ''\n}"
          }
        }
      }
    ],
    "category": "app",
    "related": []
  },
  {
    "name": "app function run",
    "description": "Runs the function from your current directory for [testing purposes](/docs/apps/functions/testing-and-debugging). To learn how you can monitor and debug functions when errors occur, refer to [Shopify Functions error handling](/docs/api/functions/errors).",
    "overviewPreviewDescription": "Run a function locally for testing.",
    "type": "command",
    "isVisualComponent": false,
    "defaultExample": {
      "codeblock": {
        "tabs": [
          {
            "title": "app function run",
            "code": "shopify app function run [flags]",
            "language": "bash"
          }
        ],
        "title": "app function run"
      }
    },
    "definitions": [
      {
        "title": "Flags",
        "description": "The following flags are available for the `app function run` command:",
        "type": "appfunctionrun",
        "typeDefinitions": {
          "appfunctionrun": {
            "filePath": "docs-shopify.dev/commands/interfaces/app-function-run.interface.ts",
            "name": "appfunctionrun",
            "description": "",
            "members": [
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-function-run.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--client-id <value>",
                "value": "string",
                "description": "The Client ID of your app.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_CLIENT_ID"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-function-run.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--no-color",
                "value": "\"\"",
                "description": "Disable color output.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_NO_COLOR"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-function-run.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--path <value>",
                "value": "string",
                "description": "The path to your function directory.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_PATH"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-function-run.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--reset",
                "value": "\"\"",
                "description": "Reset all your settings.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_RESET"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-function-run.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--verbose",
                "value": "\"\"",
                "description": "Increase the verbosity of the output.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_VERBOSE"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-function-run.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-c, --config <value>",
                "value": "string",
                "description": "The name of the app configuration.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_APP_CONFIG"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-function-run.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-e, --export <value>",
                "value": "string",
                "description": "Name of the WebAssembly export to invoke.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_EXPORT"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-function-run.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-i, --input <value>",
                "value": "string",
                "description": "The input JSON to pass to the function. If omitted, standard input is used.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_INPUT"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-function-run.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-j, --json",
                "value": "\"\"",
                "description": "Output the result as JSON.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_JSON"
              }
            ],
            "value": "export interface appfunctionrun {\n  /**\n   * The Client ID of your app.\n   * @environment SHOPIFY_FLAG_CLIENT_ID\n   */\n  '--client-id <value>'?: string\n\n  /**\n   * The name of the app configuration.\n   * @environment SHOPIFY_FLAG_APP_CONFIG\n   */\n  '-c, --config <value>'?: string\n\n  /**\n   * Name of the WebAssembly export to invoke.\n   * @environment SHOPIFY_FLAG_EXPORT\n   */\n  '-e, --export <value>'?: string\n\n  /**\n   * The input JSON to pass to the function. If omitted, standard input is used.\n   * @environment SHOPIFY_FLAG_INPUT\n   */\n  '-i, --input <value>'?: string\n\n  /**\n   * Output the result as JSON.\n   * @environment SHOPIFY_FLAG_JSON\n   */\n  '-j, --json'?: ''\n\n  /**\n   * Disable color output.\n   * @environment SHOPIFY_FLAG_NO_COLOR\n   */\n  '--no-color'?: ''\n\n  /**\n   * The path to your function directory.\n   * @environment SHOPIFY_FLAG_PATH\n   */\n  '--path <value>'?: string\n\n  /**\n   * Reset all your settings.\n   * @environment SHOPIFY_FLAG_RESET\n   */\n  '--reset'?: ''\n\n  /**\n   * Increase the verbosity of the output.\n   * @environment SHOPIFY_FLAG_VERBOSE\n   */\n  '--verbose'?: ''\n}"
          }
        }
      }
    ],
    "category": "app",
    "related": []
  },
  {
    "name": "app function schema",
    "description": "Generates the latest [GraphQL schema](/docs/apps/functions/input-output#graphql-schema) for a function in your app. Run this command from the function directory.\n\n  This command uses the API type and version of your function, as defined in your extension TOML file, to generate the latest GraphQL schema. The schema is written to the `schema.graphql` file.",
    "overviewPreviewDescription": "Fetch the latest GraphQL schema for a function.",
    "type": "command",
    "isVisualComponent": false,
    "defaultExample": {
      "codeblock": {
        "tabs": [
          {
            "title": "app function schema",
            "code": "shopify app function schema [flags]",
            "language": "bash"
          }
        ],
        "title": "app function schema"
      }
    },
    "definitions": [
      {
        "title": "Flags",
        "description": "The following flags are available for the `app function schema` command:",
        "type": "appfunctionschema",
        "typeDefinitions": {
          "appfunctionschema": {
            "filePath": "docs-shopify.dev/commands/interfaces/app-function-schema.interface.ts",
            "name": "appfunctionschema",
            "description": "",
            "members": [
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-function-schema.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--client-id <value>",
                "value": "string",
                "description": "The Client ID of your app.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_CLIENT_ID"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-function-schema.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--no-color",
                "value": "\"\"",
                "description": "Disable color output.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_NO_COLOR"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-function-schema.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--path <value>",
                "value": "string",
                "description": "The path to your function directory.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_PATH"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-function-schema.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--reset",
                "value": "\"\"",
                "description": "Reset all your settings.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_RESET"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-function-schema.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--stdout",
                "value": "\"\"",
                "description": "Output the schema to stdout instead of writing to a file.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_STDOUT"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-function-schema.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--verbose",
                "value": "\"\"",
                "description": "Increase the verbosity of the output.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_VERBOSE"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-function-schema.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-c, --config <value>",
                "value": "string",
                "description": "The name of the app configuration.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_APP_CONFIG"
              }
            ],
            "value": "export interface appfunctionschema {\n  /**\n   * The Client ID of your app.\n   * @environment SHOPIFY_FLAG_CLIENT_ID\n   */\n  '--client-id <value>'?: string\n\n  /**\n   * The name of the app configuration.\n   * @environment SHOPIFY_FLAG_APP_CONFIG\n   */\n  '-c, --config <value>'?: string\n\n  /**\n   * Disable color output.\n   * @environment SHOPIFY_FLAG_NO_COLOR\n   */\n  '--no-color'?: ''\n\n  /**\n   * The path to your function directory.\n   * @environment SHOPIFY_FLAG_PATH\n   */\n  '--path <value>'?: string\n\n  /**\n   * Reset all your settings.\n   * @environment SHOPIFY_FLAG_RESET\n   */\n  '--reset'?: ''\n\n  /**\n   * Output the schema to stdout instead of writing to a file.\n   * @environment SHOPIFY_FLAG_STDOUT\n   */\n  '--stdout'?: ''\n\n  /**\n   * Increase the verbosity of the output.\n   * @environment SHOPIFY_FLAG_VERBOSE\n   */\n  '--verbose'?: ''\n}"
          }
        }
      }
    ],
    "category": "app",
    "related": []
  },
  {
    "name": "app function typegen",
    "description": "Creates GraphQL types based on your [input query](/docs/apps/functions/input-output#input) for a function. Supports JavaScript functions out of the box, or any language via the `build.typegen_command` configuration.",
    "overviewPreviewDescription": "Generate GraphQL types for a function.",
    "type": "command",
    "isVisualComponent": false,
    "defaultExample": {
      "codeblock": {
        "tabs": [
          {
            "title": "app function typegen",
            "code": "shopify app function typegen [flags]",
            "language": "bash"
          }
        ],
        "title": "app function typegen"
      }
    },
    "definitions": [
      {
        "title": "Flags",
        "description": "The following flags are available for the `app function typegen` command:",
        "type": "appfunctiontypegen",
        "typeDefinitions": {
          "appfunctiontypegen": {
            "filePath": "docs-shopify.dev/commands/interfaces/app-function-typegen.interface.ts",
            "name": "appfunctiontypegen",
            "description": "",
            "members": [
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-function-typegen.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--client-id <value>",
                "value": "string",
                "description": "The Client ID of your app.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_CLIENT_ID"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-function-typegen.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--no-color",
                "value": "\"\"",
                "description": "Disable color output.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_NO_COLOR"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-function-typegen.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--path <value>",
                "value": "string",
                "description": "The path to your function directory.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_PATH"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-function-typegen.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--reset",
                "value": "\"\"",
                "description": "Reset all your settings.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_RESET"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-function-typegen.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--verbose",
                "value": "\"\"",
                "description": "Increase the verbosity of the output.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_VERBOSE"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-function-typegen.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-c, --config <value>",
                "value": "string",
                "description": "The name of the app configuration.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_APP_CONFIG"
              }
            ],
            "value": "export interface appfunctiontypegen {\n  /**\n   * The Client ID of your app.\n   * @environment SHOPIFY_FLAG_CLIENT_ID\n   */\n  '--client-id <value>'?: string\n\n  /**\n   * The name of the app configuration.\n   * @environment SHOPIFY_FLAG_APP_CONFIG\n   */\n  '-c, --config <value>'?: string\n\n  /**\n   * Disable color output.\n   * @environment SHOPIFY_FLAG_NO_COLOR\n   */\n  '--no-color'?: ''\n\n  /**\n   * The path to your function directory.\n   * @environment SHOPIFY_FLAG_PATH\n   */\n  '--path <value>'?: string\n\n  /**\n   * Reset all your settings.\n   * @environment SHOPIFY_FLAG_RESET\n   */\n  '--reset'?: ''\n\n  /**\n   * Increase the verbosity of the output.\n   * @environment SHOPIFY_FLAG_VERBOSE\n   */\n  '--verbose'?: ''\n}"
          }
        }
      }
    ],
    "category": "app",
    "related": []
  },
  {
    "name": "app generate extension",
    "description": "Generates a new [app extension](/docs/apps/app-extensions). For a list of app extensions that you can generate using this command, refer to [Supported extensions](/docs/apps/structure/app-extensions/list).\n\n  Each new app extension is created in a folder under `extensions/`. To learn more about the extensions file structure, refer to [App structure](/docs/apps/tools/cli/structure) and the documentation for your extension.\n  ",
    "overviewPreviewDescription": "Generate a new app Extension.",
    "type": "command",
    "isVisualComponent": false,
    "defaultExample": {
      "codeblock": {
        "tabs": [
          {
            "title": "app generate extension",
            "code": "shopify app generate extension [flags]",
            "language": "bash"
          }
        ],
        "title": "app generate extension"
      }
    },
    "definitions": [
      {
        "title": "Flags",
        "description": "The following flags are available for the `app generate extension` command:",
        "type": "appgenerateextension",
        "typeDefinitions": {
          "appgenerateextension": {
            "filePath": "docs-shopify.dev/commands/interfaces/app-generate-extension.interface.ts",
            "name": "appgenerateextension",
            "description": "",
            "members": [
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-generate-extension.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--client-id <value>",
                "value": "string",
                "description": "The Client ID of your app.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_CLIENT_ID"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-generate-extension.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--flavor <value>",
                "value": "string",
                "description": "Choose a starting template for your extension, where applicable",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_FLAVOR"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-generate-extension.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--no-color",
                "value": "\"\"",
                "description": "Disable color output.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_NO_COLOR"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-generate-extension.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--path <value>",
                "value": "string",
                "description": "The path to your app directory.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_PATH"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-generate-extension.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--reset",
                "value": "\"\"",
                "description": "Reset all your settings.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_RESET"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-generate-extension.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--verbose",
                "value": "\"\"",
                "description": "Increase the verbosity of the output.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_VERBOSE"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-generate-extension.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-c, --config <value>",
                "value": "string",
                "description": "The name of the app configuration.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_APP_CONFIG"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-generate-extension.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-n, --name <value>",
                "value": "string",
                "description": "name of your Extension",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_NAME"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-generate-extension.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-t, --template <value>",
                "value": "string",
                "description": "Extension template",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_EXTENSION_TEMPLATE"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-generate-extension.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-t, --type <value>",
                "value": "string",
                "description": "Deprecated. Please use --template",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_EXTENSION_TYPE"
              }
            ],
            "value": "export interface appgenerateextension {\n  /**\n   * The Client ID of your app.\n   * @environment SHOPIFY_FLAG_CLIENT_ID\n   */\n  '--client-id <value>'?: string\n\n  /**\n   * The name of the app configuration.\n   * @environment SHOPIFY_FLAG_APP_CONFIG\n   */\n  '-c, --config <value>'?: string\n\n  /**\n   * Choose a starting template for your extension, where applicable\n   * @environment SHOPIFY_FLAG_FLAVOR\n   */\n  '--flavor <value>'?: string\n\n  /**\n   * name of your Extension\n   * @environment SHOPIFY_FLAG_NAME\n   */\n  '-n, --name <value>'?: string\n\n  /**\n   * Disable color output.\n   * @environment SHOPIFY_FLAG_NO_COLOR\n   */\n  '--no-color'?: ''\n\n  /**\n   * The path to your app directory.\n   * @environment SHOPIFY_FLAG_PATH\n   */\n  '--path <value>'?: string\n\n  /**\n   * Reset all your settings.\n   * @environment SHOPIFY_FLAG_RESET\n   */\n  '--reset'?: ''\n\n  /**\n   * Extension template\n   * @environment SHOPIFY_FLAG_EXTENSION_TEMPLATE\n   */\n  '-t, --template <value>'?: string\n\n  /**\n   * Deprecated. Please use --template\n   * @environment SHOPIFY_FLAG_EXTENSION_TYPE\n   */\n  '-t, --type <value>'?: string\n\n  /**\n   * Increase the verbosity of the output.\n   * @environment SHOPIFY_FLAG_VERBOSE\n   */\n  '--verbose'?: ''\n}"
          }
        }
      }
    ],
    "category": "app",
    "related": []
  },
  {
    "name": "app import-custom-data-definitions",
    "description": "Import metafield and metaobject definitions from your development store. [Read more about declarative custom data definitions](/docs/apps/build/custom-data/declarative-custom-data-definitions).",
    "overviewPreviewDescription": "Import metafield and metaobject definitions.",
    "type": "command",
    "isVisualComponent": false,
    "defaultExample": {
      "codeblock": {
        "tabs": [
          {
            "title": "app import-custom-data-definitions",
            "code": "shopify app import-custom-data-definitions [flags]",
            "language": "bash"
          }
        ],
        "title": "app import-custom-data-definitions"
      }
    },
    "definitions": [
      {
        "title": "Flags",
        "description": "The following flags are available for the `app import-custom-data-definitions` command:",
        "type": "appimportcustomdatadefinitions",
        "typeDefinitions": {
          "appimportcustomdatadefinitions": {
            "filePath": "docs-shopify.dev/commands/interfaces/app-import-custom-data-definitions.interface.ts",
            "name": "appimportcustomdatadefinitions",
            "description": "",
            "members": [
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-import-custom-data-definitions.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--client-id <value>",
                "value": "string",
                "description": "The Client ID of your app.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_CLIENT_ID"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-import-custom-data-definitions.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--include-existing",
                "value": "\"\"",
                "description": "Include existing declared definitions in the output.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_INCLUDE_EXISTING"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-import-custom-data-definitions.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--no-color",
                "value": "\"\"",
                "description": "Disable color output.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_NO_COLOR"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-import-custom-data-definitions.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--path <value>",
                "value": "string",
                "description": "The path to your app directory.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_PATH"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-import-custom-data-definitions.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--reset",
                "value": "\"\"",
                "description": "Reset all your settings.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_RESET"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-import-custom-data-definitions.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--verbose",
                "value": "\"\"",
                "description": "Increase the verbosity of the output.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_VERBOSE"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-import-custom-data-definitions.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-c, --config <value>",
                "value": "string",
                "description": "The name of the app configuration.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_APP_CONFIG"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-import-custom-data-definitions.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-s, --store <value>",
                "value": "string",
                "description": "Store URL. Must be an existing development or Shopify Plus sandbox store.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_STORE"
              }
            ],
            "value": "export interface appimportcustomdatadefinitions {\n  /**\n   * The Client ID of your app.\n   * @environment SHOPIFY_FLAG_CLIENT_ID\n   */\n  '--client-id <value>'?: string\n\n  /**\n   * The name of the app configuration.\n   * @environment SHOPIFY_FLAG_APP_CONFIG\n   */\n  '-c, --config <value>'?: string\n\n  /**\n   * Include existing declared definitions in the output.\n   * @environment SHOPIFY_FLAG_INCLUDE_EXISTING\n   */\n  '--include-existing'?: ''\n\n  /**\n   * Disable color output.\n   * @environment SHOPIFY_FLAG_NO_COLOR\n   */\n  '--no-color'?: ''\n\n  /**\n   * The path to your app directory.\n   * @environment SHOPIFY_FLAG_PATH\n   */\n  '--path <value>'?: string\n\n  /**\n   * Reset all your settings.\n   * @environment SHOPIFY_FLAG_RESET\n   */\n  '--reset'?: ''\n\n  /**\n   * Store URL. Must be an existing development or Shopify Plus sandbox store.\n   * @environment SHOPIFY_FLAG_STORE\n   */\n  '-s, --store <value>'?: string\n\n  /**\n   * Increase the verbosity of the output.\n   * @environment SHOPIFY_FLAG_VERBOSE\n   */\n  '--verbose'?: ''\n}"
          }
        }
      }
    ],
    "category": "app",
    "related": []
  },
  {
    "name": "app import-extensions",
    "description": "Import dashboard-managed extensions into your app.",
    "overviewPreviewDescription": "Import dashboard-managed extensions into your app.",
    "type": "command",
    "isVisualComponent": false,
    "defaultExample": {
      "codeblock": {
        "tabs": [
          {
            "title": "app import-extensions",
            "code": "shopify app import-extensions [flags]",
            "language": "bash"
          }
        ],
        "title": "app import-extensions"
      }
    },
    "definitions": [
      {
        "title": "Flags",
        "description": "The following flags are available for the `app import-extensions` command:",
        "type": "appimportextensions",
        "typeDefinitions": {
          "appimportextensions": {
            "filePath": "docs-shopify.dev/commands/interfaces/app-import-extensions.interface.ts",
            "name": "appimportextensions",
            "description": "",
            "members": [
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-import-extensions.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--client-id <value>",
                "value": "string",
                "description": "The Client ID of your app.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_CLIENT_ID"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-import-extensions.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--no-color",
                "value": "\"\"",
                "description": "Disable color output.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_NO_COLOR"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-import-extensions.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--path <value>",
                "value": "string",
                "description": "The path to your app directory.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_PATH"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-import-extensions.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--reset",
                "value": "\"\"",
                "description": "Reset all your settings.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_RESET"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-import-extensions.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--verbose",
                "value": "\"\"",
                "description": "Increase the verbosity of the output.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_VERBOSE"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-import-extensions.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-c, --config <value>",
                "value": "string",
                "description": "The name of the app configuration.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_APP_CONFIG"
              }
            ],
            "value": "export interface appimportextensions {\n  /**\n   * The Client ID of your app.\n   * @environment SHOPIFY_FLAG_CLIENT_ID\n   */\n  '--client-id <value>'?: string\n\n  /**\n   * The name of the app configuration.\n   * @environment SHOPIFY_FLAG_APP_CONFIG\n   */\n  '-c, --config <value>'?: string\n\n  /**\n   * Disable color output.\n   * @environment SHOPIFY_FLAG_NO_COLOR\n   */\n  '--no-color'?: ''\n\n  /**\n   * The path to your app directory.\n   * @environment SHOPIFY_FLAG_PATH\n   */\n  '--path <value>'?: string\n\n  /**\n   * Reset all your settings.\n   * @environment SHOPIFY_FLAG_RESET\n   */\n  '--reset'?: ''\n\n  /**\n   * Increase the verbosity of the output.\n   * @environment SHOPIFY_FLAG_VERBOSE\n   */\n  '--verbose'?: ''\n}"
          }
        }
      }
    ],
    "category": "app",
    "related": []
  },
  {
    "name": "app info",
    "description": "The information returned includes the following:\n\n  - The app and dev store that's used when you run the [dev](/docs/api/shopify-cli/app/app-dev) command. You can reset these configurations using [`dev --reset`](/docs/api/shopify-cli/app/app-dev#flags-propertydetail-reset).\n  - The [structure](/docs/apps/tools/cli/structure) of your app project.\n  - The [access scopes](/docs/api/usage) your app has requested.\n  - System information, including the package manager and version of Shopify CLI used in the project.",
    "overviewPreviewDescription": "Print basic information about your app and extensions.",
    "type": "command",
    "isVisualComponent": false,
    "defaultExample": {
      "codeblock": {
        "tabs": [
          {
            "title": "app info",
            "code": "shopify app info [flags]",
            "language": "bash"
          }
        ],
        "title": "app info"
      }
    },
    "definitions": [
      {
        "title": "Flags",
        "description": "The following flags are available for the `app info` command:",
        "type": "appinfo",
        "typeDefinitions": {
          "appinfo": {
            "filePath": "docs-shopify.dev/commands/interfaces/app-info.interface.ts",
            "name": "appinfo",
            "description": "",
            "members": [
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-info.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--client-id <value>",
                "value": "string",
                "description": "The Client ID of your app.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_CLIENT_ID"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-info.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--no-color",
                "value": "\"\"",
                "description": "Disable color output.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_NO_COLOR"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-info.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--path <value>",
                "value": "string",
                "description": "The path to your app directory.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_PATH"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-info.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--reset",
                "value": "\"\"",
                "description": "Reset all your settings.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_RESET"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-info.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--verbose",
                "value": "\"\"",
                "description": "Increase the verbosity of the output.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_VERBOSE"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-info.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--web-env",
                "value": "\"\"",
                "description": "Outputs environment variables necessary for running and deploying web/.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_OUTPUT_WEB_ENV"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-info.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-c, --config <value>",
                "value": "string",
                "description": "The name of the app configuration.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_APP_CONFIG"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-info.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-j, --json",
                "value": "\"\"",
                "description": "Output the result as JSON.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_JSON"
              }
            ],
            "value": "export interface appinfo {\n  /**\n   * The Client ID of your app.\n   * @environment SHOPIFY_FLAG_CLIENT_ID\n   */\n  '--client-id <value>'?: string\n\n  /**\n   * The name of the app configuration.\n   * @environment SHOPIFY_FLAG_APP_CONFIG\n   */\n  '-c, --config <value>'?: string\n\n  /**\n   * Output the result as JSON.\n   * @environment SHOPIFY_FLAG_JSON\n   */\n  '-j, --json'?: ''\n\n  /**\n   * Disable color output.\n   * @environment SHOPIFY_FLAG_NO_COLOR\n   */\n  '--no-color'?: ''\n\n  /**\n   * The path to your app directory.\n   * @environment SHOPIFY_FLAG_PATH\n   */\n  '--path <value>'?: string\n\n  /**\n   * Reset all your settings.\n   * @environment SHOPIFY_FLAG_RESET\n   */\n  '--reset'?: ''\n\n  /**\n   * Increase the verbosity of the output.\n   * @environment SHOPIFY_FLAG_VERBOSE\n   */\n  '--verbose'?: ''\n\n  /**\n   * Outputs environment variables necessary for running and deploying web/.\n   * @environment SHOPIFY_FLAG_OUTPUT_WEB_ENV\n   */\n  '--web-env'?: ''\n}"
          }
        }
      }
    ],
    "category": "app",
    "related": []
  },
  {
    "name": "app init",
    "description": "Create a new app project",
    "overviewPreviewDescription": "Create a new app project",
    "type": "command",
    "isVisualComponent": false,
    "defaultExample": {
      "codeblock": {
        "tabs": [
          {
            "title": "app init",
            "code": "shopify app init [flags]",
            "language": "bash"
          }
        ],
        "title": "app init"
      }
    },
    "definitions": [
      {
        "title": "Flags",
        "description": "The following flags are available for the `app init` command:",
        "type": "appinit",
        "typeDefinitions": {
          "appinit": {
            "filePath": "docs-shopify.dev/commands/interfaces/app-init.interface.ts",
            "name": "appinit",
            "description": "",
            "members": [
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-init.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--client-id <value>",
                "value": "string",
                "description": "The Client ID of your app. Use this to automatically link your new project to an existing app. Using this flag avoids the app selection prompt.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_CLIENT_ID"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-init.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--flavor <value>",
                "value": "string",
                "description": "Which flavor of the given template to use.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_TEMPLATE_FLAVOR"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-init.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--no-color",
                "value": "\"\"",
                "description": "Disable color output.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_NO_COLOR"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-init.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--template <value>",
                "value": "string",
                "description": "The app template. Accepts one of the following:   - <reactRouter|remix|none>\n  - Any GitHub repo with optional branch and subpath, e.g., https://github.com/Shopify/<repository>/[subpath]#[branch]",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_TEMPLATE"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-init.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--verbose",
                "value": "\"\"",
                "description": "Increase the verbosity of the output.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_VERBOSE"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-init.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-d, --package-manager <value>",
                "value": "string",
                "description": "",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_PACKAGE_MANAGER"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-init.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-n, --name <value>",
                "value": "string",
                "description": "",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_NAME"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-init.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-p, --path <value>",
                "value": "string",
                "description": "",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_PATH"
              }
            ],
            "value": "export interface appinit {\n  /**\n   * The Client ID of your app. Use this to automatically link your new project to an existing app. Using this flag avoids the app selection prompt.\n   * @environment SHOPIFY_FLAG_CLIENT_ID\n   */\n  '--client-id <value>'?: string\n\n  /**\n   * Which flavor of the given template to use.\n   * @environment SHOPIFY_FLAG_TEMPLATE_FLAVOR\n   */\n  '--flavor <value>'?: string\n\n  /**\n   * \n   * @environment SHOPIFY_FLAG_NAME\n   */\n  '-n, --name <value>'?: string\n\n  /**\n   * Disable color output.\n   * @environment SHOPIFY_FLAG_NO_COLOR\n   */\n  '--no-color'?: ''\n\n  /**\n   * \n   * @environment SHOPIFY_FLAG_PACKAGE_MANAGER\n   */\n  '-d, --package-manager <value>'?: string\n\n  /**\n   * \n   * @environment SHOPIFY_FLAG_PATH\n   */\n  '-p, --path <value>'?: string\n\n  /**\n   * The app template. Accepts one of the following:\n       - <reactRouter|remix|none>\n       - Any GitHub repo with optional branch and subpath, e.g., https://github.com/Shopify/<repository>/[subpath]#[branch]\n   * @environment SHOPIFY_FLAG_TEMPLATE\n   */\n  '--template <value>'?: string\n\n  /**\n   * Increase the verbosity of the output.\n   * @environment SHOPIFY_FLAG_VERBOSE\n   */\n  '--verbose'?: ''\n}"
          }
        }
      }
    ],
    "category": "app",
    "related": []
  },
  {
    "name": "app logs sources",
    "description": "The output source names can be used with the `--source` argument of `shopify app logs` to filter log output. Currently only function extensions are supported as sources.",
    "overviewPreviewDescription": "Print out a list of sources that may be used with the logs command.",
    "type": "command",
    "isVisualComponent": false,
    "defaultExample": {
      "codeblock": {
        "tabs": [
          {
            "title": "app logs sources",
            "code": "shopify app logs sources [flags]",
            "language": "bash"
          }
        ],
        "title": "app logs sources"
      }
    },
    "definitions": [
      {
        "title": "Flags",
        "description": "The following flags are available for the `app logs sources` command:",
        "type": "applogssources",
        "typeDefinitions": {
          "applogssources": {
            "filePath": "docs-shopify.dev/commands/interfaces/app-logs-sources.interface.ts",
            "name": "applogssources",
            "description": "",
            "members": [
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-logs-sources.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--client-id <value>",
                "value": "string",
                "description": "The Client ID of your app.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_CLIENT_ID"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-logs-sources.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--no-color",
                "value": "\"\"",
                "description": "Disable color output.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_NO_COLOR"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-logs-sources.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--path <value>",
                "value": "string",
                "description": "The path to your app directory.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_PATH"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-logs-sources.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--reset",
                "value": "\"\"",
                "description": "Reset all your settings.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_RESET"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-logs-sources.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--verbose",
                "value": "\"\"",
                "description": "Increase the verbosity of the output.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_VERBOSE"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-logs-sources.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-c, --config <value>",
                "value": "string",
                "description": "The name of the app configuration.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_APP_CONFIG"
              }
            ],
            "value": "export interface applogssources {\n  /**\n   * The Client ID of your app.\n   * @environment SHOPIFY_FLAG_CLIENT_ID\n   */\n  '--client-id <value>'?: string\n\n  /**\n   * The name of the app configuration.\n   * @environment SHOPIFY_FLAG_APP_CONFIG\n   */\n  '-c, --config <value>'?: string\n\n  /**\n   * Disable color output.\n   * @environment SHOPIFY_FLAG_NO_COLOR\n   */\n  '--no-color'?: ''\n\n  /**\n   * The path to your app directory.\n   * @environment SHOPIFY_FLAG_PATH\n   */\n  '--path <value>'?: string\n\n  /**\n   * Reset all your settings.\n   * @environment SHOPIFY_FLAG_RESET\n   */\n  '--reset'?: ''\n\n  /**\n   * Increase the verbosity of the output.\n   * @environment SHOPIFY_FLAG_VERBOSE\n   */\n  '--verbose'?: ''\n}"
          }
        }
      }
    ],
    "category": "app",
    "related": []
  },
  {
    "name": "app logs",
    "description": "\n  Opens a real-time stream of detailed app logs from the selected app and store.\n  Use the `--source` argument to limit output to a particular log source, such as a specific Shopify Function handle. Use the `shopify app logs sources` command to view a list of sources.\n  Use the `--status` argument to filter on status, either `success` or `failure`.\n  ```\n  shopify app logs --status=success --source=extension.discount-function\n  ```\n  ",
    "overviewPreviewDescription": "Stream detailed logs for your Shopify app.",
    "type": "command",
    "isVisualComponent": false,
    "defaultExample": {
      "codeblock": {
        "tabs": [
          {
            "title": "app logs",
            "code": "shopify app logs [flags]",
            "language": "bash"
          }
        ],
        "title": "app logs"
      }
    },
    "definitions": [
      {
        "title": "Flags",
        "description": "The following flags are available for the `app logs` command:",
        "type": "applogs",
        "typeDefinitions": {
          "applogs": {
            "filePath": "docs-shopify.dev/commands/interfaces/app-logs.interface.ts",
            "name": "applogs",
            "description": "",
            "members": [
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-logs.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--client-id <value>",
                "value": "string",
                "description": "The Client ID of your app.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_CLIENT_ID"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-logs.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--no-color",
                "value": "\"\"",
                "description": "Disable color output.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_NO_COLOR"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-logs.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--path <value>",
                "value": "string",
                "description": "The path to your app directory.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_PATH"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-logs.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--reset",
                "value": "\"\"",
                "description": "Reset all your settings.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_RESET"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-logs.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--source <value>",
                "value": "string",
                "description": "Filters output to the specified log source.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_SOURCE"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-logs.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--status <value>",
                "value": "string",
                "description": "Filters output to the specified status (success or failure).",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_STATUS"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-logs.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--verbose",
                "value": "\"\"",
                "description": "Increase the verbosity of the output.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_VERBOSE"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-logs.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-c, --config <value>",
                "value": "string",
                "description": "The name of the app configuration.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_APP_CONFIG"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-logs.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-j, --json",
                "value": "\"\"",
                "description": "Output the result as JSON.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_JSON"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-logs.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-s, --store <value>",
                "value": "string",
                "description": "Store URL. Must be an existing development or Shopify Plus sandbox store.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_STORE"
              }
            ],
            "value": "export interface applogs {\n  /**\n   * The Client ID of your app.\n   * @environment SHOPIFY_FLAG_CLIENT_ID\n   */\n  '--client-id <value>'?: string\n\n  /**\n   * The name of the app configuration.\n   * @environment SHOPIFY_FLAG_APP_CONFIG\n   */\n  '-c, --config <value>'?: string\n\n  /**\n   * Output the result as JSON.\n   * @environment SHOPIFY_FLAG_JSON\n   */\n  '-j, --json'?: ''\n\n  /**\n   * Disable color output.\n   * @environment SHOPIFY_FLAG_NO_COLOR\n   */\n  '--no-color'?: ''\n\n  /**\n   * The path to your app directory.\n   * @environment SHOPIFY_FLAG_PATH\n   */\n  '--path <value>'?: string\n\n  /**\n   * Reset all your settings.\n   * @environment SHOPIFY_FLAG_RESET\n   */\n  '--reset'?: ''\n\n  /**\n   * Filters output to the specified log source.\n   * @environment SHOPIFY_FLAG_SOURCE\n   */\n  '--source <value>'?: string\n\n  /**\n   * Filters output to the specified status (success or failure).\n   * @environment SHOPIFY_FLAG_STATUS\n   */\n  '--status <value>'?: string\n\n  /**\n   * Store URL. Must be an existing development or Shopify Plus sandbox store.\n   * @environment SHOPIFY_FLAG_STORE\n   */\n  '-s, --store <value>'?: string\n\n  /**\n   * Increase the verbosity of the output.\n   * @environment SHOPIFY_FLAG_VERBOSE\n   */\n  '--verbose'?: ''\n}"
          }
        }
      }
    ],
    "category": "app",
    "related": []
  },
  {
    "name": "app release",
    "description": "Releases an existing app version. Pass the name of the version that you want to release using the `--version` flag.",
    "overviewPreviewDescription": "Release an app version.",
    "type": "command",
    "isVisualComponent": false,
    "defaultExample": {
      "codeblock": {
        "tabs": [
          {
            "title": "app release",
            "code": "shopify app release --version &lt;version&gt;",
            "language": "bash"
          }
        ],
        "title": "app release"
      }
    },
    "definitions": [
      {
        "title": "Flags",
        "description": "The following flags are available for the `app release` command:",
        "type": "apprelease",
        "typeDefinitions": {
          "apprelease": {
            "filePath": "docs-shopify.dev/commands/interfaces/app-release.interface.ts",
            "name": "apprelease",
            "description": "",
            "members": [
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-release.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--allow-deletes",
                "value": "\"\"",
                "description": "Allows removing extensions and configuration without requiring user confirmation. For CI/CD environments, the recommended flag is --allow-updates.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_ALLOW_DELETES"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-release.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--allow-updates",
                "value": "\"\"",
                "description": "Allows adding and updating extensions and configuration without requiring user confirmation. Recommended option for CI/CD environments.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_ALLOW_UPDATES"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-release.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--client-id <value>",
                "value": "string",
                "description": "The Client ID of your app.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_CLIENT_ID"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-release.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--no-color",
                "value": "\"\"",
                "description": "Disable color output.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_NO_COLOR"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-release.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--path <value>",
                "value": "string",
                "description": "The path to your app directory.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_PATH"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-release.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--reset",
                "value": "\"\"",
                "description": "Reset all your settings.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_RESET"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-release.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--verbose",
                "value": "\"\"",
                "description": "Increase the verbosity of the output.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_VERBOSE"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-release.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--version <value>",
                "value": "string",
                "description": "The name of the app version to release.",
                "environmentValue": "SHOPIFY_FLAG_VERSION"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-release.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-c, --config <value>",
                "value": "string",
                "description": "The name of the app configuration.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_APP_CONFIG"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-release.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-f, --force",
                "value": "\"\"",
                "description": "Release without asking for confirmation. Equivalent to --allow-updates --allow-deletes. For CI/CD environments, the recommended flag is --allow-updates.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_FORCE"
              }
            ],
            "value": "export interface apprelease {\n  /**\n   * Allows removing extensions and configuration without requiring user confirmation. For CI/CD environments, the recommended flag is --allow-updates.\n   * @environment SHOPIFY_FLAG_ALLOW_DELETES\n   */\n  '--allow-deletes'?: ''\n\n  /**\n   * Allows adding and updating extensions and configuration without requiring user confirmation. Recommended option for CI/CD environments.\n   * @environment SHOPIFY_FLAG_ALLOW_UPDATES\n   */\n  '--allow-updates'?: ''\n\n  /**\n   * The Client ID of your app.\n   * @environment SHOPIFY_FLAG_CLIENT_ID\n   */\n  '--client-id <value>'?: string\n\n  /**\n   * The name of the app configuration.\n   * @environment SHOPIFY_FLAG_APP_CONFIG\n   */\n  '-c, --config <value>'?: string\n\n  /**\n   * Release without asking for confirmation. Equivalent to --allow-updates --allow-deletes. For CI/CD environments, the recommended flag is --allow-updates.\n   * @environment SHOPIFY_FLAG_FORCE\n   */\n  '-f, --force'?: ''\n\n  /**\n   * Disable color output.\n   * @environment SHOPIFY_FLAG_NO_COLOR\n   */\n  '--no-color'?: ''\n\n  /**\n   * The path to your app directory.\n   * @environment SHOPIFY_FLAG_PATH\n   */\n  '--path <value>'?: string\n\n  /**\n   * Reset all your settings.\n   * @environment SHOPIFY_FLAG_RESET\n   */\n  '--reset'?: ''\n\n  /**\n   * Increase the verbosity of the output.\n   * @environment SHOPIFY_FLAG_VERBOSE\n   */\n  '--verbose'?: ''\n\n  /**\n   * The name of the app version to release.\n   * @environment SHOPIFY_FLAG_VERSION\n   */\n  '--version <value>': string\n}"
          }
        }
      }
    ],
    "category": "app",
    "related": []
  },
  {
    "name": "app versions list",
    "description": "Lists the deployed app versions. An app version is a snapshot of your app extensions.",
    "overviewPreviewDescription": "List deployed versions of your app.",
    "type": "command",
    "isVisualComponent": false,
    "defaultExample": {
      "codeblock": {
        "tabs": [
          {
            "title": "app versions list",
            "code": "shopify app versions list [flags]",
            "language": "bash"
          }
        ],
        "title": "app versions list"
      }
    },
    "definitions": [
      {
        "title": "Flags",
        "description": "The following flags are available for the `app versions list` command:",
        "type": "appversionslist",
        "typeDefinitions": {
          "appversionslist": {
            "filePath": "docs-shopify.dev/commands/interfaces/app-versions-list.interface.ts",
            "name": "appversionslist",
            "description": "",
            "members": [
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-versions-list.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--client-id <value>",
                "value": "string",
                "description": "The Client ID of your app.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_CLIENT_ID"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-versions-list.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--no-color",
                "value": "\"\"",
                "description": "Disable color output.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_NO_COLOR"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-versions-list.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--path <value>",
                "value": "string",
                "description": "The path to your app directory.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_PATH"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-versions-list.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--reset",
                "value": "\"\"",
                "description": "Reset all your settings.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_RESET"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-versions-list.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--verbose",
                "value": "\"\"",
                "description": "Increase the verbosity of the output.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_VERBOSE"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-versions-list.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-c, --config <value>",
                "value": "string",
                "description": "The name of the app configuration.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_APP_CONFIG"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-versions-list.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-j, --json",
                "value": "\"\"",
                "description": "Output the result as JSON.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_JSON"
              }
            ],
            "value": "export interface appversionslist {\n  /**\n   * The Client ID of your app.\n   * @environment SHOPIFY_FLAG_CLIENT_ID\n   */\n  '--client-id <value>'?: string\n\n  /**\n   * The name of the app configuration.\n   * @environment SHOPIFY_FLAG_APP_CONFIG\n   */\n  '-c, --config <value>'?: string\n\n  /**\n   * Output the result as JSON.\n   * @environment SHOPIFY_FLAG_JSON\n   */\n  '-j, --json'?: ''\n\n  /**\n   * Disable color output.\n   * @environment SHOPIFY_FLAG_NO_COLOR\n   */\n  '--no-color'?: ''\n\n  /**\n   * The path to your app directory.\n   * @environment SHOPIFY_FLAG_PATH\n   */\n  '--path <value>'?: string\n\n  /**\n   * Reset all your settings.\n   * @environment SHOPIFY_FLAG_RESET\n   */\n  '--reset'?: ''\n\n  /**\n   * Increase the verbosity of the output.\n   * @environment SHOPIFY_FLAG_VERBOSE\n   */\n  '--verbose'?: ''\n}"
          }
        }
      }
    ],
    "category": "app",
    "related": []
  },
  {
    "name": "app webhook trigger",
    "description": "\n  Triggers the delivery of a sample Admin API event topic payload to a designated address.\n\n  You should use this command to experiment with webhooks, to initially test your webhook configuration, or for unit testing. However, to test your webhook configuration from end to end, you should always trigger webhooks by performing the related action in Shopify.\n\n  Because most webhook deliveries use remote endpoints, you can trigger the command from any directory where you can use Shopify CLI, and send the webhook to any of the supported endpoint types. For example, you can run the command from your app's local directory, but send the webhook to a staging environment endpoint.\n\n  To learn more about using webhooks in a Shopify app, refer to [Webhooks overview](/docs/apps/webhooks).\n\n  ### Limitations\n\n  - Webhooks triggered using this method always have the same payload, so they can't be used to test scenarios that differ based on the payload contents.\n  - Webhooks triggered using this method aren't retried when they fail.\n  - Trigger requests are rate-limited using the [Partner API rate limit](/docs/api/partner#rate_limits).\n  - You can't use this method to validate your API webhook subscriptions.\n  ",
    "overviewPreviewDescription": "Trigger delivery of a sample webhook topic payload to a designated address.",
    "type": "command",
    "isVisualComponent": false,
    "defaultExample": {
      "codeblock": {
        "tabs": [
          {
            "title": "app webhook trigger",
            "code": "shopify app webhook trigger [flags]",
            "language": "bash"
          }
        ],
        "title": "app webhook trigger"
      }
    },
    "definitions": [
      {
        "title": "Flags",
        "description": "The following flags are available for the `app webhook trigger` command:",
        "type": "appwebhooktrigger",
        "typeDefinitions": {
          "appwebhooktrigger": {
            "filePath": "docs-shopify.dev/commands/interfaces/app-webhook-trigger.interface.ts",
            "name": "appwebhooktrigger",
            "description": "",
            "members": [
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-webhook-trigger.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--address <value>",
                "value": "string",
                "description": "The URL where the webhook payload should be sent.                You will need a different address type for each delivery-method:\n                     · For remote HTTP testing, use a URL that starts with https://\n · For local HTTP testing, use http://localhost:{port}/{url-path}\n                     · For Google Pub/Sub, use pubsub://{project-id}:{topic-id}\n                     · For Amazon EventBridge, use an Amazon Resource Name (ARN) starting with arn:aws:events:",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_ADDRESS"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-webhook-trigger.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--api-version <value>",
                "value": "string",
                "description": "The API Version of the webhook topic.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_API_VERSION"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-webhook-trigger.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--client-id <value>",
                "value": "string",
                "description": "The Client ID of your app.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_CLIENT_ID"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-webhook-trigger.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--client-secret <value>",
                "value": "string",
                "description": "Your app's client secret. This secret allows us to return the X-Shopify-Hmac-SHA256 header that lets you validate the origin of the response that you receive.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_CLIENT_SECRET"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-webhook-trigger.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--delivery-method <value>",
                "value": "string",
                "description": "Method chosen to deliver the topic payload. If not passed, it's inferred from the address.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_DELIVERY_METHOD"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-webhook-trigger.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--help",
                "value": "\"\"",
                "description": "This help. When you run the trigger command the CLI will prompt you for any information that isn't passed using flags.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_HELP"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-webhook-trigger.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--path <value>",
                "value": "string",
                "description": "The path to your app directory.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_PATH"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-webhook-trigger.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--reset",
                "value": "\"\"",
                "description": "Reset all your settings.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_RESET"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-webhook-trigger.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--shared-secret <value>",
                "value": "string",
                "description": "Deprecated. Please use client-secret.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_SHARED_SECRET"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-webhook-trigger.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--topic <value>",
                "value": "string",
                "description": "The requested webhook topic.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_TOPIC"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/app-webhook-trigger.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-c, --config <value>",
                "value": "string",
                "description": "The name of the app configuration.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_APP_CONFIG"
              }
            ],
            "value": "export interface appwebhooktrigger {\n  /**\n   * The URL where the webhook payload should be sent.\n                    You will need a different address type for each delivery-method:\n                          · For remote HTTP testing, use a URL that starts with https://\n      · For local HTTP testing, use http://localhost:{port}/{url-path}\n                          · For Google Pub/Sub, use pubsub://{project-id}:{topic-id}\n                          · For Amazon EventBridge, use an Amazon Resource Name (ARN) starting with arn:aws:events:\n   * @environment SHOPIFY_FLAG_ADDRESS\n   */\n  '--address <value>'?: string\n\n  /**\n   * The API Version of the webhook topic.\n   * @environment SHOPIFY_FLAG_API_VERSION\n   */\n  '--api-version <value>'?: string\n\n  /**\n   * The Client ID of your app.\n   * @environment SHOPIFY_FLAG_CLIENT_ID\n   */\n  '--client-id <value>'?: string\n\n  /**\n   * Your app's client secret. This secret allows us to return the X-Shopify-Hmac-SHA256 header that lets you validate the origin of the response that you receive.\n   * @environment SHOPIFY_FLAG_CLIENT_SECRET\n   */\n  '--client-secret <value>'?: string\n\n  /**\n   * The name of the app configuration.\n   * @environment SHOPIFY_FLAG_APP_CONFIG\n   */\n  '-c, --config <value>'?: string\n\n  /**\n   * Method chosen to deliver the topic payload. If not passed, it's inferred from the address.\n   * @environment SHOPIFY_FLAG_DELIVERY_METHOD\n   */\n  '--delivery-method <value>'?: string\n\n  /**\n   * This help. When you run the trigger command the CLI will prompt you for any information that isn't passed using flags.\n   * @environment SHOPIFY_FLAG_HELP\n   */\n  '--help'?: ''\n\n  /**\n   * The path to your app directory.\n   * @environment SHOPIFY_FLAG_PATH\n   */\n  '--path <value>'?: string\n\n  /**\n   * Reset all your settings.\n   * @environment SHOPIFY_FLAG_RESET\n   */\n  '--reset'?: ''\n\n  /**\n   * Deprecated. Please use client-secret.\n   * @environment SHOPIFY_FLAG_SHARED_SECRET\n   */\n  '--shared-secret <value>'?: string\n\n  /**\n   * The requested webhook topic.\n   * @environment SHOPIFY_FLAG_TOPIC\n   */\n  '--topic <value>'?: string\n}"
          }
        }
      }
    ],
    "category": "app",
    "related": []
  },
  {
    "name": "auth login",
    "description": "Logs you in to your Shopify account.",
    "overviewPreviewDescription": "Logs you in to your Shopify account.",
    "type": "command",
    "isVisualComponent": false,
    "defaultExample": {
      "codeblock": {
        "tabs": [
          {
            "title": "auth login",
            "code": "shopify auth login [flags]",
            "language": "bash"
          }
        ],
        "title": "auth login"
      }
    },
    "definitions": [
      {
        "title": "Flags",
        "description": "The following flags are available for the `auth login` command:",
        "type": "authlogin",
        "typeDefinitions": {
          "authlogin": {
            "filePath": "docs-shopify.dev/commands/interfaces/auth-login.interface.ts",
            "name": "authlogin",
            "description": "",
            "members": [
              {
                "filePath": "docs-shopify.dev/commands/interfaces/auth-login.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--alias <value>",
                "value": "string",
                "description": "Alias of the session you want to login to.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_AUTH_ALIAS"
              }
            ],
            "value": "export interface authlogin {\n  /**\n   * Alias of the session you want to login to.\n   * @environment SHOPIFY_FLAG_AUTH_ALIAS\n   */\n  '--alias <value>'?: string\n}"
          }
        }
      }
    ],
    "category": "general commands",
    "related": []
  },
  {
    "name": "auth logout",
    "description": "Logs you out of the Shopify account or Partner account and store.",
    "overviewPreviewDescription": "Logs you out of the Shopify account or Partner account and store.",
    "type": "command",
    "isVisualComponent": false,
    "defaultExample": {
      "codeblock": {
        "tabs": [
          {
            "title": "auth logout",
            "code": "shopify auth logout",
            "language": "bash"
          }
        ],
        "title": "auth logout"
      }
    },
    "definitions": [],
    "category": "general commands",
    "related": []
  },
  {
    "name": "commands",
    "description": "List all shopify commands.",
    "overviewPreviewDescription": "List all shopify commands.",
    "type": "command",
    "isVisualComponent": false,
    "defaultExample": {
      "codeblock": {
        "tabs": [
          {
            "title": "commands",
            "code": "shopify commands [flags]",
            "language": "bash"
          }
        ],
        "title": "commands"
      }
    },
    "definitions": [
      {
        "title": "Flags",
        "description": "The following flags are available for the `commands` command:",
        "type": "commands",
        "typeDefinitions": {
          "commands": {
            "filePath": "docs-shopify.dev/commands/interfaces/commands.interface.ts",
            "name": "commands",
            "description": "",
            "members": [
              {
                "filePath": "docs-shopify.dev/commands/interfaces/commands.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--deprecated",
                "value": "\"\"",
                "description": "Show deprecated commands.",
                "isOptional": true
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/commands.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--hidden",
                "value": "\"\"",
                "description": "Show hidden commands.",
                "isOptional": true
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/commands.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--json",
                "value": "\"\"",
                "description": "Format output as json.",
                "isOptional": true
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/commands.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--no-truncate",
                "value": "\"\"",
                "description": "Do not truncate output.",
                "isOptional": true
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/commands.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--sort <value>",
                "value": "string",
                "description": "Property to sort by.",
                "isOptional": true
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/commands.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--tree",
                "value": "\"\"",
                "description": "Show tree of commands.",
                "isOptional": true
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/commands.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-c, --columns <value>",
                "value": "string",
                "description": "Only show provided columns (comma-separated).",
                "isOptional": true
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/commands.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-x, --extended",
                "value": "\"\"",
                "description": "Show extra columns.",
                "isOptional": true
              }
            ],
            "value": "export interface commands {\n  /**\n   * Only show provided columns (comma-separated).\n   *\n   */\n  '-c, --columns <value>'?: string\n\n  /**\n   * Show deprecated commands.\n   *\n   */\n  '--deprecated'?: ''\n\n  /**\n   * Show extra columns.\n   *\n   */\n  '-x, --extended'?: ''\n\n  /**\n   * Show hidden commands.\n   *\n   */\n  '--hidden'?: ''\n\n  /**\n   * Format output as json.\n   *\n   */\n  '--json'?: ''\n\n  /**\n   * Do not truncate output.\n   *\n   */\n  '--no-truncate'?: ''\n\n  /**\n   * Property to sort by.\n   *\n   */\n  '--sort <value>'?: string\n\n  /**\n   * Show tree of commands.\n   *\n   */\n  '--tree'?: ''\n}"
          }
        }
      }
    ],
    "category": "general commands",
    "related": []
  },
  {
    "name": "config autocorrect off",
    "description": "Disable autocorrect. Off by default.\n\n  When autocorrection is enabled, Shopify CLI automatically runs a corrected version of your command if a correction is available.\n\n  When autocorrection is disabled, you need to confirm that you want to run corrections for mistyped commands.\n",
    "overviewPreviewDescription": "Disable autocorrect. Off by default.",
    "type": "command",
    "isVisualComponent": false,
    "defaultExample": {
      "codeblock": {
        "tabs": [
          {
            "title": "config autocorrect off",
            "code": "shopify config autocorrect off",
            "language": "bash"
          }
        ],
        "title": "config autocorrect off"
      }
    },
    "definitions": [],
    "category": "general commands",
    "related": []
  },
  {
    "name": "config autocorrect on",
    "description": "Enable autocorrect. Off by default.\n\n  When autocorrection is enabled, Shopify CLI automatically runs a corrected version of your command if a correction is available.\n\n  When autocorrection is disabled, you need to confirm that you want to run corrections for mistyped commands.\n",
    "overviewPreviewDescription": "Enable autocorrect. Off by default.",
    "type": "command",
    "isVisualComponent": false,
    "defaultExample": {
      "codeblock": {
        "tabs": [
          {
            "title": "config autocorrect on",
            "code": "shopify config autocorrect on",
            "language": "bash"
          }
        ],
        "title": "config autocorrect on"
      }
    },
    "definitions": [],
    "category": "general commands",
    "related": []
  },
  {
    "name": "config autocorrect status",
    "description": "Check whether autocorrect is enabled or disabled. On by default.\n\n  When autocorrection is enabled, Shopify CLI automatically runs a corrected version of your command if a correction is available.\n\n  When autocorrection is disabled, you need to confirm that you want to run corrections for mistyped commands.\n",
    "overviewPreviewDescription": "Check whether autocorrect is enabled or disabled. On by default.",
    "type": "command",
    "isVisualComponent": false,
    "defaultExample": {
      "codeblock": {
        "tabs": [
          {
            "title": "config autocorrect status",
            "code": "shopify config autocorrect status",
            "language": "bash"
          }
        ],
        "title": "config autocorrect status"
      }
    },
    "definitions": [],
    "category": "general commands",
    "related": []
  },
  {
    "name": "help",
    "description": "Display help for Shopify CLI",
    "overviewPreviewDescription": "Display help for Shopify CLI",
    "type": "command",
    "isVisualComponent": false,
    "defaultExample": {
      "codeblock": {
        "tabs": [
          {
            "title": "help",
            "code": "shopify help [command] [flags]",
            "language": "bash"
          }
        ],
        "title": "help"
      }
    },
    "definitions": [
      {
        "title": "Flags",
        "description": "The following flags are available for the `help` command:",
        "type": "help",
        "typeDefinitions": {
          "help": {
            "filePath": "docs-shopify.dev/commands/interfaces/help.interface.ts",
            "name": "help",
            "description": "",
            "members": [
              {
                "filePath": "docs-shopify.dev/commands/interfaces/help.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-n, --nested-commands",
                "value": "\"\"",
                "description": "Include all nested commands in the output.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_CLI_NESTED_COMMANDS"
              }
            ],
            "value": "export interface help {\n  /**\n   * Include all nested commands in the output.\n   * @environment SHOPIFY_FLAG_CLI_NESTED_COMMANDS\n   */\n  '-n, --nested-commands'?: ''\n}"
          }
        }
      }
    ],
    "category": "general commands",
    "related": []
  },
  {
    "name": "hydrogen build",
    "description": "Builds a Hydrogen storefront for production. The client and app worker files are compiled to a `/dist` folder in your Hydrogen project directory.",
    "overviewPreviewDescription": "Builds a Hydrogen storefront for production. The client and app worker files are compiled to a `/dist` folder in your Hydrogen project directory.",
    "type": "command",
    "isVisualComponent": false,
    "defaultExample": {
      "codeblock": {
        "tabs": [
          {
            "title": "hydrogen build",
            "code": "shopify hydrogen build [flags]",
            "language": "bash"
          }
        ],
        "title": "hydrogen build"
      }
    },
    "definitions": [
      {
        "title": "Flags",
        "description": "The following flags are available for the `hydrogen build` command:",
        "type": "hydrogenbuild",
        "typeDefinitions": {
          "hydrogenbuild": {
            "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-build.interface.ts",
            "name": "hydrogenbuild",
            "description": "",
            "members": [
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-build.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--bundle-stats",
                "value": "\"\"",
                "description": "Show a bundle size summary after building. Defaults to true, use `--no-bundle-stats` to disable.",
                "isOptional": true
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-build.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--codegen",
                "value": "\"\"",
                "description": "Automatically generates GraphQL types for your project’s Storefront API queries.",
                "isOptional": true
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-build.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--codegen-config-path <value>",
                "value": "string",
                "description": "Specifies a path to a codegen configuration file. Defaults to `<root>/codegen.ts` if this file exists.",
                "isOptional": true
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-build.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--disable-route-warning",
                "value": "\"\"",
                "description": "Disables any warnings about missing standard routes.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_HYDROGEN_FLAG_DISABLE_ROUTE_WARNING"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-build.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--entry <value>",
                "value": "string",
                "description": "Entry file for the worker. Defaults to `./server`.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_HYDROGEN_FLAG_ENTRY"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-build.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--force-client-sourcemap",
                "value": "\"\"",
                "description": "Client sourcemapping is avoided by default because it makes backend code visible in the browser. Use this flag to force enabling it.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_HYDROGEN_FLAG_FORCE_CLIENT_SOURCEMAP"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-build.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--lockfile-check",
                "value": "\"\"",
                "description": "Checks that there is exactly one valid lockfile in the project. Defaults to `true`. Deactivate with `--no-lockfile-check`.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_HYDROGEN_FLAG_LOCKFILE_CHECK"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-build.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--path <value>",
                "value": "string",
                "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_HYDROGEN_FLAG_PATH"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-build.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--sourcemap",
                "value": "\"\"",
                "description": "Controls whether server sourcemaps are generated. Default to `true`. Deactivate `--no-sourcemaps`.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_HYDROGEN_FLAG_SOURCEMAP"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-build.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--watch",
                "value": "\"\"",
                "description": "Watches for changes and rebuilds the project writing output to disk.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_HYDROGEN_FLAG_WATCH"
              }
            ],
            "value": "export interface hydrogenbuild {\n  /**\n   * Show a bundle size summary after building. Defaults to true, use `--no-bundle-stats` to disable.\n   *\n   */\n  '--bundle-stats'?: ''\n\n  /**\n   * Automatically generates GraphQL types for your project’s Storefront API queries.\n   *\n   */\n  '--codegen'?: ''\n\n  /**\n   * Specifies a path to a codegen configuration file. Defaults to `<root>/codegen.ts` if this file exists.\n   *\n   */\n  '--codegen-config-path <value>'?: string\n\n  /**\n   * Disables any warnings about missing standard routes.\n   * @environment SHOPIFY_HYDROGEN_FLAG_DISABLE_ROUTE_WARNING\n   */\n  '--disable-route-warning'?: ''\n\n  /**\n   * Entry file for the worker. Defaults to `./server`.\n   * @environment SHOPIFY_HYDROGEN_FLAG_ENTRY\n   */\n  '--entry <value>'?: string\n\n  /**\n   * Client sourcemapping is avoided by default because it makes backend code visible in the browser. Use this flag to force enabling it.\n   * @environment SHOPIFY_HYDROGEN_FLAG_FORCE_CLIENT_SOURCEMAP\n   */\n  '--force-client-sourcemap'?: ''\n\n  /**\n   * Checks that there is exactly one valid lockfile in the project. Defaults to `true`. Deactivate with `--no-lockfile-check`.\n   * @environment SHOPIFY_HYDROGEN_FLAG_LOCKFILE_CHECK\n   */\n  '--lockfile-check'?: ''\n\n  /**\n   * The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.\n   * @environment SHOPIFY_HYDROGEN_FLAG_PATH\n   */\n  '--path <value>'?: string\n\n  /**\n   * Controls whether server sourcemaps are generated. Default to `true`. Deactivate `--no-sourcemaps`.\n   * @environment SHOPIFY_HYDROGEN_FLAG_SOURCEMAP\n   */\n  '--sourcemap'?: ''\n\n  /**\n   * Watches for changes and rebuilds the project writing output to disk.\n   * @environment SHOPIFY_HYDROGEN_FLAG_WATCH\n   */\n  '--watch'?: ''\n}"
          }
        }
      }
    ],
    "category": "hydrogen",
    "related": []
  },
  {
    "name": "hydrogen check",
    "description": "Checks whether your Hydrogen app includes a set of standard Shopify routes.",
    "overviewPreviewDescription": "Checks whether your Hydrogen app includes a set of standard Shopify routes.",
    "type": "command",
    "isVisualComponent": false,
    "defaultExample": {
      "codeblock": {
        "tabs": [
          {
            "title": "hydrogen check",
            "code": "shopify hydrogen check [flags]",
            "language": "bash"
          }
        ],
        "title": "hydrogen check"
      }
    },
    "definitions": [
      {
        "title": "Flags",
        "description": "The following flags are available for the `hydrogen check` command:",
        "type": "hydrogencheck",
        "typeDefinitions": {
          "hydrogencheck": {
            "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-check.interface.ts",
            "name": "hydrogencheck",
            "description": "",
            "members": [
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-check.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--path <value>",
                "value": "string",
                "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_HYDROGEN_FLAG_PATH"
              }
            ],
            "value": "export interface hydrogencheck {\n  /**\n   * The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.\n   * @environment SHOPIFY_HYDROGEN_FLAG_PATH\n   */\n  '--path <value>'?: string\n}"
          }
        }
      }
    ],
    "category": "hydrogen",
    "related": []
  },
  {
    "name": "hydrogen codegen",
    "description": "Automatically generates GraphQL types for your project’s Storefront API queries.",
    "overviewPreviewDescription": "Automatically generates GraphQL types for your project’s Storefront API queries.",
    "type": "command",
    "isVisualComponent": false,
    "defaultExample": {
      "codeblock": {
        "tabs": [
          {
            "title": "hydrogen codegen",
            "code": "shopify hydrogen codegen [flags]",
            "language": "bash"
          }
        ],
        "title": "hydrogen codegen"
      }
    },
    "definitions": [
      {
        "title": "Flags",
        "description": "The following flags are available for the `hydrogen codegen` command:",
        "type": "hydrogencodegen",
        "typeDefinitions": {
          "hydrogencodegen": {
            "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-codegen.interface.ts",
            "name": "hydrogencodegen",
            "description": "",
            "members": [
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-codegen.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--codegen-config-path <value>",
                "value": "string",
                "description": "Specify a path to a codegen configuration file. Defaults to `<root>/codegen.ts` if it exists.",
                "isOptional": true
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-codegen.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--path <value>",
                "value": "string",
                "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_HYDROGEN_FLAG_PATH"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-codegen.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--watch",
                "value": "\"\"",
                "description": "Watch the project for changes to update types on file save.",
                "isOptional": true
              }
            ],
            "value": "export interface hydrogencodegen {\n  /**\n   * Specify a path to a codegen configuration file. Defaults to `<root>/codegen.ts` if it exists.\n   *\n   */\n  '--codegen-config-path <value>'?: string\n\n  /**\n   * The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.\n   * @environment SHOPIFY_HYDROGEN_FLAG_PATH\n   */\n  '--path <value>'?: string\n\n  /**\n   * Watch the project for changes to update types on file save.\n   *\n   */\n  '--watch'?: ''\n}"
          }
        }
      }
    ],
    "category": "hydrogen",
    "related": []
  },
  {
    "name": "hydrogen customer-account-push",
    "description": "Push project configuration to admin",
    "overviewPreviewDescription": "Push project configuration to admin",
    "type": "command",
    "isVisualComponent": false,
    "defaultExample": {
      "codeblock": {
        "tabs": [
          {
            "title": "hydrogen customer-account-push",
            "code": "shopify hydrogen customer-account-push [flags]",
            "language": "bash"
          }
        ],
        "title": "hydrogen customer-account-push"
      }
    },
    "definitions": [
      {
        "title": "Flags",
        "description": "The following flags are available for the `hydrogen customer-account-push` command:",
        "type": "hydrogencustomeraccountpush",
        "typeDefinitions": {
          "hydrogencustomeraccountpush": {
            "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-customer-account-push.interface.ts",
            "name": "hydrogencustomeraccountpush",
            "description": "",
            "members": [
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-customer-account-push.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--dev-origin <value>",
                "value": "string",
                "description": "The development domain of your application."
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-customer-account-push.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--path <value>",
                "value": "string",
                "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_HYDROGEN_FLAG_PATH"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-customer-account-push.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--relative-logout-uri <value>",
                "value": "string",
                "description": "The relative url of allowed url that will be redirected to post-logout for Customer Account API OAuth flow. Default to nothing.",
                "isOptional": true
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-customer-account-push.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--relative-redirect-uri <value>",
                "value": "string",
                "description": "The relative url of allowed callback url for Customer Account API OAuth flow. Default is '/account/authorize'",
                "isOptional": true
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-customer-account-push.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--storefront-id <value>",
                "value": "string",
                "description": "The id of the storefront the configuration should be pushed to. Must start with 'gid://shopify/HydrogenStorefront/'",
                "isOptional": true
              }
            ],
            "value": "export interface hydrogencustomeraccountpush {\n  /**\n   * The development domain of your application.\n   *\n   */\n  '--dev-origin <value>': string\n\n  /**\n   * The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.\n   * @environment SHOPIFY_HYDROGEN_FLAG_PATH\n   */\n  '--path <value>'?: string\n\n  /**\n   * The relative url of allowed url that will be redirected to post-logout for Customer Account API OAuth flow. Default to nothing.\n   *\n   */\n  '--relative-logout-uri <value>'?: string\n\n  /**\n   * The relative url of allowed callback url for Customer Account API OAuth flow. Default is '/account/authorize'\n   *\n   */\n  '--relative-redirect-uri <value>'?: string\n\n  /**\n   * The id of the storefront the configuration should be pushed to. Must start with 'gid://shopify/HydrogenStorefront/'\n   *\n   */\n  '--storefront-id <value>'?: string\n}"
          }
        }
      }
    ],
    "category": "hydrogen",
    "related": []
  },
  {
    "name": "hydrogen debug cpu",
    "description": "Builds the app and runs the resulting code to profile the server startup time, watching for changes. This command can be used to [debug slow app startup times](/docs/custom-storefronts/hydrogen/debugging/cpu-startup) that cause failed deployments in Oxygen.\n\n  The profiling results are written to a `.cpuprofile` file that can be viewed with certain tools such as [Flame Chart Visualizer for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=ms-vscode.vscode-js-profile-flame).",
    "overviewPreviewDescription": "Builds the app and runs the resulting code to profile the server startup time, watching for changes. This command can be used to [debug slow app startup times](/docs/custom-storefronts/hydrogen/debugging/cpu-startup) that cause failed deployments in Oxygen.\n\n  The profiling results are written to a `.cpuprofile` file that can be viewed with certain tools such as [Flame Chart Visualizer for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=ms-vscode.vscode-js-profile-flame).",
    "type": "command",
    "isVisualComponent": false,
    "defaultExample": {
      "codeblock": {
        "tabs": [
          {
            "title": "hydrogen debug cpu",
            "code": "shopify hydrogen debug cpu [flags]",
            "language": "bash"
          }
        ],
        "title": "hydrogen debug cpu"
      }
    },
    "definitions": [
      {
        "title": "Flags",
        "description": "The following flags are available for the `hydrogen debug cpu` command:",
        "type": "hydrogendebugcpu",
        "typeDefinitions": {
          "hydrogendebugcpu": {
            "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-debug-cpu.interface.ts",
            "name": "hydrogendebugcpu",
            "description": "",
            "members": [
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-debug-cpu.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--entry <value>",
                "value": "string",
                "description": "Entry file for the worker. Defaults to `./server`.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_HYDROGEN_FLAG_ENTRY"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-debug-cpu.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--output <value>",
                "value": "string",
                "description": "Specify a path to generate the profile file. Defaults to \"startup.cpuprofile\".",
                "isOptional": true
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-debug-cpu.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--path <value>",
                "value": "string",
                "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_HYDROGEN_FLAG_PATH"
              }
            ],
            "value": "export interface hydrogendebugcpu {\n  /**\n   * Entry file for the worker. Defaults to `./server`.\n   * @environment SHOPIFY_HYDROGEN_FLAG_ENTRY\n   */\n  '--entry <value>'?: string\n\n  /**\n   * Specify a path to generate the profile file. Defaults to \"startup.cpuprofile\".\n   *\n   */\n  '--output <value>'?: string\n\n  /**\n   * The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.\n   * @environment SHOPIFY_HYDROGEN_FLAG_PATH\n   */\n  '--path <value>'?: string\n}"
          }
        }
      }
    ],
    "category": "hydrogen",
    "related": []
  },
  {
    "name": "hydrogen deploy",
    "description": "Builds and deploys your Hydrogen storefront to Oxygen. Requires an Oxygen deployment token to be set with the `--token` flag or an environment variable (`SHOPIFY_HYDROGEN_DEPLOYMENT_TOKEN`). If the storefront is [linked](/docs/api/shopify-cli/hydrogen/hydrogen-link) then the Oxygen deployment token for the linked storefront will be used automatically.",
    "overviewPreviewDescription": "Builds and deploys your Hydrogen storefront to Oxygen. Requires an Oxygen deployment token to be set with the `--token` flag or an environment variable (`SHOPIFY_HYDROGEN_DEPLOYMENT_TOKEN`). If the storefront is [linked](/docs/api/shopify-cli/hydrogen/hydrogen-link) then the Oxygen deployment token for the linked storefront will be used automatically.",
    "type": "command",
    "isVisualComponent": false,
    "defaultExample": {
      "codeblock": {
        "tabs": [
          {
            "title": "hydrogen deploy",
            "code": "shopify hydrogen deploy [flags]",
            "language": "bash"
          }
        ],
        "title": "hydrogen deploy"
      }
    },
    "definitions": [
      {
        "title": "Flags",
        "description": "The following flags are available for the `hydrogen deploy` command:",
        "type": "hydrogendeploy",
        "typeDefinitions": {
          "hydrogendeploy": {
            "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-deploy.interface.ts",
            "name": "hydrogendeploy",
            "description": "",
            "members": [
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-deploy.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--auth-bypass-token",
                "value": "\"\"",
                "description": "Generate an authentication bypass token, which can be used to perform end-to-end tests against the deployment.",
                "isOptional": true,
                "environmentValue": "AUTH_BYPASS_TOKEN"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-deploy.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--auth-bypass-token-duration <value>",
                "value": "string",
                "description": "Specify the duration (in hours) up to 12 hours for the authentication bypass token. Defaults to `2`",
                "isOptional": true,
                "environmentValue": "AUTH_BYPASS_TOKEN_DURATION"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-deploy.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--build-command <value>",
                "value": "string",
                "description": "Specify a build command to run before deploying. If not specified, `shopify hydrogen build` will be used.",
                "isOptional": true
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-deploy.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--entry <value>",
                "value": "string",
                "description": "Entry file for the worker. Defaults to `./server`.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_HYDROGEN_FLAG_ENTRY"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-deploy.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--env <value>",
                "value": "string",
                "description": "Specifies the environment to perform the operation using its handle. Fetch the handle using the `env list` command.",
                "isOptional": true
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-deploy.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--env-branch <value>",
                "value": "string",
                "description": "Specifies the environment to perform the operation using its Git branch name.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_HYDROGEN_ENVIRONMENT_BRANCH"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-deploy.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--env-file <value>",
                "value": "string",
                "description": "Path to an environment file to override existing environment variables for the deployment.",
                "isOptional": true
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-deploy.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--force-client-sourcemap",
                "value": "\"\"",
                "description": "Client sourcemapping is avoided by default because it makes backend code visible in the browser. Use this flag to force enabling it.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_HYDROGEN_FLAG_FORCE_CLIENT_SOURCEMAP"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-deploy.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--json-output",
                "value": "\"\"",
                "description": "Create a JSON file containing the deployment details in CI environments. Defaults to true, use `--no-json-output` to disable.",
                "isOptional": true
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-deploy.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--lockfile-check",
                "value": "\"\"",
                "description": "Checks that there is exactly one valid lockfile in the project. Defaults to `true`. Deactivate with `--no-lockfile-check`.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_HYDROGEN_FLAG_LOCKFILE_CHECK"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-deploy.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--metadata-description <value>",
                "value": "string",
                "description": "Description of the changes in the deployment. Defaults to the commit message of the latest commit if there are no uncommited changes.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_HYDROGEN_FLAG_METADATA_DESCRIPTION"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-deploy.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--metadata-user <value>",
                "value": "string",
                "description": "User that initiated the deployment. Will be saved and displayed in the Shopify admin",
                "isOptional": true,
                "environmentValue": "SHOPIFY_HYDROGEN_FLAG_METADATA_USER"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-deploy.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--no-verify",
                "value": "\"\"",
                "description": "Skip the routability verification step after deployment.",
                "isOptional": true
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-deploy.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--path <value>",
                "value": "string",
                "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_HYDROGEN_FLAG_PATH"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-deploy.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--preview",
                "value": "\"\"",
                "description": "Deploys to the Preview environment.",
                "isOptional": true
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-deploy.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-f, --force",
                "value": "\"\"",
                "description": "Forces a deployment to proceed if there are uncommited changes in its Git repository.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_HYDROGEN_FLAG_FORCE"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-deploy.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-s, --shop <value>",
                "value": "string",
                "description": "Shop URL. It can be the shop prefix (janes-apparel) or the full myshopify.com URL (janes-apparel.myshopify.com, https://janes-apparel.myshopify.com).",
                "isOptional": true,
                "environmentValue": "SHOPIFY_SHOP"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-deploy.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-t, --token <value>",
                "value": "string",
                "description": "Oxygen deployment token. Defaults to the linked storefront's token if available.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_HYDROGEN_DEPLOYMENT_TOKEN"
              }
            ],
            "value": "export interface hydrogendeploy {\n  /**\n   * Generate an authentication bypass token, which can be used to perform end-to-end tests against the deployment.\n   * @environment AUTH_BYPASS_TOKEN\n   */\n  '--auth-bypass-token'?: ''\n\n  /**\n   * Specify the duration (in hours) up to 12 hours for the authentication bypass token. Defaults to `2`\n   * @environment AUTH_BYPASS_TOKEN_DURATION\n   */\n  '--auth-bypass-token-duration <value>'?: string\n\n  /**\n   * Specify a build command to run before deploying. If not specified, `shopify hydrogen build` will be used.\n   *\n   */\n  '--build-command <value>'?: string\n\n  /**\n   * Entry file for the worker. Defaults to `./server`.\n   * @environment SHOPIFY_HYDROGEN_FLAG_ENTRY\n   */\n  '--entry <value>'?: string\n\n  /**\n   * Specifies the environment to perform the operation using its handle. Fetch the handle using the `env list` command.\n   *\n   */\n  '--env <value>'?: string\n\n  /**\n   * Specifies the environment to perform the operation using its Git branch name.\n   * @environment SHOPIFY_HYDROGEN_ENVIRONMENT_BRANCH\n   */\n  '--env-branch <value>'?: string\n\n  /**\n   * Path to an environment file to override existing environment variables for the deployment.\n   *\n   */\n  '--env-file <value>'?: string\n\n  /**\n   * Forces a deployment to proceed if there are uncommited changes in its Git repository.\n   * @environment SHOPIFY_HYDROGEN_FLAG_FORCE\n   */\n  '-f, --force'?: ''\n\n  /**\n   * Client sourcemapping is avoided by default because it makes backend code visible in the browser. Use this flag to force enabling it.\n   * @environment SHOPIFY_HYDROGEN_FLAG_FORCE_CLIENT_SOURCEMAP\n   */\n  '--force-client-sourcemap'?: ''\n\n  /**\n   * Create a JSON file containing the deployment details in CI environments. Defaults to true, use `--no-json-output` to disable.\n   *\n   */\n  '--json-output'?: ''\n\n  /**\n   * Checks that there is exactly one valid lockfile in the project. Defaults to `true`. Deactivate with `--no-lockfile-check`.\n   * @environment SHOPIFY_HYDROGEN_FLAG_LOCKFILE_CHECK\n   */\n  '--lockfile-check'?: ''\n\n  /**\n   * Description of the changes in the deployment. Defaults to the commit message of the latest commit if there are no uncommited changes.\n   * @environment SHOPIFY_HYDROGEN_FLAG_METADATA_DESCRIPTION\n   */\n  '--metadata-description <value>'?: string\n\n  /**\n   * User that initiated the deployment. Will be saved and displayed in the Shopify admin\n   * @environment SHOPIFY_HYDROGEN_FLAG_METADATA_USER\n   */\n  '--metadata-user <value>'?: string\n\n  /**\n   * Skip the routability verification step after deployment.\n   *\n   */\n  '--no-verify'?: ''\n\n  /**\n   * The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.\n   * @environment SHOPIFY_HYDROGEN_FLAG_PATH\n   */\n  '--path <value>'?: string\n\n  /**\n   * Deploys to the Preview environment.\n   *\n   */\n  '--preview'?: ''\n\n  /**\n   * Shop URL. It can be the shop prefix (janes-apparel) or the full myshopify.com URL (janes-apparel.myshopify.com, https://janes-apparel.myshopify.com).\n   * @environment SHOPIFY_SHOP\n   */\n  '-s, --shop <value>'?: string\n\n  /**\n   * Oxygen deployment token. Defaults to the linked storefront's token if available.\n   * @environment SHOPIFY_HYDROGEN_DEPLOYMENT_TOKEN\n   */\n  '-t, --token <value>'?: string\n}"
          }
        }
      }
    ],
    "category": "hydrogen",
    "related": []
  },
  {
    "name": "hydrogen dev",
    "description": "Runs a Hydrogen storefront in a local runtime that emulates an Oxygen worker for development.\n\n  If your project is [linked](/docs/api/shopify-cli/hydrogen/hydrogen-link) to a Hydrogen storefront, then its environment variables will be loaded with the runtime.",
    "overviewPreviewDescription": "Runs a Hydrogen storefront in a local runtime that emulates an Oxygen worker for development.\n\n  If your project is [linked](/docs/api/shopify-cli/hydrogen/hydrogen-link) to a Hydrogen storefront, then its environment variables will be loaded with the runtime.",
    "type": "command",
    "isVisualComponent": false,
    "defaultExample": {
      "codeblock": {
        "tabs": [
          {
            "title": "hydrogen dev",
            "code": "shopify hydrogen dev [flags]",
            "language": "bash"
          }
        ],
        "title": "hydrogen dev"
      }
    },
    "definitions": [
      {
        "title": "Flags",
        "description": "The following flags are available for the `hydrogen dev` command:",
        "type": "hydrogendev",
        "typeDefinitions": {
          "hydrogendev": {
            "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-dev.interface.ts",
            "name": "hydrogendev",
            "description": "",
            "members": [
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-dev.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--codegen",
                "value": "\"\"",
                "description": "Automatically generates GraphQL types for your project’s Storefront API queries.",
                "isOptional": true
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-dev.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--codegen-config-path <value>",
                "value": "string",
                "description": "Specifies a path to a codegen configuration file. Defaults to `<root>/codegen.ts` if this file exists.",
                "isOptional": true
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-dev.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--customer-account-push",
                "value": "\"\"",
                "description": "Use tunneling for local development and push the tunneling domain to admin. Required to use Customer Account API's OAuth flow",
                "isOptional": true,
                "environmentValue": "SHOPIFY_HYDROGEN_FLAG_CUSTOMER_ACCOUNT_PUSH"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-dev.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--debug",
                "value": "\"\"",
                "description": "Enables inspector connections to the server with a debugger such as Visual Studio Code or Chrome DevTools.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_HYDROGEN_FLAG_DEBUG"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-dev.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--disable-deps-optimizer",
                "value": "\"\"",
                "description": "Disable adding dependencies to Vite's `ssr.optimizeDeps.include` automatically",
                "isOptional": true,
                "environmentValue": "SHOPIFY_HYDROGEN_FLAG_DISABLE_DEPS_OPTIMIZER"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-dev.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--disable-version-check",
                "value": "\"\"",
                "description": "Skip the version check when running `hydrogen dev`",
                "isOptional": true
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-dev.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--disable-virtual-routes",
                "value": "\"\"",
                "description": "Disable rendering fallback routes when a route file doesn't exist.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_HYDROGEN_FLAG_DISABLE_VIRTUAL_ROUTES"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-dev.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--entry <value>",
                "value": "string",
                "description": "Entry file for the worker. Defaults to `./server`.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_HYDROGEN_FLAG_ENTRY"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-dev.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--env <value>",
                "value": "string",
                "description": "Specifies the environment to perform the operation using its handle. Fetch the handle using the `env list` command.",
                "isOptional": true
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-dev.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--env-branch <value>",
                "value": "string",
                "description": "Specifies the environment to perform the operation using its Git branch name.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_HYDROGEN_ENVIRONMENT_BRANCH"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-dev.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--env-file <value>",
                "value": "string",
                "description": "Path to an environment file to override existing environment variables. Defaults to the '.env' located in your project path `--path`.",
                "isOptional": true
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-dev.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--host",
                "value": "\"\"",
                "description": "Expose the server to the local network",
                "isOptional": true
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-dev.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--inspector-port <value>",
                "value": "string",
                "description": "The port where the inspector is available. Defaults to 9229.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_HYDROGEN_FLAG_INSPECTOR_PORT"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-dev.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--path <value>",
                "value": "string",
                "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_HYDROGEN_FLAG_PATH"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-dev.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--port <value>",
                "value": "string",
                "description": "The port to run the server on. Defaults to 3000.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_HYDROGEN_FLAG_PORT"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-dev.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--verbose",
                "value": "\"\"",
                "description": "Outputs more information about the command's execution.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_HYDROGEN_FLAG_VERBOSE"
              }
            ],
            "value": "export interface hydrogendev {\n  /**\n   * Automatically generates GraphQL types for your project’s Storefront API queries.\n   *\n   */\n  '--codegen'?: ''\n\n  /**\n   * Specifies a path to a codegen configuration file. Defaults to `<root>/codegen.ts` if this file exists.\n   *\n   */\n  '--codegen-config-path <value>'?: string\n\n  /**\n   * Use tunneling for local development and push the tunneling domain to admin. Required to use Customer Account API's OAuth flow\n   * @environment SHOPIFY_HYDROGEN_FLAG_CUSTOMER_ACCOUNT_PUSH\n   */\n  '--customer-account-push'?: ''\n\n  /**\n   * Enables inspector connections to the server with a debugger such as Visual Studio Code or Chrome DevTools.\n   * @environment SHOPIFY_HYDROGEN_FLAG_DEBUG\n   */\n  '--debug'?: ''\n\n  /**\n   * Disable adding dependencies to Vite's `ssr.optimizeDeps.include` automatically\n   * @environment SHOPIFY_HYDROGEN_FLAG_DISABLE_DEPS_OPTIMIZER\n   */\n  '--disable-deps-optimizer'?: ''\n\n  /**\n   * Skip the version check when running `hydrogen dev`\n   *\n   */\n  '--disable-version-check'?: ''\n\n  /**\n   * Disable rendering fallback routes when a route file doesn't exist.\n   * @environment SHOPIFY_HYDROGEN_FLAG_DISABLE_VIRTUAL_ROUTES\n   */\n  '--disable-virtual-routes'?: ''\n\n  /**\n   * Entry file for the worker. Defaults to `./server`.\n   * @environment SHOPIFY_HYDROGEN_FLAG_ENTRY\n   */\n  '--entry <value>'?: string\n\n  /**\n   * Specifies the environment to perform the operation using its handle. Fetch the handle using the `env list` command.\n   *\n   */\n  '--env <value>'?: string\n\n  /**\n   * Specifies the environment to perform the operation using its Git branch name.\n   * @environment SHOPIFY_HYDROGEN_ENVIRONMENT_BRANCH\n   */\n  '--env-branch <value>'?: string\n\n  /**\n   * Path to an environment file to override existing environment variables. Defaults to the '.env' located in your project path `--path`.\n   *\n   */\n  '--env-file <value>'?: string\n\n  /**\n   * Expose the server to the local network\n   *\n   */\n  '--host'?: ''\n\n  /**\n   * The port where the inspector is available. Defaults to 9229.\n   * @environment SHOPIFY_HYDROGEN_FLAG_INSPECTOR_PORT\n   */\n  '--inspector-port <value>'?: string\n\n  /**\n   * The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.\n   * @environment SHOPIFY_HYDROGEN_FLAG_PATH\n   */\n  '--path <value>'?: string\n\n  /**\n   * The port to run the server on. Defaults to 3000.\n   * @environment SHOPIFY_HYDROGEN_FLAG_PORT\n   */\n  '--port <value>'?: string\n\n  /**\n   * Outputs more information about the command's execution.\n   * @environment SHOPIFY_HYDROGEN_FLAG_VERBOSE\n   */\n  '--verbose'?: ''\n}"
          }
        }
      }
    ],
    "category": "hydrogen",
    "related": []
  },
  {
    "name": "hydrogen env list",
    "description": "Lists all environments available on the linked Hydrogen storefront.",
    "overviewPreviewDescription": "Lists all environments available on the linked Hydrogen storefront.",
    "type": "command",
    "isVisualComponent": false,
    "defaultExample": {
      "codeblock": {
        "tabs": [
          {
            "title": "hydrogen env list",
            "code": "shopify hydrogen env list [flags]",
            "language": "bash"
          }
        ],
        "title": "hydrogen env list"
      }
    },
    "definitions": [
      {
        "title": "Flags",
        "description": "The following flags are available for the `hydrogen env list` command:",
        "type": "hydrogenenvlist",
        "typeDefinitions": {
          "hydrogenenvlist": {
            "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-env-list.interface.ts",
            "name": "hydrogenenvlist",
            "description": "",
            "members": [
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-env-list.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--path <value>",
                "value": "string",
                "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_HYDROGEN_FLAG_PATH"
              }
            ],
            "value": "export interface hydrogenenvlist {\n  /**\n   * The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.\n   * @environment SHOPIFY_HYDROGEN_FLAG_PATH\n   */\n  '--path <value>'?: string\n}"
          }
        }
      }
    ],
    "category": "hydrogen",
    "related": []
  },
  {
    "name": "hydrogen env pull",
    "description": "Pulls environment variables from the linked Hydrogen storefront and writes them to an `.env` file.",
    "overviewPreviewDescription": "Pulls environment variables from the linked Hydrogen storefront and writes them to an `.env` file.",
    "type": "command",
    "isVisualComponent": false,
    "defaultExample": {
      "codeblock": {
        "tabs": [
          {
            "title": "hydrogen env pull",
            "code": "shopify hydrogen env pull [flags]",
            "language": "bash"
          }
        ],
        "title": "hydrogen env pull"
      }
    },
    "definitions": [
      {
        "title": "Flags",
        "description": "The following flags are available for the `hydrogen env pull` command:",
        "type": "hydrogenenvpull",
        "typeDefinitions": {
          "hydrogenenvpull": {
            "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-env-pull.interface.ts",
            "name": "hydrogenenvpull",
            "description": "",
            "members": [
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-env-pull.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--env <value>",
                "value": "string",
                "description": "Specifies the environment to perform the operation using its handle. Fetch the handle using the `env list` command.",
                "isOptional": true
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-env-pull.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--env-branch <value>",
                "value": "string",
                "description": "Specifies the environment to perform the operation using its Git branch name.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_HYDROGEN_ENVIRONMENT_BRANCH"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-env-pull.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--env-file <value>",
                "value": "string",
                "description": "Path to an environment file to override existing environment variables. Defaults to the '.env' located in your project path `--path`.",
                "isOptional": true
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-env-pull.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--path <value>",
                "value": "string",
                "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_HYDROGEN_FLAG_PATH"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-env-pull.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-f, --force",
                "value": "\"\"",
                "description": "Overwrites the destination directory and files if they already exist.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_HYDROGEN_FLAG_FORCE"
              }
            ],
            "value": "export interface hydrogenenvpull {\n  /**\n   * Specifies the environment to perform the operation using its handle. Fetch the handle using the `env list` command.\n   *\n   */\n  '--env <value>'?: string\n\n  /**\n   * Specifies the environment to perform the operation using its Git branch name.\n   * @environment SHOPIFY_HYDROGEN_ENVIRONMENT_BRANCH\n   */\n  '--env-branch <value>'?: string\n\n  /**\n   * Path to an environment file to override existing environment variables. Defaults to the '.env' located in your project path `--path`.\n   *\n   */\n  '--env-file <value>'?: string\n\n  /**\n   * Overwrites the destination directory and files if they already exist.\n   * @environment SHOPIFY_HYDROGEN_FLAG_FORCE\n   */\n  '-f, --force'?: ''\n\n  /**\n   * The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.\n   * @environment SHOPIFY_HYDROGEN_FLAG_PATH\n   */\n  '--path <value>'?: string\n}"
          }
        }
      }
    ],
    "category": "hydrogen",
    "related": []
  },
  {
    "name": "hydrogen env push",
    "description": "Push environment variables from the local .env file to your linked Hydrogen storefront.",
    "overviewPreviewDescription": "Push environment variables from the local .env file to your linked Hydrogen storefront.",
    "type": "command",
    "isVisualComponent": false,
    "defaultExample": {
      "codeblock": {
        "tabs": [
          {
            "title": "hydrogen env push",
            "code": "shopify hydrogen env push [flags]",
            "language": "bash"
          }
        ],
        "title": "hydrogen env push"
      }
    },
    "definitions": [
      {
        "title": "Flags",
        "description": "The following flags are available for the `hydrogen env push` command:",
        "type": "hydrogenenvpush",
        "typeDefinitions": {
          "hydrogenenvpush": {
            "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-env-push.interface.ts",
            "name": "hydrogenenvpush",
            "description": "",
            "members": [
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-env-push.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--env <value>",
                "value": "string",
                "description": "Specifies the environment to perform the operation using its handle. Fetch the handle using the `env list` command.",
                "isOptional": true
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-env-push.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--env-file <value>",
                "value": "string",
                "description": "Path to an environment file to override existing environment variables. Defaults to the '.env' located in your project path `--path`.",
                "isOptional": true
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-env-push.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--path <value>",
                "value": "string",
                "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_HYDROGEN_FLAG_PATH"
              }
            ],
            "value": "export interface hydrogenenvpush {\n  /**\n   * Specifies the environment to perform the operation using its handle. Fetch the handle using the `env list` command.\n   *\n   */\n  '--env <value>'?: string\n\n  /**\n   * Path to an environment file to override existing environment variables. Defaults to the '.env' located in your project path `--path`.\n   *\n   */\n  '--env-file <value>'?: string\n\n  /**\n   * The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.\n   * @environment SHOPIFY_HYDROGEN_FLAG_PATH\n   */\n  '--path <value>'?: string\n}"
          }
        }
      }
    ],
    "category": "hydrogen",
    "related": []
  },
  {
    "name": "hydrogen generate route",
    "description": "Generates a set of default routes from the starter template.",
    "overviewPreviewDescription": "Generates a set of default routes from the starter template.",
    "type": "command",
    "isVisualComponent": false,
    "defaultExample": {
      "codeblock": {
        "tabs": [
          {
            "title": "hydrogen generate route",
            "code": "shopify hydrogen generate route [flags]",
            "language": "bash"
          }
        ],
        "title": "hydrogen generate route"
      }
    },
    "definitions": [
      {
        "title": "Flags",
        "description": "The following flags are available for the `hydrogen generate route` command:",
        "type": "hydrogengenerateroute",
        "typeDefinitions": {
          "hydrogengenerateroute": {
            "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-generate-route.interface.ts",
            "name": "hydrogengenerateroute",
            "description": "",
            "members": [
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-generate-route.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--adapter <value>",
                "value": "string",
                "description": "Remix adapter used in the route. The default is `@shopify/remix-oxygen`.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_HYDROGEN_FLAG_ADAPTER"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-generate-route.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--locale-param <value>",
                "value": "string",
                "description": "The param name in Remix routes for the i18n locale, if any. Example: `locale` becomes ($locale).",
                "isOptional": true,
                "environmentValue": "SHOPIFY_HYDROGEN_FLAG_ADAPTER"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-generate-route.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--path <value>",
                "value": "string",
                "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_HYDROGEN_FLAG_PATH"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-generate-route.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--typescript",
                "value": "\"\"",
                "description": "Generate TypeScript files",
                "isOptional": true,
                "environmentValue": "SHOPIFY_HYDROGEN_FLAG_TYPESCRIPT"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-generate-route.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-f, --force",
                "value": "\"\"",
                "description": "Overwrites the destination directory and files if they already exist.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_HYDROGEN_FLAG_FORCE"
              }
            ],
            "value": "export interface hydrogengenerateroute {\n  /**\n   * Remix adapter used in the route. The default is `@shopify/remix-oxygen`.\n   * @environment SHOPIFY_HYDROGEN_FLAG_ADAPTER\n   */\n  '--adapter <value>'?: string\n\n  /**\n   * Overwrites the destination directory and files if they already exist.\n   * @environment SHOPIFY_HYDROGEN_FLAG_FORCE\n   */\n  '-f, --force'?: ''\n\n  /**\n   * The param name in Remix routes for the i18n locale, if any. Example: `locale` becomes ($locale).\n   * @environment SHOPIFY_HYDROGEN_FLAG_ADAPTER\n   */\n  '--locale-param <value>'?: string\n\n  /**\n   * The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.\n   * @environment SHOPIFY_HYDROGEN_FLAG_PATH\n   */\n  '--path <value>'?: string\n\n  /**\n   * Generate TypeScript files\n   * @environment SHOPIFY_HYDROGEN_FLAG_TYPESCRIPT\n   */\n  '--typescript'?: ''\n}"
          }
        }
      }
    ],
    "category": "hydrogen",
    "related": []
  },
  {
    "name": "hydrogen generate routes",
    "description": "Generates all supported standard shopify routes.",
    "overviewPreviewDescription": "Generates all supported standard shopify routes.",
    "type": "command",
    "isVisualComponent": false,
    "defaultExample": {
      "codeblock": {
        "tabs": [
          {
            "title": "hydrogen generate routes",
            "code": "shopify hydrogen generate routes [flags]",
            "language": "bash"
          }
        ],
        "title": "hydrogen generate routes"
      }
    },
    "definitions": [
      {
        "title": "Flags",
        "description": "The following flags are available for the `hydrogen generate routes` command:",
        "type": "hydrogengenerateroutes",
        "typeDefinitions": {
          "hydrogengenerateroutes": {
            "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-generate-routes.interface.ts",
            "name": "hydrogengenerateroutes",
            "description": "",
            "members": [
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-generate-routes.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--adapter <value>",
                "value": "string",
                "description": "Remix adapter used in the route. The default is `@shopify/remix-oxygen`.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_HYDROGEN_FLAG_ADAPTER"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-generate-routes.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--locale-param <value>",
                "value": "string",
                "description": "The param name in Remix routes for the i18n locale, if any. Example: `locale` becomes ($locale).",
                "isOptional": true,
                "environmentValue": "SHOPIFY_HYDROGEN_FLAG_ADAPTER"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-generate-routes.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--path <value>",
                "value": "string",
                "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_HYDROGEN_FLAG_PATH"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-generate-routes.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--typescript",
                "value": "\"\"",
                "description": "Generate TypeScript files",
                "isOptional": true,
                "environmentValue": "SHOPIFY_HYDROGEN_FLAG_TYPESCRIPT"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-generate-routes.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-f, --force",
                "value": "\"\"",
                "description": "Overwrites the destination directory and files if they already exist.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_HYDROGEN_FLAG_FORCE"
              }
            ],
            "value": "export interface hydrogengenerateroutes {\n  /**\n   * Remix adapter used in the route. The default is `@shopify/remix-oxygen`.\n   * @environment SHOPIFY_HYDROGEN_FLAG_ADAPTER\n   */\n  '--adapter <value>'?: string\n\n  /**\n   * Overwrites the destination directory and files if they already exist.\n   * @environment SHOPIFY_HYDROGEN_FLAG_FORCE\n   */\n  '-f, --force'?: ''\n\n  /**\n   * The param name in Remix routes for the i18n locale, if any. Example: `locale` becomes ($locale).\n   * @environment SHOPIFY_HYDROGEN_FLAG_ADAPTER\n   */\n  '--locale-param <value>'?: string\n\n  /**\n   * The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.\n   * @environment SHOPIFY_HYDROGEN_FLAG_PATH\n   */\n  '--path <value>'?: string\n\n  /**\n   * Generate TypeScript files\n   * @environment SHOPIFY_HYDROGEN_FLAG_TYPESCRIPT\n   */\n  '--typescript'?: ''\n}"
          }
        }
      }
    ],
    "category": "hydrogen",
    "related": []
  },
  {
    "name": "hydrogen init",
    "description": "Creates a new Hydrogen storefront.",
    "overviewPreviewDescription": "Creates a new Hydrogen storefront.",
    "type": "command",
    "isVisualComponent": false,
    "defaultExample": {
      "codeblock": {
        "tabs": [
          {
            "title": "hydrogen init",
            "code": "shopify hydrogen init [flags]",
            "language": "bash"
          }
        ],
        "title": "hydrogen init"
      }
    },
    "definitions": [
      {
        "title": "Flags",
        "description": "The following flags are available for the `hydrogen init` command:",
        "type": "hydrogeninit",
        "typeDefinitions": {
          "hydrogeninit": {
            "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-init.interface.ts",
            "name": "hydrogeninit",
            "description": "",
            "members": [
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-init.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--git",
                "value": "\"\"",
                "description": "Init Git and create initial commits.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_HYDROGEN_FLAG_GIT"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-init.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--install-deps",
                "value": "\"\"",
                "description": "Auto installs dependencies using the active package manager.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_HYDROGEN_FLAG_INSTALL_DEPS"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-init.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--language <value>",
                "value": "string",
                "description": "Sets the template language to use. One of `js` or `ts`.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_HYDROGEN_FLAG_LANGUAGE"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-init.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--markets <value>",
                "value": "string",
                "description": "Sets the URL structure to support multiple markets. Must be one of: `subfolders`, `domains`, `subdomains`, `none`. Example: `--markets subfolders`.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_HYDROGEN_FLAG_I18N"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-init.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--mock-shop",
                "value": "\"\"",
                "description": "Use mock.shop as the data source for the storefront.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_HYDROGEN_FLAG_MOCK_DATA"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-init.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--path <value>",
                "value": "string",
                "description": "The path to the directory of the new Hydrogen storefront.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_HYDROGEN_FLAG_PATH"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-init.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--quickstart",
                "value": "\"\"",
                "description": "Scaffolds a new Hydrogen project with a set of sensible defaults. Equivalent to `shopify hydrogen init --path hydrogen-quickstart --mock-shop --language js --shortcut --routes --markets none`",
                "isOptional": true,
                "environmentValue": "SHOPIFY_HYDROGEN_FLAG_QUICKSTART"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-init.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--routes",
                "value": "\"\"",
                "description": "Generate routes for all pages.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_HYDROGEN_FLAG_ROUTES"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-init.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--shortcut",
                "value": "\"\"",
                "description": "Creates a global h2 shortcut for Shopify CLI using shell aliases. Deactivate with `--no-shortcut`.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_HYDROGEN_FLAG_SHORTCUT"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-init.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--styling <value>",
                "value": "string",
                "description": "Sets the styling strategy to use. One of `tailwind`, `vanilla-extract`, `css-modules`, `postcss`, `none`.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_HYDROGEN_FLAG_STYLING"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-init.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--template <value>",
                "value": "string",
                "description": "Scaffolds project based on an existing template or example from the Hydrogen repository.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_HYDROGEN_FLAG_TEMPLATE"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-init.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-f, --force",
                "value": "\"\"",
                "description": "Overwrites the destination directory and files if they already exist.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_HYDROGEN_FLAG_FORCE"
              }
            ],
            "value": "export interface hydrogeninit {\n  /**\n   * Overwrites the destination directory and files if they already exist.\n   * @environment SHOPIFY_HYDROGEN_FLAG_FORCE\n   */\n  '-f, --force'?: ''\n\n  /**\n   * Init Git and create initial commits.\n   * @environment SHOPIFY_HYDROGEN_FLAG_GIT\n   */\n  '--git'?: ''\n\n  /**\n   * Auto installs dependencies using the active package manager.\n   * @environment SHOPIFY_HYDROGEN_FLAG_INSTALL_DEPS\n   */\n  '--install-deps'?: ''\n\n  /**\n   * Sets the template language to use. One of `js` or `ts`.\n   * @environment SHOPIFY_HYDROGEN_FLAG_LANGUAGE\n   */\n  '--language <value>'?: string\n\n  /**\n   * Sets the URL structure to support multiple markets. Must be one of: `subfolders`, `domains`, `subdomains`, `none`. Example: `--markets subfolders`.\n   * @environment SHOPIFY_HYDROGEN_FLAG_I18N\n   */\n  '--markets <value>'?: string\n\n  /**\n   * Use mock.shop as the data source for the storefront.\n   * @environment SHOPIFY_HYDROGEN_FLAG_MOCK_DATA\n   */\n  '--mock-shop'?: ''\n\n  /**\n   * The path to the directory of the new Hydrogen storefront.\n   * @environment SHOPIFY_HYDROGEN_FLAG_PATH\n   */\n  '--path <value>'?: string\n\n  /**\n   * Scaffolds a new Hydrogen project with a set of sensible defaults. Equivalent to `shopify hydrogen init --path hydrogen-quickstart --mock-shop --language js --shortcut --routes --markets none`\n   * @environment SHOPIFY_HYDROGEN_FLAG_QUICKSTART\n   */\n  '--quickstart'?: ''\n\n  /**\n   * Generate routes for all pages.\n   * @environment SHOPIFY_HYDROGEN_FLAG_ROUTES\n   */\n  '--routes'?: ''\n\n  /**\n   * Creates a global h2 shortcut for Shopify CLI using shell aliases. Deactivate with `--no-shortcut`.\n   * @environment SHOPIFY_HYDROGEN_FLAG_SHORTCUT\n   */\n  '--shortcut'?: ''\n\n  /**\n   * Sets the styling strategy to use. One of `tailwind`, `vanilla-extract`, `css-modules`, `postcss`, `none`.\n   * @environment SHOPIFY_HYDROGEN_FLAG_STYLING\n   */\n  '--styling <value>'?: string\n\n  /**\n   * Scaffolds project based on an existing template or example from the Hydrogen repository.\n   * @environment SHOPIFY_HYDROGEN_FLAG_TEMPLATE\n   */\n  '--template <value>'?: string\n}"
          }
        }
      }
    ],
    "category": "hydrogen",
    "related": []
  },
  {
    "name": "hydrogen link",
    "description": "Links your local development environment to a remote Hydrogen storefront. You can link an unlimited number of development environments to a single Hydrogen storefront.\n\n  Linking to a Hydrogen storefront enables you to run [dev](/docs/api/shopify-cli/hydrogen/hydrogen-dev) and automatically inject your linked Hydrogen storefront's environment variables directly into the server runtime.\n\n  After you run the `link` command, you can access the [env list](/docs/api/shopify-cli/hydrogen/hydrogen-env-list), [env pull](/docs/api/shopify-cli/hydrogen/hydrogen-env-pull), and [unlink](/docs/api/shopify-cli/hydrogen/hydrogen-unlink) commands.",
    "overviewPreviewDescription": "Links your local development environment to a remote Hydrogen storefront. You can link an unlimited number of development environments to a single Hydrogen storefront.\n\n  Linking to a Hydrogen storefront enables you to run [dev](/docs/api/shopify-cli/hydrogen/hydrogen-dev) and automatically inject your linked Hydrogen storefront's environment variables directly into the server runtime.\n\n  After you run the `link` command, you can access the [env list](/docs/api/shopify-cli/hydrogen/hydrogen-env-list), [env pull](/docs/api/shopify-cli/hydrogen/hydrogen-env-pull), and [unlink](/docs/api/shopify-cli/hydrogen/hydrogen-unlink) commands.",
    "type": "command",
    "isVisualComponent": false,
    "defaultExample": {
      "codeblock": {
        "tabs": [
          {
            "title": "hydrogen link",
            "code": "shopify hydrogen link [flags]",
            "language": "bash"
          }
        ],
        "title": "hydrogen link"
      }
    },
    "definitions": [
      {
        "title": "Flags",
        "description": "The following flags are available for the `hydrogen link` command:",
        "type": "hydrogenlink",
        "typeDefinitions": {
          "hydrogenlink": {
            "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-link.interface.ts",
            "name": "hydrogenlink",
            "description": "",
            "members": [
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-link.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--path <value>",
                "value": "string",
                "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_HYDROGEN_FLAG_PATH"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-link.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--storefront <value>",
                "value": "string",
                "description": "The name of a Hydrogen Storefront (e.g. \"Jane's Apparel\")",
                "isOptional": true,
                "environmentValue": "SHOPIFY_HYDROGEN_STOREFRONT"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-link.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-f, --force",
                "value": "\"\"",
                "description": "Overwrites the destination directory and files if they already exist.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_HYDROGEN_FLAG_FORCE"
              }
            ],
            "value": "export interface hydrogenlink {\n  /**\n   * Overwrites the destination directory and files if they already exist.\n   * @environment SHOPIFY_HYDROGEN_FLAG_FORCE\n   */\n  '-f, --force'?: ''\n\n  /**\n   * The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.\n   * @environment SHOPIFY_HYDROGEN_FLAG_PATH\n   */\n  '--path <value>'?: string\n\n  /**\n   * The name of a Hydrogen Storefront (e.g. \"Jane's Apparel\")\n   * @environment SHOPIFY_HYDROGEN_STOREFRONT\n   */\n  '--storefront <value>'?: string\n}"
          }
        }
      }
    ],
    "category": "hydrogen",
    "related": []
  },
  {
    "name": "hydrogen list",
    "description": "Lists all remote Hydrogen storefronts available to link to your local development environment.",
    "overviewPreviewDescription": "Lists all remote Hydrogen storefronts available to link to your local development environment.",
    "type": "command",
    "isVisualComponent": false,
    "defaultExample": {
      "codeblock": {
        "tabs": [
          {
            "title": "hydrogen list",
            "code": "shopify hydrogen list [flags]",
            "language": "bash"
          }
        ],
        "title": "hydrogen list"
      }
    },
    "definitions": [
      {
        "title": "Flags",
        "description": "The following flags are available for the `hydrogen list` command:",
        "type": "hydrogenlist",
        "typeDefinitions": {
          "hydrogenlist": {
            "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-list.interface.ts",
            "name": "hydrogenlist",
            "description": "",
            "members": [
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-list.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--path <value>",
                "value": "string",
                "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_HYDROGEN_FLAG_PATH"
              }
            ],
            "value": "export interface hydrogenlist {\n  /**\n   * The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.\n   * @environment SHOPIFY_HYDROGEN_FLAG_PATH\n   */\n  '--path <value>'?: string\n}"
          }
        }
      }
    ],
    "category": "hydrogen",
    "related": []
  },
  {
    "name": "hydrogen login",
    "description": "Logs in to the specified shop and saves the shop domain to the project.",
    "overviewPreviewDescription": "Logs in to the specified shop and saves the shop domain to the project.",
    "type": "command",
    "isVisualComponent": false,
    "defaultExample": {
      "codeblock": {
        "tabs": [
          {
            "title": "hydrogen login",
            "code": "shopify hydrogen login [flags]",
            "language": "bash"
          }
        ],
        "title": "hydrogen login"
      }
    },
    "definitions": [
      {
        "title": "Flags",
        "description": "The following flags are available for the `hydrogen login` command:",
        "type": "hydrogenlogin",
        "typeDefinitions": {
          "hydrogenlogin": {
            "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-login.interface.ts",
            "name": "hydrogenlogin",
            "description": "",
            "members": [
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-login.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--path <value>",
                "value": "string",
                "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_HYDROGEN_FLAG_PATH"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-login.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-s, --shop <value>",
                "value": "string",
                "description": "Shop URL. It can be the shop prefix (janes-apparel) or the full myshopify.com URL (janes-apparel.myshopify.com, https://janes-apparel.myshopify.com).",
                "isOptional": true,
                "environmentValue": "SHOPIFY_SHOP"
              }
            ],
            "value": "export interface hydrogenlogin {\n  /**\n   * The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.\n   * @environment SHOPIFY_HYDROGEN_FLAG_PATH\n   */\n  '--path <value>'?: string\n\n  /**\n   * Shop URL. It can be the shop prefix (janes-apparel) or the full myshopify.com URL (janes-apparel.myshopify.com, https://janes-apparel.myshopify.com).\n   * @environment SHOPIFY_SHOP\n   */\n  '-s, --shop <value>'?: string\n}"
          }
        }
      }
    ],
    "category": "hydrogen",
    "related": []
  },
  {
    "name": "hydrogen logout",
    "description": "Log out from the current shop.",
    "overviewPreviewDescription": "Log out from the current shop.",
    "type": "command",
    "isVisualComponent": false,
    "defaultExample": {
      "codeblock": {
        "tabs": [
          {
            "title": "hydrogen logout",
            "code": "shopify hydrogen logout [flags]",
            "language": "bash"
          }
        ],
        "title": "hydrogen logout"
      }
    },
    "definitions": [
      {
        "title": "Flags",
        "description": "The following flags are available for the `hydrogen logout` command:",
        "type": "hydrogenlogout",
        "typeDefinitions": {
          "hydrogenlogout": {
            "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-logout.interface.ts",
            "name": "hydrogenlogout",
            "description": "",
            "members": [
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-logout.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--path <value>",
                "value": "string",
                "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_HYDROGEN_FLAG_PATH"
              }
            ],
            "value": "export interface hydrogenlogout {\n  /**\n   * The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.\n   * @environment SHOPIFY_HYDROGEN_FLAG_PATH\n   */\n  '--path <value>'?: string\n}"
          }
        }
      }
    ],
    "category": "hydrogen",
    "related": []
  },
  {
    "name": "hydrogen preview",
    "description": "Runs a server in your local development environment that serves your Hydrogen app's production build. Requires running the [build](/docs/api/shopify-cli/hydrogen/hydrogen-build) command first.",
    "overviewPreviewDescription": "Runs a server in your local development environment that serves your Hydrogen app's production build. Requires running the [build](/docs/api/shopify-cli/hydrogen/hydrogen-build) command first.",
    "type": "command",
    "isVisualComponent": false,
    "defaultExample": {
      "codeblock": {
        "tabs": [
          {
            "title": "hydrogen preview",
            "code": "shopify hydrogen preview [flags]",
            "language": "bash"
          }
        ],
        "title": "hydrogen preview"
      }
    },
    "definitions": [
      {
        "title": "Flags",
        "description": "The following flags are available for the `hydrogen preview` command:",
        "type": "hydrogenpreview",
        "typeDefinitions": {
          "hydrogenpreview": {
            "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-preview.interface.ts",
            "name": "hydrogenpreview",
            "description": "",
            "members": [
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-preview.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--build",
                "value": "\"\"",
                "description": "Builds the app before starting the preview server.",
                "isOptional": true
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-preview.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--codegen",
                "value": "\"\"",
                "description": "Automatically generates GraphQL types for your project’s Storefront API queries.",
                "isOptional": true
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-preview.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--codegen-config-path <value>",
                "value": "string",
                "description": "Specifies a path to a codegen configuration file. Defaults to `<root>/codegen.ts` if this file exists.",
                "isOptional": true
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-preview.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--debug",
                "value": "\"\"",
                "description": "Enables inspector connections to the server with a debugger such as Visual Studio Code or Chrome DevTools.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_HYDROGEN_FLAG_DEBUG"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-preview.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--entry <value>",
                "value": "string",
                "description": "Entry file for the worker. Defaults to `./server`.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_HYDROGEN_FLAG_ENTRY"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-preview.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--env <value>",
                "value": "string",
                "description": "Specifies the environment to perform the operation using its handle. Fetch the handle using the `env list` command.",
                "isOptional": true
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-preview.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--env-branch <value>",
                "value": "string",
                "description": "Specifies the environment to perform the operation using its Git branch name.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_HYDROGEN_ENVIRONMENT_BRANCH"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-preview.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--env-file <value>",
                "value": "string",
                "description": "Path to an environment file to override existing environment variables. Defaults to the '.env' located in your project path `--path`.",
                "isOptional": true
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-preview.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--inspector-port <value>",
                "value": "string",
                "description": "The port where the inspector is available. Defaults to 9229.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_HYDROGEN_FLAG_INSPECTOR_PORT"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-preview.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--path <value>",
                "value": "string",
                "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_HYDROGEN_FLAG_PATH"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-preview.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--port <value>",
                "value": "string",
                "description": "The port to run the server on. Defaults to 3000.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_HYDROGEN_FLAG_PORT"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-preview.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--verbose",
                "value": "\"\"",
                "description": "Outputs more information about the command's execution.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_HYDROGEN_FLAG_VERBOSE"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-preview.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--watch",
                "value": "\"\"",
                "description": "Watches for changes and rebuilds the project.",
                "isOptional": true
              }
            ],
            "value": "export interface hydrogenpreview {\n  /**\n   * Builds the app before starting the preview server.\n   *\n   */\n  '--build'?: ''\n\n  /**\n   * Automatically generates GraphQL types for your project’s Storefront API queries.\n   *\n   */\n  '--codegen'?: ''\n\n  /**\n   * Specifies a path to a codegen configuration file. Defaults to `<root>/codegen.ts` if this file exists.\n   *\n   */\n  '--codegen-config-path <value>'?: string\n\n  /**\n   * Enables inspector connections to the server with a debugger such as Visual Studio Code or Chrome DevTools.\n   * @environment SHOPIFY_HYDROGEN_FLAG_DEBUG\n   */\n  '--debug'?: ''\n\n  /**\n   * Entry file for the worker. Defaults to `./server`.\n   * @environment SHOPIFY_HYDROGEN_FLAG_ENTRY\n   */\n  '--entry <value>'?: string\n\n  /**\n   * Specifies the environment to perform the operation using its handle. Fetch the handle using the `env list` command.\n   *\n   */\n  '--env <value>'?: string\n\n  /**\n   * Specifies the environment to perform the operation using its Git branch name.\n   * @environment SHOPIFY_HYDROGEN_ENVIRONMENT_BRANCH\n   */\n  '--env-branch <value>'?: string\n\n  /**\n   * Path to an environment file to override existing environment variables. Defaults to the '.env' located in your project path `--path`.\n   *\n   */\n  '--env-file <value>'?: string\n\n  /**\n   * The port where the inspector is available. Defaults to 9229.\n   * @environment SHOPIFY_HYDROGEN_FLAG_INSPECTOR_PORT\n   */\n  '--inspector-port <value>'?: string\n\n  /**\n   * The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.\n   * @environment SHOPIFY_HYDROGEN_FLAG_PATH\n   */\n  '--path <value>'?: string\n\n  /**\n   * The port to run the server on. Defaults to 3000.\n   * @environment SHOPIFY_HYDROGEN_FLAG_PORT\n   */\n  '--port <value>'?: string\n\n  /**\n   * Outputs more information about the command's execution.\n   * @environment SHOPIFY_HYDROGEN_FLAG_VERBOSE\n   */\n  '--verbose'?: ''\n\n  /**\n   * Watches for changes and rebuilds the project.\n   *\n   */\n  '--watch'?: ''\n}"
          }
        }
      }
    ],
    "category": "hydrogen",
    "related": []
  },
  {
    "name": "hydrogen setup css",
    "description": "Adds support for certain CSS strategies to your project.",
    "overviewPreviewDescription": "Adds support for certain CSS strategies to your project.",
    "type": "command",
    "isVisualComponent": false,
    "defaultExample": {
      "codeblock": {
        "tabs": [
          {
            "title": "hydrogen setup css",
            "code": "shopify hydrogen setup css [flags]",
            "language": "bash"
          }
        ],
        "title": "hydrogen setup css"
      }
    },
    "definitions": [
      {
        "title": "Flags",
        "description": "The following flags are available for the `hydrogen setup css` command:",
        "type": "hydrogensetupcss",
        "typeDefinitions": {
          "hydrogensetupcss": {
            "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-setup-css.interface.ts",
            "name": "hydrogensetupcss",
            "description": "",
            "members": [
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-setup-css.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--install-deps",
                "value": "\"\"",
                "description": "Auto installs dependencies using the active package manager.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_HYDROGEN_FLAG_INSTALL_DEPS"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-setup-css.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--path <value>",
                "value": "string",
                "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_HYDROGEN_FLAG_PATH"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-setup-css.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-f, --force",
                "value": "\"\"",
                "description": "Overwrites the destination directory and files if they already exist.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_HYDROGEN_FLAG_FORCE"
              }
            ],
            "value": "export interface hydrogensetupcss {\n  /**\n   * Overwrites the destination directory and files if they already exist.\n   * @environment SHOPIFY_HYDROGEN_FLAG_FORCE\n   */\n  '-f, --force'?: ''\n\n  /**\n   * Auto installs dependencies using the active package manager.\n   * @environment SHOPIFY_HYDROGEN_FLAG_INSTALL_DEPS\n   */\n  '--install-deps'?: ''\n\n  /**\n   * The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.\n   * @environment SHOPIFY_HYDROGEN_FLAG_PATH\n   */\n  '--path <value>'?: string\n}"
          }
        }
      }
    ],
    "category": "hydrogen",
    "related": []
  },
  {
    "name": "hydrogen setup markets",
    "description": "Adds support for multiple [markets](/docs/custom-storefronts/hydrogen/markets) to your project by using the URL structure.",
    "overviewPreviewDescription": "Adds support for multiple [markets](/docs/custom-storefronts/hydrogen/markets) to your project by using the URL structure.",
    "type": "command",
    "isVisualComponent": false,
    "defaultExample": {
      "codeblock": {
        "tabs": [
          {
            "title": "hydrogen setup markets",
            "code": "shopify hydrogen setup markets [flags]",
            "language": "bash"
          }
        ],
        "title": "hydrogen setup markets"
      }
    },
    "definitions": [
      {
        "title": "Flags",
        "description": "The following flags are available for the `hydrogen setup markets` command:",
        "type": "hydrogensetupmarkets",
        "typeDefinitions": {
          "hydrogensetupmarkets": {
            "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-setup-markets.interface.ts",
            "name": "hydrogensetupmarkets",
            "description": "",
            "members": [
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-setup-markets.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--path <value>",
                "value": "string",
                "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_HYDROGEN_FLAG_PATH"
              }
            ],
            "value": "export interface hydrogensetupmarkets {\n  /**\n   * The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.\n   * @environment SHOPIFY_HYDROGEN_FLAG_PATH\n   */\n  '--path <value>'?: string\n}"
          }
        }
      }
    ],
    "category": "hydrogen",
    "related": []
  },
  {
    "name": "hydrogen setup vite",
    "description": "EXPERIMENTAL: Upgrades the project to use Vite.",
    "overviewPreviewDescription": "EXPERIMENTAL: Upgrades the project to use Vite.",
    "type": "command",
    "isVisualComponent": false,
    "defaultExample": {
      "codeblock": {
        "tabs": [
          {
            "title": "hydrogen setup vite",
            "code": "shopify hydrogen setup vite [flags]",
            "language": "bash"
          }
        ],
        "title": "hydrogen setup vite"
      }
    },
    "definitions": [
      {
        "title": "Flags",
        "description": "The following flags are available for the `hydrogen setup vite` command:",
        "type": "hydrogensetupvite",
        "typeDefinitions": {
          "hydrogensetupvite": {
            "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-setup-vite.interface.ts",
            "name": "hydrogensetupvite",
            "description": "",
            "members": [
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-setup-vite.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--path <value>",
                "value": "string",
                "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_HYDROGEN_FLAG_PATH"
              }
            ],
            "value": "export interface hydrogensetupvite {\n  /**\n   * The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.\n   * @environment SHOPIFY_HYDROGEN_FLAG_PATH\n   */\n  '--path <value>'?: string\n}"
          }
        }
      }
    ],
    "category": "hydrogen",
    "related": []
  },
  {
    "name": "hydrogen setup",
    "description": "Scaffold routes and core functionality.",
    "overviewPreviewDescription": "Scaffold routes and core functionality.",
    "type": "command",
    "isVisualComponent": false,
    "defaultExample": {
      "codeblock": {
        "tabs": [
          {
            "title": "hydrogen setup",
            "code": "shopify hydrogen setup [flags]",
            "language": "bash"
          }
        ],
        "title": "hydrogen setup"
      }
    },
    "definitions": [
      {
        "title": "Flags",
        "description": "The following flags are available for the `hydrogen setup` command:",
        "type": "hydrogensetup",
        "typeDefinitions": {
          "hydrogensetup": {
            "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-setup.interface.ts",
            "name": "hydrogensetup",
            "description": "",
            "members": [
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-setup.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--install-deps",
                "value": "\"\"",
                "description": "Auto installs dependencies using the active package manager.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_HYDROGEN_FLAG_INSTALL_DEPS"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-setup.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--markets <value>",
                "value": "string",
                "description": "Sets the URL structure to support multiple markets. Must be one of: `subfolders`, `domains`, `subdomains`, `none`. Example: `--markets subfolders`.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_HYDROGEN_FLAG_I18N"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-setup.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--path <value>",
                "value": "string",
                "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_HYDROGEN_FLAG_PATH"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-setup.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--shortcut",
                "value": "\"\"",
                "description": "Creates a global h2 shortcut for Shopify CLI using shell aliases. Deactivate with `--no-shortcut`.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_HYDROGEN_FLAG_SHORTCUT"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-setup.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-f, --force",
                "value": "\"\"",
                "description": "Overwrites the destination directory and files if they already exist.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_HYDROGEN_FLAG_FORCE"
              }
            ],
            "value": "export interface hydrogensetup {\n  /**\n   * Overwrites the destination directory and files if they already exist.\n   * @environment SHOPIFY_HYDROGEN_FLAG_FORCE\n   */\n  '-f, --force'?: ''\n\n  /**\n   * Auto installs dependencies using the active package manager.\n   * @environment SHOPIFY_HYDROGEN_FLAG_INSTALL_DEPS\n   */\n  '--install-deps'?: ''\n\n  /**\n   * Sets the URL structure to support multiple markets. Must be one of: `subfolders`, `domains`, `subdomains`, `none`. Example: `--markets subfolders`.\n   * @environment SHOPIFY_HYDROGEN_FLAG_I18N\n   */\n  '--markets <value>'?: string\n\n  /**\n   * The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.\n   * @environment SHOPIFY_HYDROGEN_FLAG_PATH\n   */\n  '--path <value>'?: string\n\n  /**\n   * Creates a global h2 shortcut for Shopify CLI using shell aliases. Deactivate with `--no-shortcut`.\n   * @environment SHOPIFY_HYDROGEN_FLAG_SHORTCUT\n   */\n  '--shortcut'?: ''\n}"
          }
        }
      }
    ],
    "category": "hydrogen",
    "related": []
  },
  {
    "name": "hydrogen shortcut",
    "description": "Creates a global h2 shortcut for Shopify CLI using shell aliases.\n\n  The following shells are supported:\n\n  - Bash (using `~/.bashrc`)\n  - ZSH (using `~/.zshrc`)\n  - Fish (using `~/.config/fish/functions`)\n  - PowerShell (added to `$PROFILE`)\n\n  After the alias is created, you can call Shopify CLI from anywhere in your project using `h2 <command>`.",
    "overviewPreviewDescription": "Creates a global h2 shortcut for Shopify CLI using shell aliases.\n\n  The following shells are supported:\n\n  - Bash (using `~/.bashrc`)\n  - ZSH (using `~/.zshrc`)\n  - Fish (using `~/.config/fish/functions`)\n  - PowerShell (added to `$PROFILE`)\n\n  After the alias is created, you can call Shopify CLI from anywhere in your project using `h2 <command>`.",
    "type": "command",
    "isVisualComponent": false,
    "defaultExample": {
      "codeblock": {
        "tabs": [
          {
            "title": "hydrogen shortcut",
            "code": "shopify hydrogen shortcut",
            "language": "bash"
          }
        ],
        "title": "hydrogen shortcut"
      }
    },
    "definitions": [],
    "category": "hydrogen",
    "related": []
  },
  {
    "name": "hydrogen unlink",
    "description": "Unlinks your local development environment from a remote Hydrogen storefront.",
    "overviewPreviewDescription": "Unlinks your local development environment from a remote Hydrogen storefront.",
    "type": "command",
    "isVisualComponent": false,
    "defaultExample": {
      "codeblock": {
        "tabs": [
          {
            "title": "hydrogen unlink",
            "code": "shopify hydrogen unlink [flags]",
            "language": "bash"
          }
        ],
        "title": "hydrogen unlink"
      }
    },
    "definitions": [
      {
        "title": "Flags",
        "description": "The following flags are available for the `hydrogen unlink` command:",
        "type": "hydrogenunlink",
        "typeDefinitions": {
          "hydrogenunlink": {
            "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-unlink.interface.ts",
            "name": "hydrogenunlink",
            "description": "",
            "members": [
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-unlink.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--path <value>",
                "value": "string",
                "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_HYDROGEN_FLAG_PATH"
              }
            ],
            "value": "export interface hydrogenunlink {\n  /**\n   * The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.\n   * @environment SHOPIFY_HYDROGEN_FLAG_PATH\n   */\n  '--path <value>'?: string\n}"
          }
        }
      }
    ],
    "category": "hydrogen",
    "related": []
  },
  {
    "name": "hydrogen upgrade",
    "description": "Upgrade Hydrogen project dependencies, preview features, fixes and breaking changes. The command also generates an instruction file for each upgrade.",
    "overviewPreviewDescription": "Upgrade Hydrogen project dependencies, preview features, fixes and breaking changes. The command also generates an instruction file for each upgrade.",
    "type": "command",
    "isVisualComponent": false,
    "defaultExample": {
      "codeblock": {
        "tabs": [
          {
            "title": "hydrogen upgrade",
            "code": "shopify hydrogen upgrade [flags]",
            "language": "bash"
          }
        ],
        "title": "hydrogen upgrade"
      }
    },
    "definitions": [
      {
        "title": "Flags",
        "description": "The following flags are available for the `hydrogen upgrade` command:",
        "type": "hydrogenupgrade",
        "typeDefinitions": {
          "hydrogenupgrade": {
            "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-upgrade.interface.ts",
            "name": "hydrogenupgrade",
            "description": "",
            "members": [
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-upgrade.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--path <value>",
                "value": "string",
                "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_HYDROGEN_FLAG_PATH"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-upgrade.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-f, --force",
                "value": "\"\"",
                "description": "Ignore warnings and force the upgrade to the target version",
                "isOptional": true,
                "environmentValue": "SHOPIFY_HYDROGEN_FLAG_FORCE"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-upgrade.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-v, --version <value>",
                "value": "string",
                "description": "A target hydrogen version to update to",
                "isOptional": true
              }
            ],
            "value": "export interface hydrogenupgrade {\n  /**\n   * Ignore warnings and force the upgrade to the target version\n   * @environment SHOPIFY_HYDROGEN_FLAG_FORCE\n   */\n  '-f, --force'?: ''\n\n  /**\n   * The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.\n   * @environment SHOPIFY_HYDROGEN_FLAG_PATH\n   */\n  '--path <value>'?: string\n\n  /**\n   * A target hydrogen version to update to\n   *\n   */\n  '-v, --version <value>'?: string\n}"
          }
        }
      }
    ],
    "category": "hydrogen",
    "related": []
  },
  {
    "name": "search",
    "description": "Starts a search on shopify.dev.",
    "overviewPreviewDescription": "Starts a search on shopify.dev.",
    "type": "command",
    "isVisualComponent": false,
    "defaultExample": {
      "codeblock": {
        "tabs": [
          {
            "title": "search",
            "code": "shopify search [query]",
            "language": "bash"
          }
        ],
        "title": "search"
      }
    },
    "definitions": [],
    "category": "general commands",
    "related": []
  },
  {
    "name": "theme check",
    "description": "Calls and runs [Theme Check](/docs/themes/tools/theme-check) to analyze your theme code for errors and to ensure that it follows theme and Liquid best practices. [Learn more about the checks that Theme Check runs.](/docs/themes/tools/theme-check/checks)",
    "overviewPreviewDescription": "Validate the theme.",
    "type": "command",
    "isVisualComponent": false,
    "defaultExample": {
      "codeblock": {
        "tabs": [
          {
            "title": "theme check",
            "code": "shopify theme check [flags]",
            "language": "bash"
          }
        ],
        "title": "theme check"
      }
    },
    "definitions": [
      {
        "title": "Flags",
        "description": "The following flags are available for the `theme check` command:",
        "type": "themecheck",
        "typeDefinitions": {
          "themecheck": {
            "filePath": "docs-shopify.dev/commands/interfaces/theme-check.interface.ts",
            "name": "themecheck",
            "description": "",
            "members": [
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-check.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--fail-level <value>",
                "value": "string",
                "description": "Minimum severity for exit with error code",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_FAIL_LEVEL"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-check.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--init",
                "value": "\"\"",
                "description": "Generate a .theme-check.yml file",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_INIT"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-check.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--list",
                "value": "\"\"",
                "description": "List enabled checks",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_LIST"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-check.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--no-color",
                "value": "\"\"",
                "description": "Disable color output.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_NO_COLOR"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-check.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--path <value>",
                "value": "string",
                "description": "The path where you want to run the command. Defaults to the current working directory.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_PATH"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-check.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--print",
                "value": "\"\"",
                "description": "Output active config to STDOUT",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_PRINT"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-check.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--verbose",
                "value": "\"\"",
                "description": "Increase the verbosity of the output.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_VERBOSE"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-check.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-a, --auto-correct",
                "value": "\"\"",
                "description": "Automatically fix offenses",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_AUTO_CORRECT"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-check.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-C, --config <value>",
                "value": "string",
                "description": "Use the config provided, overriding .theme-check.yml if present  Supports all theme-check: config values, e.g., theme-check:theme-app-extension,\n theme-check:recommended, theme-check:all\n For backwards compatibility, :theme_app_extension is also supported",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_CONFIG"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-check.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-e, --environment <value>",
                "value": "string",
                "description": "The environment to apply to the current command.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_ENVIRONMENT"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-check.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-o, --output <value>",
                "value": "string",
                "description": "The output format to use",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_OUTPUT"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-check.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-v, --version",
                "value": "\"\"",
                "description": "Print Theme Check version",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_VERSION"
              }
            ],
            "value": "export interface themecheck {\n  /**\n   * Automatically fix offenses\n   * @environment SHOPIFY_FLAG_AUTO_CORRECT\n   */\n  '-a, --auto-correct'?: ''\n\n  /**\n   * Use the config provided, overriding .theme-check.yml if present\n      Supports all theme-check: config values, e.g., theme-check:theme-app-extension,\n      theme-check:recommended, theme-check:all\n      For backwards compatibility, :theme_app_extension is also supported \n   * @environment SHOPIFY_FLAG_CONFIG\n   */\n  '-C, --config <value>'?: string\n\n  /**\n   * The environment to apply to the current command.\n   * @environment SHOPIFY_FLAG_ENVIRONMENT\n   */\n  '-e, --environment <value>'?: string\n\n  /**\n   * Minimum severity for exit with error code\n   * @environment SHOPIFY_FLAG_FAIL_LEVEL\n   */\n  '--fail-level <value>'?: string\n\n  /**\n   * Generate a .theme-check.yml file\n   * @environment SHOPIFY_FLAG_INIT\n   */\n  '--init'?: ''\n\n  /**\n   * List enabled checks\n   * @environment SHOPIFY_FLAG_LIST\n   */\n  '--list'?: ''\n\n  /**\n   * Disable color output.\n   * @environment SHOPIFY_FLAG_NO_COLOR\n   */\n  '--no-color'?: ''\n\n  /**\n   * The output format to use\n   * @environment SHOPIFY_FLAG_OUTPUT\n   */\n  '-o, --output <value>'?: string\n\n  /**\n   * The path where you want to run the command. Defaults to the current working directory.\n   * @environment SHOPIFY_FLAG_PATH\n   */\n  '--path <value>'?: string\n\n  /**\n   * Output active config to STDOUT\n   * @environment SHOPIFY_FLAG_PRINT\n   */\n  '--print'?: ''\n\n  /**\n   * Increase the verbosity of the output.\n   * @environment SHOPIFY_FLAG_VERBOSE\n   */\n  '--verbose'?: ''\n\n  /**\n   * Print Theme Check version\n   * @environment SHOPIFY_FLAG_VERSION\n   */\n  '-v, --version'?: ''\n}"
          }
        }
      }
    ],
    "category": "theme",
    "related": []
  },
  {
    "name": "theme console",
    "description": "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.\n\n  You can also provide context to the console using a URL, as some Liquid objects are context-specific",
    "overviewPreviewDescription": "Shopify Liquid REPL (read-eval-print loop) tool",
    "type": "command",
    "isVisualComponent": false,
    "defaultExample": {
      "codeblock": {
        "tabs": [
          {
            "title": "theme console",
            "code": "shopify theme console\n\nshopify theme console --url /products/classic-leather-jacket",
            "language": "bash"
          }
        ],
        "title": "theme console"
      }
    },
    "definitions": [
      {
        "title": "Flags",
        "description": "The following flags are available for the `theme console` command:",
        "type": "themeconsole",
        "typeDefinitions": {
          "themeconsole": {
            "filePath": "docs-shopify.dev/commands/interfaces/theme-console.interface.ts",
            "name": "themeconsole",
            "description": "",
            "members": [
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-console.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--no-color",
                "value": "\"\"",
                "description": "Disable color output.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_NO_COLOR"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-console.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--password <value>",
                "value": "string",
                "description": "Password generated from the Theme Access app or an Admin API token.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_CLI_THEME_TOKEN"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-console.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--path <value>",
                "value": "string",
                "description": "The path where you want to run the command. Defaults to the current working directory.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_PATH"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-console.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--store-password <value>",
                "value": "string",
                "description": "The password for storefronts with password protection.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_STORE_PASSWORD"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-console.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--url <value>",
                "value": "string",
                "description": "The url to be used as context",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_URL"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-console.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--verbose",
                "value": "\"\"",
                "description": "Increase the verbosity of the output.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_VERBOSE"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-console.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-e, --environment <value>",
                "value": "string",
                "description": "The environment to apply to the current command.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_ENVIRONMENT"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-console.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-s, --store <value>",
                "value": "string",
                "description": "Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_STORE"
              }
            ],
            "value": "export interface themeconsole {\n  /**\n   * The environment to apply to the current command.\n   * @environment SHOPIFY_FLAG_ENVIRONMENT\n   */\n  '-e, --environment <value>'?: string\n\n  /**\n   * Disable color output.\n   * @environment SHOPIFY_FLAG_NO_COLOR\n   */\n  '--no-color'?: ''\n\n  /**\n   * Password generated from the Theme Access app or an Admin API token.\n   * @environment SHOPIFY_CLI_THEME_TOKEN\n   */\n  '--password <value>'?: string\n\n  /**\n   * The path where you want to run the command. Defaults to the current working directory.\n   * @environment SHOPIFY_FLAG_PATH\n   */\n  '--path <value>'?: string\n\n  /**\n   * Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).\n   * @environment SHOPIFY_FLAG_STORE\n   */\n  '-s, --store <value>'?: string\n\n  /**\n   * The password for storefronts with password protection.\n   * @environment SHOPIFY_FLAG_STORE_PASSWORD\n   */\n  '--store-password <value>'?: string\n\n  /**\n   * The url to be used as context\n   * @environment SHOPIFY_FLAG_URL\n   */\n  '--url <value>'?: string\n\n  /**\n   * Increase the verbosity of the output.\n   * @environment SHOPIFY_FLAG_VERBOSE\n   */\n  '--verbose'?: ''\n}"
          }
        }
      }
    ],
    "category": "theme",
    "related": []
  },
  {
    "name": "theme delete",
    "description": "Deletes a theme from your store.\n\n  You can specify multiple themes by ID. If no theme is specified, then you're prompted to select the theme that you want to delete from the list of themes in your store.\n\n  You're asked to confirm that you want to delete the specified themes before they are deleted. You can skip this confirmation using the `--force` flag.",
    "overviewPreviewDescription": "Delete remote themes from the connected store. This command can't be undone.",
    "type": "command",
    "isVisualComponent": false,
    "defaultExample": {
      "codeblock": {
        "tabs": [
          {
            "title": "theme delete",
            "code": "shopify theme delete [flags]",
            "language": "bash"
          }
        ],
        "title": "theme delete"
      }
    },
    "definitions": [
      {
        "title": "Flags",
        "description": "The following flags are available for the `theme delete` command:",
        "type": "themedelete",
        "typeDefinitions": {
          "themedelete": {
            "filePath": "docs-shopify.dev/commands/interfaces/theme-delete.interface.ts",
            "name": "themedelete",
            "description": "",
            "members": [
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-delete.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--no-color",
                "value": "\"\"",
                "description": "Disable color output.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_NO_COLOR"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-delete.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--password <value>",
                "value": "string",
                "description": "Password generated from the Theme Access app or an Admin API token.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_CLI_THEME_TOKEN"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-delete.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--path <value>",
                "value": "string",
                "description": "The path where you want to run the command. Defaults to the current working directory.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_PATH"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-delete.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--verbose",
                "value": "\"\"",
                "description": "Increase the verbosity of the output.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_VERBOSE"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-delete.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-a, --show-all",
                "value": "\"\"",
                "description": "Include others development themes in theme list.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_SHOW_ALL"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-delete.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-d, --development",
                "value": "\"\"",
                "description": "Delete your development theme.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_DEVELOPMENT"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-delete.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-e, --environment <value>",
                "value": "string",
                "description": "The environment to apply to the current command.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_ENVIRONMENT"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-delete.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-f, --force",
                "value": "\"\"",
                "description": "Skip confirmation.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_FORCE"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-delete.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-s, --store <value>",
                "value": "string",
                "description": "Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_STORE"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-delete.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-t, --theme <value>",
                "value": "string",
                "description": "Theme ID or name of the remote theme.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_THEME_ID"
              }
            ],
            "value": "export interface themedelete {\n  /**\n   * Delete your development theme.\n   * @environment SHOPIFY_FLAG_DEVELOPMENT\n   */\n  '-d, --development'?: ''\n\n  /**\n   * The environment to apply to the current command.\n   * @environment SHOPIFY_FLAG_ENVIRONMENT\n   */\n  '-e, --environment <value>'?: string\n\n  /**\n   * Skip confirmation.\n   * @environment SHOPIFY_FLAG_FORCE\n   */\n  '-f, --force'?: ''\n\n  /**\n   * Disable color output.\n   * @environment SHOPIFY_FLAG_NO_COLOR\n   */\n  '--no-color'?: ''\n\n  /**\n   * Password generated from the Theme Access app or an Admin API token.\n   * @environment SHOPIFY_CLI_THEME_TOKEN\n   */\n  '--password <value>'?: string\n\n  /**\n   * The path where you want to run the command. Defaults to the current working directory.\n   * @environment SHOPIFY_FLAG_PATH\n   */\n  '--path <value>'?: string\n\n  /**\n   * Include others development themes in theme list.\n   * @environment SHOPIFY_FLAG_SHOW_ALL\n   */\n  '-a, --show-all'?: ''\n\n  /**\n   * Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).\n   * @environment SHOPIFY_FLAG_STORE\n   */\n  '-s, --store <value>'?: string\n\n  /**\n   * Theme ID or name of the remote theme.\n   * @environment SHOPIFY_FLAG_THEME_ID\n   */\n  '-t, --theme <value>'?: string\n\n  /**\n   * Increase the verbosity of the output.\n   * @environment SHOPIFY_FLAG_VERBOSE\n   */\n  '--verbose'?: ''\n}"
          }
        }
      }
    ],
    "category": "theme",
    "related": []
  },
  {
    "name": "theme dev",
    "description": "\n  Uploads the current theme as the specified theme, or a [development theme](/docs/themes/tools/cli#development-themes), to a store so you can preview it.\n\nThis command returns the following information:\n\n- A link to your development theme at http://127.0.0.1:9292. This URL can hot reload local changes to CSS and sections, or refresh the entire page when a file changes, enabling you to preview changes in real time using the store's data.\n\n  You can specify a different network interface and port using `--host` and `--port`.\n\n- A link to the [editor](/docs/themes/tools/online-editor) for the theme in the Shopify admin.\n\n- A [preview link](https://help.shopify.com/manual/online-store/themes/adding-themes#share-a-theme-preview-with-others) that you can share with other developers.\n\nIf you already have a development theme for your current environment, then this command replaces the development theme with your local theme. You can override this using the `--theme-editor-sync` flag.\n\n> Note: You can't preview checkout customizations using http://127.0.0.1:9292.\n\nDevelopment themes are deleted when you run `shopify auth logout`. If you need a preview link that can be used after you log out, then you should [share](/docs/api/shopify-cli/theme/theme-share) your theme or [push](/docs/api/shopify-cli/theme/theme-push) to an unpublished theme on your store.\n\nYou can run this command only in a directory that matches the [default Shopify theme folder structure](/docs/themes/tools/cli#directory-structure).",
    "overviewPreviewDescription": "Uploads the current theme as a development theme to the connected store, then prints theme editor and preview URLs to your terminal. While running, changes will push to the store in real time.",
    "type": "command",
    "isVisualComponent": false,
    "defaultExample": {
      "codeblock": {
        "tabs": [
          {
            "title": "theme dev",
            "code": "shopify theme dev [flags]",
            "language": "bash"
          }
        ],
        "title": "theme dev"
      }
    },
    "definitions": [
      {
        "title": "Flags",
        "description": "The following flags are available for the `theme dev` command:",
        "type": "themedev",
        "typeDefinitions": {
          "themedev": {
            "filePath": "docs-shopify.dev/commands/interfaces/theme-dev.interface.ts",
            "name": "themedev",
            "description": "",
            "members": [
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-dev.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--error-overlay <value>",
                "value": "string",
                "description": "Controls the visibility of the error overlay when an theme asset upload fails: - silent Prevents the error overlay from appearing. - default Displays the error overlay.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_ERROR_OVERLAY"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-dev.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--host <value>",
                "value": "string",
                "description": "Set which network interface the web server listens on. The default value is 127.0.0.1.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_HOST"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-dev.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--listing <value>",
                "value": "string",
                "description": "The listing preset to use for multi-preset themes. Applies preset files from listings/[preset-name] directory.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_LISTING"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-dev.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--live-reload <value>",
                "value": "string",
                "description": "The live reload mode switches the server behavior when a file is modified: - hot-reload Hot reloads local changes to CSS and sections (default) - full-page  Always refreshes the entire page - off        Deactivate live reload",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_LIVE_RELOAD"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-dev.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--no-color",
                "value": "\"\"",
                "description": "Disable color output.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_NO_COLOR"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-dev.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--notify <value>",
                "value": "string",
                "description": "The file path or URL. The file path is to a file that you want updated on idle. The URL path is where you want a webhook posted to report on file changes.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_NOTIFY"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-dev.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--open",
                "value": "\"\"",
                "description": "Automatically launch the theme preview in your default web browser.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_OPEN"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-dev.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--password <value>",
                "value": "string",
                "description": "Password generated from the Theme Access app or an Admin API token.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_CLI_THEME_TOKEN"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-dev.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--path <value>",
                "value": "string",
                "description": "The path where you want to run the command. Defaults to the current working directory.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_PATH"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-dev.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--port <value>",
                "value": "string",
                "description": "Local port to serve theme preview from.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_PORT"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-dev.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--store-password <value>",
                "value": "string",
                "description": "The password for storefronts with password protection.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_STORE_PASSWORD"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-dev.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--theme-editor-sync",
                "value": "\"\"",
                "description": "Synchronize Theme Editor updates in the local theme files.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_THEME_EDITOR_SYNC"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-dev.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--verbose",
                "value": "\"\"",
                "description": "Increase the verbosity of the output.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_VERBOSE"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-dev.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-a, --allow-live",
                "value": "\"\"",
                "description": "Allow development on a live theme.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_ALLOW_LIVE"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-dev.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-e, --environment <value>",
                "value": "string",
                "description": "The environment to apply to the current command.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_ENVIRONMENT"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-dev.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-n, --nodelete",
                "value": "\"\"",
                "description": "Prevents files from being deleted in the remote theme when a file has been deleted locally. This applies to files that are deleted while the command is running, and files that have been deleted locally before the command is run.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_NODELETE"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-dev.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-o, --only <value>",
                "value": "string",
                "description": "Hot reload only files that match the specified pattern.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_ONLY"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-dev.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-s, --store <value>",
                "value": "string",
                "description": "Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_STORE"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-dev.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-t, --theme <value>",
                "value": "string",
                "description": "Theme ID or name of the remote theme.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_THEME_ID"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-dev.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-x, --ignore <value>",
                "value": "string",
                "description": "Skip hot reloading any files that match the specified pattern.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_IGNORE"
              }
            ],
            "value": "export interface themedev {\n  /**\n   * Allow development on a live theme.\n   * @environment SHOPIFY_FLAG_ALLOW_LIVE\n   */\n  '-a, --allow-live'?: ''\n\n  /**\n   * The environment to apply to the current command.\n   * @environment SHOPIFY_FLAG_ENVIRONMENT\n   */\n  '-e, --environment <value>'?: string\n\n  /**\n   * Controls the visibility of the error overlay when an theme asset upload fails:\n- silent Prevents the error overlay from appearing.\n- default Displays the error overlay.\n      \n   * @environment SHOPIFY_FLAG_ERROR_OVERLAY\n   */\n  '--error-overlay <value>'?: string\n\n  /**\n   * Set which network interface the web server listens on. The default value is 127.0.0.1.\n   * @environment SHOPIFY_FLAG_HOST\n   */\n  '--host <value>'?: string\n\n  /**\n   * Skip hot reloading any files that match the specified pattern.\n   * @environment SHOPIFY_FLAG_IGNORE\n   */\n  '-x, --ignore <value>'?: string\n\n  /**\n   * The listing preset to use for multi-preset themes. Applies preset files from listings/[preset-name] directory.\n   * @environment SHOPIFY_FLAG_LISTING\n   */\n  '--listing <value>'?: string\n\n  /**\n   * The live reload mode switches the server behavior when a file is modified:\n- hot-reload Hot reloads local changes to CSS and sections (default)\n- full-page  Always refreshes the entire page\n- off        Deactivate live reload\n   * @environment SHOPIFY_FLAG_LIVE_RELOAD\n   */\n  '--live-reload <value>'?: string\n\n  /**\n   * Disable color output.\n   * @environment SHOPIFY_FLAG_NO_COLOR\n   */\n  '--no-color'?: ''\n\n  /**\n   * Prevents files from being deleted in the remote theme when a file has been deleted locally. This applies to files that are deleted while the command is running, and files that have been deleted locally before the command is run.\n   * @environment SHOPIFY_FLAG_NODELETE\n   */\n  '-n, --nodelete'?: ''\n\n  /**\n   * The file path or URL. The file path is to a file that you want updated on idle. The URL path is where you want a webhook posted to report on file changes.\n   * @environment SHOPIFY_FLAG_NOTIFY\n   */\n  '--notify <value>'?: string\n\n  /**\n   * Hot reload only files that match the specified pattern.\n   * @environment SHOPIFY_FLAG_ONLY\n   */\n  '-o, --only <value>'?: string\n\n  /**\n   * Automatically launch the theme preview in your default web browser.\n   * @environment SHOPIFY_FLAG_OPEN\n   */\n  '--open'?: ''\n\n  /**\n   * Password generated from the Theme Access app or an Admin API token.\n   * @environment SHOPIFY_CLI_THEME_TOKEN\n   */\n  '--password <value>'?: string\n\n  /**\n   * The path where you want to run the command. Defaults to the current working directory.\n   * @environment SHOPIFY_FLAG_PATH\n   */\n  '--path <value>'?: string\n\n  /**\n   * Local port to serve theme preview from.\n   * @environment SHOPIFY_FLAG_PORT\n   */\n  '--port <value>'?: string\n\n  /**\n   * Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).\n   * @environment SHOPIFY_FLAG_STORE\n   */\n  '-s, --store <value>'?: string\n\n  /**\n   * The password for storefronts with password protection.\n   * @environment SHOPIFY_FLAG_STORE_PASSWORD\n   */\n  '--store-password <value>'?: string\n\n  /**\n   * Theme ID or name of the remote theme.\n   * @environment SHOPIFY_FLAG_THEME_ID\n   */\n  '-t, --theme <value>'?: string\n\n  /**\n   * Synchronize Theme Editor updates in the local theme files.\n   * @environment SHOPIFY_FLAG_THEME_EDITOR_SYNC\n   */\n  '--theme-editor-sync'?: ''\n\n  /**\n   * Increase the verbosity of the output.\n   * @environment SHOPIFY_FLAG_VERBOSE\n   */\n  '--verbose'?: ''\n}"
          }
        }
      }
    ],
    "category": "theme",
    "related": []
  },
  {
    "name": "theme duplicate",
    "description": "If you want to duplicate your local theme, you need to run `shopify theme push` first.\n\nIf no theme ID is specified, you're prompted to select the theme that you want to duplicate from the list of themes in your store. You're asked to confirm that you want to duplicate the specified theme.\n\nPrompts and confirmations are not shown when duplicate is run in a CI environment or the `--force` flag is used, therefore you must specify a theme ID using the `--theme` flag.\n\nYou can optionally name the duplicated theme using the `--name` flag.\n\nIf you use the `--json` flag, then theme information is returned in JSON format, which can be used as a machine-readable input for scripts or continuous integration.\n\nSample JSON output:\n\n```json\n{\n  \"theme\": {\n    \"id\": 108267175958,\n    \"name\": \"A Duplicated Theme\",\n    \"role\": \"unpublished\",\n    \"shop\": \"mystore.myshopify.com\"\n  }\n}\n```\n\n```json\n{\n  \"message\": \"The theme 'Summer Edition' could not be duplicated due to errors\",\n  \"errors\": [\"Maximum number of themes reached\"],\n  \"requestId\": \"12345-abcde-67890\"\n}\n```",
    "overviewPreviewDescription": "Duplicates a theme from your theme library.",
    "type": "command",
    "isVisualComponent": false,
    "defaultExample": {
      "codeblock": {
        "tabs": [
          {
            "title": "theme duplicate",
            "code": "shopify theme duplicate\n\nshopify theme duplicate --theme 10 --name 'New Theme'",
            "language": "bash"
          }
        ],
        "title": "theme duplicate"
      }
    },
    "definitions": [
      {
        "title": "Flags",
        "description": "The following flags are available for the `theme duplicate` command:",
        "type": "themeduplicate",
        "typeDefinitions": {
          "themeduplicate": {
            "filePath": "docs-shopify.dev/commands/interfaces/theme-duplicate.interface.ts",
            "name": "themeduplicate",
            "description": "",
            "members": [
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-duplicate.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--no-color",
                "value": "\"\"",
                "description": "Disable color output.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_NO_COLOR"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-duplicate.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--password <value>",
                "value": "string",
                "description": "Password generated from the Theme Access app or an Admin API token.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_CLI_THEME_TOKEN"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-duplicate.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--verbose",
                "value": "\"\"",
                "description": "Increase the verbosity of the output.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_VERBOSE"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-duplicate.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-e, --environment <value>",
                "value": "string",
                "description": "The environment to apply to the current command.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_ENVIRONMENT"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-duplicate.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-f, --force",
                "value": "\"\"",
                "description": "Force the duplicate operation to run without prompts or confirmations.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_FORCE"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-duplicate.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-j, --json",
                "value": "\"\"",
                "description": "Output the result as JSON.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_JSON"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-duplicate.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-n, --name <value>",
                "value": "string",
                "description": "Name of the newly duplicated theme.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_NAME"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-duplicate.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-s, --store <value>",
                "value": "string",
                "description": "Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_STORE"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-duplicate.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-t, --theme <value>",
                "value": "string",
                "description": "Theme ID or name of the remote theme.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_THEME_ID"
              }
            ],
            "value": "export interface themeduplicate {\n  /**\n   * The environment to apply to the current command.\n   * @environment SHOPIFY_FLAG_ENVIRONMENT\n   */\n  '-e, --environment <value>'?: string\n\n  /**\n   * Force the duplicate operation to run without prompts or confirmations.\n   * @environment SHOPIFY_FLAG_FORCE\n   */\n  '-f, --force'?: ''\n\n  /**\n   * Output the result as JSON.\n   * @environment SHOPIFY_FLAG_JSON\n   */\n  '-j, --json'?: ''\n\n  /**\n   * Name of the newly duplicated theme.\n   * @environment SHOPIFY_FLAG_NAME\n   */\n  '-n, --name <value>'?: string\n\n  /**\n   * Disable color output.\n   * @environment SHOPIFY_FLAG_NO_COLOR\n   */\n  '--no-color'?: ''\n\n  /**\n   * Password generated from the Theme Access app or an Admin API token.\n   * @environment SHOPIFY_CLI_THEME_TOKEN\n   */\n  '--password <value>'?: string\n\n  /**\n   * Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).\n   * @environment SHOPIFY_FLAG_STORE\n   */\n  '-s, --store <value>'?: string\n\n  /**\n   * Theme ID or name of the remote theme.\n   * @environment SHOPIFY_FLAG_THEME_ID\n   */\n  '-t, --theme <value>'?: string\n\n  /**\n   * Increase the verbosity of the output.\n   * @environment SHOPIFY_FLAG_VERBOSE\n   */\n  '--verbose'?: ''\n}"
          }
        }
      }
    ],
    "category": "theme",
    "related": []
  },
  {
    "name": "theme info",
    "description": "Displays information about your theme environment, including your current store. Can also retrieve information about a specific theme.",
    "overviewPreviewDescription": "Displays information about your theme environment, including your current store. Can also retrieve information about a specific theme.",
    "type": "command",
    "isVisualComponent": false,
    "defaultExample": {
      "codeblock": {
        "tabs": [
          {
            "title": "theme info",
            "code": "shopify theme info [flags]",
            "language": "bash"
          }
        ],
        "title": "theme info"
      }
    },
    "definitions": [
      {
        "title": "Flags",
        "description": "The following flags are available for the `theme info` command:",
        "type": "themeinfo",
        "typeDefinitions": {
          "themeinfo": {
            "filePath": "docs-shopify.dev/commands/interfaces/theme-info.interface.ts",
            "name": "themeinfo",
            "description": "",
            "members": [
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-info.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--no-color",
                "value": "\"\"",
                "description": "Disable color output.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_NO_COLOR"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-info.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--password <value>",
                "value": "string",
                "description": "Password generated from the Theme Access app or an Admin API token.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_CLI_THEME_TOKEN"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-info.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--path <value>",
                "value": "string",
                "description": "The path where you want to run the command. Defaults to the current working directory.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_PATH"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-info.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--verbose",
                "value": "\"\"",
                "description": "Increase the verbosity of the output.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_VERBOSE"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-info.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-d, --development",
                "value": "\"\"",
                "description": "Retrieve info from your development theme.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_DEVELOPMENT"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-info.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-e, --environment <value>",
                "value": "string",
                "description": "The environment to apply to the current command.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_ENVIRONMENT"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-info.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-j, --json",
                "value": "\"\"",
                "description": "Output the result as JSON.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_JSON"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-info.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-s, --store <value>",
                "value": "string",
                "description": "Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_STORE"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-info.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-t, --theme <value>",
                "value": "string",
                "description": "Theme ID or name of the remote theme.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_THEME_ID"
              }
            ],
            "value": "export interface themeinfo {\n  /**\n   * Retrieve info from your development theme.\n   * @environment SHOPIFY_FLAG_DEVELOPMENT\n   */\n  '-d, --development'?: ''\n\n  /**\n   * The environment to apply to the current command.\n   * @environment SHOPIFY_FLAG_ENVIRONMENT\n   */\n  '-e, --environment <value>'?: string\n\n  /**\n   * Output the result as JSON.\n   * @environment SHOPIFY_FLAG_JSON\n   */\n  '-j, --json'?: ''\n\n  /**\n   * Disable color output.\n   * @environment SHOPIFY_FLAG_NO_COLOR\n   */\n  '--no-color'?: ''\n\n  /**\n   * Password generated from the Theme Access app or an Admin API token.\n   * @environment SHOPIFY_CLI_THEME_TOKEN\n   */\n  '--password <value>'?: string\n\n  /**\n   * The path where you want to run the command. Defaults to the current working directory.\n   * @environment SHOPIFY_FLAG_PATH\n   */\n  '--path <value>'?: string\n\n  /**\n   * Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).\n   * @environment SHOPIFY_FLAG_STORE\n   */\n  '-s, --store <value>'?: string\n\n  /**\n   * Theme ID or name of the remote theme.\n   * @environment SHOPIFY_FLAG_THEME_ID\n   */\n  '-t, --theme <value>'?: string\n\n  /**\n   * Increase the verbosity of the output.\n   * @environment SHOPIFY_FLAG_VERBOSE\n   */\n  '--verbose'?: ''\n}"
          }
        }
      }
    ],
    "category": "theme",
    "related": []
  },
  {
    "name": "theme init",
    "description": "Clones a Git repository to your local machine to use as the starting point for building a theme.\n\n  If no Git repository is specified, then this command creates a copy of Shopify's [Skeleton theme](https://github.com/Shopify/skeleton-theme.git), with the specified name in the current folder. If no name is provided, then you're prompted to enter one.\n\n  > Caution: If you're building a theme for the Shopify Theme Store, then you can use our example theme as a starting point. However, the theme that you submit needs to be [substantively different from existing themes](/docs/themes/store/requirements#uniqueness) so that it provides added value for users.\n  ",
    "overviewPreviewDescription": "Clones a Git repository to use as a starting point for building a new theme.",
    "type": "command",
    "isVisualComponent": false,
    "defaultExample": {
      "codeblock": {
        "tabs": [
          {
            "title": "theme init",
            "code": "shopify theme init [name] [flags]",
            "language": "bash"
          }
        ],
        "title": "theme init"
      }
    },
    "definitions": [
      {
        "title": "Flags",
        "description": "The following flags are available for the `theme init` command:",
        "type": "themeinit",
        "typeDefinitions": {
          "themeinit": {
            "filePath": "docs-shopify.dev/commands/interfaces/theme-init.interface.ts",
            "name": "themeinit",
            "description": "",
            "members": [
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-init.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--no-color",
                "value": "\"\"",
                "description": "Disable color output.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_NO_COLOR"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-init.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--path <value>",
                "value": "string",
                "description": "The path where you want to run the command. Defaults to the current working directory.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_PATH"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-init.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--verbose",
                "value": "\"\"",
                "description": "Increase the verbosity of the output.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_VERBOSE"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-init.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-l, --latest",
                "value": "\"\"",
                "description": "Downloads the latest release of the `clone-url`",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_LATEST"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-init.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-u, --clone-url <value>",
                "value": "string",
                "description": "The Git URL to clone from. Defaults to Shopify's Skeleton theme.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_CLONE_URL"
              }
            ],
            "value": "export interface themeinit {\n  /**\n   * The Git URL to clone from. Defaults to Shopify's Skeleton theme.\n   * @environment SHOPIFY_FLAG_CLONE_URL\n   */\n  '-u, --clone-url <value>'?: string\n\n  /**\n   * Downloads the latest release of the `clone-url`\n   * @environment SHOPIFY_FLAG_LATEST\n   */\n  '-l, --latest'?: ''\n\n  /**\n   * Disable color output.\n   * @environment SHOPIFY_FLAG_NO_COLOR\n   */\n  '--no-color'?: ''\n\n  /**\n   * The path where you want to run the command. Defaults to the current working directory.\n   * @environment SHOPIFY_FLAG_PATH\n   */\n  '--path <value>'?: string\n\n  /**\n   * Increase the verbosity of the output.\n   * @environment SHOPIFY_FLAG_VERBOSE\n   */\n  '--verbose'?: ''\n}"
          }
        }
      }
    ],
    "category": "theme",
    "related": []
  },
  {
    "name": "theme language-server",
    "description": "Starts the [Language Server](/docs/themes/tools/cli/language-server).",
    "overviewPreviewDescription": "Start a Language Server Protocol server.",
    "type": "command",
    "isVisualComponent": false,
    "defaultExample": {
      "codeblock": {
        "tabs": [
          {
            "title": "theme language-server",
            "code": "shopify theme language-server [flags]",
            "language": "bash"
          }
        ],
        "title": "theme language-server"
      }
    },
    "definitions": [
      {
        "title": "Flags",
        "description": "The following flags are available for the `theme language-server` command:",
        "type": "themelanguageserver",
        "typeDefinitions": {
          "themelanguageserver": {
            "filePath": "docs-shopify.dev/commands/interfaces/theme-language-server.interface.ts",
            "name": "themelanguageserver",
            "description": "",
            "members": [
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-language-server.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--no-color",
                "value": "\"\"",
                "description": "Disable color output.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_NO_COLOR"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-language-server.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--verbose",
                "value": "\"\"",
                "description": "Increase the verbosity of the output.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_VERBOSE"
              }
            ],
            "value": "export interface themelanguageserver {\n  /**\n   * Disable color output.\n   * @environment SHOPIFY_FLAG_NO_COLOR\n   */\n  '--no-color'?: ''\n\n  /**\n   * Increase the verbosity of the output.\n   * @environment SHOPIFY_FLAG_VERBOSE\n   */\n  '--verbose'?: ''\n}"
          }
        }
      }
    ],
    "category": "theme",
    "related": []
  },
  {
    "name": "theme list",
    "description": "Lists the themes in your store, along with their IDs and statuses.",
    "overviewPreviewDescription": "Lists the themes in your store, along with their IDs and statuses.",
    "type": "command",
    "isVisualComponent": false,
    "defaultExample": {
      "codeblock": {
        "tabs": [
          {
            "title": "theme list",
            "code": "shopify theme list [flags]",
            "language": "bash"
          }
        ],
        "title": "theme list"
      }
    },
    "definitions": [
      {
        "title": "Flags",
        "description": "The following flags are available for the `theme list` command:",
        "type": "themelist",
        "typeDefinitions": {
          "themelist": {
            "filePath": "docs-shopify.dev/commands/interfaces/theme-list.interface.ts",
            "name": "themelist",
            "description": "",
            "members": [
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-list.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--id <value>",
                "value": "string",
                "description": "Only list theme with the given ID.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_ID"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-list.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--name <value>",
                "value": "string",
                "description": "Only list themes that contain the given name.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_NAME"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-list.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--no-color",
                "value": "\"\"",
                "description": "Disable color output.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_NO_COLOR"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-list.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--password <value>",
                "value": "string",
                "description": "Password generated from the Theme Access app or an Admin API token.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_CLI_THEME_TOKEN"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-list.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--path <value>",
                "value": "string",
                "description": "The path where you want to run the command. Defaults to the current working directory.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_PATH"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-list.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--role <value>",
                "value": "string",
                "description": "Only list themes with the given role.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_ROLE"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-list.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--verbose",
                "value": "\"\"",
                "description": "Increase the verbosity of the output.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_VERBOSE"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-list.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-e, --environment <value>",
                "value": "string",
                "description": "The environment to apply to the current command.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_ENVIRONMENT"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-list.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-j, --json",
                "value": "\"\"",
                "description": "Output the result as JSON.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_JSON"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-list.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-s, --store <value>",
                "value": "string",
                "description": "Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_STORE"
              }
            ],
            "value": "export interface themelist {\n  /**\n   * The environment to apply to the current command.\n   * @environment SHOPIFY_FLAG_ENVIRONMENT\n   */\n  '-e, --environment <value>'?: string\n\n  /**\n   * Only list theme with the given ID.\n   * @environment SHOPIFY_FLAG_ID\n   */\n  '--id <value>'?: string\n\n  /**\n   * Output the result as JSON.\n   * @environment SHOPIFY_FLAG_JSON\n   */\n  '-j, --json'?: ''\n\n  /**\n   * Only list themes that contain the given name.\n   * @environment SHOPIFY_FLAG_NAME\n   */\n  '--name <value>'?: string\n\n  /**\n   * Disable color output.\n   * @environment SHOPIFY_FLAG_NO_COLOR\n   */\n  '--no-color'?: ''\n\n  /**\n   * Password generated from the Theme Access app or an Admin API token.\n   * @environment SHOPIFY_CLI_THEME_TOKEN\n   */\n  '--password <value>'?: string\n\n  /**\n   * The path where you want to run the command. Defaults to the current working directory.\n   * @environment SHOPIFY_FLAG_PATH\n   */\n  '--path <value>'?: string\n\n  /**\n   * Only list themes with the given role.\n   * @environment SHOPIFY_FLAG_ROLE\n   */\n  '--role <value>'?: string\n\n  /**\n   * Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).\n   * @environment SHOPIFY_FLAG_STORE\n   */\n  '-s, --store <value>'?: string\n\n  /**\n   * Increase the verbosity of the output.\n   * @environment SHOPIFY_FLAG_VERBOSE\n   */\n  '--verbose'?: ''\n}"
          }
        }
      }
    ],
    "category": "theme",
    "related": []
  },
  {
    "name": "theme metafields pull",
    "description": "Retrieves metafields from Shopify Admin.\n\nIf the metafields file already exists, it will be overwritten.",
    "overviewPreviewDescription": "Download metafields definitions from your shop into a local file.",
    "type": "command",
    "isVisualComponent": false,
    "defaultExample": {
      "codeblock": {
        "tabs": [
          {
            "title": "theme metafields pull",
            "code": "shopify theme metafields pull [flags]",
            "language": "bash"
          }
        ],
        "title": "theme metafields pull"
      }
    },
    "definitions": [
      {
        "title": "Flags",
        "description": "The following flags are available for the `theme metafields pull` command:",
        "type": "thememetafieldspull",
        "typeDefinitions": {
          "thememetafieldspull": {
            "filePath": "docs-shopify.dev/commands/interfaces/theme-metafields-pull.interface.ts",
            "name": "thememetafieldspull",
            "description": "",
            "members": [
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-metafields-pull.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--no-color",
                "value": "\"\"",
                "description": "Disable color output.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_NO_COLOR"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-metafields-pull.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--password <value>",
                "value": "string",
                "description": "Password generated from the Theme Access app or an Admin API token.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_CLI_THEME_TOKEN"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-metafields-pull.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--path <value>",
                "value": "string",
                "description": "The path where you want to run the command. Defaults to the current working directory.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_PATH"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-metafields-pull.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--verbose",
                "value": "\"\"",
                "description": "Increase the verbosity of the output.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_VERBOSE"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-metafields-pull.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-e, --environment <value>",
                "value": "string",
                "description": "The environment to apply to the current command.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_ENVIRONMENT"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-metafields-pull.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-s, --store <value>",
                "value": "string",
                "description": "Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_STORE"
              }
            ],
            "value": "export interface thememetafieldspull {\n  /**\n   * The environment to apply to the current command.\n   * @environment SHOPIFY_FLAG_ENVIRONMENT\n   */\n  '-e, --environment <value>'?: string\n\n  /**\n   * Disable color output.\n   * @environment SHOPIFY_FLAG_NO_COLOR\n   */\n  '--no-color'?: ''\n\n  /**\n   * Password generated from the Theme Access app or an Admin API token.\n   * @environment SHOPIFY_CLI_THEME_TOKEN\n   */\n  '--password <value>'?: string\n\n  /**\n   * The path where you want to run the command. Defaults to the current working directory.\n   * @environment SHOPIFY_FLAG_PATH\n   */\n  '--path <value>'?: string\n\n  /**\n   * Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).\n   * @environment SHOPIFY_FLAG_STORE\n   */\n  '-s, --store <value>'?: string\n\n  /**\n   * Increase the verbosity of the output.\n   * @environment SHOPIFY_FLAG_VERBOSE\n   */\n  '--verbose'?: ''\n}"
          }
        }
      }
    ],
    "category": "theme",
    "related": []
  },
  {
    "name": "theme open",
    "description": "Returns links that let you preview the specified theme. The following links are returned:\n\n  - A link to the [editor](/docs/themes/tools/online-editor) for the theme in the Shopify admin.\n  - A [preview link](https://help.shopify.com/manual/online-store/themes/adding-themes#share-a-theme-preview-with-others) that you can share with other developers.\n\n  If you don't specify a theme, then you're prompted to select the theme to open from the list of the themes in your store.",
    "overviewPreviewDescription": "Opens the preview of your remote theme.",
    "type": "command",
    "isVisualComponent": false,
    "defaultExample": {
      "codeblock": {
        "tabs": [
          {
            "title": "theme open",
            "code": "shopify theme open [flags]",
            "language": "bash"
          }
        ],
        "title": "theme open"
      }
    },
    "definitions": [
      {
        "title": "Flags",
        "description": "The following flags are available for the `theme open` command:",
        "type": "themeopen",
        "typeDefinitions": {
          "themeopen": {
            "filePath": "docs-shopify.dev/commands/interfaces/theme-open.interface.ts",
            "name": "themeopen",
            "description": "",
            "members": [
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-open.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--no-color",
                "value": "\"\"",
                "description": "Disable color output.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_NO_COLOR"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-open.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--password <value>",
                "value": "string",
                "description": "Password generated from the Theme Access app or an Admin API token.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_CLI_THEME_TOKEN"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-open.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--path <value>",
                "value": "string",
                "description": "The path where you want to run the command. Defaults to the current working directory.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_PATH"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-open.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--verbose",
                "value": "\"\"",
                "description": "Increase the verbosity of the output.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_VERBOSE"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-open.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-d, --development",
                "value": "\"\"",
                "description": "Open your development theme.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_DEVELOPMENT"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-open.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-E, --editor",
                "value": "\"\"",
                "description": "Open the theme editor for the specified theme in the browser.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_EDITOR"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-open.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-e, --environment <value>",
                "value": "string",
                "description": "The environment to apply to the current command.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_ENVIRONMENT"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-open.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-l, --live",
                "value": "\"\"",
                "description": "Open your live (published) theme.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_LIVE"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-open.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-s, --store <value>",
                "value": "string",
                "description": "Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_STORE"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-open.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-t, --theme <value>",
                "value": "string",
                "description": "Theme ID or name of the remote theme.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_THEME_ID"
              }
            ],
            "value": "export interface themeopen {\n  /**\n   * Open your development theme.\n   * @environment SHOPIFY_FLAG_DEVELOPMENT\n   */\n  '-d, --development'?: ''\n\n  /**\n   * Open the theme editor for the specified theme in the browser.\n   * @environment SHOPIFY_FLAG_EDITOR\n   */\n  '-E, --editor'?: ''\n\n  /**\n   * The environment to apply to the current command.\n   * @environment SHOPIFY_FLAG_ENVIRONMENT\n   */\n  '-e, --environment <value>'?: string\n\n  /**\n   * Open your live (published) theme.\n   * @environment SHOPIFY_FLAG_LIVE\n   */\n  '-l, --live'?: ''\n\n  /**\n   * Disable color output.\n   * @environment SHOPIFY_FLAG_NO_COLOR\n   */\n  '--no-color'?: ''\n\n  /**\n   * Password generated from the Theme Access app or an Admin API token.\n   * @environment SHOPIFY_CLI_THEME_TOKEN\n   */\n  '--password <value>'?: string\n\n  /**\n   * The path where you want to run the command. Defaults to the current working directory.\n   * @environment SHOPIFY_FLAG_PATH\n   */\n  '--path <value>'?: string\n\n  /**\n   * Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).\n   * @environment SHOPIFY_FLAG_STORE\n   */\n  '-s, --store <value>'?: string\n\n  /**\n   * Theme ID or name of the remote theme.\n   * @environment SHOPIFY_FLAG_THEME_ID\n   */\n  '-t, --theme <value>'?: string\n\n  /**\n   * Increase the verbosity of the output.\n   * @environment SHOPIFY_FLAG_VERBOSE\n   */\n  '--verbose'?: ''\n}"
          }
        }
      }
    ],
    "category": "theme",
    "related": []
  },
  {
    "name": "theme package",
    "description": "Packages your local theme files into a ZIP file that can be uploaded to Shopify.\n\n  Only folders that match the [default Shopify theme folder structure](/docs/storefronts/themes/tools/cli#directory-structure) are included in the package.\n\n  The package includes the `listings` directory if present (required for multi-preset themes per [Theme Store requirements](/docs/storefronts/themes/store/requirements#adding-presets-to-your-theme-zip-submission)).\n\n  The ZIP file uses the name `theme_name-theme_version.zip`, based on parameters in your [settings_schema.json](/docs/storefronts/themes/architecture/config/settings-schema-json) file.",
    "overviewPreviewDescription": "Package your theme into a .zip file, ready to upload to the Online Store.",
    "type": "command",
    "isVisualComponent": false,
    "defaultExample": {
      "codeblock": {
        "tabs": [
          {
            "title": "theme package",
            "code": "shopify theme package [flags]",
            "language": "bash"
          }
        ],
        "title": "theme package"
      }
    },
    "definitions": [
      {
        "title": "Flags",
        "description": "The following flags are available for the `theme package` command:",
        "type": "themepackage",
        "typeDefinitions": {
          "themepackage": {
            "filePath": "docs-shopify.dev/commands/interfaces/theme-package.interface.ts",
            "name": "themepackage",
            "description": "",
            "members": [
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-package.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--no-color",
                "value": "\"\"",
                "description": "Disable color output.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_NO_COLOR"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-package.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--path <value>",
                "value": "string",
                "description": "The path where you want to run the command. Defaults to the current working directory.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_PATH"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-package.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--verbose",
                "value": "\"\"",
                "description": "Increase the verbosity of the output.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_VERBOSE"
              }
            ],
            "value": "export interface themepackage {\n  /**\n   * Disable color output.\n   * @environment SHOPIFY_FLAG_NO_COLOR\n   */\n  '--no-color'?: ''\n\n  /**\n   * The path where you want to run the command. Defaults to the current working directory.\n   * @environment SHOPIFY_FLAG_PATH\n   */\n  '--path <value>'?: string\n\n  /**\n   * Increase the verbosity of the output.\n   * @environment SHOPIFY_FLAG_VERBOSE\n   */\n  '--verbose'?: ''\n}"
          }
        }
      }
    ],
    "category": "theme",
    "related": []
  },
  {
    "name": "theme profile",
    "description": "Profile the Shopify Liquid on a given page.\n\n  This command will open a web page with the Speedscope profiler detailing the time spent executing Liquid on the given page.",
    "overviewPreviewDescription": "Profile the Liquid rendering of a theme page.",
    "type": "command",
    "isVisualComponent": false,
    "defaultExample": {
      "codeblock": {
        "tabs": [
          {
            "title": "theme profile",
            "code": "shopify theme profile\n\nshopify theme profile --url /products/classic-leather-jacket",
            "language": "bash"
          }
        ],
        "title": "theme profile"
      }
    },
    "definitions": [
      {
        "title": "Flags",
        "description": "The following flags are available for the `theme profile` command:",
        "type": "themeprofile",
        "typeDefinitions": {
          "themeprofile": {
            "filePath": "docs-shopify.dev/commands/interfaces/theme-profile.interface.ts",
            "name": "themeprofile",
            "description": "",
            "members": [
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-profile.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--no-color",
                "value": "\"\"",
                "description": "Disable color output.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_NO_COLOR"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-profile.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--password <value>",
                "value": "string",
                "description": "Password generated from the Theme Access app or an Admin API token.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_CLI_THEME_TOKEN"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-profile.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--path <value>",
                "value": "string",
                "description": "The path where you want to run the command. Defaults to the current working directory.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_PATH"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-profile.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--store-password <value>",
                "value": "string",
                "description": "The password for storefronts with password protection.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_STORE_PASSWORD"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-profile.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--url <value>",
                "value": "string",
                "description": "The url to be used as context",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_URL"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-profile.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--verbose",
                "value": "\"\"",
                "description": "Increase the verbosity of the output.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_VERBOSE"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-profile.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-e, --environment <value>",
                "value": "string",
                "description": "The environment to apply to the current command.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_ENVIRONMENT"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-profile.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-j, --json",
                "value": "\"\"",
                "description": "Output the result as JSON.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_JSON"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-profile.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-s, --store <value>",
                "value": "string",
                "description": "Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_STORE"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-profile.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-t, --theme <value>",
                "value": "string",
                "description": "Theme ID or name of the remote theme.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_THEME_ID"
              }
            ],
            "value": "export interface themeprofile {\n  /**\n   * The environment to apply to the current command.\n   * @environment SHOPIFY_FLAG_ENVIRONMENT\n   */\n  '-e, --environment <value>'?: string\n\n  /**\n   * Output the result as JSON.\n   * @environment SHOPIFY_FLAG_JSON\n   */\n  '-j, --json'?: ''\n\n  /**\n   * Disable color output.\n   * @environment SHOPIFY_FLAG_NO_COLOR\n   */\n  '--no-color'?: ''\n\n  /**\n   * Password generated from the Theme Access app or an Admin API token.\n   * @environment SHOPIFY_CLI_THEME_TOKEN\n   */\n  '--password <value>'?: string\n\n  /**\n   * The path where you want to run the command. Defaults to the current working directory.\n   * @environment SHOPIFY_FLAG_PATH\n   */\n  '--path <value>'?: string\n\n  /**\n   * Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).\n   * @environment SHOPIFY_FLAG_STORE\n   */\n  '-s, --store <value>'?: string\n\n  /**\n   * The password for storefronts with password protection.\n   * @environment SHOPIFY_FLAG_STORE_PASSWORD\n   */\n  '--store-password <value>'?: string\n\n  /**\n   * Theme ID or name of the remote theme.\n   * @environment SHOPIFY_FLAG_THEME_ID\n   */\n  '-t, --theme <value>'?: string\n\n  /**\n   * The url to be used as context\n   * @environment SHOPIFY_FLAG_URL\n   */\n  '--url <value>'?: string\n\n  /**\n   * Increase the verbosity of the output.\n   * @environment SHOPIFY_FLAG_VERBOSE\n   */\n  '--verbose'?: ''\n}"
          }
        }
      }
    ],
    "category": "theme",
    "related": []
  },
  {
    "name": "theme publish",
    "description": "Publishes an unpublished theme from your theme library.\n\nIf no theme ID is specified, then you're prompted to select the theme that you want to publish from the list of themes in your store.\n\nYou can run this command only in a directory that matches the [default Shopify theme folder structure](/docs/themes/tools/cli#directory-structure).\n\nIf you want to publish your local theme, then you need to run `shopify theme push` first. You're asked to confirm that you want to publish the specified theme. You can skip this confirmation using the `--force` flag.",
    "overviewPreviewDescription": "Set a remote theme as the live theme.",
    "type": "command",
    "isVisualComponent": false,
    "defaultExample": {
      "codeblock": {
        "tabs": [
          {
            "title": "theme publish",
            "code": "shopify theme publish [flags]",
            "language": "bash"
          }
        ],
        "title": "theme publish"
      }
    },
    "definitions": [
      {
        "title": "Flags",
        "description": "The following flags are available for the `theme publish` command:",
        "type": "themepublish",
        "typeDefinitions": {
          "themepublish": {
            "filePath": "docs-shopify.dev/commands/interfaces/theme-publish.interface.ts",
            "name": "themepublish",
            "description": "",
            "members": [
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-publish.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--no-color",
                "value": "\"\"",
                "description": "Disable color output.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_NO_COLOR"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-publish.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--password <value>",
                "value": "string",
                "description": "Password generated from the Theme Access app or an Admin API token.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_CLI_THEME_TOKEN"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-publish.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--path <value>",
                "value": "string",
                "description": "The path where you want to run the command. Defaults to the current working directory.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_PATH"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-publish.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--verbose",
                "value": "\"\"",
                "description": "Increase the verbosity of the output.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_VERBOSE"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-publish.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-e, --environment <value>",
                "value": "string",
                "description": "The environment to apply to the current command.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_ENVIRONMENT"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-publish.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-f, --force",
                "value": "\"\"",
                "description": "Skip confirmation.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_FORCE"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-publish.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-s, --store <value>",
                "value": "string",
                "description": "Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_STORE"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-publish.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-t, --theme <value>",
                "value": "string",
                "description": "Theme ID or name of the remote theme.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_THEME_ID"
              }
            ],
            "value": "export interface themepublish {\n  /**\n   * The environment to apply to the current command.\n   * @environment SHOPIFY_FLAG_ENVIRONMENT\n   */\n  '-e, --environment <value>'?: string\n\n  /**\n   * Skip confirmation.\n   * @environment SHOPIFY_FLAG_FORCE\n   */\n  '-f, --force'?: ''\n\n  /**\n   * Disable color output.\n   * @environment SHOPIFY_FLAG_NO_COLOR\n   */\n  '--no-color'?: ''\n\n  /**\n   * Password generated from the Theme Access app or an Admin API token.\n   * @environment SHOPIFY_CLI_THEME_TOKEN\n   */\n  '--password <value>'?: string\n\n  /**\n   * The path where you want to run the command. Defaults to the current working directory.\n   * @environment SHOPIFY_FLAG_PATH\n   */\n  '--path <value>'?: string\n\n  /**\n   * Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).\n   * @environment SHOPIFY_FLAG_STORE\n   */\n  '-s, --store <value>'?: string\n\n  /**\n   * Theme ID or name of the remote theme.\n   * @environment SHOPIFY_FLAG_THEME_ID\n   */\n  '-t, --theme <value>'?: string\n\n  /**\n   * Increase the verbosity of the output.\n   * @environment SHOPIFY_FLAG_VERBOSE\n   */\n  '--verbose'?: ''\n}"
          }
        }
      }
    ],
    "category": "theme",
    "related": []
  },
  {
    "name": "theme pull",
    "description": "Retrieves theme files from Shopify.\n\nIf no theme is specified, then you're prompted to select the theme to pull from the list of the themes in your store.",
    "overviewPreviewDescription": "Download your remote theme files locally.",
    "type": "command",
    "isVisualComponent": false,
    "defaultExample": {
      "codeblock": {
        "tabs": [
          {
            "title": "theme pull",
            "code": "shopify theme pull [flags]",
            "language": "bash"
          }
        ],
        "title": "theme pull"
      }
    },
    "definitions": [
      {
        "title": "Flags",
        "description": "The following flags are available for the `theme pull` command:",
        "type": "themepull",
        "typeDefinitions": {
          "themepull": {
            "filePath": "docs-shopify.dev/commands/interfaces/theme-pull.interface.ts",
            "name": "themepull",
            "description": "",
            "members": [
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-pull.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--no-color",
                "value": "\"\"",
                "description": "Disable color output.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_NO_COLOR"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-pull.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--password <value>",
                "value": "string",
                "description": "Password generated from the Theme Access app or an Admin API token.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_CLI_THEME_TOKEN"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-pull.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--path <value>",
                "value": "string",
                "description": "The path where you want to run the command. Defaults to the current working directory.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_PATH"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-pull.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--verbose",
                "value": "\"\"",
                "description": "Increase the verbosity of the output.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_VERBOSE"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-pull.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-d, --development",
                "value": "\"\"",
                "description": "Pull theme files from your remote development theme.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_DEVELOPMENT"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-pull.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-e, --environment <value>",
                "value": "string",
                "description": "The environment to apply to the current command.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_ENVIRONMENT"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-pull.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-l, --live",
                "value": "\"\"",
                "description": "Pull theme files from your remote live theme.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_LIVE"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-pull.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-n, --nodelete",
                "value": "\"\"",
                "description": "Prevent deleting local files that don't exist remotely.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_NODELETE"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-pull.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-o, --only <value>",
                "value": "string",
                "description": "Download only the specified files (Multiple flags allowed). Wrap the value in double quotes if you're using wildcards.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_ONLY"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-pull.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-s, --store <value>",
                "value": "string",
                "description": "Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_STORE"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-pull.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-t, --theme <value>",
                "value": "string",
                "description": "Theme ID or name of the remote theme.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_THEME_ID"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-pull.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-x, --ignore <value>",
                "value": "string",
                "description": "Skip downloading the specified files (Multiple flags allowed). Wrap the value in double quotes if you're using wildcards.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_IGNORE"
              }
            ],
            "value": "export interface themepull {\n  /**\n   * Pull theme files from your remote development theme.\n   * @environment SHOPIFY_FLAG_DEVELOPMENT\n   */\n  '-d, --development'?: ''\n\n  /**\n   * The environment to apply to the current command.\n   * @environment SHOPIFY_FLAG_ENVIRONMENT\n   */\n  '-e, --environment <value>'?: string\n\n  /**\n   * Skip downloading the specified files (Multiple flags allowed). Wrap the value in double quotes if you're using wildcards.\n   * @environment SHOPIFY_FLAG_IGNORE\n   */\n  '-x, --ignore <value>'?: string\n\n  /**\n   * Pull theme files from your remote live theme.\n   * @environment SHOPIFY_FLAG_LIVE\n   */\n  '-l, --live'?: ''\n\n  /**\n   * Disable color output.\n   * @environment SHOPIFY_FLAG_NO_COLOR\n   */\n  '--no-color'?: ''\n\n  /**\n   * Prevent deleting local files that don't exist remotely.\n   * @environment SHOPIFY_FLAG_NODELETE\n   */\n  '-n, --nodelete'?: ''\n\n  /**\n   * Download only the specified files (Multiple flags allowed). Wrap the value in double quotes if you're using wildcards.\n   * @environment SHOPIFY_FLAG_ONLY\n   */\n  '-o, --only <value>'?: string\n\n  /**\n   * Password generated from the Theme Access app or an Admin API token.\n   * @environment SHOPIFY_CLI_THEME_TOKEN\n   */\n  '--password <value>'?: string\n\n  /**\n   * The path where you want to run the command. Defaults to the current working directory.\n   * @environment SHOPIFY_FLAG_PATH\n   */\n  '--path <value>'?: string\n\n  /**\n   * Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).\n   * @environment SHOPIFY_FLAG_STORE\n   */\n  '-s, --store <value>'?: string\n\n  /**\n   * Theme ID or name of the remote theme.\n   * @environment SHOPIFY_FLAG_THEME_ID\n   */\n  '-t, --theme <value>'?: string\n\n  /**\n   * Increase the verbosity of the output.\n   * @environment SHOPIFY_FLAG_VERBOSE\n   */\n  '--verbose'?: ''\n}"
          }
        }
      }
    ],
    "category": "theme",
    "related": []
  },
  {
    "name": "theme push",
    "description": "Uploads your local theme files to Shopify, overwriting the remote version if specified.\n\n  If no theme is specified, then you're prompted to select the theme to overwrite from the list of the themes in your store.\n\n  You can run this command only in a directory that matches the [default Shopify theme folder structure](/docs/themes/tools/cli#directory-structure).\n\n  This command returns the following information:\n\n  - A link to the [editor](/docs/themes/tools/online-editor) for the theme in the Shopify admin.\n  - A [preview link](https://help.shopify.com/manual/online-store/themes/adding-themes#share-a-theme-preview-with-others) that you can share with others.\n\n  If you use the `--json` flag, then theme information is returned in JSON format, which can be used as a machine-readable input for scripts or continuous integration.\n\n  Sample output:\n\n  ```json\n  {\n    \"theme\": {\n      \"id\": 108267175958,\n      \"name\": \"MyTheme\",\n      \"role\": \"unpublished\",\n      \"shop\": \"mystore.myshopify.com\",\n      \"editor_url\": \"https://mystore.myshopify.com/admin/themes/108267175958/editor\",\n      \"preview_url\": \"https://mystore.myshopify.com/?preview_theme_id=108267175958\"\n    }\n  }\n  ```\n    ",
    "overviewPreviewDescription": "Uploads your local theme files to the connected store, overwriting the remote version if specified.",
    "type": "command",
    "isVisualComponent": false,
    "defaultExample": {
      "codeblock": {
        "tabs": [
          {
            "title": "theme push",
            "code": "shopify theme push\n\nshopify theme push --unpublished --json",
            "language": "bash"
          }
        ],
        "title": "theme push"
      }
    },
    "definitions": [
      {
        "title": "Flags",
        "description": "The following flags are available for the `theme push` command:",
        "type": "themepush",
        "typeDefinitions": {
          "themepush": {
            "filePath": "docs-shopify.dev/commands/interfaces/theme-push.interface.ts",
            "name": "themepush",
            "description": "",
            "members": [
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-push.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--listing <value>",
                "value": "string",
                "description": "The listing preset to use for multi-preset themes. Applies preset files from listings/[preset-name] directory.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_LISTING"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-push.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--no-color",
                "value": "\"\"",
                "description": "Disable color output.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_NO_COLOR"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-push.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--password <value>",
                "value": "string",
                "description": "Password generated from the Theme Access app or an Admin API token.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_CLI_THEME_TOKEN"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-push.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--path <value>",
                "value": "string",
                "description": "The path where you want to run the command. Defaults to the current working directory.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_PATH"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-push.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--strict",
                "value": "\"\"",
                "description": "Require theme check to pass without errors before pushing. Warnings are allowed.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_STRICT_PUSH"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-push.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--verbose",
                "value": "\"\"",
                "description": "Increase the verbosity of the output.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_VERBOSE"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-push.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-a, --allow-live",
                "value": "\"\"",
                "description": "Allow push to a live theme.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_ALLOW_LIVE"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-push.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-d, --development",
                "value": "\"\"",
                "description": "Push theme files from your remote development theme.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_DEVELOPMENT"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-push.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-e, --environment <value>",
                "value": "string",
                "description": "The environment to apply to the current command.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_ENVIRONMENT"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-push.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-j, --json",
                "value": "\"\"",
                "description": "Output the result as JSON.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_JSON"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-push.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-l, --live",
                "value": "\"\"",
                "description": "Push theme files from your remote live theme.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_LIVE"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-push.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-n, --nodelete",
                "value": "\"\"",
                "description": "Prevent deleting remote files that don't exist locally.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_NODELETE"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-push.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-o, --only <value>",
                "value": "string",
                "description": "Upload only the specified files (Multiple flags allowed). Wrap the value in double quotes if you're using wildcards.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_ONLY"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-push.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-p, --publish",
                "value": "\"\"",
                "description": "Publish as the live theme after uploading.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_PUBLISH"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-push.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-s, --store <value>",
                "value": "string",
                "description": "Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_STORE"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-push.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-t, --theme <value>",
                "value": "string",
                "description": "Theme ID or name of the remote theme.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_THEME_ID"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-push.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-u, --unpublished",
                "value": "\"\"",
                "description": "Create a new unpublished theme and push to it.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_UNPUBLISHED"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-push.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-x, --ignore <value>",
                "value": "string",
                "description": "Skip uploading the specified files (Multiple flags allowed). Wrap the value in double quotes if you're using wildcards.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_IGNORE"
              }
            ],
            "value": "export interface themepush {\n  /**\n   * Allow push to a live theme.\n   * @environment SHOPIFY_FLAG_ALLOW_LIVE\n   */\n  '-a, --allow-live'?: ''\n\n  /**\n   * Push theme files from your remote development theme.\n   * @environment SHOPIFY_FLAG_DEVELOPMENT\n   */\n  '-d, --development'?: ''\n\n  /**\n   * The environment to apply to the current command.\n   * @environment SHOPIFY_FLAG_ENVIRONMENT\n   */\n  '-e, --environment <value>'?: string\n\n  /**\n   * Skip uploading the specified files (Multiple flags allowed). Wrap the value in double quotes if you're using wildcards.\n   * @environment SHOPIFY_FLAG_IGNORE\n   */\n  '-x, --ignore <value>'?: string\n\n  /**\n   * Output the result as JSON.\n   * @environment SHOPIFY_FLAG_JSON\n   */\n  '-j, --json'?: ''\n\n  /**\n   * The listing preset to use for multi-preset themes. Applies preset files from listings/[preset-name] directory.\n   * @environment SHOPIFY_FLAG_LISTING\n   */\n  '--listing <value>'?: string\n\n  /**\n   * Push theme files from your remote live theme.\n   * @environment SHOPIFY_FLAG_LIVE\n   */\n  '-l, --live'?: ''\n\n  /**\n   * Disable color output.\n   * @environment SHOPIFY_FLAG_NO_COLOR\n   */\n  '--no-color'?: ''\n\n  /**\n   * Prevent deleting remote files that don't exist locally.\n   * @environment SHOPIFY_FLAG_NODELETE\n   */\n  '-n, --nodelete'?: ''\n\n  /**\n   * Upload only the specified files (Multiple flags allowed). Wrap the value in double quotes if you're using wildcards.\n   * @environment SHOPIFY_FLAG_ONLY\n   */\n  '-o, --only <value>'?: string\n\n  /**\n   * Password generated from the Theme Access app or an Admin API token.\n   * @environment SHOPIFY_CLI_THEME_TOKEN\n   */\n  '--password <value>'?: string\n\n  /**\n   * The path where you want to run the command. Defaults to the current working directory.\n   * @environment SHOPIFY_FLAG_PATH\n   */\n  '--path <value>'?: string\n\n  /**\n   * Publish as the live theme after uploading.\n   * @environment SHOPIFY_FLAG_PUBLISH\n   */\n  '-p, --publish'?: ''\n\n  /**\n   * Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).\n   * @environment SHOPIFY_FLAG_STORE\n   */\n  '-s, --store <value>'?: string\n\n  /**\n   * Require theme check to pass without errors before pushing. Warnings are allowed.\n   * @environment SHOPIFY_FLAG_STRICT_PUSH\n   */\n  '--strict'?: ''\n\n  /**\n   * Theme ID or name of the remote theme.\n   * @environment SHOPIFY_FLAG_THEME_ID\n   */\n  '-t, --theme <value>'?: string\n\n  /**\n   * Create a new unpublished theme and push to it.\n   * @environment SHOPIFY_FLAG_UNPUBLISHED\n   */\n  '-u, --unpublished'?: ''\n\n  /**\n   * Increase the verbosity of the output.\n   * @environment SHOPIFY_FLAG_VERBOSE\n   */\n  '--verbose'?: ''\n}"
          }
        }
      }
    ],
    "category": "theme",
    "related": []
  },
  {
    "name": "theme rename",
    "description": "Renames a theme in your store.\n\n  If no theme is specified, then you're prompted to select the theme that you want to rename from the list of themes in your store.\n  ",
    "overviewPreviewDescription": "Renames an existing theme.",
    "type": "command",
    "isVisualComponent": false,
    "defaultExample": {
      "codeblock": {
        "tabs": [
          {
            "title": "theme rename",
            "code": "shopify theme rename [flags]",
            "language": "bash"
          }
        ],
        "title": "theme rename"
      }
    },
    "definitions": [
      {
        "title": "Flags",
        "description": "The following flags are available for the `theme rename` command:",
        "type": "themerename",
        "typeDefinitions": {
          "themerename": {
            "filePath": "docs-shopify.dev/commands/interfaces/theme-rename.interface.ts",
            "name": "themerename",
            "description": "",
            "members": [
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-rename.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--no-color",
                "value": "\"\"",
                "description": "Disable color output.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_NO_COLOR"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-rename.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--password <value>",
                "value": "string",
                "description": "Password generated from the Theme Access app or an Admin API token.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_CLI_THEME_TOKEN"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-rename.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--path <value>",
                "value": "string",
                "description": "The path where you want to run the command. Defaults to the current working directory.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_PATH"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-rename.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--verbose",
                "value": "\"\"",
                "description": "Increase the verbosity of the output.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_VERBOSE"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-rename.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-d, --development",
                "value": "\"\"",
                "description": "Rename your development theme.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_DEVELOPMENT"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-rename.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-e, --environment <value>",
                "value": "string",
                "description": "The environment to apply to the current command.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_ENVIRONMENT"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-rename.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-l, --live",
                "value": "\"\"",
                "description": "Rename your remote live theme.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_LIVE"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-rename.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-n, --name <value>",
                "value": "string",
                "description": "The new name for the theme.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_NEW_NAME"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-rename.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-s, --store <value>",
                "value": "string",
                "description": "Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_STORE"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-rename.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-t, --theme <value>",
                "value": "string",
                "description": "Theme ID or name of the remote theme.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_THEME_ID"
              }
            ],
            "value": "export interface themerename {\n  /**\n   * Rename your development theme.\n   * @environment SHOPIFY_FLAG_DEVELOPMENT\n   */\n  '-d, --development'?: ''\n\n  /**\n   * The environment to apply to the current command.\n   * @environment SHOPIFY_FLAG_ENVIRONMENT\n   */\n  '-e, --environment <value>'?: string\n\n  /**\n   * Rename your remote live theme.\n   * @environment SHOPIFY_FLAG_LIVE\n   */\n  '-l, --live'?: ''\n\n  /**\n   * The new name for the theme.\n   * @environment SHOPIFY_FLAG_NEW_NAME\n   */\n  '-n, --name <value>'?: string\n\n  /**\n   * Disable color output.\n   * @environment SHOPIFY_FLAG_NO_COLOR\n   */\n  '--no-color'?: ''\n\n  /**\n   * Password generated from the Theme Access app or an Admin API token.\n   * @environment SHOPIFY_CLI_THEME_TOKEN\n   */\n  '--password <value>'?: string\n\n  /**\n   * The path where you want to run the command. Defaults to the current working directory.\n   * @environment SHOPIFY_FLAG_PATH\n   */\n  '--path <value>'?: string\n\n  /**\n   * Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).\n   * @environment SHOPIFY_FLAG_STORE\n   */\n  '-s, --store <value>'?: string\n\n  /**\n   * Theme ID or name of the remote theme.\n   * @environment SHOPIFY_FLAG_THEME_ID\n   */\n  '-t, --theme <value>'?: string\n\n  /**\n   * Increase the verbosity of the output.\n   * @environment SHOPIFY_FLAG_VERBOSE\n   */\n  '--verbose'?: ''\n}"
          }
        }
      }
    ],
    "category": "theme",
    "related": []
  },
  {
    "name": "theme share",
    "description": "Uploads your theme as a new, unpublished theme in your theme library. The theme is given a randomized name.\n\n  This command returns a [preview link](https://help.shopify.com/manual/online-store/themes/adding-themes#share-a-theme-preview-with-others) that you can share with others.",
    "overviewPreviewDescription": "Creates a shareable, unpublished, and new theme on your theme library with a randomized name.",
    "type": "command",
    "isVisualComponent": false,
    "defaultExample": {
      "codeblock": {
        "tabs": [
          {
            "title": "theme share",
            "code": "shopify theme share [flags]",
            "language": "bash"
          }
        ],
        "title": "theme share"
      }
    },
    "definitions": [
      {
        "title": "Flags",
        "description": "The following flags are available for the `theme share` command:",
        "type": "themeshare",
        "typeDefinitions": {
          "themeshare": {
            "filePath": "docs-shopify.dev/commands/interfaces/theme-share.interface.ts",
            "name": "themeshare",
            "description": "",
            "members": [
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-share.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--listing <value>",
                "value": "string",
                "description": "The listing preset to use for multi-preset themes. Applies preset files from listings/[preset-name] directory.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_LISTING"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-share.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--no-color",
                "value": "\"\"",
                "description": "Disable color output.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_NO_COLOR"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-share.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--password <value>",
                "value": "string",
                "description": "Password generated from the Theme Access app or an Admin API token.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_CLI_THEME_TOKEN"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-share.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--path <value>",
                "value": "string",
                "description": "The path where you want to run the command. Defaults to the current working directory.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_PATH"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-share.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "--verbose",
                "value": "\"\"",
                "description": "Increase the verbosity of the output.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_VERBOSE"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-share.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-e, --environment <value>",
                "value": "string",
                "description": "The environment to apply to the current command.",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_ENVIRONMENT"
              },
              {
                "filePath": "docs-shopify.dev/commands/interfaces/theme-share.interface.ts",
                "syntaxKind": "PropertySignature",
                "name": "-s, --store <value>",
                "value": "string",
                "description": "Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).",
                "isOptional": true,
                "environmentValue": "SHOPIFY_FLAG_STORE"
              }
            ],
            "value": "export interface themeshare {\n  /**\n   * The environment to apply to the current command.\n   * @environment SHOPIFY_FLAG_ENVIRONMENT\n   */\n  '-e, --environment <value>'?: string\n\n  /**\n   * The listing preset to use for multi-preset themes. Applies preset files from listings/[preset-name] directory.\n   * @environment SHOPIFY_FLAG_LISTING\n   */\n  '--listing <value>'?: string\n\n  /**\n   * Disable color output.\n   * @environment SHOPIFY_FLAG_NO_COLOR\n   */\n  '--no-color'?: ''\n\n  /**\n   * Password generated from the Theme Access app or an Admin API token.\n   * @environment SHOPIFY_CLI_THEME_TOKEN\n   */\n  '--password <value>'?: string\n\n  /**\n   * The path where you want to run the command. Defaults to the current working directory.\n   * @environment SHOPIFY_FLAG_PATH\n   */\n  '--path <value>'?: string\n\n  /**\n   * Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).\n   * @environment SHOPIFY_FLAG_STORE\n   */\n  '-s, --store <value>'?: string\n\n  /**\n   * Increase the verbosity of the output.\n   * @environment SHOPIFY_FLAG_VERBOSE\n   */\n  '--verbose'?: ''\n}"
          }
        }
      }
    ],
    "category": "theme",
    "related": []
  },
  {
    "name": "upgrade",
    "description": "Shows details on how to upgrade Shopify CLI.",
    "overviewPreviewDescription": "Shows details on how to upgrade Shopify CLI.",
    "type": "command",
    "isVisualComponent": false,
    "defaultExample": {
      "codeblock": {
        "tabs": [
          {
            "title": "upgrade",
            "code": "shopify upgrade",
            "language": "bash"
          }
        ],
        "title": "upgrade"
      }
    },
    "definitions": [],
    "category": "general commands",
    "related": []
  },
  {
    "name": "version",
    "description": "Shopify CLI version currently installed.",
    "overviewPreviewDescription": "Shopify CLI version currently installed.",
    "type": "command",
    "isVisualComponent": false,
    "defaultExample": {
      "codeblock": {
        "tabs": [
          {
            "title": "version",
            "code": "shopify version",
            "language": "bash"
          }
        ],
        "title": "version"
      }
    },
    "definitions": [],
    "category": "general commands",
    "related": []
  }
]