{ "commands": { "app:build": { "aliases": [ ], "args": { }, "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": "Application's Client ID that will be exposed at build time.", "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" }, "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 logs.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [ ], "id": "app:build", "isESM": true, "pluginAlias": "@shopify/app", "pluginName": "@shopify/app", "pluginType": "core", "relativePath": [ "dist", "cli", "commands", "app", "build.js" ], "strict": true, "summary": "Build the app, including extensions." }, "app:config:link": { "aliases": [ ], "args": { }, "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", "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" }, "verbose": { "allowNo": false, "description": "Increase the verbosity of the logs.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [ ], "id": "app:config:link", "isESM": true, "pluginAlias": "@shopify/app", "pluginName": "@shopify/app", "pluginType": "core", "relativePath": [ "dist", "cli", "commands", "app", "config", "link.js" ], "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" } }, "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": { "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 current configuration.", "env": "SHOPIFY_FLAG_RESET", "hidden": false, "name": "reset", "type": "boolean" }, "verbose": { "allowNo": false, "description": "Increase the verbosity of the logs.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [ ], "id": "app:config:use", "isESM": true, "pluginAlias": "@shopify/app", "pluginName": "@shopify/app", "pluginType": "core", "relativePath": [ "dist", "cli", "commands", "app", "config", "use.js" ], "strict": true, "summary": "Activate an app configuration." }, "app:deploy": { "aliases": [ ], "args": { }, "description": "\"Builds the app\" (https://shopify.dev/docs/apps/tools/cli/commands#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/apps/tools/cli/commands#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-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 logs.", "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", "isESM": true, "pluginAlias": "@shopify/app", "pluginName": "@shopify/app", "pluginType": "core", "relativePath": [ "dist", "cli", "commands", "app", "deploy.js" ], "strict": true, "summary": "Deploy your Shopify app." }, "app:dev": { "aliases": [ ], "args": { }, "description": "\"Builds the app\" (https://shopify.dev/docs/apps/tools/cli/commands#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?shpxid=09640797-900B-4D1E-6E65-76A35B54FF4A).\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 PHP or Ruby app template, then you need to complete the following steps before you can preview your app for the first time:\n\n- PHP: \"Set up your Laravel app\" (https://github.com/Shopify/shopify-app-template-php#setting-up-your-laravel-app)\n- Ruby: \"Set up your Rails app\" (https://github.com/Shopify/shopify-app-template-ruby#setting-up-your-rails-app)\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?shpxid=09640797-900B-4D1E-6E65-76A35B54FF4A) 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/apps/tools/cli/commands#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?shpxid=09640797-900B-4D1E-6E65-76A35B54FF4A).\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 PHP or Ruby app template, then you need to complete the following steps before you can preview your app for the first time:\n\n- PHP: [Set up your Laravel app](https://github.com/Shopify/shopify-app-template-php#setting-up-your-laravel-app)\n- Ruby: [Set up your Rails app](https://github.com/Shopify/shopify-app-template-ruby#setting-up-your-rails-app)\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?shpxid=09640797-900B-4D1E-6E65-76A35B54FF4A) 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, "hidden": 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" }, "no-color": { "allowNo": false, "description": "Disable color output.", "env": "SHOPIFY_FLAG_NO_COLOR", "hidden": false, "name": "no-color", "type": "boolean" }, "no-tunnel": { "allowNo": false, "description": "Automatic creation of a tunnel is disabled. Service entry point will listen to localhost instead", "env": "SHOPIFY_FLAG_NO_TUNNEL", "exclusive": [ "tunnel-url", "tunnel" ], "hidden": true, "name": "no-tunnel", "type": "boolean" }, "no-update": { "allowNo": false, "description": "Skips the Partners Dashboard URL update step.", "env": "SHOPIFY_FLAG_NO_UPDATE", "hidden": false, "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", "hidden": false, "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, "hidden": 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, "hidden": 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, "hidden": 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, "hidden": 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": [ "no-tunnel", "tunnel" ], "hasDynamicHelp": false, "hidden": false, "multiple": false, "name": "tunnel-url", "type": "option" }, "verbose": { "allowNo": false, "description": "Increase the verbosity of the logs.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [ ], "id": "app:dev", "isESM": true, "pluginAlias": "@shopify/app", "pluginName": "@shopify/app", "pluginType": "core", "relativePath": [ "dist", "cli", "commands", "app", "dev.js" ], "strict": true, "summary": "Run the app." }, "app:draft-extensions:push": { "aliases": [ ], "args": { }, "description": "Updates the content of the app draft version.", "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" }, "enable-dev-preview": { "allowNo": false, "description": "Enable dev preview after the draft content is updated.", "env": "SHOPIFY_FLAG_ENABLE_DEV_PREVIEW", "hidden": false, "name": "enable-dev-preview", "type": "boolean" }, "path": { "default": ".", "description": "The path to your app directory.", "env": "SHOPIFY_FLAG_PATH", "hasDynamicHelp": false, "multiple": false, "name": "path", "type": "option" }, "reset": { "allowNo": false, "description": "Reset all your settings.", "env": "SHOPIFY_FLAG_RESET", "hidden": false, "name": "reset", "type": "boolean" }, "verbose": { "allowNo": false, "description": "Increase the verbosity of the logs.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "type": "boolean" } }, "hasDynamicHelp": false, "hidden": true, "hiddenAliases": [ ], "id": "app:draft-extensions:push", "isESM": true, "pluginAlias": "@shopify/app", "pluginName": "@shopify/app", "pluginType": "core", "relativePath": [ "dist", "cli", "commands", "app", "draft-extensions", "push.js" ], "strict": true }, "app:env:pull": { "aliases": [ ], "args": { }, "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": { "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" }, "verbose": { "allowNo": false, "description": "Increase the verbosity of the logs.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [ ], "id": "app:env:pull", "isESM": true, "pluginAlias": "@shopify/app", "pluginName": "@shopify/app", "pluginType": "core", "relativePath": [ "dist", "cli", "commands", "app", "env", "pull.js" ], "strict": true, "summary": "Pull app and extensions environment variables." }, "app:env:show": { "aliases": [ ], "args": { }, "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": { "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" }, "verbose": { "allowNo": false, "description": "Increase the verbosity of the logs.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [ ], "id": "app:env:show", "isESM": true, "pluginAlias": "@shopify/app", "pluginName": "@shopify/app", "pluginType": "core", "relativePath": [ "dist", "cli", "commands", "app", "env", "show.js" ], "strict": true, "summary": "Display app and extensions environment variables." }, "app:function:build": { "aliases": [ ], "args": { }, "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": { "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" }, "verbose": { "allowNo": false, "description": "Increase the verbosity of the logs.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [ ], "id": "app:function:build", "isESM": true, "pluginAlias": "@shopify/app", "pluginName": "@shopify/app", "pluginType": "core", "relativePath": [ "dist", "cli", "commands", "app", "function", "build.js" ], "strict": true, "summary": "Compile a function to wasm." }, "app:function:run": { "aliases": [ ], "args": { }, "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": { "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", "default": "_start", "description": "Name of the wasm 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": "Log the run result as a JSON object.", "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" }, "verbose": { "allowNo": false, "description": "Increase the verbosity of the logs.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [ ], "id": "app:function:run", "isESM": true, "pluginAlias": "@shopify/app", "pluginName": "@shopify/app", "pluginType": "core", "relativePath": [ "dist", "cli", "commands", "app", "function", "run.js" ], "strict": true, "summary": "Run a function locally for testing." }, "app:function:schema": { "aliases": [ ], "args": { }, "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 to fetch the schema with.", "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" }, "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 logs.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [ ], "id": "app:function:schema", "isESM": true, "pluginAlias": "@shopify/app", "pluginName": "@shopify/app", "pluginType": "core", "relativePath": [ "dist", "cli", "commands", "app", "function", "schema.js" ], "strict": true, "summary": "Fetch the latest GraphQL schema for a function." }, "app:function:typegen": { "aliases": [ ], "args": { }, "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": { "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" }, "verbose": { "allowNo": false, "description": "Increase the verbosity of the logs.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [ ], "id": "app:function:typegen", "isESM": true, "pluginAlias": "@shopify/app", "pluginName": "@shopify/app", "pluginType": "core", "relativePath": [ "dist", "cli", "commands", "app", "function", "typegen.js" ], "strict": true, "summary": "Generate GraphQL types for a JavaScript function." }, "app:generate:extension": { "aliases": [ ], "args": { "file": { "name": "file" } }, "description": "Generates a new \"app extension\" (https://shopify.dev/docs/apps/app-extensions). For a list of app extensions that you can generate using this command, refer to \"Supported extensions\" (https://shopify.dev/docs/apps/tools/cli/commands#supported-extensions).\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\" (https://shopify.dev/docs/apps/tools/cli/structure) and the documentation for your extension.\n ", "descriptionWithMarkdown": "Generates a new [app extension](https://shopify.dev/docs/apps/app-extensions). For a list of app extensions that you can generate using this command, refer to [Supported extensions](https://shopify.dev/docs/apps/tools/cli/commands#supported-extensions).\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](https://shopify.dev/docs/apps/tools/cli/structure) and the documentation for your extension.\n ", "examples": [ "<%= config.bin %> <%= command.id %>" ], "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" }, "clone-url": { "char": "u", "description": "The Git URL to clone the function extensions templates from. Defaults to: https://github.com/Shopify/function-examples", "env": "SHOPIFY_FLAG_CLONE_URL", "hasDynamicHelp": false, "hidden": true, "multiple": false, "name": "clone-url", "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" }, "flavor": { "description": "Choose a starting template for your extension, where applicable", "env": "SHOPIFY_FLAG_FLAVOR", "hasDynamicHelp": false, "hidden": false, "multiple": false, "name": "flavor", "options": [ "vanilla-js", "react", "typescript", "typescript-react", "wasm", "rust" ], "type": "option" }, "name": { "char": "n", "description": "name of your Extension", "env": "SHOPIFY_FLAG_NAME", "hasDynamicHelp": false, "hidden": false, "multiple": false, "name": "name", "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" }, "template": { "char": "t", "description": "Extension template", "env": "SHOPIFY_FLAG_EXTENSION_TEMPLATE", "hasDynamicHelp": false, "hidden": false, "multiple": false, "name": "template", "type": "option" }, "type": { "char": "t", "description": "Deprecated. Please use --template", "env": "SHOPIFY_FLAG_EXTENSION_TYPE", "hasDynamicHelp": false, "hidden": false, "multiple": false, "name": "type", "type": "option" }, "verbose": { "allowNo": false, "description": "Increase the verbosity of the logs.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [ ], "id": "app:generate:extension", "isESM": true, "pluginAlias": "@shopify/app", "pluginName": "@shopify/app", "pluginType": "core", "relativePath": [ "dist", "cli", "commands", "app", "generate", "extension.js" ], "strict": true, "summary": "Generate a new app Extension." }, "app:generate:schema": { "aliases": [ ], "args": { }, "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 to fetch the schema with.", "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" }, "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 logs.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [ ], "id": "app:generate:schema", "isESM": true, "pluginAlias": "@shopify/app", "pluginName": "@shopify/app", "pluginType": "core", "relativePath": [ "dist", "cli", "commands", "app", "generate", "schema.js" ], "summary": "Fetch the latest GraphQL schema for a function." }, "app:import-flow-legacy-extensions": { "aliases": [ ], "args": { }, "description": "Import dashboard-managed flow extensions into your app.", "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" }, "verbose": { "allowNo": false, "description": "Increase the verbosity of the logs.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [ ], "id": "app:import-flow-legacy-extensions", "isESM": true, "pluginAlias": "@shopify/app", "pluginName": "@shopify/app", "pluginType": "core", "relativePath": [ "dist", "cli", "commands", "app", "import-flow-legacy-extensions.js" ], "strict": true }, "app:info": { "aliases": [ ], "args": { }, "description": "The information returned includes the following:\n\n - The app and development store or Plus sandbox store that's used when you run the \"dev\" (https://shopify.dev/docs/apps/tools/cli/commands#dev) command. You can reset these configurations using \"dev --reset\" (https://shopify.dev/docs/apps/tools/cli/commands#dev).\n - The \"structure\" (https://shopify.dev/docs/apps/tools/cli/structure) of your app project.\n - The \"access scopes\" (https://shopify.dev/docs/api/usage) your app has requested.\n - System information, including the package manager and version of Shopify CLI used in the project.", "descriptionWithMarkdown": "The information returned includes the following:\n\n - The app and development store or Plus sandbox store that's used when you run the [dev](https://shopify.dev/docs/apps/tools/cli/commands#dev) command. You can reset these configurations using [dev --reset](https://shopify.dev/docs/apps/tools/cli/commands#dev).\n - The [structure](https://shopify.dev/docs/apps/tools/cli/structure) of your app project.\n - The [access scopes](https://shopify.dev/docs/api/usage) your app has requested.\n - System information, including the package manager and version of Shopify CLI used in the project.", "flags": { "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, "description": "format output 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 app directory.", "env": "SHOPIFY_FLAG_PATH", "hasDynamicHelp": false, "multiple": false, "name": "path", "noCacheDefault": true, "type": "option" }, "verbose": { "allowNo": false, "description": "Increase the verbosity of the logs.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "type": "boolean" }, "web-env": { "allowNo": false, "description": "Outputs environment variables necessary for running and deploying web/.", "env": "SHOPIFY_FLAG_OUTPUT_WEB_ENV", "hidden": false, "name": "web-env", "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [ ], "id": "app:info", "isESM": true, "pluginAlias": "@shopify/app", "pluginName": "@shopify/app", "pluginType": "core", "relativePath": [ "dist", "cli", "commands", "app", "info.js" ], "strict": true, "summary": "Print basic information about your app and extensions." }, "app:init": { "aliases": [ ], "args": { }, "flags": { "flavor": { "description": "Which flavor of the given template to use.", "env": "SHOPIFY_FLAG_TEMPLATE_FLAVOR", "hasDynamicHelp": false, "multiple": false, "name": "flavor", "type": "option" }, "local": { "allowNo": false, "char": "l", "env": "SHOPIFY_FLAG_LOCAL", "hidden": true, "name": "local", "type": "boolean" }, "name": { "char": "n", "env": "SHOPIFY_FLAG_NAME", "hasDynamicHelp": false, "hidden": false, "multiple": false, "name": "name", "type": "option" }, "no-color": { "allowNo": false, "description": "Disable color output.", "env": "SHOPIFY_FLAG_NO_COLOR", "hidden": false, "name": "no-color", "type": "boolean" }, "package-manager": { "char": "d", "env": "SHOPIFY_FLAG_PACKAGE_MANAGER", "hasDynamicHelp": false, "hidden": false, "multiple": false, "name": "package-manager", "options": [ "npm", "yarn", "pnpm", "bun" ], "type": "option" }, "path": { "char": "p", "default": ".", "env": "SHOPIFY_FLAG_PATH", "hasDynamicHelp": false, "hidden": false, "multiple": false, "name": "path", "type": "option" }, "template": { "description": "The app template. Accepts one of the following:\n - \n - Any GitHub repo with optional branch and subpath, e.g., https://github.com/Shopify//[subpath]#[branch]", "env": "SHOPIFY_FLAG_TEMPLATE", "hasDynamicHelp": false, "multiple": false, "name": "template", "type": "option" }, "verbose": { "allowNo": false, "description": "Increase the verbosity of the logs.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [ ], "id": "app:init", "isESM": true, "pluginAlias": "@shopify/app", "pluginName": "@shopify/app", "pluginType": "core", "relativePath": [ "dist", "cli", "commands", "app", "init.js" ], "strict": true, "summary": "Create a new app project" }, "app:release": { "aliases": [ ], "args": { }, "description": "Releases an existing app version. Pass the name of the version that you want to release using the `--version` flag.", "descriptionWithMarkdown": "Releases an existing app version. Pass the name of the version that you want to release using the `--version` flag.", "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": "Release without asking for confirmation.", "env": "SHOPIFY_FLAG_FORCE", "hidden": false, "name": "force", "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 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", "hidden": false, "name": "reset", "type": "boolean" }, "verbose": { "allowNo": false, "description": "Increase the verbosity of the logs.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "type": "boolean" }, "version": { "description": "The name of the app version to release.", "env": "SHOPIFY_FLAG_VERSION", "hasDynamicHelp": false, "hidden": false, "multiple": false, "name": "version", "required": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [ ], "id": "app:release", "isESM": true, "pluginAlias": "@shopify/app", "pluginName": "@shopify/app", "pluginType": "core", "relativePath": [ "dist", "cli", "commands", "app", "release.js" ], "strict": true, "summary": "Release an app version.", "usage": "app:release --version " }, "app:scaffold:extension": { "aliases": [ ], "args": { "file": { "name": "file" } }, "description": "Scaffold an Extension.", "descriptionWithMarkdown": "Generates a new [app extension](https://shopify.dev/docs/apps/app-extensions). For a list of app extensions that you can generate using this command, refer to [Supported extensions](https://shopify.dev/docs/apps/tools/cli/commands#supported-extensions).\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](https://shopify.dev/docs/apps/tools/cli/structure) and the documentation for your extension.\n ", "examples": [ "<%= config.bin %> <%= command.id %>" ], "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" }, "clone-url": { "char": "u", "description": "The Git URL to clone the function extensions templates from. Defaults to: https://github.com/Shopify/function-examples", "env": "SHOPIFY_FLAG_CLONE_URL", "hasDynamicHelp": false, "hidden": true, "multiple": false, "name": "clone-url", "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" }, "flavor": { "description": "Choose a starting template for your extension, where applicable", "env": "SHOPIFY_FLAG_FLAVOR", "hasDynamicHelp": false, "hidden": false, "multiple": false, "name": "flavor", "options": [ "vanilla-js", "react", "typescript", "typescript-react", "wasm", "rust" ], "type": "option" }, "name": { "char": "n", "description": "name of your Extension", "env": "SHOPIFY_FLAG_NAME", "hasDynamicHelp": false, "hidden": false, "multiple": false, "name": "name", "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" }, "template": { "char": "t", "description": "Extension template", "env": "SHOPIFY_FLAG_EXTENSION_TEMPLATE", "hasDynamicHelp": false, "hidden": false, "multiple": false, "name": "template", "type": "option" }, "type": { "char": "t", "description": "Deprecated. Please use --template", "env": "SHOPIFY_FLAG_EXTENSION_TYPE", "hasDynamicHelp": false, "hidden": false, "multiple": false, "name": "type", "type": "option" }, "verbose": { "allowNo": false, "description": "Increase the verbosity of the logs.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "type": "boolean" } }, "hasDynamicHelp": false, "hidden": true, "hiddenAliases": [ ], "id": "app:scaffold:extension", "isESM": true, "pluginAlias": "@shopify/app", "pluginName": "@shopify/app", "pluginType": "core", "relativePath": [ "dist", "cli", "commands", "app", "scaffold", "extension.js" ], "summary": "Generate a new app Extension." }, "app:versions:list": { "aliases": [ ], "args": { "file": { "name": "file" } }, "description": "Lists the deployed app versions. An app version is a snapshot of your app extensions.", "descriptionWithMarkdown": "Lists the deployed app versions. An app version is a snapshot of your app extensions.", "examples": [ "<%= config.bin %> <%= command.id %>" ], "flags": { "api-key": { "description": "Application's API key to fetch versions for.", "env": "SHOPIFY_FLAG_API_KEY", "exclusive": [ "config" ], "hasDynamicHelp": false, "hidden": true, "multiple": false, "name": "api-key", "type": "option" }, "client-id": { "description": "The Client ID to fetch versions for.", "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, "description": "Output the versions list as JSON.", "env": "SHOPIFY_FLAG_JSON", "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 app directory.", "env": "SHOPIFY_FLAG_PATH", "hasDynamicHelp": false, "multiple": false, "name": "path", "noCacheDefault": true, "type": "option" }, "verbose": { "allowNo": false, "description": "Increase the verbosity of the logs.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [ ], "id": "app:versions:list", "isESM": true, "pluginAlias": "@shopify/app", "pluginName": "@shopify/app", "pluginType": "core", "relativePath": [ "dist", "cli", "commands", "app", "versions", "list.js" ], "strict": true, "summary": "List deployed versions of your app." }, "app:webhook:trigger": { "aliases": [ ], "args": { }, "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\" (https://shopify.dev/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\" (https://shopify.dev/docs/api/partner#rate_limits).\n - You can't use this method to validate your API webhook subscriptions.\n ", "descriptionWithMarkdown": "\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](https://shopify.dev/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](https://shopify.dev/docs/api/partner#rate_limits).\n - You can't use this method to validate your API webhook subscriptions.\n ", "flags": { "address": { "description": "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:", "env": "SHOPIFY_FLAG_ADDRESS", "hasDynamicHelp": false, "hidden": false, "multiple": false, "name": "address", "required": false, "type": "option" }, "api-version": { "description": "The API Version of the webhook topic.", "env": "SHOPIFY_FLAG_API_VERSION", "hasDynamicHelp": false, "hidden": false, "multiple": false, "name": "api-version", "required": false, "type": "option" }, "client-secret": { "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.", "env": "SHOPIFY_FLAG_CLIENT_SECRET", "hasDynamicHelp": false, "hidden": false, "multiple": false, "name": "client-secret", "required": false, "type": "option" }, "delivery-method": { "description": "Method chosen to deliver the topic payload. If not passed, it's inferred from the address.", "env": "SHOPIFY_FLAG_DELIVERY_METHOD", "hasDynamicHelp": false, "hidden": false, "multiple": false, "name": "delivery-method", "options": [ "http", "google-pub-sub", "event-bridge" ], "required": false, "type": "option" }, "help": { "allowNo": false, "description": "This help. When you run the trigger command the CLI will prompt you for any information that isn't passed using flags.", "env": "SHOPIFY_FLAG_HELP", "hidden": false, "name": "help", "required": false, "type": "boolean" }, "shared-secret": { "description": "Deprecated. Please use client-secret.", "env": "SHOPIFY_FLAG_SHARED_SECRET", "hasDynamicHelp": false, "hidden": false, "multiple": false, "name": "shared-secret", "required": false, "type": "option" }, "topic": { "description": "The requested webhook topic.", "env": "SHOPIFY_FLAG_TOPIC", "hasDynamicHelp": false, "hidden": false, "multiple": false, "name": "topic", "required": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [ ], "id": "app:webhook:trigger", "isESM": true, "pluginAlias": "@shopify/app", "pluginName": "@shopify/app", "pluginType": "core", "relativePath": [ "dist", "cli", "commands", "app", "webhook", "trigger.js" ], "strict": true, "summary": "Trigger delivery of a sample webhook topic payload to a designated address." }, "webhook:trigger": { "aliases": [ ], "args": { }, "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\" (https://shopify.dev/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\" (https://shopify.dev/docs/api/partner#rate_limits).\n - You can't use this method to validate your API webhook subscriptions.\n ", "descriptionWithMarkdown": "\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](https://shopify.dev/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](https://shopify.dev/docs/api/partner#rate_limits).\n - You can't use this method to validate your API webhook subscriptions.\n ", "flags": { "address": { "description": "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:", "env": "SHOPIFY_FLAG_ADDRESS", "hasDynamicHelp": false, "hidden": false, "multiple": false, "name": "address", "required": false, "type": "option" }, "api-version": { "description": "The API Version of the webhook topic.", "env": "SHOPIFY_FLAG_API_VERSION", "hasDynamicHelp": false, "hidden": false, "multiple": false, "name": "api-version", "required": false, "type": "option" }, "client-secret": { "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.", "env": "SHOPIFY_FLAG_CLIENT_SECRET", "hasDynamicHelp": false, "hidden": false, "multiple": false, "name": "client-secret", "required": false, "type": "option" }, "delivery-method": { "description": "Method chosen to deliver the topic payload. If not passed, it's inferred from the address.", "env": "SHOPIFY_FLAG_DELIVERY_METHOD", "hasDynamicHelp": false, "hidden": false, "multiple": false, "name": "delivery-method", "options": [ "http", "google-pub-sub", "event-bridge" ], "required": false, "type": "option" }, "help": { "allowNo": false, "description": "This help. When you run the trigger command the CLI will prompt you for any information that isn't passed using flags.", "env": "SHOPIFY_FLAG_HELP", "hidden": false, "name": "help", "required": false, "type": "boolean" }, "shared-secret": { "description": "Deprecated. Please use client-secret.", "env": "SHOPIFY_FLAG_SHARED_SECRET", "hasDynamicHelp": false, "hidden": false, "multiple": false, "name": "shared-secret", "required": false, "type": "option" }, "topic": { "description": "The requested webhook topic.", "env": "SHOPIFY_FLAG_TOPIC", "hasDynamicHelp": false, "hidden": false, "multiple": false, "name": "topic", "required": false, "type": "option" } }, "hasDynamicHelp": false, "hidden": true, "hiddenAliases": [ ], "id": "webhook:trigger", "isESM": true, "pluginAlias": "@shopify/app", "pluginName": "@shopify/app", "pluginType": "core", "relativePath": [ "dist", "cli", "commands", "webhook", "trigger.js" ], "summary": "Trigger delivery of a sample webhook topic payload to a designated address." } }, "version": "3.58.2" }