@shopify/cli/oclif.manifest.json

A CLI tool to build for the Shopify platform

{
  "commands": {
    "app:build": {
      "aliases": [
      ],
      "args": {
      },
      "customPluginName": "@shopify/app",
      "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\" (https://shopify.dev/docs/apps/tools/cli/configuration).\n\n  If you're building a \"theme app extension\" (https://shopify.dev/docs/apps/online-store/theme-app-extensions), then running the `build` command runs \"Theme Check\" (https://shopify.dev/docs/themes/tools/theme-check) against your extension to ensure that it's valid.",
      "descriptionWithMarkdown": "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](https://shopify.dev/docs/apps/tools/cli/configuration).\n\n  If you're building a [theme app extension](https://shopify.dev/docs/apps/online-store/theme-app-extensions), then running the `build` command runs [Theme Check](https://shopify.dev/docs/themes/tools/theme-check) against your extension to ensure that it's valid.",
      "flags": {
        "api-key": {
          "description": "Application's API key that will be exposed at build time.",
          "env": "SHOPIFY_FLAG_API_KEY",
          "exclusive": [
            "config"
          ],
          "hasDynamicHelp": false,
          "hidden": true,
          "multiple": false,
          "name": "api-key",
          "type": "option"
        },
        "client-id": {
          "description": "The Client ID of your app.",
          "env": "SHOPIFY_FLAG_CLIENT_ID",
          "exclusive": [
            "config"
          ],
          "hasDynamicHelp": false,
          "hidden": false,
          "multiple": false,
          "name": "client-id",
          "type": "option"
        },
        "config": {
          "char": "c",
          "description": "The name of the app configuration.",
          "env": "SHOPIFY_FLAG_APP_CONFIG",
          "hasDynamicHelp": false,
          "hidden": false,
          "multiple": false,
          "name": "config",
          "type": "option"
        },
        "no-color": {
          "allowNo": false,
          "description": "Disable color output.",
          "env": "SHOPIFY_FLAG_NO_COLOR",
          "hidden": false,
          "name": "no-color",
          "type": "boolean"
        },
        "path": {
          "description": "The path to your app directory.",
          "env": "SHOPIFY_FLAG_PATH",
          "hasDynamicHelp": false,
          "multiple": false,
          "name": "path",
          "noCacheDefault": true,
          "type": "option"
        },
        "reset": {
          "allowNo": false,
          "description": "Reset all your settings.",
          "env": "SHOPIFY_FLAG_RESET",
          "exclusive": [
            "config"
          ],
          "hidden": false,
          "name": "reset",
          "type": "boolean"
        },
        "skip-dependencies-installation": {
          "allowNo": false,
          "description": "Skips the installation of dependencies. Deprecated, use workspaces instead.",
          "env": "SHOPIFY_FLAG_SKIP_DEPENDENCIES_INSTALLATION",
          "hidden": false,
          "name": "skip-dependencies-installation",
          "type": "boolean"
        },
        "verbose": {
          "allowNo": false,
          "description": "Increase the verbosity of the output.",
          "env": "SHOPIFY_FLAG_VERBOSE",
          "hidden": false,
          "name": "verbose",
          "type": "boolean"
        }
      },
      "hasDynamicHelp": false,
      "hiddenAliases": [
      ],
      "id": "app:build",
      "pluginAlias": "@shopify/cli",
      "pluginName": "@shopify/cli",
      "pluginType": "core",
      "strict": true,
      "summary": "Build the app, including extensions."
    },
    "app:config:link": {
      "aliases": [
      ],
      "args": {
      },
      "customPluginName": "@shopify/app",
      "description": "Pulls app configuration from the Partner 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\" (https://shopify.dev/docs/apps/tools/cli/configuration) page.\n  ",
      "descriptionWithMarkdown": "Pulls app configuration from the Partner 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](https://shopify.dev/docs/apps/tools/cli/configuration) page.\n  ",
      "flags": {
        "client-id": {
          "description": "The Client ID of your app.",
          "env": "SHOPIFY_FLAG_CLIENT_ID",
          "exclusive": [
            "config"
          ],
          "hasDynamicHelp": false,
          "hidden": false,
          "multiple": false,
          "name": "client-id",
          "type": "option"
        },
        "config": {
          "char": "c",
          "description": "The name of the app configuration.",
          "env": "SHOPIFY_FLAG_APP_CONFIG",
          "hasDynamicHelp": false,
          "hidden": false,
          "multiple": false,
          "name": "config",
          "type": "option"
        },
        "no-color": {
          "allowNo": false,
          "description": "Disable color output.",
          "env": "SHOPIFY_FLAG_NO_COLOR",
          "hidden": false,
          "name": "no-color",
          "type": "boolean"
        },
        "path": {
          "description": "The path to your app directory.",
          "env": "SHOPIFY_FLAG_PATH",
          "hasDynamicHelp": false,
          "multiple": false,
          "name": "path",
          "noCacheDefault": true,
          "type": "option"
        },
        "reset": {
          "allowNo": false,
          "description": "Reset all your settings.",
          "env": "SHOPIFY_FLAG_RESET",
          "exclusive": [
            "config"
          ],
          "hidden": false,
          "name": "reset",
          "type": "boolean"
        },
        "verbose": {
          "allowNo": false,
          "description": "Increase the verbosity of the output.",
          "env": "SHOPIFY_FLAG_VERBOSE",
          "hidden": false,
          "name": "verbose",
          "type": "boolean"
        }
      },
      "hasDynamicHelp": false,
      "hiddenAliases": [
      ],
      "id": "app:config:link",
      "pluginAlias": "@shopify/cli",
      "pluginName": "@shopify/cli",
      "pluginType": "core",
      "strict": true,
      "summary": "Fetch your app configuration from the Partner Dashboard."
    },
    "app:config:use": {
      "aliases": [
      ],
      "args": {
        "config": {
          "description": "The name of the app configuration. Can be 'shopify.app.staging.toml' or simply 'staging'.",
          "name": "config"
        }
      },
      "customPluginName": "@shopify/app",
      "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.",
      "descriptionWithMarkdown": "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.",
      "flags": {
        "client-id": {
          "description": "The Client ID of your app.",
          "env": "SHOPIFY_FLAG_CLIENT_ID",
          "exclusive": [
            "config"
          ],
          "hasDynamicHelp": false,
          "hidden": false,
          "multiple": false,
          "name": "client-id",
          "type": "option"
        },
        "no-color": {
          "allowNo": false,
          "description": "Disable color output.",
          "env": "SHOPIFY_FLAG_NO_COLOR",
          "hidden": false,
          "name": "no-color",
          "type": "boolean"
        },
        "path": {
          "description": "The path to your app directory.",
          "env": "SHOPIFY_FLAG_PATH",
          "hasDynamicHelp": false,
          "multiple": false,
          "name": "path",
          "noCacheDefault": true,
          "type": "option"
        },
        "reset": {
          "allowNo": false,
          "description": "Reset all your settings.",
          "env": "SHOPIFY_FLAG_RESET",
          "exclusive": [
            "config"
          ],
          "hidden": false,
          "name": "reset",
          "type": "boolean"
        },
        "verbose": {
          "allowNo": false,
          "description": "Increase the verbosity of the output.",
          "env": "SHOPIFY_FLAG_VERBOSE",
          "hidden": false,
          "name": "verbose",
          "type": "boolean"
        }
      },
      "hasDynamicHelp": false,
      "hiddenAliases": [
      ],
      "id": "app:config:use",
      "pluginAlias": "@shopify/cli",
      "pluginName": "@shopify/cli",
      "pluginType": "core",
      "strict": true,
      "summary": "Activate an app configuration.",
      "usage": "app config use [config] [flags]"
    },
    "app:deploy": {
      "aliases": [
      ],
      "args": {
      },
      "customPluginName": "@shopify/app",
      "description": "\"Builds the app\" (https://shopify.dev/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, including the app extensions that you manage in the Partner Dashboard. This version is then released to users.\n\n  This command doesn't deploy your \"web app\" (https://shopify.dev/docs/apps/tools/cli/structure#web-components). You need to \"deploy your web app\" (https://shopify.dev/docs/apps/deployment/web) to your own hosting solution.\n  ",
      "descriptionWithMarkdown": "[Builds the app](https://shopify.dev/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, including the app extensions that you manage in the Partner Dashboard. This version is then released to users.\n\n  This command doesn't deploy your [web app](https://shopify.dev/docs/apps/tools/cli/structure#web-components). You need to [deploy your web app](https://shopify.dev/docs/apps/deployment/web) to your own hosting solution.\n  ",
      "flags": {
        "api-key": {
          "description": "The API key of your app.",
          "env": "SHOPIFY_FLAG_APP_API_KEY",
          "exclusive": [
            "config"
          ],
          "hasDynamicHelp": false,
          "hidden": true,
          "multiple": false,
          "name": "api-key",
          "type": "option"
        },
        "client-id": {
          "description": "The Client ID of your app.",
          "env": "SHOPIFY_FLAG_CLIENT_ID",
          "exclusive": [
            "config"
          ],
          "hasDynamicHelp": false,
          "hidden": false,
          "multiple": false,
          "name": "client-id",
          "type": "option"
        },
        "config": {
          "char": "c",
          "description": "The name of the app configuration.",
          "env": "SHOPIFY_FLAG_APP_CONFIG",
          "hasDynamicHelp": false,
          "hidden": false,
          "multiple": false,
          "name": "config",
          "type": "option"
        },
        "force": {
          "allowNo": false,
          "char": "f",
          "description": "Deploy without asking for confirmation.",
          "env": "SHOPIFY_FLAG_FORCE",
          "hidden": false,
          "name": "force",
          "type": "boolean"
        },
        "message": {
          "description": "Optional message that will be associated with this version. This is for internal use only and won't be available externally.",
          "env": "SHOPIFY_FLAG_MESSAGE",
          "hasDynamicHelp": false,
          "hidden": false,
          "multiple": false,
          "name": "message",
          "type": "option"
        },
        "no-build": {
          "allowNo": false,
          "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.",
          "env": "SHOPIFY_FLAG_NO_BUILD",
          "name": "no-build",
          "type": "boolean"
        },
        "no-color": {
          "allowNo": false,
          "description": "Disable color output.",
          "env": "SHOPIFY_FLAG_NO_COLOR",
          "hidden": false,
          "name": "no-color",
          "type": "boolean"
        },
        "no-release": {
          "allowNo": false,
          "description": "Creates a version but doesn't release it - it's not made available to merchants.",
          "env": "SHOPIFY_FLAG_NO_RELEASE",
          "hidden": false,
          "name": "no-release",
          "type": "boolean"
        },
        "path": {
          "description": "The path to your app directory.",
          "env": "SHOPIFY_FLAG_PATH",
          "hasDynamicHelp": false,
          "multiple": false,
          "name": "path",
          "noCacheDefault": true,
          "type": "option"
        },
        "reset": {
          "allowNo": false,
          "description": "Reset all your settings.",
          "env": "SHOPIFY_FLAG_RESET",
          "exclusive": [
            "config"
          ],
          "hidden": false,
          "name": "reset",
          "type": "boolean"
        },
        "source-control-url": {
          "description": "URL associated with the new app version.",
          "env": "SHOPIFY_FLAG_SOURCE_CONTROL_URL",
          "hasDynamicHelp": false,
          "hidden": false,
          "multiple": false,
          "name": "source-control-url",
          "type": "option"
        },
        "verbose": {
          "allowNo": false,
          "description": "Increase the verbosity of the output.",
          "env": "SHOPIFY_FLAG_VERBOSE",
          "hidden": false,
          "name": "verbose",
          "type": "boolean"
        },
        "version": {
          "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.",
          "env": "SHOPIFY_FLAG_VERSION",
          "hasDynamicHelp": false,
          "hidden": false,
          "multiple": false,
          "name": "version",
          "type": "option"
        }
      },
      "hasDynamicHelp": false,
      "hiddenAliases": [
      ],
      "id": "app:deploy",
      "pluginAlias": "@shopify/cli",
      "pluginName": "@shopify/cli",
      "pluginType": "core",
      "strict": true,
      "summary": "Deploy your Shopify app."
    },
    "app:dev": {
      "aliases": [
      ],
      "args": {
      },
      "customPluginName": "@shopify/app",
      "description": "\"Builds the app\" (https://shopify.dev/docs/api/shopify-cli/app/app-build) and lets you preview it on a \"development store\" (https://shopify.dev/docs/apps/tools/development-stores) or \"Plus sandbox store\" (https://help.shopify.com/partners/dashboard/managing-stores/plus-sandbox-store).\n\n> Note: Development store preview of extension drafts is not supported for Plus sandbox stores. You must `deploy` your app.\n\n  To preview your app on a development store or Plus sandbox store, Shopify CLI walks you through the following steps. If you've run `dev` before, then your settings are saved and some of these steps are skipped. You can reset these configurations using `dev --reset` to go through all of them again:\n\n- Associating your project with an app associated with your Partner account or organization, or creating a new app.\n- Selecting a development store or Plus sandbox store to use for testing. If you have only one store, then it's selected automatically.\n- Installing your app on the store using the provided install link.\n- Creating a tunnel between your local environment and the store using Cloudflare.\n\n  You can use your own tunneling software instead, by passing your tunnel URL with the `--tunnel-url` flag.\n- Updating the app URLs that are set in the Partner Dashboard.\n\n  To avoid overwriting any URLs that are already set, select the No, never option. If you select this option, then you're provided with URLs that you can manually add in the Partner Dashboard so you can preview your app.\n\n- Enabling development store preview for extensions.\n- Serving \"GraphiQL for the Admin API\" (https://shopify.dev/docs/apps/tools/graphiql-admin-api#use-a-local-graphiql-instance) using your app's credentials and access scopes.\n- Building and serving your app and app extensions.\n\nIf you're using the Ruby app template, then you need to complete the following steps outlined in the \"README\" (https://github.com/Shopify/shopify-app-template-ruby#setting-up-your-rails-app) before you can preview your app for the first time.\n\n> Caution: To use a development store or Plus sandbox store with Shopify CLI, you need to be the store owner, or have a \"staff account\" (https://help.shopify.com/manual/your-account/staff-accounts) on the store. Staff accounts are created automatically the first time you access a development store with your Partner staff account through the Partner Dashboard.\n",
      "descriptionWithMarkdown": "[Builds the app](https://shopify.dev/docs/api/shopify-cli/app/app-build) and lets you preview it on a [development store](https://shopify.dev/docs/apps/tools/development-stores) or [Plus sandbox store](https://help.shopify.com/partners/dashboard/managing-stores/plus-sandbox-store).\n\n> Note: Development store preview of extension drafts is not supported for Plus sandbox stores. You must `deploy` your app.\n\n  To preview your app on a development store or Plus sandbox store, Shopify CLI walks you through the following steps. If you've run `dev` before, then your settings are saved and some of these steps are skipped. You can reset these configurations using `dev --reset` to go through all of them again:\n\n- Associating your project with an app associated with your Partner account or organization, or creating a new app.\n- Selecting a development store or Plus sandbox store to use for testing. If you have only one store, then it's selected automatically.\n- Installing your app on the store using the provided install link.\n- Creating a tunnel between your local environment and the store using Cloudflare.\n\n  You can use your own tunneling software instead, by passing your tunnel URL with the `--tunnel-url` flag.\n- Updating the app URLs that are set in the Partner Dashboard.\n\n  To avoid overwriting any URLs that are already set, select the No, never option. If you select this option, then you're provided with URLs that you can manually add in the Partner Dashboard so you can preview your app.\n\n- Enabling development store preview for extensions.\n- Serving [GraphiQL for the Admin API](https://shopify.dev/docs/apps/tools/graphiql-admin-api#use-a-local-graphiql-instance) using your app's credentials and access scopes.\n- Building and serving your app and app extensions.\n\nIf you're using the Ruby app template, then you need to complete the following steps outlined in the [README](https://github.com/Shopify/shopify-app-template-ruby#setting-up-your-rails-app) before you can preview your app for the first time.\n\n> Caution: To use a development store or Plus sandbox store with Shopify CLI, you need to be the store owner, or have a [staff account](https://help.shopify.com/manual/your-account/staff-accounts) on the store. Staff accounts are created automatically the first time you access a development store with your Partner staff account through the Partner Dashboard.\n",
      "flags": {
        "api-key": {
          "description": "The API key of your app.",
          "env": "SHOPIFY_FLAG_APP_API_KEY",
          "exclusive": [
            "config"
          ],
          "hasDynamicHelp": false,
          "hidden": true,
          "multiple": false,
          "name": "api-key",
          "type": "option"
        },
        "checkout-cart-url": {
          "description": "Resource URL for checkout UI extension. Format: \"/cart/{productVariantID}:{productQuantity}\"",
          "env": "SHOPIFY_FLAG_CHECKOUT_CART_URL",
          "hasDynamicHelp": false,
          "multiple": false,
          "name": "checkout-cart-url",
          "type": "option"
        },
        "client-id": {
          "description": "The Client ID of your app.",
          "env": "SHOPIFY_FLAG_CLIENT_ID",
          "exclusive": [
            "config"
          ],
          "hasDynamicHelp": false,
          "hidden": false,
          "multiple": false,
          "name": "client-id",
          "type": "option"
        },
        "config": {
          "char": "c",
          "description": "The name of the app configuration.",
          "env": "SHOPIFY_FLAG_APP_CONFIG",
          "hasDynamicHelp": false,
          "hidden": false,
          "multiple": false,
          "name": "config",
          "type": "option"
        },
        "graphiql-key": {
          "description": "Key used to authenticate GraphiQL requests. Should be specified if exposing GraphiQL on a publicly accessible URL. By default, no key is required.",
          "env": "SHOPIFY_FLAG_GRAPHIQL_KEY",
          "hasDynamicHelp": false,
          "hidden": true,
          "multiple": false,
          "name": "graphiql-key",
          "type": "option"
        },
        "graphiql-port": {
          "description": "Local port of the GraphiQL development server.",
          "env": "SHOPIFY_FLAG_GRAPHIQL_PORT",
          "hasDynamicHelp": false,
          "hidden": true,
          "multiple": false,
          "name": "graphiql-port",
          "type": "option"
        },
        "localhost-port": {
          "description": "Port to use for localhost.",
          "env": "SHOPIFY_FLAG_LOCALHOST_PORT",
          "hasDynamicHelp": false,
          "multiple": false,
          "name": "localhost-port",
          "type": "option"
        },
        "no-color": {
          "allowNo": false,
          "description": "Disable color output.",
          "env": "SHOPIFY_FLAG_NO_COLOR",
          "hidden": false,
          "name": "no-color",
          "type": "boolean"
        },
        "no-update": {
          "allowNo": false,
          "description": "Skips the Partners Dashboard URL update step.",
          "env": "SHOPIFY_FLAG_NO_UPDATE",
          "name": "no-update",
          "type": "boolean"
        },
        "notify": {
          "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.",
          "env": "SHOPIFY_FLAG_NOTIFY",
          "hasDynamicHelp": false,
          "multiple": false,
          "name": "notify",
          "type": "option"
        },
        "path": {
          "description": "The path to your app directory.",
          "env": "SHOPIFY_FLAG_PATH",
          "hasDynamicHelp": false,
          "multiple": false,
          "name": "path",
          "noCacheDefault": true,
          "type": "option"
        },
        "reset": {
          "allowNo": false,
          "description": "Reset all your settings.",
          "env": "SHOPIFY_FLAG_RESET",
          "exclusive": [
            "config"
          ],
          "hidden": false,
          "name": "reset",
          "type": "boolean"
        },
        "skip-dependencies-installation": {
          "allowNo": false,
          "description": "Skips the installation of dependencies. Deprecated, use workspaces instead.",
          "env": "SHOPIFY_FLAG_SKIP_DEPENDENCIES_INSTALLATION",
          "name": "skip-dependencies-installation",
          "type": "boolean"
        },
        "store": {
          "char": "s",
          "description": "Store URL. Must be an existing development or Shopify Plus sandbox store.",
          "env": "SHOPIFY_FLAG_STORE",
          "hasDynamicHelp": false,
          "multiple": false,
          "name": "store",
          "type": "option"
        },
        "subscription-product-url": {
          "description": "Resource URL for subscription UI extension. Format: \"/products/{productId}\"",
          "env": "SHOPIFY_FLAG_SUBSCRIPTION_PRODUCT_URL",
          "hasDynamicHelp": false,
          "multiple": false,
          "name": "subscription-product-url",
          "type": "option"
        },
        "theme": {
          "char": "t",
          "description": "Theme ID or name of the theme app extension host theme.",
          "env": "SHOPIFY_FLAG_THEME",
          "hasDynamicHelp": false,
          "multiple": false,
          "name": "theme",
          "type": "option"
        },
        "theme-app-extension-port": {
          "description": "Local port of the theme app extension development server.",
          "env": "SHOPIFY_FLAG_THEME_APP_EXTENSION_PORT",
          "hasDynamicHelp": false,
          "multiple": false,
          "name": "theme-app-extension-port",
          "type": "option"
        },
        "tunnel-url": {
          "description": "Use a custom tunnel, it must be running before executing dev. Format: \"https://my-tunnel-url:port\".",
          "env": "SHOPIFY_FLAG_TUNNEL_URL",
          "exclusive": [
            "tunnel"
          ],
          "hasDynamicHelp": false,
          "multiple": false,
          "name": "tunnel-url",
          "type": "option"
        },
        "use-localhost": {
          "allowNo": false,
          "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)",
          "env": "SHOPIFY_FLAG_USE_LOCALHOST",
          "exclusive": [
            "tunnel-url"
          ],
          "name": "use-localhost",
          "type": "boolean"
        },
        "verbose": {
          "allowNo": false,
          "description": "Increase the verbosity of the output.",
          "env": "SHOPIFY_FLAG_VERBOSE",
          "hidden": false,
          "name": "verbose",
          "type": "boolean"
        }
      },
      "hasDynamicHelp": false,
      "hiddenAliases": [
      ],
      "id": "app:dev",
      "pluginAlias": "@shopify/cli",
      "pluginName": "@shopify/cli",
      "pluginType": "core",
      "strict": true,
      "summary": "Run the app."
    },
    "app:dev:clean": {
      "aliases": [
      ],
      "args": {
      },
      "customPluginName": "@shopify/app",
      "description": "Stop the app preview that was started with `shopify app dev`.\n\n  It restores the app's active version to the selected development store.\n\n  It's valid only for apps created on the Next-Gen Dev Platform.\n  ",
      "descriptionWithMarkdown": "Stop the app preview that was started with `shopify app dev`.\n\n  It restores the app's active version to the selected development store.\n\n  It's valid only for apps created on the Next-Gen Dev Platform.\n  ",
      "flags": {
        "client-id": {
          "description": "The Client ID of your app.",
          "env": "SHOPIFY_FLAG_CLIENT_ID",
          "exclusive": [
            "config"
          ],
          "hasDynamicHelp": false,
          "hidden": false,
          "multiple": false,
          "name": "client-id",
          "type": "option"
        },
        "config": {
          "char": "c",
          "description": "The name of the app configuration.",
          "env": "SHOPIFY_FLAG_APP_CONFIG",
          "hasDynamicHelp": false,
          "hidden": false,
          "multiple": false,
          "name": "config",
          "type": "option"
        },
        "no-color": {
          "allowNo": false,
          "description": "Disable color output.",
          "env": "SHOPIFY_FLAG_NO_COLOR",
          "hidden": false,
          "name": "no-color",
          "type": "boolean"
        },
        "path": {
          "description": "The path to your app directory.",
          "env": "SHOPIFY_FLAG_PATH",
          "hasDynamicHelp": false,
          "multiple": false,
          "name": "path",
          "noCacheDefault": true,
          "type": "option"
        },
        "reset": {
          "allowNo": false,
          "description": "Reset all your settings.",
          "env": "SHOPIFY_FLAG_RESET",
          "exclusive": [
            "config"
          ],
          "hidden": false,
          "name": "reset",
          "type": "boolean"
        },
        "store": {
          "char": "s",
          "description": "Store URL. Must be an existing development store.",
          "env": "SHOPIFY_FLAG_STORE",
          "hasDynamicHelp": false,
          "hidden": false,
          "multiple": false,
          "name": "store",
          "type": "option"
        },
        "verbose": {
          "allowNo": false,
          "description": "Increase the verbosity of the output.",
          "env": "SHOPIFY_FLAG_VERBOSE",
          "hidden": false,
          "name": "verbose",
          "type": "boolean"
        }
      },
      "hasDynamicHelp": false,
      "hiddenAliases": [
      ],
      "id": "app:dev:clean",
      "pluginAlias": "@shopify/cli",
      "pluginName": "@shopify/cli",
      "pluginType": "core",
      "strict": true,
      "summary": "Cleans up the app preview from the selected store."
    },
    "app:env:pull": {
      "aliases": [
      ],
      "args": {
      },
      "customPluginName": "@shopify/app",
      "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.",
      "descriptionWithMarkdown": "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.",
      "flags": {
        "client-id": {
          "description": "The Client ID of your app.",
          "env": "SHOPIFY_FLAG_CLIENT_ID",
          "exclusive": [
            "config"
          ],
          "hasDynamicHelp": false,
          "hidden": false,
          "multiple": false,
          "name": "client-id",
          "type": "option"
        },
        "config": {
          "char": "c",
          "description": "The name of the app configuration.",
          "env": "SHOPIFY_FLAG_APP_CONFIG",
          "hasDynamicHelp": false,
          "hidden": false,
          "multiple": false,
          "name": "config",
          "type": "option"
        },
        "env-file": {
          "description": "Specify an environment file to update if the update flag is set",
          "env": "SHOPIFY_FLAG_ENV_FILE",
          "hasDynamicHelp": false,
          "hidden": false,
          "multiple": false,
          "name": "env-file",
          "type": "option"
        },
        "no-color": {
          "allowNo": false,
          "description": "Disable color output.",
          "env": "SHOPIFY_FLAG_NO_COLOR",
          "hidden": false,
          "name": "no-color",
          "type": "boolean"
        },
        "path": {
          "description": "The path to your app directory.",
          "env": "SHOPIFY_FLAG_PATH",
          "hasDynamicHelp": false,
          "multiple": false,
          "name": "path",
          "noCacheDefault": true,
          "type": "option"
        },
        "reset": {
          "allowNo": false,
          "description": "Reset all your settings.",
          "env": "SHOPIFY_FLAG_RESET",
          "exclusive": [
            "config"
          ],
          "hidden": false,
          "name": "reset",
          "type": "boolean"
        },
        "verbose": {
          "allowNo": false,
          "description": "Increase the verbosity of the output.",
          "env": "SHOPIFY_FLAG_VERBOSE",
          "hidden": false,
          "name": "verbose",
          "type": "boolean"
        }
      },
      "hasDynamicHelp": false,
      "hiddenAliases": [
      ],
      "id": "app:env:pull",
      "pluginAlias": "@shopify/cli",
      "pluginName": "@shopify/cli",
      "pluginType": "core",
      "strict": true,
      "summary": "Pull app and extensions environment variables."
    },
    "app:env:show": {
      "aliases": [
      ],
      "args": {
      },
      "customPluginName": "@shopify/app",
      "description": "Displays environment variables that can be used to deploy apps and app extensions.",
      "descriptionWithMarkdown": "Displays environment variables that can be used to deploy apps and app extensions.",
      "flags": {
        "client-id": {
          "description": "The Client ID of your app.",
          "env": "SHOPIFY_FLAG_CLIENT_ID",
          "exclusive": [
            "config"
          ],
          "hasDynamicHelp": false,
          "hidden": false,
          "multiple": false,
          "name": "client-id",
          "type": "option"
        },
        "config": {
          "char": "c",
          "description": "The name of the app configuration.",
          "env": "SHOPIFY_FLAG_APP_CONFIG",
          "hasDynamicHelp": false,
          "hidden": false,
          "multiple": false,
          "name": "config",
          "type": "option"
        },
        "no-color": {
          "allowNo": false,
          "description": "Disable color output.",
          "env": "SHOPIFY_FLAG_NO_COLOR",
          "hidden": false,
          "name": "no-color",
          "type": "boolean"
        },
        "path": {
          "description": "The path to your app directory.",
          "env": "SHOPIFY_FLAG_PATH",
          "hasDynamicHelp": false,
          "multiple": false,
          "name": "path",
          "noCacheDefault": true,
          "type": "option"
        },
        "reset": {
          "allowNo": false,
          "description": "Reset all your settings.",
          "env": "SHOPIFY_FLAG_RESET",
          "exclusive": [
            "config"
          ],
          "hidden": false,
          "name": "reset",
          "type": "boolean"
        },
        "verbose": {
          "allowNo": false,
          "description": "Increase the verbosity of the output.",
          "env": "SHOPIFY_FLAG_VERBOSE",
          "hidden": false,
          "name": "verbose",
          "type": "boolean"
        }
      },
      "hasDynamicHelp": false,
      "hiddenAliases": [
      ],
      "id": "app:env:show",
      "pluginAlias": "@shopify/cli",
      "pluginName": "@shopify/cli",
      "pluginType": "core",
      "strict": true,
      "summary": "Display app and extensions environment variables."
    },
    "app:function:build": {
      "aliases": [
      ],
      "args": {
      },
      "customPluginName": "@shopify/app",
      "description": "Compiles the function in your current directory to WebAssembly (Wasm) for testing purposes.",
      "descriptionWithMarkdown": "Compiles the function in your current directory to WebAssembly (Wasm) for testing purposes.",
      "flags": {
        "client-id": {
          "description": "The Client ID of your app.",
          "env": "SHOPIFY_FLAG_CLIENT_ID",
          "exclusive": [
            "config"
          ],
          "hasDynamicHelp": false,
          "hidden": false,
          "multiple": false,
          "name": "client-id",
          "type": "option"
        },
        "config": {
          "char": "c",
          "description": "The name of the app configuration.",
          "env": "SHOPIFY_FLAG_APP_CONFIG",
          "hasDynamicHelp": false,
          "hidden": false,
          "multiple": false,
          "name": "config",
          "type": "option"
        },
        "no-color": {
          "allowNo": false,
          "description": "Disable color output.",
          "env": "SHOPIFY_FLAG_NO_COLOR",
          "hidden": false,
          "name": "no-color",
          "type": "boolean"
        },
        "path": {
          "description": "The path to your function directory.",
          "env": "SHOPIFY_FLAG_PATH",
          "hasDynamicHelp": false,
          "hidden": false,
          "multiple": false,
          "name": "path",
          "noCacheDefault": true,
          "type": "option"
        },
        "reset": {
          "allowNo": false,
          "description": "Reset all your settings.",
          "env": "SHOPIFY_FLAG_RESET",
          "exclusive": [
            "config"
          ],
          "hidden": false,
          "name": "reset",
          "type": "boolean"
        },
        "verbose": {
          "allowNo": false,
          "description": "Increase the verbosity of the output.",
          "env": "SHOPIFY_FLAG_VERBOSE",
          "hidden": false,
          "name": "verbose",
          "type": "boolean"
        }
      },
      "hasDynamicHelp": false,
      "hiddenAliases": [
      ],
      "id": "app:function:build",
      "pluginAlias": "@shopify/cli",
      "pluginName": "@shopify/cli",
      "pluginType": "core",
      "strict": true,
      "summary": "Compile a function to wasm."
    },
    "app:function:replay": {
      "aliases": [
      ],
      "args": {
      },
      "customPluginName": "@shopify/app",
      "description": "Runs the function from your current directory for \"testing purposes\" (https://shopify.dev/docs/apps/functions/testing-and-debugging). To learn how you can monitor and debug functions when errors occur, refer to \"Shopify Functions error handling\" (https://shopify.dev/docs/api/functions/errors).",
      "descriptionWithMarkdown": "Runs the function from your current directory for [testing purposes](https://shopify.dev/docs/apps/functions/testing-and-debugging). To learn how you can monitor and debug functions when errors occur, refer to [Shopify Functions error handling](https://shopify.dev/docs/api/functions/errors).",
      "flags": {
        "api-key": {
          "description": "Application's API key",
          "env": "SHOPIFY_FLAG_API_KEY",
          "exclusive": [
            "config"
          ],
          "hasDynamicHelp": false,
          "hidden": true,
          "multiple": false,
          "name": "api-key",
          "type": "option"
        },
        "client-id": {
          "description": "The Client ID of your app.",
          "env": "SHOPIFY_FLAG_CLIENT_ID",
          "exclusive": [
            "config"
          ],
          "hasDynamicHelp": false,
          "hidden": false,
          "multiple": false,
          "name": "client-id",
          "type": "option"
        },
        "config": {
          "char": "c",
          "description": "The name of the app configuration.",
          "env": "SHOPIFY_FLAG_APP_CONFIG",
          "hasDynamicHelp": false,
          "hidden": false,
          "multiple": false,
          "name": "config",
          "type": "option"
        },
        "json": {
          "allowNo": false,
          "char": "j",
          "description": "Output the result as JSON.",
          "env": "SHOPIFY_FLAG_JSON",
          "hidden": false,
          "name": "json",
          "type": "boolean"
        },
        "log": {
          "char": "l",
          "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.",
          "env": "SHOPIFY_FLAG_LOG",
          "hasDynamicHelp": false,
          "multiple": false,
          "name": "log",
          "type": "option"
        },
        "no-color": {
          "allowNo": false,
          "description": "Disable color output.",
          "env": "SHOPIFY_FLAG_NO_COLOR",
          "hidden": false,
          "name": "no-color",
          "type": "boolean"
        },
        "path": {
          "description": "The path to your function directory.",
          "env": "SHOPIFY_FLAG_PATH",
          "hasDynamicHelp": false,
          "hidden": false,
          "multiple": false,
          "name": "path",
          "noCacheDefault": true,
          "type": "option"
        },
        "reset": {
          "allowNo": false,
          "description": "Reset all your settings.",
          "env": "SHOPIFY_FLAG_RESET",
          "exclusive": [
            "config"
          ],
          "hidden": false,
          "name": "reset",
          "type": "boolean"
        },
        "verbose": {
          "allowNo": false,
          "description": "Increase the verbosity of the output.",
          "env": "SHOPIFY_FLAG_VERBOSE",
          "hidden": false,
          "name": "verbose",
          "type": "boolean"
        },
        "watch": {
          "allowNo": true,
          "char": "w",
          "description": "Re-run the function when the source code changes.",
          "env": "SHOPIFY_FLAG_WATCH",
          "hidden": false,
          "name": "watch",
          "type": "boolean"
        }
      },
      "hasDynamicHelp": false,
      "hiddenAliases": [
      ],
      "id": "app:function:replay",
      "pluginAlias": "@shopify/cli",
      "pluginName": "@shopify/cli",
      "pluginType": "core",
      "strict": true,
      "summary": "Replays a function run from an app log."
    },
    "app:function:run": {
      "aliases": [
      ],
      "args": {
      },
      "customPluginName": "@shopify/app",
      "description": "Runs the function from your current directory for \"testing purposes\" (https://shopify.dev/docs/apps/functions/testing-and-debugging). To learn how you can monitor and debug functions when errors occur, refer to \"Shopify Functions error handling\" (https://shopify.dev/docs/api/functions/errors).",
      "descriptionWithMarkdown": "Runs the function from your current directory for [testing purposes](https://shopify.dev/docs/apps/functions/testing-and-debugging). To learn how you can monitor and debug functions when errors occur, refer to [Shopify Functions error handling](https://shopify.dev/docs/api/functions/errors).",
      "flags": {
        "client-id": {
          "description": "The Client ID of your app.",
          "env": "SHOPIFY_FLAG_CLIENT_ID",
          "exclusive": [
            "config"
          ],
          "hasDynamicHelp": false,
          "hidden": false,
          "multiple": false,
          "name": "client-id",
          "type": "option"
        },
        "config": {
          "char": "c",
          "description": "The name of the app configuration.",
          "env": "SHOPIFY_FLAG_APP_CONFIG",
          "hasDynamicHelp": false,
          "hidden": false,
          "multiple": false,
          "name": "config",
          "type": "option"
        },
        "export": {
          "char": "e",
          "description": "Name of the WebAssembly export to invoke.",
          "env": "SHOPIFY_FLAG_EXPORT",
          "hasDynamicHelp": false,
          "hidden": false,
          "multiple": false,
          "name": "export",
          "type": "option"
        },
        "input": {
          "char": "i",
          "description": "The input JSON to pass to the function. If omitted, standard input is used.",
          "env": "SHOPIFY_FLAG_INPUT",
          "hasDynamicHelp": false,
          "multiple": false,
          "name": "input",
          "type": "option"
        },
        "json": {
          "allowNo": false,
          "char": "j",
          "description": "Output the result as JSON.",
          "env": "SHOPIFY_FLAG_JSON",
          "hidden": false,
          "name": "json",
          "type": "boolean"
        },
        "no-color": {
          "allowNo": false,
          "description": "Disable color output.",
          "env": "SHOPIFY_FLAG_NO_COLOR",
          "hidden": false,
          "name": "no-color",
          "type": "boolean"
        },
        "path": {
          "description": "The path to your function directory.",
          "env": "SHOPIFY_FLAG_PATH",
          "hasDynamicHelp": false,
          "hidden": false,
          "multiple": false,
          "name": "path",
          "noCacheDefault": true,
          "type": "option"
        },
        "reset": {
          "allowNo": false,
          "description": "Reset all your settings.",
          "env": "SHOPIFY_FLAG_RESET",
          "exclusive": [
            "config"
          ],
          "hidden": false,
          "name": "reset",
          "type": "boolean"
        },
        "verbose": {
          "allowNo": false,
          "description": "Increase the verbosity of the output.",
          "env": "SHOPIFY_FLAG_VERBOSE",
          "hidden": false,
          "name": "verbose",
          "type": "boolean"
        }
      },
      "hasDynamicHelp": false,
      "hiddenAliases": [
      ],
      "id": "app:function:run",
      "pluginAlias": "@shopify/cli",
      "pluginName": "@shopify/cli",
      "pluginType": "core",
      "strict": true,
      "summary": "Run a function locally for testing."
    },
    "app:function:schema": {
      "aliases": [
      ],
      "args": {
      },
      "customPluginName": "@shopify/app",
      "description": "Generates the latest \"GraphQL schema\" (https://shopify.dev/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.",
      "descriptionWithMarkdown": "Generates the latest [GraphQL schema](https://shopify.dev/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.",
      "flags": {
        "api-key": {
          "description": "The API key to fetch the schema with.",
          "env": "SHOPIFY_FLAG_APP_API_KEY",
          "exclusive": [
            "config"
          ],
          "hasDynamicHelp": false,
          "hidden": true,
          "multiple": false,
          "name": "api-key",
          "type": "option"
        },
        "client-id": {
          "description": "The Client ID of your app.",
          "env": "SHOPIFY_FLAG_CLIENT_ID",
          "exclusive": [
            "config"
          ],
          "hasDynamicHelp": false,
          "hidden": false,
          "multiple": false,
          "name": "client-id",
          "type": "option"
        },
        "config": {
          "char": "c",
          "description": "The name of the app configuration.",
          "env": "SHOPIFY_FLAG_APP_CONFIG",
          "hasDynamicHelp": false,
          "hidden": false,
          "multiple": false,
          "name": "config",
          "type": "option"
        },
        "no-color": {
          "allowNo": false,
          "description": "Disable color output.",
          "env": "SHOPIFY_FLAG_NO_COLOR",
          "hidden": false,
          "name": "no-color",
          "type": "boolean"
        },
        "path": {
          "description": "The path to your function directory.",
          "env": "SHOPIFY_FLAG_PATH",
          "hasDynamicHelp": false,
          "hidden": false,
          "multiple": false,
          "name": "path",
          "noCacheDefault": true,
          "type": "option"
        },
        "reset": {
          "allowNo": false,
          "description": "Reset all your settings.",
          "env": "SHOPIFY_FLAG_RESET",
          "exclusive": [
            "config"
          ],
          "hidden": false,
          "name": "reset",
          "type": "boolean"
        },
        "stdout": {
          "allowNo": false,
          "description": "Output the schema to stdout instead of writing to a file.",
          "env": "SHOPIFY_FLAG_STDOUT",
          "name": "stdout",
          "required": false,
          "type": "boolean"
        },
        "verbose": {
          "allowNo": false,
          "description": "Increase the verbosity of the output.",
          "env": "SHOPIFY_FLAG_VERBOSE",
          "hidden": false,
          "name": "verbose",
          "type": "boolean"
        }
      },
      "hasDynamicHelp": false,
      "hiddenAliases": [
      ],
      "id": "app:function:schema",
      "pluginAlias": "@shopify/cli",
      "pluginName": "@shopify/cli",
      "pluginType": "core",
      "strict": true,
      "summary": "Fetch the latest GraphQL schema for a function."
    },
    "app:function:typegen": {
      "aliases": [
      ],
      "args": {
      },
      "customPluginName": "@shopify/app",
      "description": "Creates GraphQL types based on your \"input query\" (https://shopify.dev/docs/apps/functions/input-output#input) for a function written in JavaScript.",
      "descriptionWithMarkdown": "Creates GraphQL types based on your [input query](https://shopify.dev/docs/apps/functions/input-output#input) for a function written in JavaScript.",
      "flags": {
        "client-id": {
          "description": "The Client ID of your app.",
          "env": "SHOPIFY_FLAG_CLIENT_ID",
          "exclusive": [
            "config"
          ],
          "hasDynamicHelp": false,
          "hidden": false,
          "multiple": false,
          "name": "client-id",
          "type": "option"
        },
        "config": {
          "char": "c",
          "description": "The name of the app configuration.",
          "env": "SHOPIFY_FLAG_APP_CONFIG",