@shopify/cli

{ "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.", "flags": { "no-color": { "description": "Disable color output.", "env": "SHOPIFY_FLAG_NO_COLOR", "hidden": false, "name": "no-color", "allowNo": false, "type": "boolean" }, "verbose": { "description": "Increase the verbosity of the output.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "allowNo": false, "type": "boolean" }, "path": { "description": "The path to your app directory.", "env": "SHOPIFY_FLAG_PATH", "name": "path", "noCacheDefault": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "config": { "char": "c", "description": "The name of the app configuration.", "env": "SHOPIFY_FLAG_APP_CONFIG", "hidden": false, "name": "config", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "client-id": { "description": "The Client ID of your app.", "env": "SHOPIFY_FLAG_CLIENT_ID", "exclusive": [ "config" ], "hidden": false, "name": "client-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "reset": { "description": "Reset all your settings.", "env": "SHOPIFY_FLAG_RESET", "exclusive": [ "config" ], "hidden": false, "name": "reset", "allowNo": false, "type": "boolean" }, "skip-dependencies-installation": { "description": "Skips the installation of dependencies. Deprecated, use workspaces instead.", "env": "SHOPIFY_FLAG_SKIP_DEPENDENCIES_INSTALLATION", "hidden": false, "name": "skip-dependencies-installation", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "app:build", "pluginAlias": "@shopify/cli", "pluginName": "@shopify/cli", "pluginType": "core", "strict": true, "summary": "Build the app, including extensions.", "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.", "customPluginName": "@shopify/app" }, "app:bulk:cancel": { "aliases": [], "args": {}, "description": "Cancels a running bulk operation by ID.", "flags": { "no-color": { "description": "Disable color output.", "env": "SHOPIFY_FLAG_NO_COLOR", "hidden": false, "name": "no-color", "allowNo": false, "type": "boolean" }, "verbose": { "description": "Increase the verbosity of the output.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "allowNo": false, "type": "boolean" }, "path": { "description": "The path to your app directory.", "env": "SHOPIFY_FLAG_PATH", "name": "path", "noCacheDefault": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "config": { "char": "c", "description": "The name of the app configuration.", "env": "SHOPIFY_FLAG_APP_CONFIG", "hidden": false, "name": "config", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "client-id": { "description": "The Client ID of your app.", "env": "SHOPIFY_FLAG_CLIENT_ID", "exclusive": [ "config" ], "hidden": false, "name": "client-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "reset": { "description": "Reset all your settings.", "env": "SHOPIFY_FLAG_RESET", "exclusive": [ "config" ], "hidden": false, "name": "reset", "allowNo": false, "type": "boolean" }, "id": { "description": "The bulk operation ID to cancel (numeric ID or full GID).", "env": "SHOPIFY_FLAG_ID", "name": "id", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "store": { "char": "s", "description": "The store domain. Must be an existing dev store.", "env": "SHOPIFY_FLAG_STORE", "name": "store", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "app:bulk:cancel", "pluginAlias": "@shopify/cli", "pluginName": "@shopify/cli", "pluginType": "core", "strict": true, "summary": "Cancel a bulk operation.", "customPluginName": "@shopify/app" }, "app:bulk:status": { "aliases": [], "args": {}, "description": "Check the status of a specific bulk operation by ID, or list all bulk operations belonging to this app on this store in the last 7 days.\n\n Bulk operations allow you to process large amounts of data asynchronously. Learn more about \"bulk query operations\" (https://shopify.dev/docs/api/usage/bulk-operations/queries) and \"bulk mutation operations\" (https://shopify.dev/docs/api/usage/bulk-operations/imports).\n\n Use \"`bulk execute`\" (https://shopify.dev/docs/api/shopify-cli/app/app-bulk-execute) to start a new bulk operation.", "flags": { "no-color": { "description": "Disable color output.", "env": "SHOPIFY_FLAG_NO_COLOR", "hidden": false, "name": "no-color", "allowNo": false, "type": "boolean" }, "verbose": { "description": "Increase the verbosity of the output.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "allowNo": false, "type": "boolean" }, "path": { "description": "The path to your app directory.", "env": "SHOPIFY_FLAG_PATH", "name": "path", "noCacheDefault": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "config": { "char": "c", "description": "The name of the app configuration.", "env": "SHOPIFY_FLAG_APP_CONFIG", "hidden": false, "name": "config", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "client-id": { "description": "The Client ID of your app.", "env": "SHOPIFY_FLAG_CLIENT_ID", "exclusive": [ "config" ], "hidden": false, "name": "client-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "reset": { "description": "Reset all your settings.", "env": "SHOPIFY_FLAG_RESET", "exclusive": [ "config" ], "hidden": false, "name": "reset", "allowNo": false, "type": "boolean" }, "id": { "description": "The bulk operation ID (numeric ID or full GID). If not provided, lists all bulk operations belonging to this app on this store in the last 7 days.", "env": "SHOPIFY_FLAG_ID", "name": "id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "store": { "char": "s", "description": "The store domain. Must be an existing dev store.", "env": "SHOPIFY_FLAG_STORE", "name": "store", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "app:bulk:status", "pluginAlias": "@shopify/cli", "pluginName": "@shopify/cli", "pluginType": "core", "strict": true, "summary": "Check the status of bulk operations.", "descriptionWithMarkdown": "Check the status of a specific bulk operation by ID, or list all bulk operations belonging to this app on this store in the last 7 days.\n\n Bulk operations allow you to process large amounts of data asynchronously. Learn more about [bulk query operations](https://shopify.dev/docs/api/usage/bulk-operations/queries) and [bulk mutation operations](https://shopify.dev/docs/api/usage/bulk-operations/imports).\n\n Use [`bulk execute`](https://shopify.dev/docs/api/shopify-cli/app/app-bulk-execute) to start a new bulk operation.", "customPluginName": "@shopify/app" }, "app:deploy": { "aliases": [], "args": {}, "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. 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": { "no-color": { "description": "Disable color output.", "env": "SHOPIFY_FLAG_NO_COLOR", "hidden": false, "name": "no-color", "allowNo": false, "type": "boolean" }, "verbose": { "description": "Increase the verbosity of the output.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "allowNo": false, "type": "boolean" }, "path": { "description": "The path to your app directory.", "env": "SHOPIFY_FLAG_PATH", "name": "path", "noCacheDefault": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "config": { "char": "c", "description": "The name of the app configuration.", "env": "SHOPIFY_FLAG_APP_CONFIG", "hidden": false, "name": "config", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "client-id": { "description": "The Client ID of your app.", "env": "SHOPIFY_FLAG_CLIENT_ID", "exclusive": [ "config" ], "hidden": false, "name": "client-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "reset": { "description": "Reset all your settings.", "env": "SHOPIFY_FLAG_RESET", "exclusive": [ "config" ], "hidden": false, "name": "reset", "allowNo": false, "type": "boolean" }, "allow-updates": { "description": "Allows adding and updating extensions and configuration without requiring user confirmation. Recommended option for CI/CD environments.", "env": "SHOPIFY_FLAG_ALLOW_UPDATES", "hidden": false, "name": "allow-updates", "allowNo": false, "type": "boolean" }, "allow-deletes": { "description": "Allows removing extensions and configuration without requiring user confirmation. For CI/CD environments, the recommended flag is --allow-updates.", "env": "SHOPIFY_FLAG_ALLOW_DELETES", "hidden": false, "name": "allow-deletes", "allowNo": false, "type": "boolean" }, "no-release": { "description": "Creates a version but doesn't release it - it's not made available to merchants. With this flag, a user confirmation is not required.", "env": "SHOPIFY_FLAG_NO_RELEASE", "exclusive": [ "allow-updates", "allow-deletes" ], "hidden": false, "name": "no-release", "allowNo": false, "type": "boolean" }, "no-build": { "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", "allowNo": false, "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", "hidden": false, "name": "message", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "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", "hidden": false, "name": "version", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "source-control-url": { "description": "URL associated with the new app version.", "env": "SHOPIFY_FLAG_SOURCE_CONTROL_URL", "hidden": false, "name": "source-control-url", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "app:deploy", "pluginAlias": "@shopify/cli", "pluginName": "@shopify/cli", "pluginType": "core", "strict": true, "summary": "Deploy your Shopify app.", "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. 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 ", "customPluginName": "@shopify/app" }, "app:dev": { "aliases": [], "args": {}, "description": "Builds and previews your app on a dev store, and watches for changes. \"Read more about testing apps locally\" (https://shopify.dev/docs/apps/build/cli-for-apps/test-apps-locally).", "flags": { "no-color": { "description": "Disable color output.", "env": "SHOPIFY_FLAG_NO_COLOR", "hidden": false, "name": "no-color", "allowNo": false, "type": "boolean" }, "verbose": { "description": "Increase the verbosity of the output.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "allowNo": false, "type": "boolean" }, "path": { "description": "The path to your app directory.", "env": "SHOPIFY_FLAG_PATH", "name": "path", "noCacheDefault": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "config": { "char": "c", "description": "The name of the app configuration.", "env": "SHOPIFY_FLAG_APP_CONFIG", "hidden": false, "name": "config", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "client-id": { "description": "The Client ID of your app.", "env": "SHOPIFY_FLAG_CLIENT_ID", "exclusive": [ "config" ], "hidden": false, "name": "client-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "reset": { "description": "Reset all your settings.", "env": "SHOPIFY_FLAG_RESET", "exclusive": [ "config" ], "hidden": false, "name": "reset", "allowNo": false, "type": "boolean" }, "store": { "char": "s", "description": "Store URL. Must be an existing development or Shopify Plus sandbox store.", "env": "SHOPIFY_FLAG_STORE", "name": "store", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "skip-dependencies-installation": { "description": "Skips the installation of dependencies. Deprecated, use workspaces instead.", "env": "SHOPIFY_FLAG_SKIP_DEPENDENCIES_INSTALLATION", "name": "skip-dependencies-installation", "allowNo": false, "type": "boolean" }, "no-update": { "description": "Uses the app URL from the toml file instead an autogenerated URL for dev.", "env": "SHOPIFY_FLAG_NO_UPDATE", "name": "no-update", "allowNo": false, "type": "boolean" }, "subscription-product-url": { "description": "Resource URL for subscription UI extension. Format: \"/products/{productId}\"", "env": "SHOPIFY_FLAG_SUBSCRIPTION_PRODUCT_URL", "name": "subscription-product-url", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "checkout-cart-url": { "description": "Resource URL for checkout UI extension. Format: \"/cart/{productVariantID}:{productQuantity}\"", "env": "SHOPIFY_FLAG_CHECKOUT_CART_URL", "name": "checkout-cart-url", "hasDynamicHelp": false, "multiple": false, "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" ], "name": "tunnel-url", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "use-localhost": { "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", "allowNo": false, "type": "boolean" }, "localhost-port": { "description": "Port to use for localhost.", "env": "SHOPIFY_FLAG_LOCALHOST_PORT", "name": "localhost-port", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "theme": { "char": "t", "description": "Theme ID or name of the theme app extension host theme.", "env": "SHOPIFY_FLAG_THEME", "name": "theme", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "theme-app-extension-port": { "description": "Local port of the theme app extension development server.", "env": "SHOPIFY_FLAG_THEME_APP_EXTENSION_PORT", "name": "theme-app-extension-port", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "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", "name": "notify", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "graphiql-port": { "description": "Local port of the GraphiQL development server.", "env": "SHOPIFY_FLAG_GRAPHIQL_PORT", "hidden": true, "name": "graphiql-port", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "graphiql-key": { "description": "Key used to authenticate GraphiQL requests. By default, a key is automatically derived from the app secret. Use this flag to override with a custom key.", "env": "SHOPIFY_FLAG_GRAPHIQL_KEY", "hidden": true, "name": "graphiql-key", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "app:dev", "pluginAlias": "@shopify/cli", "pluginName": "@shopify/cli", "pluginType": "core", "strict": true, "summary": "Run the app.", "descriptionWithMarkdown": "Builds and previews your app on a dev store, and watches for changes. [Read more about testing apps locally](https://shopify.dev/docs/apps/build/cli-for-apps/test-apps-locally).", "customPluginName": "@shopify/app" }, "app:dev:clean": { "aliases": [], "args": {}, "description": "Stop the dev preview that was started with `shopify app dev`.\n\n It restores the app's active version to the selected development store.\n ", "flags": { "no-color": { "description": "Disable color output.", "env": "SHOPIFY_FLAG_NO_COLOR", "hidden": false, "name": "no-color", "allowNo": false, "type": "boolean" }, "verbose": { "description": "Increase the verbosity of the output.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "allowNo": false, "type": "boolean" }, "path": { "description": "The path to your app directory.", "env": "SHOPIFY_FLAG_PATH", "name": "path", "noCacheDefault": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "config": { "char": "c", "description": "The name of the app configuration.", "env": "SHOPIFY_FLAG_APP_CONFIG", "hidden": false, "name": "config", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "client-id": { "description": "The Client ID of your app.", "env": "SHOPIFY_FLAG_CLIENT_ID", "exclusive": [ "config" ], "hidden": false, "name": "client-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "reset": { "description": "Reset all your settings.", "env": "SHOPIFY_FLAG_RESET", "exclusive": [ "config" ], "hidden": false, "name": "reset", "allowNo": false, "type": "boolean" }, "store": { "char": "s", "description": "Store URL. Must be an existing development store.", "env": "SHOPIFY_FLAG_STORE", "hidden": false, "name": "store", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "app:dev:clean", "pluginAlias": "@shopify/cli", "pluginName": "@shopify/cli", "pluginType": "core", "strict": true, "summary": "Cleans up the dev preview from the selected store.", "descriptionWithMarkdown": "Stop the dev preview that was started with `shopify app dev`.\n\n It restores the app's active version to the selected development store.\n ", "customPluginName": "@shopify/app" }, "app:logs": { "aliases": [], "args": {}, "description": "\n Opens a real-time stream of detailed app logs from the selected app and store.\n Use the `--source` argument to limit output to a particular log source, such as a specific Shopify Function handle. Use the `shopify app logs sources` command to view a list of sources.\n Use the `--status` argument to filter on status, either `success` or `failure`.\n ```\n shopify app logs --status=success --source=extension.discount-function\n ```\n ", "flags": { "no-color": { "description": "Disable color output.", "env": "SHOPIFY_FLAG_NO_COLOR", "hidden": false, "name": "no-color", "allowNo": false, "type": "boolean" }, "verbose": { "description": "Increase the verbosity of the output.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "allowNo": false, "type": "boolean" }, "path": { "description": "The path to your app directory.", "env": "SHOPIFY_FLAG_PATH", "name": "path", "noCacheDefault": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "config": { "char": "c", "description": "The name of the app configuration.", "env": "SHOPIFY_FLAG_APP_CONFIG", "hidden": false, "name": "config", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "client-id": { "description": "The Client ID of your app.", "env": "SHOPIFY_FLAG_CLIENT_ID", "exclusive": [ "config" ], "hidden": false, "name": "client-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "reset": { "description": "Reset all your settings.", "env": "SHOPIFY_FLAG_RESET", "exclusive": [ "config" ], "hidden": false, "name": "reset", "allowNo": false, "type": "boolean" }, "json": { "char": "j", "description": "Output the result as JSON. Automatically disables color output.", "env": "SHOPIFY_FLAG_JSON", "hidden": false, "name": "json", "allowNo": false, "type": "boolean" }, "store": { "char": "s", "description": "Store URL. Must be an existing development or Shopify Plus sandbox store.", "env": "SHOPIFY_FLAG_STORE", "name": "store", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "source": { "description": "Filters output to the specified log source.", "env": "SHOPIFY_FLAG_SOURCE", "name": "source", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "status": { "description": "Filters output to the specified status (success or failure).", "env": "SHOPIFY_FLAG_STATUS", "name": "status", "hasDynamicHelp": false, "multiple": false, "options": [ "success", "failure" ], "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "app:logs", "pluginAlias": "@shopify/cli", "pluginName": "@shopify/cli", "pluginType": "core", "strict": true, "summary": "Stream detailed logs for your Shopify app.", "descriptionWithMarkdown": "\n Opens a real-time stream of detailed app logs from the selected app and store.\n Use the `--source` argument to limit output to a particular log source, such as a specific Shopify Function handle. Use the `shopify app logs sources` command to view a list of sources.\n Use the `--status` argument to filter on status, either `success` or `failure`.\n ```\n shopify app logs --status=success --source=extension.discount-function\n ```\n ", "customPluginName": "@shopify/app" }, "app:logs:sources": { "aliases": [], "args": {}, "description": "The output source names can be used with the `--source` argument of `shopify app logs` to filter log output. Currently only function extensions are supported as sources.", "flags": { "no-color": { "description": "Disable color output.", "env": "SHOPIFY_FLAG_NO_COLOR", "hidden": false, "name": "no-color", "allowNo": false, "type": "boolean" }, "verbose": { "description": "Increase the verbosity of the output.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "allowNo": false, "type": "boolean" }, "path": { "description": "The path to your app directory.", "env": "SHOPIFY_FLAG_PATH", "name": "path", "noCacheDefault": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "config": { "char": "c", "description": "The name of the app configuration.", "env": "SHOPIFY_FLAG_APP_CONFIG", "hidden": false, "name": "config", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "client-id": { "description": "The Client ID of your app.", "env": "SHOPIFY_FLAG_CLIENT_ID", "exclusive": [ "config" ], "hidden": false, "name": "client-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "reset": { "description": "Reset all your settings.", "env": "SHOPIFY_FLAG_RESET", "exclusive": [ "config" ], "hidden": false, "name": "reset", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "app:logs:sources", "pluginAlias": "@shopify/cli", "pluginName": "@shopify/cli", "pluginType": "core", "strict": true, "summary": "Print out a list of sources that may be used with the logs command.", "descriptionWithMarkdown": "The output source names can be used with the `--source` argument of `shopify app logs` to filter log output. Currently only function extensions are supported as sources.", "customPluginName": "@shopify/app" }, "app:import-custom-data-definitions": { "aliases": [], "args": {}, "description": "Import metafield and metaobject definitions from your development store. \"Read more about declarative custom data definitions\" (https://shopify.dev/docs/apps/build/custom-data/declarative-custom-data-definitions).", "flags": { "no-color": { "description": "Disable color output.", "env": "SHOPIFY_FLAG_NO_COLOR", "hidden": false, "name": "no-color", "allowNo": false, "type": "boolean" }, "verbose": { "description": "Increase the verbosity of the output.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "allowNo": false, "type": "boolean" }, "path": { "description": "The path to your app directory.", "env": "SHOPIFY_FLAG_PATH", "name": "path", "noCacheDefault": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "config": { "char": "c", "description": "The name of the app configuration.", "env": "SHOPIFY_FLAG_APP_CONFIG", "hidden": false, "name": "config", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "client-id": { "description": "The Client ID of your app.", "env": "SHOPIFY_FLAG_CLIENT_ID", "exclusive": [ "config" ], "hidden": false, "name": "client-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "reset": { "description": "Reset all your settings.", "env": "SHOPIFY_FLAG_RESET", "exclusive": [ "config" ], "hidden": false, "name": "reset", "allowNo": false, "type": "boolean" }, "store": { "char": "s", "description": "Store URL. Must be an existing development or Shopify Plus sandbox store.", "env": "SHOPIFY_FLAG_STORE", "name": "store", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "include-existing": { "description": "Include existing declared definitions in the output.", "env": "SHOPIFY_FLAG_INCLUDE_EXISTING", "name": "include-existing", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "app:import-custom-data-definitions", "pluginAlias": "@shopify/cli", "pluginName": "@shopify/cli", "pluginType": "core", "strict": true, "summary": "Import metafield and metaobject definitions.", "descriptionWithMarkdown": "Import metafield and metaobject definitions from your development store. [Read more about declarative custom data definitions](https://shopify.dev/docs/apps/build/custom-data/declarative-custom-data-definitions).", "customPluginName": "@shopify/app" }, "app:import-extensions": { "aliases": [], "args": {}, "description": "Import dashboard-managed extensions into your app.", "flags": { "no-color": { "description": "Disable color output.", "env": "SHOPIFY_FLAG_NO_COLOR", "hidden": false, "name": "no-color", "allowNo": false, "type": "boolean" }, "verbose": { "description": "Increase the verbosity of the output.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "allowNo": false, "type": "boolean" }, "path": { "description": "The path to your app directory.", "env": "SHOPIFY_FLAG_PATH", "name": "path", "noCacheDefault": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "config": { "char": "c", "description": "The name of the app configuration.", "env": "SHOPIFY_FLAG_APP_CONFIG", "hidden": false, "name": "config", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "client-id": { "description": "The Client ID of your app.", "env": "SHOPIFY_FLAG_CLIENT_ID", "exclusive": [ "config" ], "hidden": false, "name": "client-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "reset": { "description": "Reset all your settings.", "env": "SHOPIFY_FLAG_RESET", "exclusive": [ "config" ], "hidden": false, "name": "reset", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "app:import-extensions", "pluginAlias": "@shopify/cli", "pluginName": "@shopify/cli", "pluginType": "core", "strict": true, "customPluginName": "@shopify/app" }, "app:info": { "aliases": [], "args": {}, "description": "The information returned includes the following:\n\n - The app and dev store that's used when you run the \"dev\" (https://shopify.dev/docs/api/shopify-cli/app/app-dev) command. You can reset these configurations using \"`dev --reset`\" (https://shopify.dev/docs/api/shopify-cli/app/app-dev#flags-propertydetail-reset).\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": { "no-color": { "description": "Disable color output.", "env": "SHOPIFY_FLAG_NO_COLOR", "hidden": false, "name": "no-color", "allowNo": false, "type": "boolean" }, "verbose": { "description": "Increase the verbosity of the output.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "allowNo": false, "type": "boolean" }, "path": { "description": "The path to your app directory.", "env": "SHOPIFY_FLAG_PATH", "name": "path", "noCacheDefault": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "config": { "char": "c", "description": "The name of the app configuration.", "env": "SHOPIFY_FLAG_APP_CONFIG", "hidden": false, "name": "config", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "client-id": { "description": "The Client ID of your app.", "env": "SHOPIFY_FLAG_CLIENT_ID", "exclusive": [ "config" ], "hidden": false, "name": "client-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "reset": { "description": "Reset all your settings.", "env": "SHOPIFY_FLAG_RESET", "exclusive": [ "config" ], "hidden": false, "name": "reset", "allowNo": false, "type": "boolean" }, "json": { "char": "j", "description": "Output the result as JSON. Automatically disables color output.", "env": "SHOPIFY_FLAG_JSON", "hidden": false, "name": "json", "allowNo": false, "type": "boolean" }, "web-env": { "description": "Outputs environment variables necessary for running and deploying web/.", "env": "SHOPIFY_FLAG_OUTPUT_WEB_ENV", "hidden": false, "name": "web-env", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "app:info", "pluginAlias": "@shopify/cli", "pluginName": "@shopify/cli", "pluginType": "core", "strict": true, "summary": "Print basic information about your app and extensions.", "descriptionWithMarkdown": "The information returned includes the following:\n\n - The app and dev store that's used when you run the [dev](https://shopify.dev/docs/api/shopify-cli/app/app-dev) command. You can reset these configurations using [`dev --reset`](https://shopify.dev/docs/api/shopify-cli/app/app-dev#flags-propertydetail-reset).\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.", "customPluginName": "@shopify/app" }, "app:init": { "aliases": [], "args": {}, "flags": { "no-color": { "description": "Disable color output.", "env": "SHOPIFY_FLAG_NO_COLOR", "hidden": false, "name": "no-color", "allowNo": false, "type": "boolean" }, "verbose": { "description": "Increase the verbosity of the output.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "allowNo": false, "type": "boolean" }, "name": { "char": "n", "description": "The name for the new app. When provided, skips the app selection prompt and creates a new app with this name.", "env": "SHOPIFY_FLAG_NAME", "hidden": false, "name": "name", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "path": { "char": "p", "env": "SHOPIFY_FLAG_PATH", "hidden": false, "name": "path", "default": "/home/runner/work/cli/cli/packages/cli", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "template": { "description": "The app template. Accepts one of the following:\n - <reactRouter|none>\n - Any GitHub repo with optional branch and subpath, e.g., https://github.com/Shopify/<repository>/[subpath]#[branch]", "env": "SHOPIFY_FLAG_TEMPLATE", "name": "template", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "flavor": { "description": "Which flavor of the given template to use.", "env": "SHOPIFY_FLAG_TEMPLATE_FLAVOR", "name": "flavor", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "package-manager": { "char": "d", "env": "SHOPIFY_FLAG_PACKAGE_MANAGER", "hidden": false, "name": "package-manager", "hasDynamicHelp": false, "multiple": false, "options": [ "npm", "yarn", "pnpm", "bun" ], "type": "option" }, "local": { "char": "l", "env": "SHOPIFY_FLAG_LOCAL", "hidden": true, "name": "local", "allowNo": false, "type": "boolean" }, "client-id": { "description": "The Client ID of your app. Use this to automatically link your new project to an existing app. Using this flag avoids the app selection prompt.", "env": "SHOPIFY_FLAG_CLIENT_ID", "exclusive": [ "config" ], "hidden": false, "name": "client-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "organization-id": { "description": "The organization ID. Your organization ID can be found in your Dev Dashboard URL: https://dev.shopify.com/dashboard/<organization-id>", "env": "SHOPIFY_FLAG_ORGANIZATION_ID", "exclusive": [ "client-id" ], "hidden": false, "name": "organization-id", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "app:init", "pluginAlias": "@shopify/cli", "pluginName": "@shopify/cli", "pluginType": "core", "strict": true, "summary": "Create a new app project", "customPluginName": "@shopify/app" }, "app:config:validate": { "aliases": [], "args": {}, "description": "Validates the selected app configuration file and all extension configurations against their schemas and reports any errors found.", "flags": { "no-color": { "description": "Disable color output.", "env": "SHOPIFY_FLAG_NO_COLOR", "hidden": false, "name": "no-color", "allowNo": false, "type": "boolean" }, "verbose": { "description": "Increase the verbosity of the output.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "allowNo": false, "type": "boolean" }, "path": { "description": "The path to your app directory.", "env": "SHOPIFY_FLAG_PATH", "name": "path", "noCacheDefault": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "config": { "char": "c", "description": "The name of the app configuration.", "env": "SHOPIFY_FLAG_APP_CONFIG", "hidden": false, "name": "config", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "client-id": { "description": "The Client ID of your app.", "env": "SHOPIFY_FLAG_CLIENT_ID", "exclusive": [ "config" ], "hidden": false, "name": "client-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "reset": { "description": "Reset all your settings.", "env": "SHOPIFY_FLAG_RESET", "exclusive": [ "config" ], "hidden": false, "name": "reset", "allowNo": false, "type": "boolean" }, "json": { "char": "j", "description": "Output the result as JSON. Automatically disables color output.", "env": "SHOPIFY_FLAG_JSON", "hidden": false, "name": "json", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "app:config:validate", "pluginAlias": "@shopify/cli", "pluginName": "@shopify/cli", "pluginType": "core", "strict": true, "summary": "Validate your app configuration and extensions.", "descriptionWithMarkdown": "Validates the selected app configuration file and all extension configurations against their schemas and reports any errors found.", "customPluginName": "@shopify/app" }, "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.", "flags": { "no-color": { "description": "Disable color output.", "env": "SHOPIFY_FLAG_NO_COLOR", "hidden": false, "name": "no-color", "allowNo": false, "type": "boolean" }, "verbose": { "description": "Increase the verbosity of the output.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "allowNo": false, "type": "boolean" }, "path": { "description": "The path to your app directory.", "env": "SHOPIFY_FLAG_PATH", "name": "path", "noCacheDefault": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "config": { "char": "c", "description": "The name of the app configuration.", "env": "SHOPIFY_FLAG_APP_CONFIG", "hidden": false, "name": "config", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "client-id": { "description": "The Client ID of your app.", "env": "SHOPIFY_FLAG_CLIENT_ID", "exclusive": [ "config" ], "hidden": false, "name": "client-id", "hasDynamicHelp": false, "multiple": false,