{ "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.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `AppBuildResult` schema.\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"const\": \"success\"\n }\n },\n \"required\": [\n \"status\"\n ],\n \"additionalProperties\": false,\n \"title\": \"AppBuildResult\",\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" }, "auth-alias": { "description": "Alias of the Shopify account to use for authentication.", "env": "SHOPIFY_FLAG_AUTH_ALIAS", "name": "auth-alias", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "no-input": { "description": "Disable interactive prompts and browser authentication.", "env": "SHOPIFY_FLAG_NO_INPUT", "name": "no-input", "allowNo": false, "type": "boolean" }, "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. May include sensitive data.", "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" }, "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", "pluginName": "shopify", "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.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `CancelBulkOperationResult` schema.\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"storeDomain\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"pattern\": \"^[^.]+\\\\.myshopify\\\\.com$\"\n },\n {\n \"type\": \"null\"\n }\n ]\n },\n \"apiVersion\": {\n \"type\": [\n \"string\",\n \"null\"\n ],\n \"description\": \"The API version selected for the request.\"\n },\n \"status\": {\n \"type\": \"string\",\n \"const\": \"success\"\n },\n \"operation\": {\n \"$ref\": \"#/definitions/BulkOperation\"\n }\n },\n \"required\": [\n \"storeDomain\",\n \"apiVersion\",\n \"status\",\n \"operation\"\n ],\n \"additionalProperties\": false,\n \"title\": \"CancelBulkOperationResult\",\n \"definitions\": {\n \"BulkOperation\": {\n \"type\": \"object\",\n \"properties\": {\n \"gid\": {\n \"type\": \"string\",\n \"pattern\": \"^gid:\\\\/\\\\/shopify\\\\/BulkOperation\\\\/[^/]+$\",\n \"description\": \"The Shopify global ID of a bulk operation.\"\n },\n \"type\": {\n \"type\": \"string\"\n },\n \"status\": {\n \"type\": \"string\"\n },\n \"errorCode\": {\n \"type\": [\n \"string\",\n \"null\"\n ]\n },\n \"createdAt\": {\n \"type\": \"string\",\n \"format\": \"date-time\",\n \"pattern\": \"^\\\\d{4}-\\\\d{2}-\\\\d{2}T\\\\d{2}:\\\\d{2}:\\\\d{2}Z$\",\n \"description\": \"A UTC ISO 8601 instant with whole seconds and the Z timezone marker.\"\n },\n \"completedAt\": {\n \"anyOf\": [\n {\n \"$ref\": \"#/definitions/BulkOperation/properties/createdAt\"\n },\n {\n \"type\": \"null\"\n }\n ],\n \"description\": \"A UTC ISO 8601 instant with whole seconds and the Z timezone marker.\"\n },\n \"objectCount\": {\n \"type\": \"string\",\n \"pattern\": \"^\\\\d+$\",\n \"description\": \"A nonnegative decimal count, without loss of integer precision.\"\n },\n \"url\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"format\": \"uri\"\n },\n {\n \"type\": \"null\"\n }\n ]\n },\n \"partialDataUrl\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"format\": \"uri\"\n },\n {\n \"type\": \"null\"\n }\n ]\n }\n },\n \"required\": [\n \"gid\",\n \"type\",\n \"status\",\n \"errorCode\",\n \"createdAt\",\n \"completedAt\",\n \"objectCount\",\n \"url\",\n \"partialDataUrl\"\n ],\n \"additionalProperties\": false\n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" }, "auth-alias": { "description": "Alias of the Shopify account to use for authentication.", "env": "SHOPIFY_FLAG_AUTH_ALIAS", "name": "auth-alias", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "no-input": { "description": "Disable interactive prompts and browser authentication.", "env": "SHOPIFY_FLAG_NO_INPUT", "name": "no-input", "allowNo": false, "type": "boolean" }, "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. May include sensitive data.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "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" }, "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", "pluginName": "shopify", "pluginType": "core", "strict": true, "summary": "Cancel a bulk operation.", "descriptionWithMarkdown": "Cancels a running bulk operation by ID.", "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.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `BulkOperationStatusResult` schema.\n\n```json\n{\n \"anyOf\": [\n {\n \"$ref\": \"#/definitions/GetBulkOperationStatusResult\"\n },\n {\n \"$ref\": \"#/definitions/ListBulkOperationsResult\"\n }\n ],\n \"title\": \"BulkOperationStatusResult\",\n \"definitions\": {\n \"GetBulkOperationStatusResult\": {\n \"type\": \"object\",\n \"properties\": {\n \"storeDomain\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"pattern\": \"^[^.]+\\\\.myshopify\\\\.com$\"\n },\n {\n \"type\": \"null\"\n }\n ]\n },\n \"apiVersion\": {\n \"type\": [\n \"string\",\n \"null\"\n ],\n \"description\": \"The API version selected for the request.\"\n },\n \"operationGid\": {\n \"type\": \"string\",\n \"pattern\": \"^gid:\\\\/\\\\/shopify\\\\/BulkOperation\\\\/[^/]+$\",\n \"description\": \"The Shopify global ID of a bulk operation.\"\n },\n \"operation\": {\n \"anyOf\": [\n {\n \"$ref\": \"#/definitions/BulkOperation\"\n },\n {\n \"type\": \"null\"\n }\n ]\n }\n },\n \"required\": [\n \"storeDomain\",\n \"apiVersion\",\n \"operationGid\",\n \"operation\"\n ],\n \"additionalProperties\": false\n },\n \"ListBulkOperationsResult\": {\n \"type\": \"object\",\n \"properties\": {\n \"storeDomain\": {\n \"$ref\": \"#/definitions/GetBulkOperationStatusResult/properties/storeDomain\"\n },\n \"apiVersion\": {\n \"$ref\": \"#/definitions/GetBulkOperationStatusResult/properties/apiVersion\"\n },\n \"operations\": {\n \"type\": \"array\",\n \"items\": {\n \"$ref\": \"#/definitions/ListedBulkOperation\"\n }\n },\n \"pageInfo\": {\n \"type\": \"object\",\n \"properties\": {\n \"hasNextPage\": {\n \"type\": [\n \"boolean\",\n \"null\"\n ],\n \"description\": \"Unknown when the API result reaches the fetch limit.\"\n }\n },\n \"required\": [\n \"hasNextPage\"\n ],\n \"additionalProperties\": false\n }\n },\n \"required\": [\n \"storeDomain\",\n \"apiVersion\",\n \"operations\",\n \"pageInfo\"\n ],\n \"additionalProperties\": false\n },\n \"BulkOperation\": {\n \"type\": \"object\",\n \"properties\": {\n \"gid\": {\n \"$ref\": \"#/definitions/GetBulkOperationStatusResult/properties/operationGid\"\n },\n \"type\": {\n \"type\": \"string\"\n },\n \"status\": {\n \"type\": \"string\"\n },\n \"errorCode\": {\n \"type\": [\n \"string\",\n \"null\"\n ]\n },\n \"createdAt\": {\n \"type\": \"string\",\n \"format\": \"date-time\",\n \"pattern\": \"^\\\\d{4}-\\\\d{2}-\\\\d{2}T\\\\d{2}:\\\\d{2}:\\\\d{2}Z$\",\n \"description\": \"A UTC ISO 8601 instant with whole seconds and the Z timezone marker.\"\n },\n \"completedAt\": {\n \"anyOf\": [\n {\n \"$ref\": \"#/definitions/BulkOperation/properties/createdAt\"\n },\n {\n \"type\": \"null\"\n }\n ],\n \"description\": \"A UTC ISO 8601 instant with whole seconds and the Z timezone marker.\"\n },\n \"objectCount\": {\n \"type\": \"string\",\n \"pattern\": \"^\\\\d+$\",\n \"description\": \"A nonnegative decimal count, without loss of integer precision.\"\n },\n \"url\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"format\": \"uri\"\n },\n {\n \"type\": \"null\"\n }\n ]\n },\n \"partialDataUrl\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"format\": \"uri\"\n },\n {\n \"type\": \"null\"\n }\n ]\n }\n },\n \"required\": [\n \"gid\",\n \"type\",\n \"status\",\n \"errorCode\",\n \"createdAt\",\n \"completedAt\",\n \"objectCount\",\n \"url\",\n \"partialDataUrl\"\n ],\n \"additionalProperties\": false\n },\n \"ListedBulkOperation\": {\n \"type\": \"object\",\n \"properties\": {\n \"gid\": {\n \"$ref\": \"#/definitions/GetBulkOperationStatusResult/properties/operationGid\"\n },\n \"status\": {\n \"$ref\": \"#/definitions/BulkOperation/properties/status\"\n },\n \"errorCode\": {\n \"$ref\": \"#/definitions/BulkOperation/properties/errorCode\"\n },\n \"createdAt\": {\n \"$ref\": \"#/definitions/BulkOperation/properties/createdAt\"\n },\n \"completedAt\": {\n \"$ref\": \"#/definitions/BulkOperation/properties/completedAt\"\n },\n \"objectCount\": {\n \"$ref\": \"#/definitions/BulkOperation/properties/objectCount\"\n },\n \"url\": {\n \"$ref\": \"#/definitions/BulkOperation/properties/url\"\n },\n \"partialDataUrl\": {\n \"$ref\": \"#/definitions/BulkOperation/properties/partialDataUrl\"\n }\n },\n \"required\": [\n \"gid\",\n \"status\",\n \"errorCode\",\n \"createdAt\",\n \"completedAt\",\n \"objectCount\",\n \"url\",\n \"partialDataUrl\"\n ],\n \"additionalProperties\": false\n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" }, "auth-alias": { "description": "Alias of the Shopify account to use for authentication.", "env": "SHOPIFY_FLAG_AUTH_ALIAS", "name": "auth-alias", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "no-input": { "description": "Disable interactive prompts and browser authentication.", "env": "SHOPIFY_FLAG_NO_INPUT", "name": "no-input", "allowNo": false, "type": "boolean" }, "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. May include sensitive data.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "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" }, "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", "pluginName": "shopify", "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 \n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `AppDeployResult` schema.\n\n```json\n{\n \"anyOf\": [\n {\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"const\": \"success\"\n },\n \"app\": {\n \"$ref\": \"#/definitions/App\"\n },\n \"deployment\": {\n \"$ref\": \"#/definitions/AppDeployment\"\n }\n },\n \"required\": [\n \"status\",\n \"app\",\n \"deployment\"\n ],\n \"additionalProperties\": false\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"const\": \"partial\"\n },\n \"app\": {\n \"$ref\": \"#/definitions/App\"\n },\n \"deployment\": {\n \"type\": \"object\",\n \"properties\": {\n \"released\": {\n \"type\": \"boolean\",\n \"const\": false\n },\n \"version\": {\n \"$ref\": \"#/definitions/AppDeploymentVersion\"\n }\n },\n \"required\": [\n \"released\",\n \"version\"\n ],\n \"additionalProperties\": false\n },\n \"errors\": {\n \"type\": \"array\",\n \"items\": {\n \"$ref\": \"#/definitions/JsonAbortError\"\n },\n \"minItems\": 1\n }\n },\n \"required\": [\n \"status\",\n \"app\",\n \"deployment\",\n \"errors\"\n ],\n \"additionalProperties\": false\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"const\": \"cancelled\"\n }\n },\n \"required\": [\n \"status\"\n ],\n \"additionalProperties\": false\n }\n ],\n \"title\": \"AppDeployResult\",\n \"definitions\": {\n \"JsonAbortError\": {\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"const\": \"abort\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"code\": {\n \"type\": \"string\",\n \"minLength\": 1,\n \"description\": \"A stable error code, included only when known.\"\n },\n \"tryMessage\": {\n \"type\": \"string\"\n },\n \"nextSteps\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n },\n \"customSections\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"title\": {\n \"type\": \"string\"\n },\n \"body\": {\n \"anyOf\": [\n {\n \"type\": \"string\"\n },\n {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n }\n ]\n }\n },\n \"required\": [\n \"body\"\n ],\n \"additionalProperties\": false\n }\n },\n \"details\": {\n \"description\": \"Selected domain details, preserving native API payloads such as GraphQL errors, extensions, and data.\"\n }\n },\n \"required\": [\n \"type\",\n \"message\"\n ],\n \"additionalProperties\": false\n },\n \"App\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"clientId\": {\n \"type\": \"string\",\n \"minLength\": 1,\n \"description\": \"The client ID of the app receiving the deployment.\"\n }\n },\n \"required\": [\n \"name\",\n \"clientId\"\n ],\n \"additionalProperties\": false\n },\n \"AppDeployment\": {\n \"type\": \"object\",\n \"properties\": {\n \"released\": {\n \"type\": \"boolean\",\n \"description\": \"Whether this command released the version to users.\"\n },\n \"version\": {\n \"$ref\": \"#/definitions/AppDeploymentVersion\"\n }\n },\n \"required\": [\n \"released\",\n \"version\"\n ],\n \"additionalProperties\": false\n },\n \"AppDeploymentVersion\": {\n \"type\": \"object\",\n \"properties\": {\n \"gid\": {\n \"type\": \"string\",\n \"pattern\": \"^gid:\\\\/\\\\/shopify\\\\/Version\\\\/\\\\d+$\",\n \"description\": \"The Shopify app version GID.\"\n },\n \"name\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"minLength\": 1\n },\n {\n \"type\": \"null\"\n }\n ],\n \"description\": \"The version tag, or null when no tag is available.\"\n },\n \"message\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"minLength\": 1\n },\n {\n \"type\": \"null\"\n }\n ],\n \"description\": \"The version message, or null when no message is available.\"\n },\n \"url\": {\n \"type\": \"string\",\n \"format\": \"uri\",\n \"description\": \"The Developer Dashboard URL for this version.\"\n }\n },\n \"required\": [\n \"gid\",\n \"name\",\n \"message\",\n \"url\"\n ],\n \"additionalProperties\": false\n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" }, "auth-alias": { "description": "Alias of the Shopify account to use for authentication.", "env": "SHOPIFY_FLAG_AUTH_ALIAS", "name": "auth-alias", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "no-input": { "description": "Disable interactive prompts and browser authentication.", "env": "SHOPIFY_FLAG_NO_INPUT", "name": "no-input", "allowNo": false, "type": "boolean" }, "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. May include sensitive data.", "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. Use with --config to deploy that configuration to a different app than the one it is linked to.", "env": "SHOPIFY_FLAG_CLIENT_ID", "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" }, "allow-updates": { "description": "Allows adding and updating extensions and configuration without requiring user confirmation. Recommended option for CI/CD environments. In non-interactive environments, provide this flag, --allow-deletes, or --no-release.", "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. In non-interactive environments, provide this flag, --allow-updates, or --no-release.", "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. In non-interactive environments, provide this flag, --allow-updates, or --allow-deletes.", "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", "pluginName": "shopify", "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).\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `DevInstanceLogEntry` schema.\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"timestamp\": {\n \"$ref\": \"#/definitions/DevInstance/properties/startedAt\"\n },\n \"source\": {\n \"type\": \"string\",\n \"description\": \"What produced the line, for example a process prefix like web or extensions.\"\n },\n \"level\": {\n \"type\": \"string\",\n \"enum\": [\n \"debug\",\n \"info\",\n \"warning\",\n \"error\"\n ]\n },\n \"message\": {\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"timestamp\",\n \"source\",\n \"message\"\n ],\n \"additionalProperties\": false,\n \"title\": \"DevInstanceLogEntry\",\n \"definitions\": {\n \"DevInstance\": {\n \"type\": \"object\",\n \"properties\": {\n \"schemaVersion\": {\n \"type\": \"number\",\n \"const\": 1\n },\n \"sessionId\": {\n \"type\": \"string\"\n },\n \"command\": {\n \"type\": \"string\",\n \"const\": \"app dev\"\n },\n \"key\": {\n \"type\": \"string\"\n },\n \"pid\": {\n \"type\": \"integer\",\n \"exclusiveMinimum\": 0\n },\n \"status\": {\n \"type\": \"string\",\n \"enum\": [\n \"starting\",\n \"running\"\n ]\n },\n \"startedAt\": {\n \"type\": \"string\",\n \"format\": \"date-time\",\n \"pattern\": \"^\\\\d{4}-\\\\d{2}-\\\\d{2}T\\\\d{2}:\\\\d{2}:\\\\d{2}Z$\",\n \"description\": \"A UTC ISO 8601 instant with whole seconds and the Z timezone marker.\"\n },\n \"updatedAt\": {\n \"$ref\": \"#/definitions/DevInstance/properties/startedAt\"\n },\n \"directory\": {\n \"type\": \"string\"\n },\n \"logFile\": {\n \"type\": \"string\"\n },\n \"details\": {\n \"type\": \"object\",\n \"properties\": {\n \"configPath\": {\n \"type\": \"string\"\n },\n \"appName\": {\n \"type\": \"string\"\n },\n \"clientId\": {\n \"type\": \"string\"\n },\n \"storeFqdn\": {\n \"type\": \"string\"\n },\n \"previewUrl\": {\n \"type\": \"string\"\n },\n \"graphiqlUrl\": {\n \"type\": \"string\"\n },\n \"appUrl\": {\n \"type\": \"string\"\n },\n \"localUrl\": {\n \"type\": \"string\"\n },\n \"preview\": {\n \"$ref\": \"#/definitions/DevPreview\",\n \"description\": \"The CLI-reported preview state in the instance file; this is not a health check.\"\n }\n },\n \"required\": [\n \"configPath\",\n \"appName\",\n \"clientId\"\n ],\n \"additionalProperties\": false\n }\n },\n \"required\": [\n \"schemaVersion\",\n \"sessionId\",\n \"command\",\n \"pid\",\n \"status\",\n \"startedAt\",\n \"updatedAt\",\n \"directory\",\n \"logFile\",\n \"details\"\n ],\n \"additionalProperties\": false,\n \"description\": \"The instance JSON file under .shopify/dev/. This object is not emitted to stdout.\"\n },\n \"DevPreview\": {\n \"type\": \"object\",\n \"properties\": {\n \"state\": {\n \"type\": \"string\",\n \"enum\": [\n \"starting\",\n \"updating\",\n \"ready\",\n \"error\"\n ]\n },\n \"message\": {\n \"type\": [\n \"string\",\n \"null\"\n ]\n },\n \"errors\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n },\n \"required\": [\n \"state\",\n \"message\",\n \"errors\"\n ],\n \"additionalProperties\": false,\n \"description\": \"The CLI-reported preview state in the instance file; this is not a health check.\"\n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" }, "auth-alias": { "description": "Alias of the Shopify account to use for authentication.", "env": "SHOPIFY_FLAG_AUTH_ALIAS", "name": "auth-alias", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "no-input": { "description": "Disable interactive prompts and browser authentication.", "env": "SHOPIFY_FLAG_NO_INPUT", "name": "no-input", "allowNo": false, "type": "boolean" }, "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. May include sensitive data.", "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. Use with --config to run dev with that configuration for a different app than the one it is linked to.", "env": "SHOPIFY_FLAG_CLIENT_ID", "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": 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" }, "unsafe-validation": { "description": "Allow app dev to continue with warnings for eligible app version validation failures.", "env": "SHOPIFY_FLAG_UNSAFE_VALIDATION", "name": "unsafe-validation", "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" }, "install-mkcert": { "dependsOn": [ "use-localhost" ], "description": "Install and use mkcert to generate localhost certificates when --use-localhost is enabled without prompting.", "env": "SHOPIFY_FLAG_INSTALL_MKCERT", "name": "install-mkcert", "allowNo": false, "type": "boolean" }, "localhost-port": { "description": "Port to use for localhost. Must be between 1 and 65535.", "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. Must be between 1 and 65535.", "env": "SHOPIFY_FLAG_THEME_APP_EXTENSION_PORT", "name": "theme-app-extension-port", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "store-password": { "description": "The password for storefronts with password protection.", "env": "SHOPIFY_FLAG_STORE_PASSWORD", "name": "store-password", "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. Must be between 1 and 65535.", "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", "pluginName": "shopify", "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 \n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `AppDevCleanResult` schema.\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"const\": \"success\"\n },\n \"app\": {\n \"$ref\": \"#/definitions/AppDevCleanApp\"\n },\n \"storeDomain\": {\n \"type\": [\n \"string\",\n \"null\"\n ],\n \"description\": \"The canonical *.myshopify.com hostname, or null when unknown.\"\n }\n },\n \"required\": [\n \"status\",\n \"app\",\n \"storeDomain\"\n ],\n \"additionalProperties\": false,\n \"title\": \"AppDevCleanResult\",\n \"definitions\": {\n \"AppDevCleanApp\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"clientId\": {\n \"type\": \"string\",\n \"minLength\": 1\n }\n },\n \"required\": [\n \"name\",\n \"clientId\"\n ],\n \"additionalProperties\": false\n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" }, "auth-alias": { "description": "Alias of the Shopify account to use for authentication.", "env": "SHOPIFY_FLAG_AUTH_ALIAS", "name": "auth-alias", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "no-input": { "description": "Disable interactive prompts and browser authentication.", "env": "SHOPIFY_FLAG_NO_INPUT", "name": "no-input", "allowNo": false, "type": "boolean" }, "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. May include sensitive data.", "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. Use with --config to clean up the dev preview for a different app than the one it is linked to.", "env": "SHOPIFY_FLAG_CLIENT_ID", "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 store.", "env": "SHOPIFY_FLAG_STORE", "hidden": false, "name": "store", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "app:dev:clean", "pluginAlias": "shopify", "pluginName": "shopify", "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 ", "jsonOutputSchema": { "name": "AppDevCleanResult", "schema": { "_def": { "unknownKeys": "strict", "catchall": { "_def": { "typeName": "ZodNever" }, "~standard": { "version": 1, "vendor": "zod" } }, "typeName": "ZodObject" }, "~standard": { "version": 1, "vendor": "zod" }, "_cached": null }, "definitions": { "AppDevCleanApp": { "_def": { "unknownKeys": "strict", "catchall": { "_def": { "typeName": "ZodNever" }, "~standard": { "version": 1, "vendor": "zod" } }, "typeName": "ZodObject" }, "~standard": { "version": 1, "vendor": "zod" }, "_cached": null } }, "jsonSchema": { "type": "object", "properties": { "status": { "type": "string", "const": "success" }, "app": { "$ref": "#/definitions/AppDevCleanApp" }, "storeDomain": { "type": [ "string", "null" ], "description": "The canonical *.myshopify.com hostname, or null when unknown." } }, "required": [ "status", "app", "storeDomain" ], "additionalProperties": false, "title": "AppDevCleanResult", "definitions": { "AppDevCleanApp": { "type": "object", "properties": { "name": { "type": "string" }, "clientId": { "type": "string", "minLength": 1 } }, "required": [ "name", "clientId" ], "additionalProperties": false } }, "$schema": "http://json-schema.org/draft-07/schema#" } }, "customPluginName": "@shopify/app" }, "app:security:check": { "aliases": [], "args": {}, "description": "Runs an app security check locally and writes `deterministic-findings.json` and `agent-checks.json` to the results directory, `.shopify/app-security//`. The results key is `--client-id` when you pass it, and otherwise the name of the app configuration file without `.toml`; the other `app security` commands take the same selection flags and find the same directory. Every run replaces both files, so it's always safe to run the check again.\n\n`deterministic-findings.json` holds the deterministic scan results. `agent-checks.json` holds the checks for your coding agent to investigate; the agent's results are recorded with `shopify app security record`. Use `--config` to select a specific app configuration when the project has multiple `shopify.app*.toml` files; the check inspects only that configuration. Use `--client-id` to replace the configuration's client ID for this run. `--client-id` is checked against your Shopify account before anything is scanned, so it needs you to be logged in. When no app configuration exists, use `--without-app-config --client-id ` to scan `--path` anyway with config checks skipped; in an interactive terminal the command offers to do this.\n\nThe check scans the app directory and each `--include-dir`. Git ignore rules apply by default: a file or directory that Git ignores is skipped, using the rules of the repository that contains it, while files that Git tracks are always scanned. Use `--no-git-ignore` to turn Git ignore rules off for every scanned directory. When the check uses Git, it requires Git 2.38.0 or later.\n\nUse `--exclude` to skip more paths. Each value is a glob that is matched against the path relative to the working directory, so a path above it starts with `../`, and a name at any depth needs `**/`, for example `--exclude '**/generated'`. Repeat the flag to add globs. An exclusion can't remove the selected app configuration file. Quote each value so your shell doesn't expand `*`. The coding-agent instructions this check offers repeat the globs. Other `app security` commands don't take `--exclude` or `--no-git-ignore`, so pass the same flags each time you run the check.\n\nUse `--list-files` to check the scope before scanning: it prints the files the check would gather, one path per line and relative to the app directory, and then stops. It writes no results and never prompts. `--client-id` is still checked, but doesn't change the list. With `--json`, the result lists the files with absolute paths.\n\nIn interactive terminals, the command offers to copy the coding-agent instructions, print them, or choose nothing; copying is the default. In CI and other non-interactive environments, instructions aren't offered unless you pass `--print-instructions`, which prints them. You can also run `shopify app security instructions` to print, copy, or write them later. With `--json`, the command offers to include the instructions in the result, with or without copying them, and `--print-instructions` includes them.\n\nWith `--json`, the result describes the scan and the files it wrote, and whether `--blocking` passed, but not the findings: run `shopify app security review --json` for those.\n\nReports the number of findings to Shopify as usage telemetry, but not finding details. See \"usage reporting\" (https://shopify.dev/docs/api/shopify-cli#usage-reporting) for details.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `AppSecurityCheckResult` schema.\n\n```json\n{\n \"anyOf\": [\n {\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"const\": \"success\"\n },\n \"valid\": {\n \"type\": \"boolean\",\n \"description\": \"Whether --blocking passed: no finding of the scan has its own severity at or above the level. blocking.blockedCheckCount counts the checks with such findings, and --blocking none always passes. Run review --json for the findings.\"\n },\n \"app\": {\n \"$ref\": \"#/definitions/AppSecurityApp\"\n },\n \"resultsDirectory\": {\n \"type\": \"string\",\n \"description\": \"The absolute path of the results directory that holds the files the scan wrote.\"\n },\n \"deterministicFindingsPath\": {\n \"type\": \"string\",\n \"description\": \"The absolute path of deterministic-findings.json, which the scan replaced.\"\n },\n \"agentChecksPath\": {\n \"type\": \"string\",\n \"description\": \"The absolute path of agent-checks.json, which the scan replaced.\"\n },\n \"scope\": {\n \"$ref\": \"#/definitions/AppSecurityScope\"\n },\n \"scanDirectories\": {\n \"type\": \"array\",\n \"items\": {\n \"$ref\": \"#/definitions/AppSecurityScanDirectory\"\n },\n \"description\": \"The directories that the scan walked.\"\n },\n \"agentCheckCount\": {\n \"type\": \"integer\",\n \"minimum\": 0,\n \"description\": \"The number of checks in agent-checks.json for a coding agent to investigate.\"\n },\n \"blocking\": {\n \"$ref\": \"#/definitions/AppSecurityBlocking\"\n },\n \"instructions\": {\n \"$ref\": \"#/definitions/AppSecurityInstructions\",\n \"description\": \"The coding-agent instructions for this scan, with --print-instructions or when chosen at the prompt. Left out otherwise.\"\n }\n },\n \"required\": [\n \"status\",\n \"valid\",\n \"app\",\n \"resultsDirectory\",\n \"deterministicFindingsPath\",\n \"agentChecksPath\",\n \"scope\",\n \"scanDirectories\",\n \"agentCheckCount\",\n \"blocking\"\n ],\n \"additionalProperties\": false\n },\n {\n \"$ref\": \"#/definitions/AppSecurityCheckFileList\"\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"const\": \"cancelled\"\n }\n },\n \"required\": [\n \"status\"\n ],\n \"additionalProperties\": false,\n \"description\": \"Asked whether to scan without app configuration, the user declined. Nothing was scanned or written.\"\n }\n ],\n \"description\": \"The scan and the files it wrote. With --list-files, the files that a scan would gather.\",\n \"title\": \"AppSecurityCheckResult\",\n \"definitions\": {\n \"AppSecurityApp\": {\n \"type\": \"object\",\n \"properties\": {\n \"directory\": {\n \"type\": \"string\",\n \"description\": \"The absolute app directory.\"\n },\n \"configurationPath\": {\n \"anyOf\": [\n {\n \"type\": \"string\"\n },\n {\n \"type\": \"null\"\n }\n ],\n \"description\": \"The absolute path of the selected app configuration file, or null with --without-app-config.\"\n },\n \"clientId\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"minLength\": 1\n },\n {\n \"type\": \"null\"\n }\n ],\n \"description\": \"The --client-id value when passed, otherwise the app configuration's client_id. Null when the app configuration isn't linked.\"\n }\n },\n \"required\": [\n \"directory\",\n \"configurationPath\",\n \"clientId\"\n ],\n \"additionalProperties\": false\n },\n \"AppSecurityScope\": {\n \"type\": \"object\",\n \"properties\": {\n \"includeDirs\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n },\n \"description\": \"The --include-dir values.\"\n },\n \"excludes\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n },\n \"description\": \"The --exclude globs.\"\n },\n \"noGitIgnore\": {\n \"type\": \"boolean\",\n \"description\": \"Whether --no-git-ignore was passed.\"\n }\n },\n \"required\": [\n \"includeDirs\",\n \"excludes\",\n \"noGitIgnore\"\n ],\n \"additionalProperties\": false,\n \"description\": \"The check flags that chose which files were gathered, exactly as typed.\"\n },\n \"AppSecurityScanDirectory\": {\n \"type\": \"object\",\n \"properties\": {\n \"directory\": {\n \"type\": \"string\",\n \"description\": \"The absolute path of the directory.\"\n },\n \"origin\": {\n \"type\": \"string\",\n \"enum\": [\n \"app-directory\",\n \"include-dir\",\n \"app-config-directory\"\n ],\n \"description\": \"Why it was scanned: it is the app directory, an --include-dir value, or an extension or web directory of the app configuration.\"\n }\n },\n \"required\": [\n \"directory\",\n \"origin\"\n ],\n \"additionalProperties\": false,\n \"description\": \"A directory that check scanned.\"\n },\n \"AppSecurityBlocking\": {\n \"type\": \"object\",\n \"properties\": {\n \"level\": {\n \"type\": \"string\",\n \"enum\": [\n \"high\",\n \"medium\",\n \"low\",\n \"none\"\n ],\n \"description\": \"The --blocking severity.\"\n },\n \"blockedCheckCount\": {\n \"type\": \"integer\",\n \"minimum\": 0,\n \"description\": \"The number of checks with findings at or above that severity. Always 0 for none.\"\n }\n },\n \"required\": [\n \"level\",\n \"blockedCheckCount\"\n ],\n \"additionalProperties\": false,\n \"description\": \"The --blocking policy and the checks that fail it.\"\n },\n \"AppSecurityInstructions\": {\n \"type\": \"object\",\n \"properties\": {\n \"content\": {\n \"type\": \"string\",\n \"minLength\": 1,\n \"description\": \"The instructions in Markdown, as printed without --json.\"\n },\n \"copied\": {\n \"type\": \"boolean\",\n \"description\": \"Whether the instructions were also copied to the clipboard.\"\n }\n },\n \"required\": [\n \"content\",\n \"copied\"\n ],\n \"additionalProperties\": false\n },\n \"AppSecurityCheckFileList\": {\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"const\": \"success\"\n },\n \"app\": {\n \"$ref\": \"#/definitions/AppSecurityApp\"\n },\n \"scope\": {\n \"$ref\": \"#/definitions/AppSecurityScope\"\n },\n \"scanDirectories\": {\n \"type\": \"array\",\n \"items\": {\n \"$ref\": \"#/definitions/AppSecurityScanDirectory\"\n },\n \"description\": \"The directories that a scan would walk.\"\n },\n \"files\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"path\": {\n \"type\": \"string\",\n \"description\": \"The absolute path of the file.\"\n }\n },\n \"required\": [\n \"path\"\n ],\n \"additionalProperties\": false\n },\n \"description\": \"The files that a scan would gather, ordered by their paths relative to the app directory, as listed without --json.\"\n }\n },\n \"required\": [\n \"status\",\n \"app\",\n \"scope\",\n \"scanDirectories\",\n \"files\"\n ],\n \"additionalProperties\": false,\n \"description\": \"With --list-files, the files that a scan would gather. Nothing is scanned or written.\"\n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "examples": [ "<%= config.bin %> <%= command.id %>", "<%= config.bin %> <%= command.id %> --include-dir ../backend", "<%= config.bin %> <%= command.id %> --path extensions --config production --include-dir .", "<%= config.bin %> <%= command.id %> --without-app-config --client-id ", "<%= config.bin %> <%= command.id %> --path app --include-dir . --exclude marketing --exclude \"**/generated\"", "<%= config.bin %> <%= command.id %> --no-git-ignore --exclude local-data", "<%= config.bin %> <%= command.id %> --include-dir ../backend --list-files" ], "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" }, "no-input": { "description": "Disable interactive prompts and browser authentication.", "env": "SHOPIFY_FLAG_NO_INPUT", "name": "no-input", "allowNo": false, "type": "boolean" }, "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. May include sensitive data.", "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" }, "without-app-config": { "dependsOn": [ "client-id" ], "description": "Scan --path as an app with no app configuration file. Config checks are skipped. Requires --client-id.", "env": "SHOPIFY_FLAG_WITHOUT_APP_CONFIG", "exclusive": [ "config" ], "name": "without-app-config", "allowNo": false, "type": "boolean" }, "include-dir": { "description": "Also scan this directory, relative to the working directory. Repeat the flag to add directories. Use it for code that lives outside the app directory, such as a backend or a shared library.", "name": "include-dir", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "exclude": { "description": "Skip paths that match this glob, relative to the working directory. Repeat the flag to add globs. The selected app configuration file can't be excluded.", "name": "exclude", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "no-git-ignore": { "description": "Turn off Git ignore rules for every scanned directory, so files that Git ignores are scanned too. Files that Git tracks are always scanned.", "env": "SHOPIFY_FLAG_NO_GIT_IGNORE", "name": "no-git-ignore", "allowNo": false, "type": "boolean" }, "list-files": { "description": "Print the files the check would gather, one path per line, and stop. Nothing is scanned, no results are written, and nothing is prompted for. With --json, the result lists them with absolute paths.", "env": "SHOPIFY_FLAG_LIST_FILES", "exclusive": [ "print-instructions", "skip-instructions", "blocking" ], "name": "list-files", "allowNo": false, "type": "boolean" }, "blocking": { "description": "The minimum finding severity that causes a non-zero exit code: high, medium, or low. Defaults to none, which never fails on findings.", "env": "SHOPIFY_FLAG_APP_SECURITY_BLOCKING", "name": "blocking", "default": "none", "hasDynamicHelp": false, "multiple": false, "options": [ "high", "medium", "low", "none" ], "type": "option" }, "print-instructions": { "description": "Print coding-agent instructions without prompting for how to deliver them. With --json, the instructions are included in the result.", "env": "SHOPIFY_FLAG_APP_SECURITY_PRINT_INSTRUCTIONS", "exclusive": [ "skip-instructions" ], "name": "print-instructions", "allowNo": false, "type": "boolean" }, "yes": { "deprecated": { "to": "--print-instructions" }, "description": "Print coding-agent instructions without prompting.", "env": "SHOPIFY_FLAG_YES", "exclusive": [ "skip-instructions", "list-files" ], "hidden": true, "name": "yes", "allowNo": false, "type": "boolean" }, "skip-instructions": { "description": "Don't offer the coding-agent instructions after the scan. Use it when you want only the deterministic scan results.", "env": "SHOPIFY_FLAG_APP_SECURITY_SKIP_INSTRUCTIONS", "exclusive": [ "print-instructions" ], "name": "skip-instructions", "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:security:check", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": true, "summary": "Check an app for Shopify-specific security issues and write deterministic-findings.json and agent-checks.json.", "enableJsonFlag": false, "descriptionWithMarkdown": "Runs an app security check locally and writes `deterministic-findings.json` and `agent-checks.json` to the results directory, `.shopify/app-security//`. The results key is `--client-id` when you pass it, and otherwise the name of the app configuration file without `.toml`; the other `app security` commands take the same selection flags and find the same directory. Every run replaces both files, so it's always safe to run the check again.\n\n`deterministic-findings.json` holds the deterministic scan results. `agent-checks.json` holds the checks for your coding agent to investigate; the agent's results are recorded with `shopify app security record`. Use `--config` to select a specific app configuration when the project has multiple `shopify.app*.toml` files; the check inspects only that configuration. Use `--client-id` to replace the configuration's client ID for this run. `--client-id` is checked against your Shopify account before anything is scanned, so it needs you to be logged in. When no app configuration exists, use `--without-app-config --client-id ` to scan `--path` anyway with config checks skipped; in an interactive terminal the command offers to do this.\n\nThe check scans the app directory and each `--include-dir`. Git ignore rules apply by default: a file or directory that Git ignores is skipped, using the rules of the repository that contains it, while files that Git tracks are always scanned. Use `--no-git-ignore` to turn Git ignore rules off for every scanned directory. When the check uses Git, it requires Git 2.38.0 or later.\n\nUse `--exclude` to skip more paths. Each value is a glob that is matched against the path relative to the working directory, so a path above it starts with `../`, and a name at any depth needs `**/`, for example `--exclude '**/generated'`. Repeat the flag to add globs. An exclusion can't remove the selected app configuration file. Quote each value so your shell doesn't expand `*`. The coding-agent instructions this check offers repeat the globs. Other `app security` commands don't take `--exclude` or `--no-git-ignore`, so pass the same flags each time you run the check.\n\nUse `--list-files` to check the scope before scanning: it prints the files the check would gather, one path per line and relative to the app directory, and then stops. It writes no results and never prompts. `--client-id` is still checked, but doesn't change the list. With `--json`, the result lists the files with absolute paths.\n\nIn interactive terminals, the command offers to copy the coding-agent instructions, print them, or choose nothing; copying is the default. In CI and other non-interactive environments, instructions aren't offered unless you pass `--print-instructions`, which prints them. You can also run `shopify app security instructions` to print, copy, or write them later. With `--json`, the command offers to include the instructions in the result, with or without copying them, and `--print-instructions` includes them.\n\nWith `--json`, the result describes the scan and the files it wrote, and whether `--blocking` passed, but not the findings: run `shopify app security review --json` for those.\n\nReports the number of findings to Shopify as usage telemetry, but not finding details. See [usage reporting](https://shopify.dev/docs/api/shopify-cli#usage-reporting) for details.", "customPluginName": "@shopify/app" }, "app:security:clean": { "aliases": [], "args": {}, "description": "Deletes the results directory, `.shopify/app-security//`, without asking. The results key is `--client-id` when you pass it, and otherwise the name of the app configuration file without `.toml`. Other results directories are left alone. Prints each removed path.\n\nUse `--all` to delete every results directory under `.shopify/app-security/` instead. `--all` takes neither `--config` nor `--client-id`, and with `--without-app-config` it doesn't need `--client-id`.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `AppSecurityCleanResult` schema.\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"const\": \"success\"\n },\n \"changed\": {\n \"type\": \"boolean\",\n \"description\": \"Whether any results directory was removed.\"\n },\n \"app\": {\n \"anyOf\": [\n {\n \"$ref\": \"#/definitions/AppSecurityApp\"\n },\n {\n \"$ref\": \"#/definitions/AppSecurityCleanAllApp\"\n }\n ],\n \"description\": \"The selected app. With --all, only its directory.\"\n },\n \"resultsDirectories\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n },\n \"description\": \"The absolute paths of the removed results directories, sorted. Empty when there was nothing to remove.\"\n }\n },\n \"required\": [\n \"status\",\n \"changed\",\n \"app\",\n \"resultsDirectories\"\n ],\n \"additionalProperties\": false,\n \"title\": \"AppSecurityCleanResult\",\n \"definitions\": {\n \"AppSecurityApp\": {\n \"type\": \"object\",\n \"properties\": {\n \"directory\": {\n \"type\": \"string\",\n \"description\": \"The absolute app directory.\"\n },\n \"configurationPath\": {\n \"anyOf\": [\n {\n \"type\": \"string\"\n },\n {\n \"type\": \"null\"\n }\n ],\n \"description\": \"The absolute path of the selected app configuration file, or null with --without-app-config.\"\n },\n \"clientId\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"minLength\": 1\n },\n {\n \"type\": \"null\"\n }\n ],\n \"description\": \"The --client-id value when passed, otherwise the app configuration's client_id. Null when the app configuration isn't linked.\"\n }\n },\n \"required\": [\n \"directory\",\n \"configurationPath\",\n \"clientId\"\n ],\n \"additionalProperties\": false\n },\n \"AppSecurityCleanAllApp\": {\n \"type\": \"object\",\n \"properties\": {\n \"directory\": {\n \"type\": \"string\",\n \"description\": \"The absolute app directory.\"\n }\n },\n \"required\": [\n \"directory\"\n ],\n \"additionalProperties\": false\n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" }, "no-input": { "description": "Disable interactive prompts and browser authentication.", "env": "SHOPIFY_FLAG_NO_INPUT", "name": "no-input", "allowNo": false, "type": "boolean" }, "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. May include sensitive data.", "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" }, "without-app-config": { "description": "Scan --path as an app with no app configuration file. Config checks are skipped. Requires --client-id.", "env": "SHOPIFY_FLAG_WITHOUT_APP_CONFIG", "exclusive": [ "config" ], "name": "without-app-config", "relationships": [ { "type": "all", "flags": [ { "name": "client-id" } ] } ], "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" }, "all": { "description": "Delete every results directory under .shopify/app-security/, not only the selected one.", "exclusive": [ "config", "client-id" ], "name": "all", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "app:security:clean", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": true, "summary": "Remove local app security check results.", "enableJsonFlag": false, "descriptionWithMarkdown": "Deletes the results directory, `.shopify/app-security//`, without asking. The results key is `--client-id` when you pass it, and otherwise the name of the app configuration file without `.toml`. Other results directories are left alone. Prints each removed path.\n\nUse `--all` to delete every results directory under `.shopify/app-security/` instead. `--all` takes neither `--config` nor `--client-id`, and with `--without-app-config` it doesn't need `--client-id`.", "customPluginName": "@shopify/app" }, "app:security:instructions": { "aliases": [], "args": {}, "description": "Prints the complete workflow that a coding agent should follow to review app security check results.\n\nBy default, the instructions are printed to stdout. Use `--copy` to copy them to the clipboard or `--write` to write them to a file. Standalone instructions always start by running `shopify app security check`; only that invocation's generated review pack is trusted as workflow input.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `AppSecurityInstructionsResult` schema.\n\n```json\n{\n \"anyOf\": [\n {\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"const\": \"success\"\n },\n \"app\": {\n \"$ref\": \"#/definitions/AppSecurityApp\"\n },\n \"resultsDirectory\": {\n \"type\": \"string\",\n \"description\": \"The absolute path of the results directory that the instructions use. It may not exist yet: the instructions start by running check, which creates it.\"\n },\n \"instructions\": {\n \"$ref\": \"#/definitions/AppSecurityInstructions\"\n }\n },\n \"required\": [\n \"status\",\n \"app\",\n \"resultsDirectory\",\n \"instructions\"\n ],\n \"additionalProperties\": false\n },\n {\n \"$ref\": \"#/definitions/AppSecurityInstructionsFile\"\n }\n ],\n \"description\": \"The instructions and the app they are for. With --write, only the file they were written to.\",\n \"title\": \"AppSecurityInstructionsResult\",\n \"definitions\": {\n \"AppSecurityApp\": {\n \"type\": \"object\",\n \"properties\": {\n \"directory\": {\n \"type\": \"string\",\n \"description\": \"The absolute app directory.\"\n },\n \"configurationPath\": {\n \"anyOf\": [\n {\n \"type\": \"string\"\n },\n {\n \"type\": \"null\"\n }\n ],\n \"description\": \"The absolute path of the selected app configuration file, or null with --without-app-config.\"\n },\n \"clientId\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"minLength\": 1\n },\n {\n \"type\": \"null\"\n }\n ],\n \"description\": \"The --client-id value when passed, otherwise the app configuration's client_id. Null when the app configuration isn't linked.\"\n }\n },\n \"required\": [\n \"directory\",\n \"configurationPath\",\n \"clientId\"\n ],\n \"additionalProperties\": false\n },\n \"AppSecurityInstructions\": {\n \"type\": \"object\",\n \"properties\": {\n \"content\": {\n \"type\": \"string\",\n \"minLength\": 1,\n \"description\": \"The instructions in Markdown, as printed without --json.\"\n },\n \"copied\": {\n \"type\": \"boolean\",\n \"description\": \"Whether the instructions were also copied to the clipboard.\"\n }\n },\n \"required\": [\n \"content\",\n \"copied\"\n ],\n \"additionalProperties\": false\n },\n \"AppSecurityInstructionsFile\": {\n \"type\": \"object\",\n \"properties\": {\n \"path\": {\n \"type\": \"string\",\n \"description\": \"The absolute path of the file that the instructions were written to.\"\n },\n \"format\": {\n \"type\": \"string\",\n \"const\": \"markdown\",\n \"description\": \"The file holds the instructions in Markdown, not a JSON result.\"\n }\n },\n \"required\": [\n \"path\",\n \"format\"\n ],\n \"additionalProperties\": false\n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" }, "no-input": { "description": "Disable interactive prompts and browser authentication.", "env": "SHOPIFY_FLAG_NO_INPUT", "name": "no-input", "allowNo": false, "type": "boolean" }, "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. May include sensitive data.", "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" }, "without-app-config": { "dependsOn": [ "client-id" ], "description": "Scan --path as an app with no app configuration file. Config checks are skipped. Requires --client-id.", "env": "SHOPIFY_FLAG_WITHOUT_APP_CONFIG", "exclusive": [ "config" ], "name": "without-app-config", "allowNo": false, "type": "boolean" }, "copy": { "description": "Copy the instructions to the clipboard instead of printing them. With --json, the result still includes them.", "env": "SHOPIFY_FLAG_APP_SECURITY_INSTRUCTIONS_COPY", "exclusive": [ "write" ], "name": "copy", "allowNo": false, "type": "boolean" }, "write": { "description": "Write the instructions to a file instead of printing them. With --json, stdout contains only the absolute path and Markdown format of the written file.", "env": "SHOPIFY_FLAG_APP_SECURITY_INSTRUCTIONS_WRITE", "exclusive": [ "copy" ], "name": "write", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "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:security:instructions", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": true, "summary": "Provide app security check instructions to a coding agent.", "enableJsonFlag": false, "descriptionWithMarkdown": "Prints the complete workflow that a coding agent should follow to review app security check results.\n\nBy default, the instructions are printed to stdout. Use `--copy` to copy them to the clipboard or `--write` to write them to a file. Standalone instructions always start by running `shopify app security check`; only that invocation's generated review pack is trusted as workflow input.", "customPluginName": "@shopify/app" }, "app:security:record": { "aliases": [], "args": {}, "description": "Reads a coding agent's complete findings document from stdin, validates it, and replaces `agent-findings.json` in the results directory, `.shopify/app-security//`. The results key is `--client-id` when you pass it, and otherwise the name of the app configuration file without `.toml`. `--client-id` is checked against your Shopify account before anything is read, so it needs you to be logged in.\n\nThe document must include a `scope` with the `include_dirs`, `excludes` and `no_git_ignore` values of the `check` run it describes, exactly as typed. It's recorded as reported and never compared with the scan's files.\n\nThe document is recorded all or nothing: if anything is invalid, the command fails with every error, writes nothing, and exits with a non-zero code. It needs the results directory that `shopify app security check` creates.\n\nReports the number of findings to Shopify as usage telemetry, but not finding details. See \"usage reporting\" (https://shopify.dev/docs/api/shopify-cli#usage-reporting) for details.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `AppSecurityRecordResult` schema.\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"const\": \"success\"\n },\n \"app\": {\n \"$ref\": \"#/definitions/AppSecurityApp\"\n },\n \"resultsDirectory\": {\n \"type\": \"string\",\n \"description\": \"The absolute path of the results directory.\"\n },\n \"path\": {\n \"type\": \"string\",\n \"description\": \"The absolute path of the agent-findings.json file that was written.\"\n },\n \"checkCount\": {\n \"type\": \"integer\",\n \"minimum\": 0,\n \"description\": \"The number of checks recorded.\"\n },\n \"findingCount\": {\n \"type\": \"integer\",\n \"minimum\": 0,\n \"description\": \"The number of findings recorded, across every check.\"\n }\n },\n \"required\": [\n \"status\",\n \"app\",\n \"resultsDirectory\",\n \"path\",\n \"checkCount\",\n \"findingCount\"\n ],\n \"additionalProperties\": false,\n \"title\": \"AppSecurityRecordResult\",\n \"definitions\": {\n \"AppSecurityApp\": {\n \"type\": \"object\",\n \"properties\": {\n \"directory\": {\n \"type\": \"string\",\n \"description\": \"The absolute app directory.\"\n },\n \"configurationPath\": {\n \"anyOf\": [\n {\n \"type\": \"string\"\n },\n {\n \"type\": \"null\"\n }\n ],\n \"description\": \"The absolute path of the selected app configuration file, or null with --without-app-config.\"\n },\n \"clientId\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"minLength\": 1\n },\n {\n \"type\": \"null\"\n }\n ],\n \"description\": \"The --client-id value when passed, otherwise the app configuration's client_id. Null when the app configuration isn't linked.\"\n }\n },\n \"required\": [\n \"directory\",\n \"configurationPath\",\n \"clientId\"\n ],\n \"additionalProperties\": false\n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" }, "no-input": { "description": "Disable interactive prompts and browser authentication.", "env": "SHOPIFY_FLAG_NO_INPUT", "name": "no-input", "allowNo": false, "type": "boolean" }, "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. May include sensitive data.", "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" }, "without-app-config": { "dependsOn": [ "client-id" ], "description": "Scan --path as an app with no app configuration file. Config checks are skipped. Requires --client-id.", "env": "SHOPIFY_FLAG_WITHOUT_APP_CONFIG", "exclusive": [ "config" ], "name": "without-app-config", "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:security:record", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": true, "summary": "Record agent findings from an app security check.", "enableJsonFlag": false, "descriptionWithMarkdown": "Reads a coding agent's complete findings document from stdin, validates it, and replaces `agent-findings.json` in the results directory, `.shopify/app-security//`. The results key is `--client-id` when you pass it, and otherwise the name of the app configuration file without `.toml`. `--client-id` is checked against your Shopify account before anything is read, so it needs you to be logged in.\n\nThe document must include a `scope` with the `include_dirs`, `excludes` and `no_git_ignore` values of the `check` run it describes, exactly as typed. It's recorded as reported and never compared with the scan's files.\n\nThe document is recorded all or nothing: if anything is invalid, the command fails with every error, writes nothing, and exits with a non-zero code. It needs the results directory that `shopify app security check` creates.\n\nReports the number of findings to Shopify as usage telemetry, but not finding details. See [usage reporting](https://shopify.dev/docs/api/shopify-cli#usage-reporting) for details.", "customPluginName": "@shopify/app" }, "app:security:review": { "aliases": [], "args": {}, "description": "Combines the deterministic results (`deterministic-findings.json`, written by `shopify app security check`) with the recorded agent results (`agent-findings.json`, written by `shopify app security record`) and shows one view of every check: its findings, status and source. Both files are in the results directory, `.shopify/app-security//`. `--client-id` is checked against your Shopify account before any results are read, so it needs you to be logged in.\n\nThe summary shows the scan directories and the scope of the latest scan, and the scope the agent reported. It notes when the agent findings were recorded for a different scope than the latest scan; that doesn't change the exit code.\n\nThe agent results are optional. Use `--check-id` to narrow the review to specific checks, `--verbose` for full reasoning, evidence and suppressed findings, and `--blocking` to exit with code 1 when a check with findings is at or above a severity. With `--json`, the result always includes every finding in full.\n\nReports the number of findings to Shopify as usage telemetry, but not finding details. See \"usage reporting\" (https://shopify.dev/docs/api/shopify-cli#usage-reporting) for details.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `AppSecurityReviewResult` schema.\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"const\": \"success\"\n },\n \"valid\": {\n \"type\": \"boolean\",\n \"description\": \"Whether --blocking passed: no check in checks has an active finding and a severity at or above the level. Unresolved checks never fail it, and --blocking none always passes.\"\n },\n \"app\": {\n \"$ref\": \"#/definitions/AppSecurityApp\"\n },\n \"resultsDirectory\": {\n \"type\": \"string\",\n \"description\": \"The absolute path of the results directory.\"\n },\n \"resultsFiles\": {\n \"type\": \"object\",\n \"properties\": {\n \"deterministic\": {\n \"anyOf\": [\n {\n \"$ref\": \"#/definitions/AppSecurityDeterministicResultsFile\"\n },\n {\n \"type\": \"null\"\n }\n ],\n \"description\": \"deterministic-findings.json, which check writes, with the scope of the scan.\"\n },\n \"agent\": {\n \"anyOf\": [\n {\n \"$ref\": \"#/definitions/AppSecurityAgentResultsFile\"\n },\n {\n \"type\": \"null\"\n }\n ],\n \"description\": \"agent-findings.json, which record writes, with the scope that the agent reported.\"\n }\n },\n \"required\": [\n \"deterministic\",\n \"agent\"\n ],\n \"additionalProperties\": false,\n \"description\": \"The results files that the review combines. Null when a file does not exist.\"\n },\n \"detection\": {\n \"anyOf\": [\n {\n \"$ref\": \"#/definitions/AppSecurityDetection\"\n },\n {\n \"type\": \"null\"\n }\n ],\n \"description\": \"What the latest check detected in the app, or null without deterministic-findings.json.\"\n },\n \"coverage\": {\n \"anyOf\": [\n {\n \"$ref\": \"#/definitions/AppSecurityCoverage\"\n },\n {\n \"type\": \"null\"\n }\n ],\n \"description\": \"What the latest check covered, or null without deterministic-findings.json.\"\n },\n \"scopeDiffers\": {\n \"type\": \"boolean\",\n \"description\": \"Whether the agent reported another scope than the latest scan used. False unless both results files exist.\"\n },\n \"checks\": {\n \"type\": \"array\",\n \"items\": {\n \"$ref\": \"#/definitions/AppSecurityCheck\"\n },\n \"description\": \"The checks after --check-id, most severe first, then by ID. Empty when no results file exists.\"\n },\n \"blocking\": {\n \"$ref\": \"#/definitions/AppSecurityBlocking\"\n }\n },\n \"required\": [\n \"status\",\n \"valid\",\n \"app\",\n \"resultsDirectory\",\n \"resultsFiles\",\n \"detection\",\n \"coverage\",\n \"scopeDiffers\",\n \"checks\",\n \"blocking\"\n ],\n \"additionalProperties\": false,\n \"description\": \"The combined results of the app security check.\",\n \"title\": \"AppSecurityReviewResult\",\n \"definitions\": {\n \"AppSecurityApp\": {\n \"type\": \"object\",\n \"properties\": {\n \"directory\": {\n \"type\": \"string\",\n \"description\": \"The absolute app directory.\"\n },\n \"configurationPath\": {\n \"anyOf\": [\n {\n \"type\": \"string\"\n },\n {\n \"type\": \"null\"\n }\n ],\n \"description\": \"The absolute path of the selected app configuration file, or null with --without-app-config.\"\n },\n \"clientId\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"minLength\": 1\n },\n {\n \"type\": \"null\"\n }\n ],\n \"description\": \"The --client-id value when passed, otherwise the app configuration's client_id. Null when the app configuration isn't linked.\"\n }\n },\n \"required\": [\n \"directory\",\n \"configurationPath\",\n \"clientId\"\n ],\n \"additionalProperties\": false\n },\n \"AppSecurityScope\": {\n \"type\": \"object\",\n \"properties\": {\n \"includeDirs\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n },\n \"description\": \"The --include-dir values.\"\n },\n \"excludes\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n },\n \"description\": \"The --exclude globs.\"\n },\n \"noGitIgnore\": {\n \"type\": \"boolean\",\n \"description\": \"Whether --no-git-ignore was passed.\"\n }\n },\n \"required\": [\n \"includeDirs\",\n \"excludes\",\n \"noGitIgnore\"\n ],\n \"additionalProperties\": false,\n \"description\": \"The check flags that chose which files were gathered, exactly as typed.\"\n },\n \"AppSecurityScanDirectory\": {\n \"type\": \"object\",\n \"properties\": {\n \"directory\": {\n \"type\": \"string\",\n \"description\": \"The absolute path of the directory.\"\n },\n \"origin\": {\n \"type\": \"string\",\n \"enum\": [\n \"app-directory\",\n \"include-dir\",\n \"app-config-directory\"\n ],\n \"description\": \"Why it was scanned: it is the app directory, an --include-dir value, or an extension or web directory of the app configuration.\"\n }\n },\n \"required\": [\n \"directory\",\n \"origin\"\n ],\n \"additionalProperties\": false,\n \"description\": \"A directory that check scanned.\"\n },\n \"AppSecurityBlocking\": {\n \"type\": \"object\",\n \"properties\": {\n \"level\": {\n \"type\": \"string\",\n \"enum\": [\n \"high\",\n \"medium\",\n \"low\",\n \"none\"\n ],\n \"description\": \"The --blocking severity.\"\n },\n \"blockedCheckCount\": {\n \"type\": \"integer\",\n \"minimum\": 0,\n \"description\": \"The number of checks with findings at or above that severity. Always 0 for none.\"\n }\n },\n \"required\": [\n \"level\",\n \"blockedCheckCount\"\n ],\n \"additionalProperties\": false,\n \"description\": \"The --blocking policy and the checks that fail it.\"\n },\n \"AppSecurityDeterministicResultsFile\": {\n \"type\": \"object\",\n \"properties\": {\n \"path\": {\n \"type\": \"string\",\n \"description\": \"The absolute path of deterministic-findings.json.\"\n },\n \"generatedAt\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"format\": \"date-time\",\n \"pattern\": \"^\\\\d{4}-\\\\d{2}-\\\\d{2}T\\\\d{2}:\\\\d{2}:\\\\d{2}Z$\",\n \"description\": \"A UTC ISO 8601 instant with whole seconds and the Z timezone marker.\"\n },\n {\n \"type\": \"null\"\n }\n ],\n \"description\": \"When check wrote the file, or null when the recorded time is not a valid instant.\"\n },\n \"engine\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"version\": {\n \"type\": \"string\"\n },\n \"ruleset\": {\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"name\",\n \"version\",\n \"ruleset\"\n ],\n \"additionalProperties\": false\n },\n \"scope\": {\n \"$ref\": \"#/definitions/AppSecurityScope\"\n }\n },\n \"required\": [\n \"path\",\n \"generatedAt\",\n \"engine\",\n \"scope\"\n ],\n \"additionalProperties\": false,\n \"description\": \"deterministic-findings.json, which check writes, with the scope of the scan.\"\n },\n \"AppSecurityAgentResultsFile\": {\n \"type\": \"object\",\n \"properties\": {\n \"path\": {\n \"type\": \"string\",\n \"description\": \"The absolute path of agent-findings.json.\"\n },\n \"generatedAt\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"format\": \"date-time\",\n \"pattern\": \"^\\\\d{4}-\\\\d{2}-\\\\d{2}T\\\\d{2}:\\\\d{2}:\\\\d{2}Z$\",\n \"description\": \"A UTC ISO 8601 instant with whole seconds and the Z timezone marker.\"\n },\n {\n \"type\": \"null\"\n }\n ],\n \"description\": \"When record wrote the file, or null when the recorded time is not a valid instant.\"\n },\n \"engine\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"version\": {\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"name\",\n \"version\"\n ],\n \"additionalProperties\": false\n },\n \"scope\": {\n \"$ref\": \"#/definitions/AppSecurityScope\"\n }\n },\n \"required\": [\n \"path\",\n \"generatedAt\",\n \"engine\",\n \"scope\"\n ],\n \"additionalProperties\": false,\n \"description\": \"agent-findings.json, which record writes, with the scope that the agent reported.\"\n },\n \"AppSecurityDetection\": {\n \"type\": \"object\",\n \"properties\": {\n \"framework\": {\n \"type\": \"string\",\n \"enum\": [\n \"react-router\",\n \"none\",\n \"unknown\",\n \"mixed\"\n ]\n },\n \"surface\": {\n \"type\": \"string\",\n \"enum\": [\n \"react-router\",\n \"theme-app-extension\",\n \"config-only\",\n \"unknown\",\n \"mixed\"\n ]\n },\n \"languages\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"description\": \"The language, such as typescript.\"\n },\n \"support\": {\n \"type\": \"string\",\n \"enum\": [\n \"supported\",\n \"unsupported\"\n ],\n \"description\": \"Whether the deterministic checks analyze it.\"\n },\n \"files\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"path\": {\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"path\"\n ],\n \"additionalProperties\": false\n }\n }\n },\n \"required\": [\n \"name\",\n \"support\",\n \"files\"\n ],\n \"additionalProperties\": false\n }\n }\n },\n \"required\": [\n \"framework\",\n \"surface\",\n \"languages\"\n ],\n \"additionalProperties\": false,\n \"description\": \"What the latest check detected in the app.\"\n },\n \"AppSecurityCoverage\": {\n \"type\": \"object\",\n \"properties\": {\n \"filesScanned\": {\n \"type\": \"integer\",\n \"minimum\": 0,\n \"description\": \"The number of files scanned.\"\n },\n \"filesSkipped\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"path\": {\n \"type\": \"string\"\n },\n \"reason\": {\n \"type\": \"string\",\n \"enum\": [\n \"too-large\",\n \"unreadable\"\n ]\n },\n \"sizeBytes\": {\n \"anyOf\": [\n {\n \"type\": \"integer\",\n \"minimum\": 0\n },\n {\n \"type\": \"null\"\n }\n ],\n \"description\": \"The file size, or null when unknown.\"\n },\n \"detail\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"minLength\": 1\n },\n {\n \"type\": \"null\"\n }\n ],\n \"description\": \"Why the file was unreadable, or null when none is recorded.\"\n }\n },\n \"required\": [\n \"path\",\n \"reason\",\n \"sizeBytes\",\n \"detail\"\n ],\n \"additionalProperties\": false\n }\n },\n \"gaps\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"code\": {\n \"type\": \"string\",\n \"enum\": [\n \"skipped-file\",\n \"unsupported-framework\",\n \"unsupported-language\",\n \"unresolved-check\"\n ]\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"checkId\": {\n \"type\": [\n \"string\",\n \"null\"\n ],\n \"description\": \"The check that the gap concerns, or null.\"\n },\n \"filePath\": {\n \"anyOf\": [\n {\n \"type\": \"string\"\n },\n {\n \"type\": \"null\"\n }\n ],\n \"description\": \"The file that the gap concerns, or null.\"\n }\n },\n \"required\": [\n \"code\",\n \"message\",\n \"checkId\",\n \"filePath\"\n ],\n \"additionalProperties\": false\n }\n },\n \"scanDirectories\": {\n \"type\": \"array\",\n \"items\": {\n \"$ref\": \"#/definitions/AppSecurityScanDirectory\"\n }\n }\n },\n \"required\": [\n \"filesScanned\",\n \"filesSkipped\",\n \"gaps\",\n \"scanDirectories\"\n ],\n \"additionalProperties\": false,\n \"description\": \"What the latest check covered.\"\n },\n \"AppSecurityCheck\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"type\": \"string\",\n \"description\": \"The check ID, such as CREDENTIAL_LOG_LEAKAGE.\"\n },\n \"title\": {\n \"type\": \"string\"\n },\n \"severity\": {\n \"type\": \"string\",\n \"enum\": [\n \"high\",\n \"medium\",\n \"low\"\n ]\n },\n \"description\": {\n \"type\": \"string\"\n },\n \"guide\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"minLength\": 1\n },\n {\n \"type\": \"null\"\n }\n ],\n \"description\": \"A guide to the check, or null when none is recorded.\"\n },\n \"docsUrl\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"format\": \"uri\"\n },\n {\n \"type\": \"null\"\n }\n ],\n \"description\": \"The check's page on shopify.dev, or null when the results files predate it.\"\n },\n \"precedence\": {\n \"type\": \"string\",\n \"enum\": [\n \"union\",\n \"prefer-agent\"\n ],\n \"description\": \"How the sources combine: union keeps both sources' findings; prefer-agent lets the agent result replace the deterministic one.\"\n },\n \"appliedPrecedence\": {\n \"type\": \"string\",\n \"enum\": [\n \"union\",\n \"prefer-agent\"\n ],\n \"description\": \"The precedence that applied: union when a prefer-agent agent result is older than the deterministic one.\"\n },\n \"status\": {\n \"type\": \"string\",\n \"enum\": [\n \"executed\",\n \"not-applicable\",\n \"unresolved\"\n ],\n \"description\": \"The combined status. Under union, executed when either source executed the check.\"\n },\n \"bySource\": {\n \"type\": \"object\",\n \"properties\": {\n \"deterministic\": {\n \"anyOf\": [\n {\n \"$ref\": \"#/definitions/AppSecuritySourceResult\"\n },\n {\n \"type\": \"null\"\n }\n ],\n \"description\": \"One source's own result for a check.\"\n },\n \"agent\": {\n \"anyOf\": [\n {\n \"$ref\": \"#/definitions/AppSecuritySourceResult\"\n },\n {\n \"type\": \"null\"\n }\n ],\n \"description\": \"One source's own result for a check.\"\n }\n },\n \"required\": [\n \"deterministic\",\n \"agent\"\n ],\n \"additionalProperties\": false,\n \"description\": \"Each source's own result, or null when that source didn't record the check.\"\n },\n \"findings\": {\n \"type\": \"array\",\n \"items\": {\n \"$ref\": \"#/definitions/AppSecurityFinding\"\n },\n \"description\": \"Every finding of both sources, including suppressed and superseded ones, whatever --verbose. Sorted by file, line, then source.\"\n }\n },\n \"required\": [\n \"id\",\n \"title\",\n \"severity\",\n \"description\",\n \"guide\",\n \"docsUrl\",\n \"precedence\",\n \"appliedPrecedence\",\n \"status\",\n \"bySource\",\n \"findings\"\n ],\n \"additionalProperties\": false,\n \"description\": \"One check, combined from both results files.\"\n },\n \"AppSecuritySourceResult\": {\n \"type\": \"object\",\n \"properties\": {\n \"version\": {\n \"type\": \"integer\",\n \"exclusiveMinimum\": 0,\n \"description\": \"The check version: the catalog version for deterministic results, the one the agent claimed for agent results.\"\n },\n \"status\": {\n \"type\": \"string\",\n \"enum\": [\n \"executed\",\n \"not-applicable\",\n \"unresolved\"\n ],\n \"description\": \"The source's own status for the check.\"\n },\n \"reason\": {\n \"anyOf\": [\n {\n \"type\": \"object\",\n \"properties\": {\n \"code\": {\n \"type\": \"string\",\n \"description\": \"A short code. Agent codes are free-form. Deterministic codes: capability_absent, no_relevant_files, unsupported_framework, unsupported_language, parser_unavailable, agent_investigation_required, input_rejected.\"\n },\n \"message\": {\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"code\",\n \"message\"\n ],\n \"additionalProperties\": false\n },\n {\n \"type\": \"null\"\n }\n ],\n \"description\": \"Why the check is unresolved or not applicable, or null when none is recorded.\"\n },\n \"analysisMode\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"enum\": [\n \"regex\",\n \"structured-config\",\n \"ast\"\n ]\n },\n {\n \"type\": \"null\"\n }\n ],\n \"description\": \"How the deterministic check analyzed the files. Null for agent results.\"\n },\n \"generatedAt\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"format\": \"date-time\",\n \"pattern\": \"^\\\\d{4}-\\\\d{2}-\\\\d{2}T\\\\d{2}:\\\\d{2}:\\\\d{2}Z$\",\n \"description\": \"A UTC ISO 8601 instant with whole seconds and the Z timezone marker.\"\n },\n {\n \"type\": \"null\"\n }\n ],\n \"description\": \"When the source recorded the check, or null when the recorded time is not a valid instant.\"\n }\n },\n \"required\": [\n \"version\",\n \"status\",\n \"reason\",\n \"analysisMode\",\n \"generatedAt\"\n ],\n \"additionalProperties\": false,\n \"description\": \"One source's own result for a check.\"\n },\n \"AppSecurityFinding\": {\n \"anyOf\": [\n {\n \"$ref\": \"#/definitions/AppSecurityDeterministicFinding\"\n },\n {\n \"$ref\": \"#/definitions/AppSecurityAgentFinding\"\n }\n ]\n },\n \"AppSecurityDeterministicFinding\": {\n \"type\": \"object\",\n \"properties\": {\n \"source\": {\n \"type\": \"string\",\n \"const\": \"deterministic\"\n },\n \"disposition\": {\n \"type\": \"string\",\n \"enum\": [\n \"active\",\n \"suppressed\",\n \"superseded\"\n ],\n \"description\": \"Whether the finding counts: active; suppressed by the agent; or superseded, a deterministic finding that a check's prefer-agent agent result replaces.\"\n },\n \"location\": {\n \"$ref\": \"#/definitions/AppSecurityLocation\"\n },\n \"message\": {\n \"type\": \"string\",\n \"description\": \"What the finding is, redacted.\"\n },\n \"snippet\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"minLength\": 1\n },\n {\n \"type\": \"null\"\n }\n ],\n \"description\": \"The flagged code, redacted, or null when none is recorded.\"\n },\n \"evidence\": {\n \"type\": \"array\",\n \"items\": {\n \"$ref\": \"#/definitions/AppSecurityEvidence\"\n }\n },\n \"fix\": {\n \"anyOf\": [\n {\n \"type\": \"object\",\n \"properties\": {\n \"description\": {\n \"type\": \"string\"\n },\n \"guide\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"minLength\": 1\n },\n {\n \"type\": \"null\"\n }\n ],\n \"description\": \"A guide to the fix, or null when none is recorded.\"\n },\n \"automated\": {\n \"type\": \"boolean\",\n \"description\": \"Whether the fix can be applied automatically.\"\n }\n },\n \"required\": [\n \"description\",\n \"guide\",\n \"automated\"\n ],\n \"additionalProperties\": false\n },\n {\n \"type\": \"null\"\n }\n ],\n \"description\": \"How to fix the finding, or null when none is recorded.\"\n }\n },\n \"required\": [\n \"source\",\n \"disposition\",\n \"location\",\n \"message\",\n \"snippet\",\n \"evidence\",\n \"fix\"\n ],\n \"additionalProperties\": false,\n \"description\": \"A finding from deterministic-findings.json.\"\n },\n \"AppSecurityAgentFinding\": {\n \"type\": \"object\",\n \"properties\": {\n \"source\": {\n \"type\": \"string\",\n \"const\": \"agent\"\n },\n \"disposition\": {\n \"type\": \"string\",\n \"enum\": [\n \"active\",\n \"suppressed\",\n \"superseded\"\n ],\n \"description\": \"Whether the finding counts: active; suppressed by the agent; or superseded, a deterministic finding that a check's prefer-agent agent result replaces.\"\n },\n \"location\": {\n \"$ref\": \"#/definitions/AppSecurityLocation\"\n },\n \"message\": {\n \"type\": \"string\",\n \"description\": \"What the finding is, redacted.\"\n },\n \"snippet\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"minLength\": 1\n },\n {\n \"type\": \"null\"\n }\n ],\n \"description\": \"The flagged code, redacted, or null when none is recorded.\"\n },\n \"evidence\": {\n \"type\": \"array\",\n \"items\": {\n \"$ref\": \"#/definitions/AppSecurityEvidence\"\n }\n },\n \"confidence\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"enum\": [\n \"high\",\n \"medium\",\n \"low\"\n ]\n },\n {\n \"type\": \"null\"\n }\n ],\n \"description\": \"The agent's confidence, or null when it didn't report one.\"\n },\n \"reasoning\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"minLength\": 1\n },\n {\n \"type\": \"null\"\n }\n ],\n \"description\": \"The agent's reasoning, redacted, or null when none is recorded.\"\n },\n \"suppression\": {\n \"anyOf\": [\n {\n \"type\": \"object\",\n \"properties\": {\n \"justification\": {\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"justification\"\n ],\n \"additionalProperties\": false\n },\n {\n \"type\": \"null\"\n }\n ],\n \"description\": \"Why the agent suppressed the finding, or null when it is not suppressed.\"\n }\n },\n \"required\": [\n \"source\",\n \"disposition\",\n \"location\",\n \"message\",\n \"snippet\",\n \"evidence\",\n \"confidence\",\n \"reasoning\",\n \"suppression\"\n ],\n \"additionalProperties\": false,\n \"description\": \"A finding from agent-findings.json.\"\n },\n \"AppSecurityLocation\": {\n \"type\": \"object\",\n \"properties\": {\n \"filePath\": {\n \"type\": \"string\",\n \"description\": \"The absolute path of the file.\"\n },\n \"line\": {\n \"anyOf\": [\n {\n \"type\": \"integer\",\n \"exclusiveMinimum\": 0\n },\n {\n \"type\": \"null\"\n }\n ],\n \"description\": \"The one-based line, or null for the whole file.\"\n },\n \"column\": {\n \"anyOf\": [\n {\n \"type\": \"integer\",\n \"exclusiveMinimum\": 0\n },\n {\n \"type\": \"null\"\n }\n ],\n \"description\": \"The one-based column, or null when none is recorded.\"\n }\n },\n \"required\": [\n \"filePath\",\n \"line\",\n \"column\"\n ],\n \"additionalProperties\": false,\n \"description\": \"A place in a file.\"\n },\n \"AppSecurityEvidence\": {\n \"type\": \"object\",\n \"properties\": {\n \"location\": {\n \"$ref\": \"#/definitions/AppSecurityLocation\"\n },\n \"quote\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"minLength\": 1\n },\n {\n \"type\": \"null\"\n }\n ],\n \"description\": \"The quoted source, redacted, or null when none is recorded.\"\n }\n },\n \"required\": [\n \"location\",\n \"quote\"\n ],\n \"additionalProperties\": false,\n \"description\": \"Source that supports a finding.\"\n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" }, "no-input": { "description": "Disable interactive prompts and browser authentication.", "env": "SHOPIFY_FLAG_NO_INPUT", "name": "no-input", "allowNo": false, "type": "boolean" }, "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. May include sensitive data.", "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" }, "without-app-config": { "dependsOn": [ "client-id" ], "description": "Scan --path as an app with no app configuration file. Config checks are skipped. Requires --client-id.", "env": "SHOPIFY_FLAG_WITHOUT_APP_CONFIG", "exclusive": [ "config" ], "name": "without-app-config", "allowNo": false, "type": "boolean" }, "check-id": { "description": "Show only this check. Repeat the flag to show several checks.", "env": "SHOPIFY_FLAG_CHECK_ID", "name": "check-id", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "blocking": { "description": "The minimum finding severity that causes a non-zero exit code: high, medium, or low. Defaults to none, which never fails on findings.", "env": "SHOPIFY_FLAG_APP_SECURITY_BLOCKING", "name": "blocking", "default": "none", "hasDynamicHelp": false, "multiple": false, "options": [ "high", "medium", "low", "none" ], "type": "option" }, "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:security:review", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": true, "summary": "Show the combined app security check results.", "enableJsonFlag": false, "descriptionWithMarkdown": "Combines the deterministic results (`deterministic-findings.json`, written by `shopify app security check`) with the recorded agent results (`agent-findings.json`, written by `shopify app security record`) and shows one view of every check: its findings, status and source. Both files are in the results directory, `.shopify/app-security//`. `--client-id` is checked against your Shopify account before any results are read, so it needs you to be logged in.\n\nThe summary shows the scan directories and the scope of the latest scan, and the scope the agent reported. It notes when the agent findings were recorded for a different scope than the latest scan; that doesn't change the exit code.\n\nThe agent results are optional. Use `--check-id` to narrow the review to specific checks, `--verbose` for full reasoning, evidence and suppressed findings, and `--blocking` to exit with code 1 when a check with findings is at or above a severity. With `--json`, the result always includes every finding in full.\n\nReports the number of findings to Shopify as usage telemetry, but not finding details. See [usage reporting](https://shopify.dev/docs/api/shopify-cli#usage-reporting) for details.", "customPluginName": "@shopify/app" }, "app:logs": { "aliases": [], "args": {}, "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" }, "no-input": { "description": "Disable interactive prompts and browser authentication.", "env": "SHOPIFY_FLAG_NO_INPUT", "name": "no-input", "allowNo": false, "type": "boolean" }, "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. May include sensitive data.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "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, "hidden": true, "hiddenAliases": [], "id": "app:logs", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": false, "summary": "App logs were removed in Shopify CLI 5.0.", "enableJsonFlag": false, "customPluginName": "@shopify/app" }, "app:import:channel-config": { "aliases": [], "args": {}, "description": "Imports the Shopify-authored channel spec for your app as a `channel_config` extension.\n\n The generated TOML only includes public `channel_config` fields. Review it, then deploy it with `shopify app deploy`.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `ImportChannelConfigResult` schema.\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"const\": \"success\"\n },\n \"handle\": {\n \"type\": \"string\",\n \"minLength\": 1\n },\n \"filename\": {\n \"type\": \"string\",\n \"minLength\": 1\n },\n \"path\": {\n \"type\": \"string\",\n \"pattern\": \"^(?:\\\\/|[a-zA-Z]:[\\\\\\\\/]|\\\\\\\\\\\\\\\\)\",\n \"description\": \"Absolute path of the written TOML file.\"\n },\n \"toml\": {\n \"type\": \"string\",\n \"description\": \"Native channel_config TOML content, unchanged from the export.\"\n },\n \"warnings\": {\n \"type\": \"array\",\n \"items\": {\n \"$ref\": \"#/definitions/ChannelSpecExportWarning\"\n },\n \"description\": \"Warnings returned with the channel spec export.\"\n }\n },\n \"required\": [\n \"status\",\n \"handle\",\n \"filename\",\n \"path\",\n \"toml\",\n \"warnings\"\n ],\n \"additionalProperties\": false,\n \"title\": \"ImportChannelConfigResult\",\n \"definitions\": {\n \"ChannelSpecExportWarning\": {\n \"type\": \"object\",\n \"properties\": {\n \"code\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"code\",\n \"message\"\n ],\n \"additionalProperties\": false\n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" }, "auth-alias": { "description": "Alias of the Shopify account to use for authentication.", "env": "SHOPIFY_FLAG_AUTH_ALIAS", "name": "auth-alias", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "no-input": { "description": "Disable interactive prompts and browser authentication.", "env": "SHOPIFY_FLAG_NO_INPUT", "name": "no-input", "allowNo": false, "type": "boolean" }, "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. May include sensitive data.", "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" }, "force": { "description": "Overwrite the existing channel spec file without prompting.", "env": "SHOPIFY_FLAG_FORCE", "name": "force", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hidden": true, "hiddenAliases": [], "id": "app:import:channel-config", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": true, "summary": "Import your app's default channel spec as a channel_config extension.", "descriptionWithMarkdown": "Imports the Shopify-authored channel spec for your app as a `channel_config` extension.\n\n The generated TOML only includes public `channel_config` fields. Review it, then deploy it with `shopify app deploy`.", "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).\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `ImportCustomDataDefinitionsResult` schema.\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"const\": \"success\"\n },\n \"storeDomain\": {\n \"type\": [\n \"string\",\n \"null\"\n ],\n \"description\": \"The full myshopify.com domain of the development store, or null when unavailable.\"\n },\n \"metafieldCount\": {\n \"type\": \"integer\",\n \"minimum\": 0,\n \"description\": \"The number of available metafields converted to TOML.\"\n },\n \"metaobjectCount\": {\n \"type\": \"integer\",\n \"minimum\": 0,\n \"description\": \"The number of available metaobjects converted to TOML.\"\n },\n \"toml\": {\n \"type\": \"string\",\n \"description\": \"Suggested native TOML for app-reserved definitions. No file is written.\"\n },\n \"skippedSections\": {\n \"type\": \"array\",\n \"items\": {\n \"anyOf\": [\n {\n \"$ref\": \"#/definitions/SkippedMetafields\"\n },\n {\n \"$ref\": \"#/definitions/SkippedMetaobjects\"\n }\n ]\n },\n \"description\": \"Sections skipped because required access scopes are unavailable. An empty array means all requests were authorized.\"\n }\n },\n \"required\": [\n \"status\",\n \"storeDomain\",\n \"metafieldCount\",\n \"metaobjectCount\",\n \"toml\",\n \"skippedSections\"\n ],\n \"additionalProperties\": false,\n \"title\": \"ImportCustomDataDefinitionsResult\",\n \"definitions\": {\n \"SkippedMetafields\": {\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"const\": \"metafields\"\n },\n \"ownerType\": {\n \"type\": \"string\",\n \"minLength\": 1,\n \"description\": \"The Admin API metafield owner type, such as PRODUCT.\"\n }\n },\n \"required\": [\n \"type\",\n \"ownerType\"\n ],\n \"additionalProperties\": false\n },\n \"SkippedMetaobjects\": {\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"const\": \"metaobjects\"\n }\n },\n \"required\": [\n \"type\"\n ],\n \"additionalProperties\": false\n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" }, "auth-alias": { "description": "Alias of the Shopify account to use for authentication.", "env": "SHOPIFY_FLAG_AUTH_ALIAS", "name": "auth-alias", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "no-input": { "description": "Disable interactive prompts and browser authentication.", "env": "SHOPIFY_FLAG_NO_INPUT", "name": "no-input", "allowNo": false, "type": "boolean" }, "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. May include sensitive data.", "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": 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", "pluginName": "shopify", "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:dashboard-extensions": { "aliases": [], "args": {}, "description": "Import dashboard-managed extensions into your app.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `ImportDashboardExtensionsResult` schema.\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"enum\": [\n \"success\",\n \"partial\",\n \"skipped\",\n \"cancelled\"\n ]\n },\n \"reason\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"enum\": [\n \"no-extensions\",\n \"directory-selection-cancelled\"\n ]\n },\n {\n \"type\": \"null\"\n }\n ]\n },\n \"extensions\": {\n \"type\": \"array\",\n \"items\": {\n \"$ref\": \"#/definitions/ImportedDashboardExtension\"\n },\n \"description\": \"Completed extension imports and kept local directories, in selection order.\"\n },\n \"errors\": {\n \"type\": \"array\",\n \"items\": {\n \"$ref\": \"#/definitions/ExtensionImportFailure\"\n },\n \"description\": \"Failed selected imports or identifier persistence.\"\n },\n \"identifiersUpdated\": {\n \"type\": \"boolean\",\n \"description\": \"Whether the extension identifier persistence step completed.\"\n }\n },\n \"required\": [\n \"status\",\n \"reason\",\n \"extensions\",\n \"errors\",\n \"identifiersUpdated\"\n ],\n \"additionalProperties\": false,\n \"title\": \"ImportDashboardExtensionsResult\",\n \"definitions\": {\n \"ImportedDashboardExtension\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"type\": \"string\",\n \"format\": \"uuid\",\n \"description\": \"The dashboard extension registration UUID, not a Shopify GID.\"\n },\n \"name\": {\n \"type\": \"string\"\n },\n \"type\": {\n \"type\": \"string\",\n \"minLength\": 1,\n \"description\": \"The upstream dashboard extension type.\"\n },\n \"directory\": {\n \"type\": \"string\",\n \"description\": \"The absolute local extension directory.\"\n },\n \"configurationPath\": {\n \"anyOf\": [\n {\n \"$ref\": \"#/definitions/ImportedDashboardExtension/properties/directory\"\n },\n {\n \"type\": \"null\"\n }\n ],\n \"description\": \"The absolute local TOML path, or null when no TOML file exists in a kept directory.\"\n },\n \"changed\": {\n \"type\": \"boolean\",\n \"description\": \"Whether this import wrote the local extension TOML.\"\n }\n },\n \"required\": [\n \"id\",\n \"name\",\n \"type\",\n \"directory\",\n \"configurationPath\",\n \"changed\"\n ],\n \"additionalProperties\": false\n },\n \"ExtensionImportFailure\": {\n \"type\": \"object\",\n \"properties\": {\n \"extensionId\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"format\": \"uuid\"\n },\n {\n \"type\": \"null\"\n }\n ],\n \"description\": \"The registration UUID, or null for identifier persistence.\"\n },\n \"error\": {\n \"$ref\": \"#/definitions/JsonError\"\n }\n },\n \"required\": [\n \"extensionId\",\n \"error\"\n ],\n \"additionalProperties\": false\n },\n \"JsonError\": {\n \"anyOf\": [\n {\n \"$ref\": \"#/definitions/JsonAbortError\"\n },\n {\n \"$ref\": \"#/definitions/JsonBugError\"\n },\n {\n \"$ref\": \"#/definitions/JsonExternalError\"\n }\n ]\n },\n \"JsonErrorCustomSection\": {\n \"type\": \"object\",\n \"properties\": {\n \"title\": {\n \"type\": \"string\"\n },\n \"body\": {\n \"anyOf\": [\n {\n \"type\": \"string\"\n },\n {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n }\n ]\n }\n },\n \"required\": [\n \"body\"\n ],\n \"additionalProperties\": false\n },\n \"JsonAbortError\": {\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"const\": \"abort\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"code\": {\n \"type\": \"string\",\n \"minLength\": 1,\n \"description\": \"A stable error code, included only when known.\"\n },\n \"tryMessage\": {\n \"type\": \"string\"\n },\n \"nextSteps\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n },\n \"customSections\": {\n \"type\": \"array\",\n \"items\": {\n \"$ref\": \"#/definitions/JsonErrorCustomSection\"\n }\n },\n \"details\": {\n \"description\": \"Selected domain details, preserving native API payloads such as GraphQL errors, extensions, and data.\"\n }\n },\n \"required\": [\n \"type\",\n \"message\"\n ],\n \"additionalProperties\": false\n },\n \"JsonBugError\": {\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"const\": \"bug\"\n },\n \"message\": {\n \"$ref\": \"#/definitions/JsonAbortError/properties/message\"\n },\n \"code\": {\n \"$ref\": \"#/definitions/JsonAbortError/properties/code\"\n },\n \"tryMessage\": {\n \"$ref\": \"#/definitions/JsonAbortError/properties/tryMessage\"\n },\n \"nextSteps\": {\n \"$ref\": \"#/definitions/JsonAbortError/properties/nextSteps\"\n },\n \"customSections\": {\n \"$ref\": \"#/definitions/JsonAbortError/properties/customSections\"\n },\n \"details\": {\n \"$ref\": \"#/definitions/JsonAbortError/properties/details\"\n },\n \"stack\": {\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"type\",\n \"message\"\n ],\n \"additionalProperties\": false\n },\n \"JsonExternalError\": {\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"const\": \"external\"\n },\n \"message\": {\n \"$ref\": \"#/definitions/JsonAbortError/properties/message\"\n },\n \"code\": {\n \"$ref\": \"#/definitions/JsonAbortError/properties/code\"\n },\n \"tryMessage\": {\n \"$ref\": \"#/definitions/JsonAbortError/properties/tryMessage\"\n },\n \"nextSteps\": {\n \"$ref\": \"#/definitions/JsonAbortError/properties/nextSteps\"\n },\n \"customSections\": {\n \"$ref\": \"#/definitions/JsonAbortError/properties/customSections\"\n },\n \"details\": {\n \"$ref\": \"#/definitions/JsonAbortError/properties/details\"\n },\n \"command\": {\n \"type\": \"string\"\n },\n \"args\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n },\n \"required\": [\n \"type\",\n \"message\",\n \"command\",\n \"args\"\n ],\n \"additionalProperties\": false\n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" }, "auth-alias": { "description": "Alias of the Shopify account to use for authentication.", "env": "SHOPIFY_FLAG_AUTH_ALIAS", "name": "auth-alias", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "no-input": { "description": "Disable interactive prompts and browser authentication.", "env": "SHOPIFY_FLAG_NO_INPUT", "name": "no-input", "allowNo": false, "type": "boolean" }, "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. May include sensitive data.", "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:import:dashboard-extensions", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": true, "descriptionWithMarkdown": "Import dashboard-managed extensions into your app.", "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).\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `ImportCustomDataDefinitionsResult` schema.\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"const\": \"success\"\n },\n \"storeDomain\": {\n \"type\": [\n \"string\",\n \"null\"\n ],\n \"description\": \"The full myshopify.com domain of the development store, or null when unavailable.\"\n },\n \"metafieldCount\": {\n \"type\": \"integer\",\n \"minimum\": 0,\n \"description\": \"The number of available metafields converted to TOML.\"\n },\n \"metaobjectCount\": {\n \"type\": \"integer\",\n \"minimum\": 0,\n \"description\": \"The number of available metaobjects converted to TOML.\"\n },\n \"toml\": {\n \"type\": \"string\",\n \"description\": \"Suggested native TOML for app-reserved definitions. No file is written.\"\n },\n \"skippedSections\": {\n \"type\": \"array\",\n \"items\": {\n \"anyOf\": [\n {\n \"$ref\": \"#/definitions/SkippedMetafields\"\n },\n {\n \"$ref\": \"#/definitions/SkippedMetaobjects\"\n }\n ]\n },\n \"description\": \"Sections skipped because required access scopes are unavailable. An empty array means all requests were authorized.\"\n }\n },\n \"required\": [\n \"status\",\n \"storeDomain\",\n \"metafieldCount\",\n \"metaobjectCount\",\n \"toml\",\n \"skippedSections\"\n ],\n \"additionalProperties\": false,\n \"title\": \"ImportCustomDataDefinitionsResult\",\n \"definitions\": {\n \"SkippedMetafields\": {\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"const\": \"metafields\"\n },\n \"ownerType\": {\n \"type\": \"string\",\n \"minLength\": 1,\n \"description\": \"The Admin API metafield owner type, such as PRODUCT.\"\n }\n },\n \"required\": [\n \"type\",\n \"ownerType\"\n ],\n \"additionalProperties\": false\n },\n \"SkippedMetaobjects\": {\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"const\": \"metaobjects\"\n }\n },\n \"required\": [\n \"type\"\n ],\n \"additionalProperties\": false\n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" }, "auth-alias": { "description": "Alias of the Shopify account to use for authentication.", "env": "SHOPIFY_FLAG_AUTH_ALIAS", "name": "auth-alias", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "no-input": { "description": "Disable interactive prompts and browser authentication.", "env": "SHOPIFY_FLAG_NO_INPUT", "name": "no-input", "allowNo": false, "type": "boolean" }, "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. May include sensitive data.", "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": 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, "hidden": true, "hiddenAliases": [], "id": "app:import-custom-data-definitions", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "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.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `ImportDashboardExtensionsResult` schema.\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"enum\": [\n \"success\",\n \"partial\",\n \"skipped\",\n \"cancelled\"\n ]\n },\n \"reason\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"enum\": [\n \"no-extensions\",\n \"directory-selection-cancelled\"\n ]\n },\n {\n \"type\": \"null\"\n }\n ]\n },\n \"extensions\": {\n \"type\": \"array\",\n \"items\": {\n \"$ref\": \"#/definitions/ImportedDashboardExtension\"\n },\n \"description\": \"Completed extension imports and kept local directories, in selection order.\"\n },\n \"errors\": {\n \"type\": \"array\",\n \"items\": {\n \"$ref\": \"#/definitions/ExtensionImportFailure\"\n },\n \"description\": \"Failed selected imports or identifier persistence.\"\n },\n \"identifiersUpdated\": {\n \"type\": \"boolean\",\n \"description\": \"Whether the extension identifier persistence step completed.\"\n }\n },\n \"required\": [\n \"status\",\n \"reason\",\n \"extensions\",\n \"errors\",\n \"identifiersUpdated\"\n ],\n \"additionalProperties\": false,\n \"title\": \"ImportDashboardExtensionsResult\",\n \"definitions\": {\n \"ImportedDashboardExtension\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"type\": \"string\",\n \"format\": \"uuid\",\n \"description\": \"The dashboard extension registration UUID, not a Shopify GID.\"\n },\n \"name\": {\n \"type\": \"string\"\n },\n \"type\": {\n \"type\": \"string\",\n \"minLength\": 1,\n \"description\": \"The upstream dashboard extension type.\"\n },\n \"directory\": {\n \"type\": \"string\",\n \"description\": \"The absolute local extension directory.\"\n },\n \"configurationPath\": {\n \"anyOf\": [\n {\n \"$ref\": \"#/definitions/ImportedDashboardExtension/properties/directory\"\n },\n {\n \"type\": \"null\"\n }\n ],\n \"description\": \"The absolute local TOML path, or null when no TOML file exists in a kept directory.\"\n },\n \"changed\": {\n \"type\": \"boolean\",\n \"description\": \"Whether this import wrote the local extension TOML.\"\n }\n },\n \"required\": [\n \"id\",\n \"name\",\n \"type\",\n \"directory\",\n \"configurationPath\",\n \"changed\"\n ],\n \"additionalProperties\": false\n },\n \"ExtensionImportFailure\": {\n \"type\": \"object\",\n \"properties\": {\n \"extensionId\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"format\": \"uuid\"\n },\n {\n \"type\": \"null\"\n }\n ],\n \"description\": \"The registration UUID, or null for identifier persistence.\"\n },\n \"error\": {\n \"$ref\": \"#/definitions/JsonError\"\n }\n },\n \"required\": [\n \"extensionId\",\n \"error\"\n ],\n \"additionalProperties\": false\n },\n \"JsonError\": {\n \"anyOf\": [\n {\n \"$ref\": \"#/definitions/JsonAbortError\"\n },\n {\n \"$ref\": \"#/definitions/JsonBugError\"\n },\n {\n \"$ref\": \"#/definitions/JsonExternalError\"\n }\n ]\n },\n \"JsonErrorCustomSection\": {\n \"type\": \"object\",\n \"properties\": {\n \"title\": {\n \"type\": \"string\"\n },\n \"body\": {\n \"anyOf\": [\n {\n \"type\": \"string\"\n },\n {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n }\n ]\n }\n },\n \"required\": [\n \"body\"\n ],\n \"additionalProperties\": false\n },\n \"JsonAbortError\": {\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"const\": \"abort\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"code\": {\n \"type\": \"string\",\n \"minLength\": 1,\n \"description\": \"A stable error code, included only when known.\"\n },\n \"tryMessage\": {\n \"type\": \"string\"\n },\n \"nextSteps\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n },\n \"customSections\": {\n \"type\": \"array\",\n \"items\": {\n \"$ref\": \"#/definitions/JsonErrorCustomSection\"\n }\n },\n \"details\": {\n \"description\": \"Selected domain details, preserving native API payloads such as GraphQL errors, extensions, and data.\"\n }\n },\n \"required\": [\n \"type\",\n \"message\"\n ],\n \"additionalProperties\": false\n },\n \"JsonBugError\": {\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"const\": \"bug\"\n },\n \"message\": {\n \"$ref\": \"#/definitions/JsonAbortError/properties/message\"\n },\n \"code\": {\n \"$ref\": \"#/definitions/JsonAbortError/properties/code\"\n },\n \"tryMessage\": {\n \"$ref\": \"#/definitions/JsonAbortError/properties/tryMessage\"\n },\n \"nextSteps\": {\n \"$ref\": \"#/definitions/JsonAbortError/properties/nextSteps\"\n },\n \"customSections\": {\n \"$ref\": \"#/definitions/JsonAbortError/properties/customSections\"\n },\n \"details\": {\n \"$ref\": \"#/definitions/JsonAbortError/properties/details\"\n },\n \"stack\": {\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"type\",\n \"message\"\n ],\n \"additionalProperties\": false\n },\n \"JsonExternalError\": {\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"const\": \"external\"\n },\n \"message\": {\n \"$ref\": \"#/definitions/JsonAbortError/properties/message\"\n },\n \"code\": {\n \"$ref\": \"#/definitions/JsonAbortError/properties/code\"\n },\n \"tryMessage\": {\n \"$ref\": \"#/definitions/JsonAbortError/properties/tryMessage\"\n },\n \"nextSteps\": {\n \"$ref\": \"#/definitions/JsonAbortError/properties/nextSteps\"\n },\n \"customSections\": {\n \"$ref\": \"#/definitions/JsonAbortError/properties/customSections\"\n },\n \"details\": {\n \"$ref\": \"#/definitions/JsonAbortError/properties/details\"\n },\n \"command\": {\n \"type\": \"string\"\n },\n \"args\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n },\n \"required\": [\n \"type\",\n \"message\",\n \"command\",\n \"args\"\n ],\n \"additionalProperties\": false\n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" }, "auth-alias": { "description": "Alias of the Shopify account to use for authentication.", "env": "SHOPIFY_FLAG_AUTH_ALIAS", "name": "auth-alias", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "no-input": { "description": "Disable interactive prompts and browser authentication.", "env": "SHOPIFY_FLAG_NO_INPUT", "name": "no-input", "allowNo": false, "type": "boolean" }, "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. May include sensitive data.", "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, "hidden": true, "hiddenAliases": [], "id": "app:import-extensions", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "descriptionWithMarkdown": "Import dashboard-managed extensions into your app.", "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.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `AppInfoResult` schema.\n\n```json\n{\n \"anyOf\": [\n {\n \"$ref\": \"#/definitions/AppInfoWebEnvironment\"\n },\n {\n \"$ref\": \"#/definitions/AppInfo\"\n }\n ],\n \"title\": \"AppInfoResult\",\n \"definitions\": {\n \"AppInfo\": {\n \"type\": \"object\",\n \"properties\": {\n \"remoteApp\": {\n \"$ref\": \"#/definitions/AppInfoRemoteApp\"\n },\n \"account\": {\n \"anyOf\": [\n {\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"const\": \"UserAccount\"\n },\n \"email\": {\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"type\",\n \"email\"\n ],\n \"additionalProperties\": false\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"const\": \"ServiceAccount\"\n },\n \"orgName\": {\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"type\",\n \"orgName\"\n ],\n \"additionalProperties\": false\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"const\": \"UnknownAccount\"\n }\n },\n \"required\": [\n \"type\"\n ],\n \"additionalProperties\": false\n }\n ]\n },\n \"project\": {\n \"$ref\": \"#/definitions/AppInfoProject\"\n },\n \"system\": {\n \"$ref\": \"#/definitions/AppInfoSystem\"\n },\n \"devStoreUrl\": {\n \"type\": \"string\"\n },\n \"name\": {\n \"type\": \"string\"\n },\n \"idEnvironmentVariableName\": {\n \"type\": \"string\",\n \"const\": \"SHOPIFY_API_KEY\"\n },\n \"directory\": {\n \"type\": \"string\"\n },\n \"configPath\": {\n \"type\": \"string\"\n },\n \"configuration\": {\n \"type\": \"object\",\n \"additionalProperties\": {}\n },\n \"webs\": {\n \"type\": \"array\",\n \"items\": {\n \"$ref\": \"#/definitions/AppInfoWeb\"\n }\n },\n \"dotenv\": {\n \"type\": \"object\",\n \"properties\": {\n \"path\": {\n \"type\": \"string\"\n },\n \"variables\": {\n \"type\": \"object\",\n \"additionalProperties\": {\n \"type\": \"string\"\n }\n }\n },\n \"required\": [\n \"path\",\n \"variables\"\n ],\n \"additionalProperties\": true\n },\n \"errors\": {\n \"type\": \"object\",\n \"properties\": {\n \"errors\": {\n \"type\": \"array\",\n \"items\": {\n \"$ref\": \"#/definitions/AppInfoConfigurationError\"\n }\n }\n },\n \"required\": [\n \"errors\"\n ],\n \"additionalProperties\": true\n },\n \"specifications\": {\n \"type\": \"array\",\n \"items\": {\n \"$ref\": \"#/definitions/AppInfoSpecification\"\n }\n },\n \"remoteFlags\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n },\n \"realExtensions\": {\n \"type\": \"array\",\n \"items\": {\n \"$ref\": \"#/definitions/AppInfoExtension\"\n }\n },\n \"devApplicationURLs\": {\n \"$ref\": \"#/definitions/AppInfo/properties/configuration\"\n },\n \"_hiddenConfig\": {\n \"$ref\": \"#/definitions/AppInfo/properties/configuration\"\n },\n \"packageManager\": {\n \"type\": \"string\"\n },\n \"nodeDependencies\": {\n \"type\": \"object\",\n \"additionalProperties\": {\n \"type\": \"string\"\n }\n },\n \"usesWorkspaces\": {\n \"type\": \"boolean\"\n },\n \"organization\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"type\": \"string\"\n },\n \"businessName\": {\n \"type\": \"string\"\n },\n \"source\": {\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"id\",\n \"businessName\",\n \"source\"\n ],\n \"additionalProperties\": false\n },\n \"allExtensions\": {\n \"type\": \"array\",\n \"items\": {\n \"$ref\": \"#/definitions/AppInfoExtension\"\n }\n }\n },\n \"required\": [\n \"remoteApp\",\n \"account\",\n \"project\",\n \"system\",\n \"name\",\n \"idEnvironmentVariableName\",\n \"directory\",\n \"configPath\",\n \"configuration\",\n \"webs\",\n \"errors\",\n \"specifications\",\n \"remoteFlags\",\n \"realExtensions\",\n \"_hiddenConfig\",\n \"packageManager\",\n \"nodeDependencies\",\n \"usesWorkspaces\",\n \"organization\",\n \"allExtensions\"\n ],\n \"additionalProperties\": true\n },\n \"AppInfoRemoteApp\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"type\": \"string\"\n },\n \"title\": {\n \"type\": \"string\"\n },\n \"apiKey\": {\n \"type\": \"string\"\n },\n \"organizationId\": {\n \"type\": \"string\"\n },\n \"appType\": {\n \"type\": \"string\"\n },\n \"newApp\": {\n \"type\": \"boolean\"\n },\n \"grantedScopes\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n },\n \"developmentStorePreviewEnabled\": {\n \"type\": \"boolean\"\n },\n \"applicationUrl\": {\n \"type\": \"string\"\n },\n \"redirectUrlWhitelist\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n },\n \"requestedAccessScopes\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n },\n \"webhookApiVersion\": {\n \"type\": \"string\"\n },\n \"embedded\": {\n \"type\": \"boolean\"\n },\n \"posEmbedded\": {\n \"type\": \"boolean\"\n },\n \"preferencesUrl\": {\n \"type\": \"string\"\n },\n \"gdprWebhooks\": {\n \"type\": \"object\",\n \"properties\": {\n \"customerDeletionUrl\": {\n \"type\": \"string\"\n },\n \"customerDataRequestUrl\": {\n \"type\": \"string\"\n },\n \"shopDeletionUrl\": {\n \"type\": \"string\"\n }\n },\n \"additionalProperties\": false\n },\n \"appProxy\": {\n \"type\": \"object\",\n \"properties\": {\n \"subPath\": {\n \"type\": \"string\"\n },\n \"subPathPrefix\": {\n \"type\": \"string\"\n },\n \"url\": {\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"subPath\",\n \"subPathPrefix\",\n \"url\"\n ],\n \"additionalProperties\": false\n },\n \"configuration\": {\n \"$ref\": \"#/definitions/AppInfo/properties/configuration\"\n },\n \"flags\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n },\n \"required\": [\n \"id\",\n \"title\",\n \"apiKey\",\n \"organizationId\",\n \"grantedScopes\",\n \"flags\"\n ],\n \"additionalProperties\": false\n },\n \"AppInfoProject\": {\n \"type\": \"object\",\n \"properties\": {\n \"directory\": {\n \"type\": \"string\"\n },\n \"appConfigFiles\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"path\": {\n \"type\": \"string\"\n },\n \"content\": {\n \"$ref\": \"#/definitions/AppInfo/properties/configuration\"\n },\n \"errors\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"path\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"path\",\n \"message\"\n ],\n \"additionalProperties\": false\n }\n }\n },\n \"required\": [\n \"path\",\n \"content\",\n \"errors\"\n ],\n \"additionalProperties\": false\n }\n },\n \"extensionConfigFiles\": {\n \"type\": \"array\",\n \"items\": {\n \"$ref\": \"#/definitions/AppInfoProject/properties/appConfigFiles/items\"\n }\n },\n \"webConfigFiles\": {\n \"type\": \"array\",\n \"items\": {\n \"$ref\": \"#/definitions/AppInfoProject/properties/appConfigFiles/items\"\n }\n },\n \"dotenvFiles\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"path\": {\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"path\"\n ],\n \"additionalProperties\": false\n }\n },\n \"errors\": {\n \"type\": \"array\",\n \"items\": {\n \"$ref\": \"#/definitions/AppInfoProject/properties/appConfigFiles/items/properties/errors/items\"\n }\n }\n },\n \"required\": [\n \"directory\",\n \"appConfigFiles\",\n \"extensionConfigFiles\",\n \"webConfigFiles\",\n \"dotenvFiles\",\n \"errors\"\n ],\n \"additionalProperties\": false\n },\n \"AppInfoSystem\": {\n \"type\": \"object\",\n \"properties\": {\n \"cliVersion\": {\n \"type\": \"string\"\n },\n \"nodeVersion\": {\n \"type\": \"string\"\n },\n \"platform\": {\n \"type\": \"string\"\n },\n \"arch\": {\n \"type\": \"string\"\n },\n \"shell\": {\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"cliVersion\",\n \"nodeVersion\",\n \"platform\",\n \"arch\"\n ],\n \"additionalProperties\": false\n },\n \"AppInfoWebEnvironment\": {\n \"type\": \"object\",\n \"properties\": {\n \"SHOPIFY_API_KEY\": {\n \"type\": \"string\"\n },\n \"SHOPIFY_API_SECRET\": {\n \"type\": \"string\"\n },\n \"SCOPES\": {\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"SHOPIFY_API_KEY\",\n \"SCOPES\"\n ],\n \"additionalProperties\": false\n },\n \"AppInfoExtension\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"type\": {\n \"type\": \"string\"\n },\n \"externalType\": {\n \"type\": \"string\"\n },\n \"humanName\": {\n \"type\": \"string\"\n },\n \"surface\": {\n \"type\": \"string\"\n },\n \"features\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n },\n \"dependency\": {\n \"type\": \"string\"\n },\n \"entrySourceFilePath\": {\n \"type\": \"string\"\n },\n \"devUUID\": {\n \"type\": \"string\"\n },\n \"localIdentifier\": {\n \"type\": \"string\"\n },\n \"idEnvironmentVariableName\": {\n \"type\": \"string\"\n },\n \"directory\": {\n \"type\": \"string\"\n },\n \"configuration\": {\n \"$ref\": \"#/definitions/AppInfo/properties/configuration\"\n },\n \"configurationPath\": {\n \"type\": \"string\"\n },\n \"outputPath\": {\n \"type\": \"string\"\n },\n \"handle\": {\n \"type\": \"string\"\n },\n \"specification\": {\n \"$ref\": \"#/definitions/AppInfoSpecification\"\n },\n \"uid\": {\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"name\",\n \"type\",\n \"externalType\",\n \"humanName\",\n \"surface\",\n \"features\",\n \"entrySourceFilePath\",\n \"devUUID\",\n \"localIdentifier\",\n \"idEnvironmentVariableName\",\n \"directory\",\n \"configuration\",\n \"configurationPath\",\n \"outputPath\",\n \"handle\",\n \"specification\",\n \"uid\"\n ],\n \"additionalProperties\": true\n },\n \"AppInfoSpecification\": {\n \"type\": \"object\",\n \"properties\": {\n \"identifier\": {\n \"type\": \"string\"\n },\n \"externalIdentifier\": {\n \"type\": \"string\"\n },\n \"externalName\": {\n \"type\": \"string\"\n },\n \"group\": {\n \"type\": \"string\"\n },\n \"additionalIdentifiers\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n },\n \"partnersWebIdentifier\": {\n \"type\": \"string\"\n },\n \"surface\": {\n \"type\": \"string\"\n },\n \"registrationLimit\": {\n \"type\": \"number\"\n },\n \"experience\": {\n \"type\": \"string\",\n \"enum\": [\n \"extension\",\n \"configuration\"\n ]\n },\n \"uidStrategy\": {\n \"type\": \"string\",\n \"enum\": [\n \"single\",\n \"dynamic\",\n \"uuid\"\n ]\n },\n \"dependency\": {\n \"type\": \"string\"\n },\n \"graphQLType\": {\n \"type\": \"string\"\n },\n \"clientSteps\": {\n \"$ref\": \"#/definitions/AppInfoClientSteps\"\n },\n \"loadedRemoteSpecs\": {\n \"type\": \"boolean\"\n }\n },\n \"required\": [\n \"identifier\",\n \"externalIdentifier\",\n \"externalName\",\n \"additionalIdentifiers\",\n \"partnersWebIdentifier\",\n \"surface\",\n \"registrationLimit\",\n \"experience\",\n \"uidStrategy\"\n ],\n \"additionalProperties\": false\n },\n \"AppInfoClientSteps\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"lifecycle\": {\n \"type\": \"string\",\n \"const\": \"deploy\"\n },\n \"steps\": {\n \"type\": \"array\",\n \"items\": {\n \"anyOf\": [\n {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"type\": \"string\"\n },\n \"name\": {\n \"type\": \"string\"\n },\n \"continueOnError\": {\n \"type\": \"boolean\"\n },\n \"type\": {\n \"type\": \"string\",\n \"const\": \"include_assets\"\n },\n \"config\": {\n \"type\": \"object\",\n \"properties\": {\n \"generatesAssetsManifest\": {\n \"type\": \"boolean\"\n },\n \"inclusions\": {\n \"type\": \"array\",\n \"items\": {\n \"anyOf\": [\n {\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"const\": \"pattern\"\n },\n \"baseDir\": {\n \"type\": \"string\"\n },\n \"include\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n },\n \"ignore\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n },\n \"destination\": {\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"type\"\n ],\n \"additionalProperties\": false\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"const\": \"static\"\n },\n \"source\": {\n \"type\": \"string\"\n },\n \"destination\": {\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"type\",\n \"source\"\n ],\n \"additionalProperties\": false\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"const\": \"configKey\"\n },\n \"key\": {\n \"type\": \"string\"\n },\n \"destination\": {\n \"type\": \"string\"\n },\n \"anchor\": {\n \"type\": \"string\"\n },\n \"groupBy\": {\n \"type\": \"string\"\n },\n \"preserveFilePaths\": {\n \"type\": \"boolean\"\n }\n },\n \"required\": [\n \"type\",\n \"key\"\n ],\n \"additionalProperties\": false\n }\n ]\n }\n }\n },\n \"required\": [\n \"inclusions\"\n ],\n \"additionalProperties\": false\n }\n },\n \"required\": [\n \"id\",\n \"name\",\n \"type\",\n \"config\"\n ],\n \"additionalProperties\": false\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"$ref\": \"#/definitions/AppInfoClientSteps/items/properties/steps/items/anyOf/0/properties/id\"\n },\n \"name\": {\n \"$ref\": \"#/definitions/AppInfoClientSteps/items/properties/steps/items/anyOf/0/properties/name\"\n },\n \"continueOnError\": {\n \"$ref\": \"#/definitions/AppInfoClientSteps/items/properties/steps/items/anyOf/0/properties/continueOnError\"\n },\n \"type\": {\n \"type\": \"string\",\n \"const\": \"bundle_ui\"\n },\n \"config\": {\n \"type\": \"object\",\n \"properties\": {\n \"generatesAssetsManifest\": {\n \"type\": \"boolean\"\n },\n \"bundleFolder\": {\n \"type\": \"string\"\n }\n },\n \"additionalProperties\": false\n }\n },\n \"required\": [\n \"id\",\n \"name\",\n \"type\"\n ],\n \"additionalProperties\": false\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"$ref\": \"#/definitions/AppInfoClientSteps/items/properties/steps/items/anyOf/0/properties/id\"\n },\n \"name\": {\n \"$ref\": \"#/definitions/AppInfoClientSteps/items/properties/steps/items/anyOf/0/properties/name\"\n },\n \"continueOnError\": {\n \"$ref\": \"#/definitions/AppInfoClientSteps/items/properties/steps/items/anyOf/0/properties/continueOnError\"\n },\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"build_theme\",\n \"bundle_theme\",\n \"build_function\",\n \"create_tax_stub\"\n ]\n },\n \"config\": {\n \"type\": \"object\",\n \"additionalProperties\": {\n \"not\": {}\n }\n }\n },\n \"required\": [\n \"id\",\n \"name\",\n \"type\"\n ],\n \"additionalProperties\": false\n }\n ]\n }\n }\n },\n \"required\": [\n \"lifecycle\",\n \"steps\"\n ],\n \"additionalProperties\": false\n }\n },\n \"AppInfoWeb\": {\n \"type\": \"object\",\n \"properties\": {\n \"directory\": {\n \"type\": \"string\"\n },\n \"configuration\": {\n \"$ref\": \"#/definitions/AppInfo/properties/configuration\"\n }\n },\n \"required\": [\n \"directory\"\n ],\n \"additionalProperties\": true\n },\n \"AppInfoConfigurationError\": {\n \"type\": \"object\",\n \"properties\": {\n \"file\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"file\",\n \"message\"\n ],\n \"additionalProperties\": true\n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" }, "auth-alias": { "description": "Alias of the Shopify account to use for authentication.", "env": "SHOPIFY_FLAG_AUTH_ALIAS", "name": "auth-alias", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "no-input": { "description": "Disable interactive prompts and browser authentication.", "env": "SHOPIFY_FLAG_NO_INPUT", "name": "no-input", "allowNo": false, "type": "boolean" }, "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. May include sensitive data.", "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", "pluginName": "shopify", "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": {}, "description": "Use `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `AppInitResult` schema.\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"const\": \"success\"\n },\n \"app\": {\n \"$ref\": \"#/definitions/InitializedApp\"\n },\n \"packageManager\": {\n \"type\": \"string\",\n \"enum\": [\n \"npm\",\n \"yarn\",\n \"pnpm\",\n \"bun\"\n ]\n },\n \"template\": {\n \"type\": \"string\",\n \"format\": \"uri\",\n \"description\": \"The selected GitHub template reference, including its branch and subpath.\"\n }\n },\n \"required\": [\n \"status\",\n \"app\",\n \"packageManager\",\n \"template\"\n ],\n \"additionalProperties\": false,\n \"title\": \"AppInitResult\",\n \"definitions\": {\n \"InitializedApp\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"type\": \"string\",\n \"pattern\": \"^\\\\d+$\",\n \"description\": \"The decimal App ID, not a Shopify GID.\"\n },\n \"name\": {\n \"type\": \"string\",\n \"minLength\": 1,\n \"description\": \"The name of the linked remote app.\"\n },\n \"clientId\": {\n \"type\": \"string\",\n \"minLength\": 1,\n \"description\": \"The client ID of the linked remote app.\"\n },\n \"organizationId\": {\n \"type\": \"string\",\n \"pattern\": \"^\\\\d+$\",\n \"description\": \"The decimal organization ID, not a Shopify GID.\"\n },\n \"directory\": {\n \"type\": \"string\",\n \"pattern\": \"^(?:\\\\/|[A-Za-z]:[\\\\\\\\/]|\\\\\\\\\\\\\\\\)\",\n \"description\": \"The absolute filesystem path of the created app project.\"\n },\n \"configurationPath\": {\n \"type\": \"string\",\n \"pattern\": \"^(?:\\\\/|[A-Za-z]:[\\\\\\\\/]|\\\\\\\\\\\\\\\\)\",\n \"description\": \"The absolute filesystem path of the linked app configuration.\"\n }\n },\n \"required\": [\n \"id\",\n \"name\",\n \"clientId\",\n \"organizationId\",\n \"directory\",\n \"configurationPath\"\n ],\n \"additionalProperties\": false\n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "examples": [ "<%= config.bin %> <%= command.id %> --name my-app --organization-id 123 --template reactRouter --flavor typescript", "<%= config.bin %> <%= command.id %> --client-id 123 --template none" ], "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" }, "auth-alias": { "description": "Alias of the Shopify account to use for authentication.", "env": "SHOPIFY_FLAG_AUTH_ALIAS", "name": "auth-alias", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "no-input": { "description": "Disable interactive prompts and browser authentication.", "env": "SHOPIFY_FLAG_NO_INPUT", "name": "no-input", "allowNo": false, "type": "boolean" }, "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. May include sensitive data.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "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" }, "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. Required in non-interactive environments unless --client-id is provided.", "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-copy", "hasDynamicHelp": false, "multiple": false, "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]. Required if non interactive.", "env": "SHOPIFY_FLAG_TEMPLATE", "name": "template", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "flavor": { "description": "Which flavor of the given template to use. Required in non-interactive environments when the selected template offers multiple flavors.", "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. In non-interactive environments, provide this flag or both --name and --organization-id.", "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/. Required in non-interactive environments unless --client-id is provided.", "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", "pluginName": "shopify", "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.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `AppConfigValidateResult` schema.\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"path\": {\n \"type\": \"string\"\n },\n \"valid\": {\n \"type\": \"boolean\"\n },\n \"issues\": {\n \"type\": \"array\",\n \"items\": {\n \"$ref\": \"#/definitions/ValidationIssue\"\n }\n }\n },\n \"required\": [\n \"path\",\n \"valid\",\n \"issues\"\n ],\n \"additionalProperties\": false,\n \"title\": \"AppConfigValidateResult\",\n \"definitions\": {\n \"ValidationIssue\": {\n \"type\": \"object\",\n \"properties\": {\n \"filePath\": {\n \"anyOf\": [\n {\n \"type\": \"string\"\n },\n {\n \"type\": \"null\"\n }\n ]\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"fieldPath\": {\n \"anyOf\": [\n {\n \"type\": \"array\",\n \"items\": {\n \"anyOf\": [\n {\n \"type\": \"string\"\n },\n {\n \"type\": \"integer\",\n \"minimum\": 0\n }\n ]\n }\n },\n {\n \"type\": \"null\"\n }\n ]\n },\n \"code\": {\n \"type\": [\n \"string\",\n \"null\"\n ],\n \"description\": \"The upstream validation code, or null when unavailable.\"\n }\n },\n \"required\": [\n \"filePath\",\n \"message\",\n \"fieldPath\",\n \"code\"\n ],\n \"additionalProperties\": false\n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" }, "auth-alias": { "description": "Alias of the Shopify account to use for authentication.", "env": "SHOPIFY_FLAG_AUTH_ALIAS", "name": "auth-alias", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "no-input": { "description": "Disable interactive prompts and browser authentication.", "env": "SHOPIFY_FLAG_NO_INPUT", "name": "no-input", "allowNo": false, "type": "boolean" }, "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. May include sensitive data.", "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", "pluginName": "shopify", "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.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `AppReleaseResult` schema.\n\n```json\n{\n \"anyOf\": [\n {\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"const\": \"success\"\n },\n \"app\": {\n \"$ref\": \"#/definitions/App\"\n },\n \"release\": {\n \"$ref\": \"#/definitions/AppRelease\"\n }\n },\n \"required\": [\n \"status\",\n \"app\",\n \"release\"\n ],\n \"additionalProperties\": false\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"const\": \"cancelled\"\n }\n },\n \"required\": [\n \"status\"\n ],\n \"additionalProperties\": false\n }\n ],\n \"title\": \"AppReleaseResult\",\n \"definitions\": {\n \"App\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"clientId\": {\n \"type\": \"string\",\n \"minLength\": 1,\n \"description\": \"The client ID of the app receiving the release.\"\n }\n },\n \"required\": [\n \"name\",\n \"clientId\"\n ],\n \"additionalProperties\": false\n },\n \"AppRelease\": {\n \"type\": \"object\",\n \"properties\": {\n \"version\": {\n \"$ref\": \"#/definitions/AppReleaseVersion\"\n }\n },\n \"required\": [\n \"version\"\n ],\n \"additionalProperties\": false\n },\n \"AppReleaseVersion\": {\n \"type\": \"object\",\n \"properties\": {\n \"gid\": {\n \"type\": \"string\",\n \"pattern\": \"^gid:\\\\/\\\\/shopify\\\\/Version\\\\/\\\\d+$\",\n \"description\": \"The Shopify app version GID.\"\n },\n \"name\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"minLength\": 1\n },\n {\n \"type\": \"null\"\n }\n ],\n \"description\": \"The version tag, or null when no tag is available.\"\n },\n \"message\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"minLength\": 1\n },\n {\n \"type\": \"null\"\n }\n ],\n \"description\": \"The version message, or null when no message is available.\"\n },\n \"url\": {\n \"type\": \"string\",\n \"format\": \"uri\",\n \"description\": \"The Developer Dashboard URL for this version.\"\n }\n },\n \"required\": [\n \"gid\",\n \"name\",\n \"message\",\n \"url\"\n ],\n \"additionalProperties\": false\n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" }, "auth-alias": { "description": "Alias of the Shopify account to use for authentication.", "env": "SHOPIFY_FLAG_AUTH_ALIAS", "name": "auth-alias", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "no-input": { "description": "Disable interactive prompts and browser authentication.", "env": "SHOPIFY_FLAG_NO_INPUT", "name": "no-input", "allowNo": false, "type": "boolean" }, "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. May include sensitive data.", "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" }, "allow-updates": { "description": "Allows adding and updating extensions and configuration without requiring user confirmation. Recommended option for CI/CD environments. Required in non-interactive environments unless --allow-deletes is provided.", "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. Required in non-interactive environments unless --allow-updates is provided.", "env": "SHOPIFY_FLAG_ALLOW_DELETES", "hidden": false, "name": "allow-deletes", "allowNo": false, "type": "boolean" }, "version": { "description": "The name of the app version to release.", "env": "SHOPIFY_FLAG_VERSION", "hidden": false, "name": "version", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "app:release", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": true, "summary": "Release an app version.", "usage": "app release --version ", "descriptionWithMarkdown": "Releases an existing app version. Pass the name of the version that you want to release using the `--version` flag.", "customPluginName": "@shopify/app" }, "app:subscription-migrations:cancel": { "aliases": [], "args": {}, "description": "Cancels app subscription migration operations.\n\nCanceling stops additional unprocessed shops, but does not undo shops that have already been scheduled or migrated. Use `unschedule` for reversible schedules.\n\nRepeat `--id` to cancel every operation GID returned by a multi-batch submission. Use `--json` to output the resulting operation states and per-shop results as structured JSON.\n\nRun the command from an app project. By default, it uses the Client ID from the active app configuration. Use `--path` to select an app directory or `--config` to select a configuration. Pass `--client-id` to select a different app within the project. Use `--reset` to relink the app.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `MigrationCancellationResult` schema.\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"enum\": [\n \"success\",\n \"partial\"\n ]\n },\n \"operations\": {\n \"type\": \"array\",\n \"items\": {\n \"$ref\": \"#/definitions/MigrationCancellationOutcome\"\n }\n }\n },\n \"required\": [\n \"status\",\n \"operations\"\n ],\n \"additionalProperties\": false,\n \"title\": \"MigrationCancellationResult\",\n \"definitions\": {\n \"MigrationCancellationOutcome\": {\n \"anyOf\": [\n {\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"const\": \"success\"\n },\n \"operationGid\": {\n \"type\": \"string\",\n \"pattern\": \"^gid:\\\\/\\\\/shopify\\\\/AppSubscriptionMigrationOperation\\\\/[^/]+$\",\n \"description\": \"The Shopify AppSubscriptionMigrationOperation GID.\"\n },\n \"operation\": {\n \"$ref\": \"#/definitions/MigrationOperation\"\n }\n },\n \"required\": [\n \"status\",\n \"operationGid\",\n \"operation\"\n ],\n \"additionalProperties\": false\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"const\": \"failed\"\n },\n \"operationGid\": {\n \"$ref\": \"#/definitions/MigrationCancellationOutcome/anyOf/0/properties/operationGid\"\n },\n \"operation\": {\n \"anyOf\": [\n {\n \"$ref\": \"#/definitions/MigrationOperation\"\n },\n {\n \"type\": \"null\"\n }\n ]\n },\n \"error\": {\n \"anyOf\": [\n {\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"const\": \"abort\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"code\": {\n \"type\": \"string\",\n \"minLength\": 1,\n \"description\": \"A stable error code, included only when known.\"\n },\n \"tryMessage\": {\n \"type\": \"string\"\n },\n \"nextSteps\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n },\n \"customSections\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"title\": {\n \"type\": \"string\"\n },\n \"body\": {\n \"anyOf\": [\n {\n \"type\": \"string\"\n },\n {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n }\n ]\n }\n },\n \"required\": [\n \"body\"\n ],\n \"additionalProperties\": false\n }\n },\n \"details\": {\n \"type\": \"object\",\n \"properties\": {\n \"userErrors\": {\n \"type\": \"array\",\n \"items\": {\n \"$ref\": \"#/definitions/MigrationUserError\"\n }\n }\n },\n \"required\": [\n \"userErrors\"\n ],\n \"additionalProperties\": false\n }\n },\n \"required\": [\n \"type\",\n \"message\",\n \"details\"\n ],\n \"additionalProperties\": false\n },\n {\n \"anyOf\": [\n {\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"$ref\": \"#/definitions/MigrationCancellationOutcome/anyOf/1/properties/error/anyOf/0/properties/type\"\n },\n \"message\": {\n \"$ref\": \"#/definitions/MigrationCancellationOutcome/anyOf/1/properties/error/anyOf/0/properties/message\"\n },\n \"code\": {\n \"$ref\": \"#/definitions/MigrationCancellationOutcome/anyOf/1/properties/error/anyOf/0/properties/code\"\n },\n \"tryMessage\": {\n \"$ref\": \"#/definitions/MigrationCancellationOutcome/anyOf/1/properties/error/anyOf/0/properties/tryMessage\"\n },\n \"nextSteps\": {\n \"$ref\": \"#/definitions/MigrationCancellationOutcome/anyOf/1/properties/error/anyOf/0/properties/nextSteps\"\n },\n \"customSections\": {\n \"$ref\": \"#/definitions/MigrationCancellationOutcome/anyOf/1/properties/error/anyOf/0/properties/customSections\"\n },\n \"details\": {\n \"description\": \"Selected domain details, preserving native API payloads such as GraphQL errors, extensions, and data.\"\n }\n },\n \"required\": [\n \"type\",\n \"message\"\n ],\n \"additionalProperties\": false\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"const\": \"bug\"\n },\n \"message\": {\n \"$ref\": \"#/definitions/MigrationCancellationOutcome/anyOf/1/properties/error/anyOf/0/properties/message\"\n },\n \"code\": {\n \"$ref\": \"#/definitions/MigrationCancellationOutcome/anyOf/1/properties/error/anyOf/0/properties/code\"\n },\n \"tryMessage\": {\n \"$ref\": \"#/definitions/MigrationCancellationOutcome/anyOf/1/properties/error/anyOf/0/properties/tryMessage\"\n },\n \"nextSteps\": {\n \"$ref\": \"#/definitions/MigrationCancellationOutcome/anyOf/1/properties/error/anyOf/0/properties/nextSteps\"\n },\n \"customSections\": {\n \"$ref\": \"#/definitions/MigrationCancellationOutcome/anyOf/1/properties/error/anyOf/0/properties/customSections\"\n },\n \"details\": {\n \"$ref\": \"#/definitions/MigrationCancellationOutcome/anyOf/1/properties/error/anyOf/1/anyOf/0/properties/details\"\n },\n \"stack\": {\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"type\",\n \"message\"\n ],\n \"additionalProperties\": false\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"const\": \"external\"\n },\n \"message\": {\n \"$ref\": \"#/definitions/MigrationCancellationOutcome/anyOf/1/properties/error/anyOf/0/properties/message\"\n },\n \"code\": {\n \"$ref\": \"#/definitions/MigrationCancellationOutcome/anyOf/1/properties/error/anyOf/0/properties/code\"\n },\n \"tryMessage\": {\n \"$ref\": \"#/definitions/MigrationCancellationOutcome/anyOf/1/properties/error/anyOf/0/properties/tryMessage\"\n },\n \"nextSteps\": {\n \"$ref\": \"#/definitions/MigrationCancellationOutcome/anyOf/1/properties/error/anyOf/0/properties/nextSteps\"\n },\n \"customSections\": {\n \"$ref\": \"#/definitions/MigrationCancellationOutcome/anyOf/1/properties/error/anyOf/0/properties/customSections\"\n },\n \"details\": {\n \"$ref\": \"#/definitions/MigrationCancellationOutcome/anyOf/1/properties/error/anyOf/1/anyOf/0/properties/details\"\n },\n \"command\": {\n \"type\": \"string\"\n },\n \"args\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n },\n \"required\": [\n \"type\",\n \"message\",\n \"command\",\n \"args\"\n ],\n \"additionalProperties\": false\n }\n ]\n }\n ]\n }\n },\n \"required\": [\n \"status\",\n \"operationGid\",\n \"operation\",\n \"error\"\n ],\n \"additionalProperties\": false\n }\n ]\n },\n \"MigrationOperation\": {\n \"type\": \"object\",\n \"properties\": {\n \"gid\": {\n \"$ref\": \"#/definitions/MigrationCancellationOutcome/anyOf/0/properties/operationGid\"\n },\n \"status\": {\n \"type\": \"string\",\n \"minLength\": 1,\n \"description\": \"Upstream status: RUNNING, COMPLETED, FAILED, or CANCELED.\"\n },\n \"total\": {\n \"type\": \"integer\",\n \"minimum\": 0\n },\n \"results\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"shopGid\": {\n \"type\": \"string\",\n \"pattern\": \"^gid:\\\\/\\\\/shopify\\\\/Shop\\\\/\\\\d+$\",\n \"description\": \"The Shopify Shop GID.\"\n },\n \"code\": {\n \"type\": \"string\",\n \"minLength\": 1,\n \"description\": \"The upstream per-shop migration result code.\"\n }\n },\n \"required\": [\n \"shopGid\",\n \"code\"\n ],\n \"additionalProperties\": false\n }\n }\n },\n \"required\": [\n \"gid\",\n \"status\",\n \"total\",\n \"results\"\n ],\n \"additionalProperties\": false\n },\n \"MigrationUserError\": {\n \"type\": \"object\",\n \"properties\": {\n \"message\": {\n \"type\": \"string\"\n },\n \"fieldPath\": {\n \"anyOf\": [\n {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n },\n {\n \"type\": \"null\"\n }\n ]\n }\n },\n \"required\": [\n \"message\",\n \"fieldPath\"\n ],\n \"additionalProperties\": false\n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "examples": [ "<%= config.bin %> <%= command.id %> --id ", "<%= config.bin %> <%= command.id %> --path ../my-app --config staging --id --id ", "<%= config.bin %> <%= command.id %> --client-id --id --json" ], "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" }, "auth-alias": { "description": "Alias of the Shopify account to use for authentication.", "env": "SHOPIFY_FLAG_AUTH_ALIAS", "name": "auth-alias", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "no-input": { "description": "Disable interactive prompts and browser authentication.", "env": "SHOPIFY_FLAG_NO_INPUT", "name": "no-input", "allowNo": false, "type": "boolean" }, "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. May include sensitive data.", "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" }, "id": { "description": "The app subscription migration operation ID. Can be specified multiple times.", "env": "SHOPIFY_FLAG_ID", "name": "id", "required": true, "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "app:subscription-migrations:cancel", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": true, "summary": "Cancels app subscription migration operations.", "descriptionWithMarkdown": "Cancels app subscription migration operations.\n\nCanceling stops additional unprocessed shops, but does not undo shops that have already been scheduled or migrated. Use `unschedule` for reversible schedules.\n\nRepeat `--id` to cancel every operation GID returned by a multi-batch submission. Use `--json` to output the resulting operation states and per-shop results as structured JSON.\n\nRun the command from an app project. By default, it uses the Client ID from the active app configuration. Use `--path` to select an app directory or `--config` to select a configuration. Pass `--client-id` to select a different app within the project. Use `--reset` to relink the app.", "customPluginName": "@shopify/app" }, "app:subscription-migrations:list": { "aliases": [], "args": {}, "description": "Lists every app subscription eligible for migration.\n\nBy default, the command writes CSV to stdout, streaming each page of results as it arrives. If a later page fails, the rows already written remain valid CSV. Use `--json` to fetch all pages first and then write a single JSON envelope to stdout. Use shell redirection to save either format, for example `shopify app subscription-migrations list > subscriptions.csv` or `shopify app subscription-migrations list --json > subscriptions.json`.\n\nUse `--status` to filter subscriptions by migration status. Supported values are `UNSCHEDULED`, `SCHEDULED`, and `MIGRATED`.\n\nRun the command from an app project. By default, it uses the Client ID from the active app configuration. Use `--path` to select an app directory or `--config` to select a configuration. Pass `--client-id` to select a different app within the project. Use `--reset` to relink the app.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `MigrationListResult` schema.\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"subscriptions\": {\n \"type\": \"array\",\n \"items\": {\n \"$ref\": \"#/definitions/MigratableSubscription\"\n },\n \"description\": \"The complete list across every fetched page.\"\n }\n },\n \"required\": [\n \"subscriptions\"\n ],\n \"additionalProperties\": false,\n \"title\": \"MigrationListResult\",\n \"definitions\": {\n \"MigratableSubscription\": {\n \"type\": \"object\",\n \"properties\": {\n \"shopGid\": {\n \"type\": \"string\",\n \"pattern\": \"^gid:\\\\/\\\\/shopify\\\\/Shop\\\\/\\\\d+$\",\n \"description\": \"The Shopify Shop GID.\"\n },\n \"status\": {\n \"type\": \"string\",\n \"description\": \"Known values: UNSCHEDULED, SCHEDULED, MIGRATED.\"\n },\n \"manualSubscriptionName\": {\n \"type\": [\n \"string\",\n \"null\"\n ]\n },\n \"manualSubscriptionPrice\": {\n \"anyOf\": [\n {\n \"$ref\": \"#/definitions/MigratableSubscriptionPrice\"\n },\n {\n \"type\": \"null\"\n }\n ]\n },\n \"manualSubscriptionInterval\": {\n \"type\": \"string\",\n \"description\": \"Known values: EVERY_30_DAYS, ANNUAL.\"\n },\n \"targetPlanHandle\": {\n \"type\": [\n \"string\",\n \"null\"\n ]\n },\n \"notification\": {\n \"anyOf\": [\n {\n \"$ref\": \"#/definitions/MigratableSubscriptionNotification\"\n },\n {\n \"type\": \"null\"\n }\n ]\n },\n \"priceBehavior\": {\n \"type\": [\n \"string\",\n \"null\"\n ],\n \"description\": \"Known values: HONOR_BILLING_PRICE, PLAN_PRICE.\"\n },\n \"effectiveDate\": {\n \"anyOf\": [\n {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"format\": \"date\"\n },\n {\n \"type\": \"string\",\n \"format\": \"date-time\",\n \"pattern\": \"^\\\\d{4}-\\\\d{2}-\\\\d{2}T\\\\d{2}:\\\\d{2}:\\\\d{2}Z$\"\n }\n ]\n },\n {\n \"type\": \"null\"\n }\n ],\n \"description\": \"The upstream calendar date or whole-second UTC instant; date-only values retain their format.\"\n },\n \"lastFailureReason\": {\n \"type\": [\n \"string\",\n \"null\"\n ],\n \"description\": \"Known values: SUPERSEDED, SCHEDULING_FAILED.\"\n }\n },\n \"required\": [\n \"shopGid\",\n \"status\",\n \"manualSubscriptionName\",\n \"manualSubscriptionPrice\",\n \"manualSubscriptionInterval\",\n \"targetPlanHandle\",\n \"notification\",\n \"priceBehavior\",\n \"effectiveDate\",\n \"lastFailureReason\"\n ],\n \"additionalProperties\": false,\n \"description\": \"All subscription projection fields are present; unavailable values are null.\"\n },\n \"MigratableSubscriptionPrice\": {\n \"type\": \"object\",\n \"properties\": {\n \"amount\": {\n \"type\": \"string\",\n \"pattern\": \"^-?\\\\d+(?:\\\\.\\\\d+)?$\"\n },\n \"currencyCode\": {\n \"type\": \"string\",\n \"pattern\": \"^[A-Z]{3}$\"\n }\n },\n \"required\": [\n \"amount\",\n \"currencyCode\"\n ],\n \"additionalProperties\": false\n },\n \"MigratableSubscriptionNotification\": {\n \"type\": \"object\",\n \"properties\": {\n \"kind\": {\n \"type\": \"string\",\n \"description\": \"Known values: NONE, OPT_OUT, WHEN_REQUIRED.\"\n },\n \"optOutDeadline\": {\n \"anyOf\": [\n {\n \"$ref\": \"#/definitions/MigratableSubscription/properties/effectiveDate/anyOf/0/anyOf/1\"\n },\n {\n \"type\": \"null\"\n }\n ]\n },\n \"sentAt\": {\n \"anyOf\": [\n {\n \"$ref\": \"#/definitions/MigratableSubscription/properties/effectiveDate/anyOf/0/anyOf/1\"\n },\n {\n \"type\": \"null\"\n }\n ]\n }\n },\n \"required\": [\n \"kind\",\n \"optOutDeadline\",\n \"sentAt\"\n ],\n \"additionalProperties\": false\n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "examples": [ "<%= config.bin %> <%= command.id %>", "<%= config.bin %> <%= command.id %> --status SCHEDULED > scheduled-subscriptions.csv", "<%= config.bin %> <%= command.id %> --json", "<%= config.bin %> <%= command.id %> --json > subscriptions.json", "<%= config.bin %> <%= command.id %> --client-id > subscriptions.csv" ], "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" }, "auth-alias": { "description": "Alias of the Shopify account to use for authentication.", "env": "SHOPIFY_FLAG_AUTH_ALIAS", "name": "auth-alias", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "no-input": { "description": "Disable interactive prompts and browser authentication.", "env": "SHOPIFY_FLAG_NO_INPUT", "name": "no-input", "allowNo": false, "type": "boolean" }, "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. May include sensitive data.", "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" }, "status": { "description": "Filter subscriptions by migration status.", "env": "SHOPIFY_FLAG_STATUS", "name": "status", "hasDynamicHelp": false, "multiple": false, "options": [ "UNSCHEDULED", "SCHEDULED", "MIGRATED" ], "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "app:subscription-migrations:list", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": true, "summary": "Lists app subscriptions eligible for migration.", "descriptionWithMarkdown": "Lists every app subscription eligible for migration.\n\nBy default, the command writes CSV to stdout, streaming each page of results as it arrives. If a later page fails, the rows already written remain valid CSV. Use `--json` to fetch all pages first and then write a single JSON envelope to stdout. Use shell redirection to save either format, for example `shopify app subscription-migrations list > subscriptions.csv` or `shopify app subscription-migrations list --json > subscriptions.json`.\n\nUse `--status` to filter subscriptions by migration status. Supported values are `UNSCHEDULED`, `SCHEDULED`, and `MIGRATED`.\n\nRun the command from an app project. By default, it uses the Client ID from the active app configuration. Use `--path` to select an app directory or `--config` to select a configuration. Pass `--client-id` to select a different app within the project. Use `--reset` to relink the app.", "customPluginName": "@shopify/app" }, "app:subscription-migrations:schedule": { "aliases": [], "args": {}, "description": "Schedules manual-billing subscriptions to migrate to Shopify-managed app pricing.\n\nWhen `--input` is omitted, the command reads CSV data from stdin. Use `--input ` to read from a file. `--input -` is also supported as an explicit stdin path.\n\n- Required CSV columns: `shop_id`, `target_plan_handle`, and `price_behavior`.\n- Optional CSV column: `notification`.\n- Example header: `shop_id,target_plan_handle,price_behavior,notification`.\n- Example row: `123456789,pro,HONOR_BILLING_PRICE,WHEN_REQUIRED`.\n\n`price_behavior` must be `HONOR_BILLING_PRICE` or `PLAN_PRICE`. `notification` can be `OPT_OUT` or `WHEN_REQUIRED` and defaults to `WHEN_REQUIRED` when omitted or blank.\n\nValidation is atomic: the command submits no operations unless the entire CSV is valid. Valid rows are submitted in batches of 250 shops. Preserve every operation GID printed by the command so you can check or cancel the submitted operations.\n\nRun the command from an app project. By default, it uses the Client ID from the active app configuration. Use `--path` to select an app directory or `--config` to select a configuration. Pass `--client-id` to select a different app within the project. Use `--reset` to relink the app.\n\nUse `--force` to skip confirmation and immediately submit every valid row. With `--watch`, human-readable output shows accepted identifiers before polling begins, then displays operation progress and the final outcome. With `--json --watch`, the command outputs one structured JSON document after every operation reaches a terminal status.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `MigrationSubmissionResult` schema.\n\n```json\n{\n \"anyOf\": [\n {\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"const\": \"success\"\n },\n \"changed\": {\n \"type\": \"boolean\"\n },\n \"clientId\": {\n \"type\": \"string\",\n \"minLength\": 1,\n \"description\": \"The app client ID, not a Shopify GID.\"\n },\n \"action\": {\n \"type\": \"string\",\n \"enum\": [\n \"schedule\",\n \"unschedule\"\n ]\n },\n \"inputDigest\": {\n \"type\": \"string\",\n \"minLength\": 1\n },\n \"total\": {\n \"type\": \"integer\",\n \"minimum\": 0\n },\n \"operations\": {\n \"type\": \"array\",\n \"items\": {\n \"$ref\": \"#/definitions/SubmittedMigrationOperation\"\n }\n }\n },\n \"required\": [\n \"status\",\n \"changed\",\n \"clientId\",\n \"action\",\n \"inputDigest\",\n \"total\",\n \"operations\"\n ],\n \"additionalProperties\": false\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"const\": \"partial\"\n },\n \"changed\": {\n \"type\": \"boolean\"\n },\n \"clientId\": {\n \"type\": \"string\",\n \"minLength\": 1,\n \"description\": \"The app client ID, not a Shopify GID.\"\n },\n \"action\": {\n \"type\": \"string\",\n \"enum\": [\n \"schedule\",\n \"unschedule\"\n ]\n },\n \"inputDigest\": {\n \"type\": \"string\",\n \"minLength\": 1\n },\n \"total\": {\n \"type\": \"integer\",\n \"minimum\": 0\n },\n \"operations\": {\n \"type\": \"array\",\n \"items\": {\n \"$ref\": \"#/definitions/SubmittedMigrationOperation\"\n }\n },\n \"failure\": {\n \"$ref\": \"#/definitions/MigrationSubmissionFailure\"\n }\n },\n \"required\": [\n \"status\",\n \"changed\",\n \"clientId\",\n \"action\",\n \"inputDigest\",\n \"total\",\n \"operations\",\n \"failure\"\n ],\n \"additionalProperties\": false\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"const\": \"cancelled\"\n },\n \"changed\": {\n \"type\": \"boolean\",\n \"const\": false\n },\n \"action\": {\n \"type\": \"string\",\n \"enum\": [\n \"schedule\",\n \"unschedule\"\n ]\n },\n \"reason\": {\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"status\",\n \"changed\",\n \"action\",\n \"reason\"\n ],\n \"additionalProperties\": false\n }\n ],\n \"title\": \"MigrationSubmissionResult\",\n \"definitions\": {\n \"SubmittedMigrationOperation\": {\n \"type\": \"object\",\n \"properties\": {\n \"batchIndex\": {\n \"type\": \"integer\",\n \"minimum\": 0\n },\n \"batchPayloadDigest\": {\n \"type\": \"string\",\n \"minLength\": 1\n },\n \"operation\": {\n \"$ref\": \"#/definitions/MigrationOperation\"\n }\n },\n \"required\": [\n \"batchIndex\",\n \"batchPayloadDigest\",\n \"operation\"\n ],\n \"additionalProperties\": false\n },\n \"MigrationOperation\": {\n \"type\": \"object\",\n \"properties\": {\n \"gid\": {\n \"type\": \"string\",\n \"pattern\": \"^gid:\\\\/\\\\/shopify\\\\/AppSubscriptionMigrationOperation\\\\/[^/]+$\",\n \"description\": \"The Shopify AppSubscriptionMigrationOperation GID.\"\n },\n \"status\": {\n \"type\": \"string\",\n \"minLength\": 1,\n \"description\": \"Upstream status: RUNNING, COMPLETED, FAILED, or CANCELED.\"\n },\n \"total\": {\n \"type\": \"integer\",\n \"minimum\": 0\n },\n \"results\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"shopGid\": {\n \"type\": \"string\",\n \"pattern\": \"^gid:\\\\/\\\\/shopify\\\\/Shop\\\\/\\\\d+$\",\n \"description\": \"The Shopify Shop GID.\"\n },\n \"code\": {\n \"type\": \"string\",\n \"minLength\": 1,\n \"description\": \"The upstream per-shop migration result code.\"\n }\n },\n \"required\": [\n \"shopGid\",\n \"code\"\n ],\n \"additionalProperties\": false\n }\n }\n },\n \"required\": [\n \"gid\",\n \"status\",\n \"total\",\n \"results\"\n ],\n \"additionalProperties\": false\n },\n \"MigrationSubmissionFailure\": {\n \"anyOf\": [\n {\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"const\": \"submission\"\n },\n \"batchIndex\": {\n \"type\": \"integer\",\n \"minimum\": 0\n },\n \"userErrors\": {\n \"type\": \"array\",\n \"items\": {\n \"$ref\": \"#/definitions/MigrationUserError\"\n }\n }\n },\n \"required\": [\n \"type\",\n \"batchIndex\",\n \"userErrors\"\n ],\n \"additionalProperties\": false\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"const\": \"operations\"\n },\n \"operationGids\": {\n \"type\": \"array\",\n \"items\": {\n \"$ref\": \"#/definitions/MigrationOperation/properties/gid\"\n }\n }\n },\n \"required\": [\n \"type\",\n \"operationGids\"\n ],\n \"additionalProperties\": false\n }\n ]\n },\n \"MigrationUserError\": {\n \"type\": \"object\",\n \"properties\": {\n \"message\": {\n \"type\": \"string\"\n },\n \"fieldPath\": {\n \"anyOf\": [\n {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n },\n {\n \"type\": \"null\"\n }\n ]\n }\n },\n \"required\": [\n \"message\",\n \"fieldPath\"\n ],\n \"additionalProperties\": false\n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "examples": [ "<%= config.bin %> <%= command.id %> --input migrations.csv --force", "cat migrations.csv | <%= config.bin %> <%= command.id %> --force", "<%= config.bin %> <%= command.id %> --input migrations.csv --path ../my-app --config staging --force --json", "<%= config.bin %> <%= command.id %> --input migrations.csv --client-id --force", "<%= config.bin %> <%= command.id %> --input - --force --watch" ], "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" }, "auth-alias": { "description": "Alias of the Shopify account to use for authentication.", "env": "SHOPIFY_FLAG_AUTH_ALIAS", "name": "auth-alias", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "no-input": { "description": "Disable interactive prompts and browser authentication.", "env": "SHOPIFY_FLAG_NO_INPUT", "name": "no-input", "allowNo": false, "type": "boolean" }, "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. May include sensitive data.", "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" }, "input": { "char": "i", "description": "Path to the migration CSV. If omitted, standard input is used.", "env": "SHOPIFY_FLAG_INPUT", "name": "input", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "force": { "char": "f", "description": "Skip confirmation. Required if non interactive.", "env": "SHOPIFY_FLAG_FORCE", "name": "force", "allowNo": false, "type": "boolean" }, "watch": { "description": "Display the current operation state while polling, then output the final outcome when every operation reaches a terminal status.", "env": "SHOPIFY_FLAG_WATCH", "name": "watch", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "app:subscription-migrations:schedule", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": true, "summary": "Schedules manual-billing subscriptions to migrate to Shopify-managed app pricing.", "descriptionWithMarkdown": "Schedules manual-billing subscriptions to migrate to Shopify-managed app pricing.\n\nWhen `--input` is omitted, the command reads CSV data from stdin. Use `--input ` to read from a file. `--input -` is also supported as an explicit stdin path.\n\n- Required CSV columns: `shop_id`, `target_plan_handle`, and `price_behavior`.\n- Optional CSV column: `notification`.\n- Example header: `shop_id,target_plan_handle,price_behavior,notification`.\n- Example row: `123456789,pro,HONOR_BILLING_PRICE,WHEN_REQUIRED`.\n\n`price_behavior` must be `HONOR_BILLING_PRICE` or `PLAN_PRICE`. `notification` can be `OPT_OUT` or `WHEN_REQUIRED` and defaults to `WHEN_REQUIRED` when omitted or blank.\n\nValidation is atomic: the command submits no operations unless the entire CSV is valid. Valid rows are submitted in batches of 250 shops. Preserve every operation GID printed by the command so you can check or cancel the submitted operations.\n\nRun the command from an app project. By default, it uses the Client ID from the active app configuration. Use `--path` to select an app directory or `--config` to select a configuration. Pass `--client-id` to select a different app within the project. Use `--reset` to relink the app.\n\nUse `--force` to skip confirmation and immediately submit every valid row. With `--watch`, human-readable output shows accepted identifiers before polling begins, then displays operation progress and the final outcome. With `--json --watch`, the command outputs one structured JSON document after every operation reaches a terminal status.", "customPluginName": "@shopify/app" }, "app:subscription-migrations:status": { "aliases": [], "args": {}, "description": "Checks app subscription migration operation status.\n\nRepeat `--id` for every operation GID returned by a multi-batch submission. With `--watch`, the command displays the current state while polling and outputs the final state after all requested operations reach a terminal status.\n\n`RUNNING` means an operation is still processing. `COMPLETED` means processing finished, but you must inspect the per-shop results to confirm each outcome. `FAILED` means the operation failed, and `CANCELED` means cancellation stopped further processing.\n\nUse `--json` to output every operation and its per-shop results as structured JSON.\n\nRun the command from an app project. By default, it uses the Client ID from the active app configuration. Use `--path` to select an app directory or `--config` to select a configuration. Pass `--client-id` to select a different app within the project. Use `--reset` to relink the app.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `MigrationStatusResult` schema.\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"operations\": {\n \"type\": \"array\",\n \"items\": {\n \"$ref\": \"#/definitions/MigrationOperation\"\n }\n }\n },\n \"required\": [\n \"operations\"\n ],\n \"additionalProperties\": false,\n \"title\": \"MigrationStatusResult\",\n \"definitions\": {\n \"MigrationOperation\": {\n \"type\": \"object\",\n \"properties\": {\n \"gid\": {\n \"type\": \"string\",\n \"pattern\": \"^gid:\\\\/\\\\/shopify\\\\/AppSubscriptionMigrationOperation\\\\/[^/]+$\",\n \"description\": \"The Shopify AppSubscriptionMigrationOperation GID.\"\n },\n \"status\": {\n \"type\": \"string\",\n \"minLength\": 1,\n \"description\": \"Upstream status: RUNNING, COMPLETED, FAILED, or CANCELED.\"\n },\n \"total\": {\n \"type\": \"integer\",\n \"minimum\": 0\n },\n \"results\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"shopGid\": {\n \"type\": \"string\",\n \"pattern\": \"^gid:\\\\/\\\\/shopify\\\\/Shop\\\\/\\\\d+$\",\n \"description\": \"The Shopify Shop GID.\"\n },\n \"code\": {\n \"type\": \"string\",\n \"minLength\": 1,\n \"description\": \"The upstream per-shop migration result code.\"\n }\n },\n \"required\": [\n \"shopGid\",\n \"code\"\n ],\n \"additionalProperties\": false\n }\n }\n },\n \"required\": [\n \"gid\",\n \"status\",\n \"total\",\n \"results\"\n ],\n \"additionalProperties\": false\n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "examples": [ "<%= config.bin %> <%= command.id %> --id ", "<%= config.bin %> <%= command.id %> --path ../my-app --config staging --id --id --watch", "<%= config.bin %> <%= command.id %> --client-id --id --json" ], "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" }, "auth-alias": { "description": "Alias of the Shopify account to use for authentication.", "env": "SHOPIFY_FLAG_AUTH_ALIAS", "name": "auth-alias", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "no-input": { "description": "Disable interactive prompts and browser authentication.", "env": "SHOPIFY_FLAG_NO_INPUT", "name": "no-input", "allowNo": false, "type": "boolean" }, "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. May include sensitive data.", "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" }, "id": { "description": "The app subscription migration operation ID. Can be specified multiple times.", "env": "SHOPIFY_FLAG_ID", "name": "id", "required": true, "hasDynamicHelp": false, "multiple": true, "type": "option" }, "watch": { "description": "Display the current operation state while polling, then output the final state when every operation reaches a terminal status.", "env": "SHOPIFY_FLAG_WATCH", "name": "watch", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "app:subscription-migrations:status", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": true, "summary": "Checks the status of app subscription migration operations.", "descriptionWithMarkdown": "Checks app subscription migration operation status.\n\nRepeat `--id` for every operation GID returned by a multi-batch submission. With `--watch`, the command displays the current state while polling and outputs the final state after all requested operations reach a terminal status.\n\n`RUNNING` means an operation is still processing. `COMPLETED` means processing finished, but you must inspect the per-shop results to confirm each outcome. `FAILED` means the operation failed, and `CANCELED` means cancellation stopped further processing.\n\nUse `--json` to output every operation and its per-shop results as structured JSON.\n\nRun the command from an app project. By default, it uses the Client ID from the active app configuration. Use `--path` to select an app directory or `--config` to select a configuration. Pass `--client-id` to select a different app within the project. Use `--reset` to relink the app.", "customPluginName": "@shopify/app" }, "app:subscription-migrations:unschedule": { "aliases": [], "args": {}, "description": "Reverses scheduled app subscription migrations that have not migrated yet.\n\nWhen `--input` is omitted, the command reads CSV data from stdin. Use `--input ` to read from a file. `--input -` is also supported as an explicit stdin path.\n\n- Required CSV header: `shop_id`.\n- Example row: `123456789`.\n\nThe CSV can contain only the `shop_id` header, or it can reuse the complete CSV supplied to `schedule`; schedule-only columns are ignored.\n\nUnscheduling is not a rollback after a subscription has migrated. The command validates the entire CSV before sending any mutation. Use `--force` to skip confirmation and immediately submit every valid row.\n\nOperations are submitted in batches of 250 shops. Preserve every operation GID printed by the command so you can check or cancel the submitted operations. With `--watch`, human-readable output shows accepted identifiers before polling begins, then displays operation progress and the final outcome. With `--json --watch`, the command outputs one structured JSON document after every operation reaches a terminal status.\n\nRun the command from an app project. By default, it uses the Client ID from the active app configuration. Use `--path` to select an app directory or `--config` to select a configuration. Pass `--client-id` to select a different app within the project. Use `--reset` to relink the app.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `MigrationSubmissionResult` schema.\n\n```json\n{\n \"anyOf\": [\n {\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"const\": \"success\"\n },\n \"changed\": {\n \"type\": \"boolean\"\n },\n \"clientId\": {\n \"type\": \"string\",\n \"minLength\": 1,\n \"description\": \"The app client ID, not a Shopify GID.\"\n },\n \"action\": {\n \"type\": \"string\",\n \"enum\": [\n \"schedule\",\n \"unschedule\"\n ]\n },\n \"inputDigest\": {\n \"type\": \"string\",\n \"minLength\": 1\n },\n \"total\": {\n \"type\": \"integer\",\n \"minimum\": 0\n },\n \"operations\": {\n \"type\": \"array\",\n \"items\": {\n \"$ref\": \"#/definitions/SubmittedMigrationOperation\"\n }\n }\n },\n \"required\": [\n \"status\",\n \"changed\",\n \"clientId\",\n \"action\",\n \"inputDigest\",\n \"total\",\n \"operations\"\n ],\n \"additionalProperties\": false\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"const\": \"partial\"\n },\n \"changed\": {\n \"type\": \"boolean\"\n },\n \"clientId\": {\n \"type\": \"string\",\n \"minLength\": 1,\n \"description\": \"The app client ID, not a Shopify GID.\"\n },\n \"action\": {\n \"type\": \"string\",\n \"enum\": [\n \"schedule\",\n \"unschedule\"\n ]\n },\n \"inputDigest\": {\n \"type\": \"string\",\n \"minLength\": 1\n },\n \"total\": {\n \"type\": \"integer\",\n \"minimum\": 0\n },\n \"operations\": {\n \"type\": \"array\",\n \"items\": {\n \"$ref\": \"#/definitions/SubmittedMigrationOperation\"\n }\n },\n \"failure\": {\n \"$ref\": \"#/definitions/MigrationSubmissionFailure\"\n }\n },\n \"required\": [\n \"status\",\n \"changed\",\n \"clientId\",\n \"action\",\n \"inputDigest\",\n \"total\",\n \"operations\",\n \"failure\"\n ],\n \"additionalProperties\": false\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"const\": \"cancelled\"\n },\n \"changed\": {\n \"type\": \"boolean\",\n \"const\": false\n },\n \"action\": {\n \"type\": \"string\",\n \"enum\": [\n \"schedule\",\n \"unschedule\"\n ]\n },\n \"reason\": {\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"status\",\n \"changed\",\n \"action\",\n \"reason\"\n ],\n \"additionalProperties\": false\n }\n ],\n \"title\": \"MigrationSubmissionResult\",\n \"definitions\": {\n \"SubmittedMigrationOperation\": {\n \"type\": \"object\",\n \"properties\": {\n \"batchIndex\": {\n \"type\": \"integer\",\n \"minimum\": 0\n },\n \"batchPayloadDigest\": {\n \"type\": \"string\",\n \"minLength\": 1\n },\n \"operation\": {\n \"$ref\": \"#/definitions/MigrationOperation\"\n }\n },\n \"required\": [\n \"batchIndex\",\n \"batchPayloadDigest\",\n \"operation\"\n ],\n \"additionalProperties\": false\n },\n \"MigrationOperation\": {\n \"type\": \"object\",\n \"properties\": {\n \"gid\": {\n \"type\": \"string\",\n \"pattern\": \"^gid:\\\\/\\\\/shopify\\\\/AppSubscriptionMigrationOperation\\\\/[^/]+$\",\n \"description\": \"The Shopify AppSubscriptionMigrationOperation GID.\"\n },\n \"status\": {\n \"type\": \"string\",\n \"minLength\": 1,\n \"description\": \"Upstream status: RUNNING, COMPLETED, FAILED, or CANCELED.\"\n },\n \"total\": {\n \"type\": \"integer\",\n \"minimum\": 0\n },\n \"results\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"shopGid\": {\n \"type\": \"string\",\n \"pattern\": \"^gid:\\\\/\\\\/shopify\\\\/Shop\\\\/\\\\d+$\",\n \"description\": \"The Shopify Shop GID.\"\n },\n \"code\": {\n \"type\": \"string\",\n \"minLength\": 1,\n \"description\": \"The upstream per-shop migration result code.\"\n }\n },\n \"required\": [\n \"shopGid\",\n \"code\"\n ],\n \"additionalProperties\": false\n }\n }\n },\n \"required\": [\n \"gid\",\n \"status\",\n \"total\",\n \"results\"\n ],\n \"additionalProperties\": false\n },\n \"MigrationSubmissionFailure\": {\n \"anyOf\": [\n {\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"const\": \"submission\"\n },\n \"batchIndex\": {\n \"type\": \"integer\",\n \"minimum\": 0\n },\n \"userErrors\": {\n \"type\": \"array\",\n \"items\": {\n \"$ref\": \"#/definitions/MigrationUserError\"\n }\n }\n },\n \"required\": [\n \"type\",\n \"batchIndex\",\n \"userErrors\"\n ],\n \"additionalProperties\": false\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"const\": \"operations\"\n },\n \"operationGids\": {\n \"type\": \"array\",\n \"items\": {\n \"$ref\": \"#/definitions/MigrationOperation/properties/gid\"\n }\n }\n },\n \"required\": [\n \"type\",\n \"operationGids\"\n ],\n \"additionalProperties\": false\n }\n ]\n },\n \"MigrationUserError\": {\n \"type\": \"object\",\n \"properties\": {\n \"message\": {\n \"type\": \"string\"\n },\n \"fieldPath\": {\n \"anyOf\": [\n {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n },\n {\n \"type\": \"null\"\n }\n ]\n }\n },\n \"required\": [\n \"message\",\n \"fieldPath\"\n ],\n \"additionalProperties\": false\n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "examples": [ "<%= config.bin %> <%= command.id %> --input migrations.csv --force", "cat migrations.csv | <%= config.bin %> <%= command.id %> --force", "<%= config.bin %> <%= command.id %> --input migrations.csv --path ../my-app --config staging --force --json", "<%= config.bin %> <%= command.id %> --input migrations.csv --client-id --force", "<%= config.bin %> <%= command.id %> --input - --force --watch" ], "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" }, "auth-alias": { "description": "Alias of the Shopify account to use for authentication.", "env": "SHOPIFY_FLAG_AUTH_ALIAS", "name": "auth-alias", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "no-input": { "description": "Disable interactive prompts and browser authentication.", "env": "SHOPIFY_FLAG_NO_INPUT", "name": "no-input", "allowNo": false, "type": "boolean" }, "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. May include sensitive data.", "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" }, "input": { "char": "i", "description": "Path to the migration CSV. If omitted, standard input is used.", "env": "SHOPIFY_FLAG_INPUT", "name": "input", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "force": { "char": "f", "description": "Skip confirmation. Required if non interactive.", "env": "SHOPIFY_FLAG_FORCE", "name": "force", "allowNo": false, "type": "boolean" }, "watch": { "description": "Display the current operation state while polling, then output the final outcome when every operation reaches a terminal status.", "env": "SHOPIFY_FLAG_WATCH", "name": "watch", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "app:subscription-migrations:unschedule", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": true, "summary": "Reverses app subscription migrations that are still scheduled.", "descriptionWithMarkdown": "Reverses scheduled app subscription migrations that have not migrated yet.\n\nWhen `--input` is omitted, the command reads CSV data from stdin. Use `--input ` to read from a file. `--input -` is also supported as an explicit stdin path.\n\n- Required CSV header: `shop_id`.\n- Example row: `123456789`.\n\nThe CSV can contain only the `shop_id` header, or it can reuse the complete CSV supplied to `schedule`; schedule-only columns are ignored.\n\nUnscheduling is not a rollback after a subscription has migrated. The command validates the entire CSV before sending any mutation. Use `--force` to skip confirmation and immediately submit every valid row.\n\nOperations are submitted in batches of 250 shops. Preserve every operation GID printed by the command so you can check or cancel the submitted operations. With `--watch`, human-readable output shows accepted identifiers before polling begins, then displays operation progress and the final outcome. With `--json --watch`, the command outputs one structured JSON document after every operation reaches a terminal status.\n\nRun the command from an app project. By default, it uses the Client ID from the active app configuration. Use `--path` to select an app directory or `--config` to select a configuration. Pass `--client-id` to select a different app within the project. Use `--reset` to relink the app.", "customPluginName": "@shopify/app" }, "app:config:link": { "aliases": [], "args": {}, "description": "Pulls app configuration from the Developer Dashboard and creates or overwrites a configuration file. You can create a new app with this command to start with a default configuration file.\n\n For more information on the format of the created TOML configuration file, refer to the \"App configuration\" (https://shopify.dev/docs/apps/tools/cli/configuration) page.\n \n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `AppConfigLinkResult` schema.\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"path\": {\n \"type\": \"string\"\n },\n \"app\": {\n \"$ref\": \"#/definitions/LinkedApp\"\n }\n },\n \"required\": [\n \"path\",\n \"app\"\n ],\n \"additionalProperties\": false,\n \"title\": \"AppConfigLinkResult\",\n \"definitions\": {\n \"LinkedApp\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"minLength\": 1\n },\n {\n \"type\": \"null\"\n }\n ],\n \"description\": \"The upstream non-GID app identifier, or null when the platform supplies a GID.\"\n },\n \"gid\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"pattern\": \"^gid:\\\\/\\\\/shopify\\\\/App\\\\/[^\\\\s/]+$\"\n },\n {\n \"type\": \"null\"\n }\n ],\n \"description\": \"The Shopify App GID, or null when the platform supplies another identifier.\"\n },\n \"name\": {\n \"type\": \"string\"\n },\n \"clientId\": {\n \"type\": \"string\",\n \"minLength\": 1,\n \"description\": \"The public OAuth client identifier.\"\n },\n \"organizationId\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"minLength\": 1\n },\n {\n \"type\": \"null\"\n }\n ],\n \"description\": \"The upstream non-GID organization identifier, or null when unavailable.\"\n },\n \"organizationGid\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"pattern\": \"^gid:\\\\/\\\\/shopify\\\\/Organization\\\\/[^\\\\s/]+$\"\n },\n {\n \"type\": \"null\"\n }\n ],\n \"description\": \"The Shopify Organization GID, or null when unavailable.\"\n }\n },\n \"required\": [\n \"id\",\n \"gid\",\n \"name\",\n \"clientId\",\n \"organizationId\",\n \"organizationGid\"\n ],\n \"additionalProperties\": false,\n \"description\": \"The linked app identity. Read the file at path for its configuration.\"\n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" }, "auth-alias": { "description": "Alias of the Shopify account to use for authentication.", "env": "SHOPIFY_FLAG_AUTH_ALIAS", "name": "auth-alias", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "no-input": { "description": "Disable interactive prompts and browser authentication.", "env": "SHOPIFY_FLAG_NO_INPUT", "name": "no-input", "allowNo": false, "type": "boolean" }, "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. May include sensitive data.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "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" }, "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 local app configuration to read and overwrite. Use --file-name instead when specifying --client-id.", "env": "SHOPIFY_FLAG_APP_CONFIG", "hidden": false, "name": "config", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "client-id": { "description": "The Client ID of the remote app to link. Use --file-name to specify the destination configuration file. Required if non interactive.", "env": "SHOPIFY_FLAG_CLIENT_ID", "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" }, "organization-id": { "env": "SHOPIFY_FLAG_ORGANIZATION_ID", "exclusive": [ "client-id" ], "hidden": true, "name": "organization-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "file-name": { "description": "The name of the app configuration file to create or overwrite. Requires --force to overwrite an existing file.", "env": "SHOPIFY_FLAG_APP_CONFIG_FILE_NAME", "exclusive": [ "config" ], "hidden": false, "name": "file-name", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "force": { "dependsOn": [ "file-name" ], "description": "Overwrite an existing configuration file without prompting.", "env": "SHOPIFY_FLAG_FORCE", "hidden": false, "name": "force", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "app:config:link", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": true, "summary": "Fetch your app configuration from the Developer Dashboard.", "descriptionWithMarkdown": "Pulls app configuration from the Developer Dashboard and creates or overwrites a configuration file. You can create a new app with this command to start with a default configuration file.\n\n For more information on the format of the created TOML configuration file, refer to the [App configuration](https://shopify.dev/docs/apps/tools/cli/configuration) page.\n ", "customPluginName": "@shopify/app" }, "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.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `AppConfigUseResult` schema.\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"const\": \"success\"\n },\n \"changed\": {\n \"type\": \"boolean\",\n \"description\": \"Whether the preferred configuration changed.\"\n },\n \"path\": {\n \"anyOf\": [\n {\n \"type\": \"string\"\n },\n {\n \"type\": \"null\"\n }\n ],\n \"description\": \"The preferred configuration file, or null after clearing the preference.\"\n },\n \"clientId\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"minLength\": 1\n },\n {\n \"type\": \"null\"\n }\n ],\n \"description\": \"The public OAuth client identifier, or null after clearing the preference.\"\n }\n },\n \"required\": [\n \"status\",\n \"changed\",\n \"path\",\n \"clientId\"\n ],\n \"additionalProperties\": false,\n \"title\": \"AppConfigUseResult\",\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" }, "auth-alias": { "description": "Alias of the Shopify account to use for authentication.", "env": "SHOPIFY_FLAG_AUTH_ALIAS", "name": "auth-alias", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "no-input": { "description": "Disable interactive prompts and browser authentication.", "env": "SHOPIFY_FLAG_NO_INPUT", "name": "no-input", "allowNo": false, "type": "boolean" }, "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. May include sensitive data.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "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" }, "path": { "description": "The path to your app directory.", "env": "SHOPIFY_FLAG_PATH", "name": "path", "noCacheDefault": true, "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:config:use", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": true, "summary": "Activate an app configuration.", "usage": "app config use [config] [flags]", "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.", "customPluginName": "@shopify/app" }, "app:config:pull": { "aliases": [], "args": {}, "description": "Pulls the latest configuration from the already-linked Shopify app and updates the selected configuration file.\n\nThis command reuses the existing linked app and organization and skips all interactive prompts. Use `--config` to target a specific configuration file, or omit it to use the default one.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `AppConfigPullResult` schema.\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"path\": {\n \"type\": \"string\"\n },\n \"app\": {\n \"$ref\": \"#/definitions/LinkedApp\"\n }\n },\n \"required\": [\n \"path\",\n \"app\"\n ],\n \"additionalProperties\": false,\n \"title\": \"AppConfigPullResult\",\n \"definitions\": {\n \"LinkedApp\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"minLength\": 1\n },\n {\n \"type\": \"null\"\n }\n ],\n \"description\": \"The upstream non-GID app identifier, or null when the platform supplies a GID.\"\n },\n \"gid\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"pattern\": \"^gid:\\\\/\\\\/shopify\\\\/App\\\\/[^\\\\s/]+$\"\n },\n {\n \"type\": \"null\"\n }\n ],\n \"description\": \"The Shopify App GID, or null when the platform supplies another identifier.\"\n },\n \"name\": {\n \"type\": \"string\"\n },\n \"clientId\": {\n \"type\": \"string\",\n \"minLength\": 1,\n \"description\": \"The public OAuth client identifier.\"\n },\n \"organizationId\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"minLength\": 1\n },\n {\n \"type\": \"null\"\n }\n ],\n \"description\": \"The upstream non-GID organization identifier, or null when unavailable.\"\n },\n \"organizationGid\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"pattern\": \"^gid:\\\\/\\\\/shopify\\\\/Organization\\\\/[^\\\\s/]+$\"\n },\n {\n \"type\": \"null\"\n }\n ],\n \"description\": \"The Shopify Organization GID, or null when unavailable.\"\n }\n },\n \"required\": [\n \"id\",\n \"gid\",\n \"name\",\n \"clientId\",\n \"organizationId\",\n \"organizationGid\"\n ],\n \"additionalProperties\": false,\n \"description\": \"The linked app identity. Read the file at path for its configuration.\"\n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" }, "auth-alias": { "description": "Alias of the Shopify account to use for authentication.", "env": "SHOPIFY_FLAG_AUTH_ALIAS", "name": "auth-alias", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "no-input": { "description": "Disable interactive prompts and browser authentication.", "env": "SHOPIFY_FLAG_NO_INPUT", "name": "no-input", "allowNo": false, "type": "boolean" }, "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. May include sensitive data.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "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" }, "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:config:pull", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": true, "summary": "Refresh an already-linked app configuration without prompts.", "descriptionWithMarkdown": "Pulls the latest configuration from the already-linked Shopify app and updates the selected configuration file.\n\nThis command reuses the existing linked app and organization and skips all interactive prompts. Use `--config` to target a specific configuration file, or omit it to use the default one.", "customPluginName": "@shopify/app" }, "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.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `AppEnvPullResult` schema.\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"path\": {\n \"type\": \"string\",\n \"description\": \"The absolute native dotenv file path.\"\n },\n \"status\": {\n \"type\": \"string\",\n \"const\": \"success\"\n },\n \"changed\": {\n \"type\": \"boolean\",\n \"description\": \"Whether the dotenv file was created or updated.\"\n },\n \"variables\": {\n \"type\": \"array\",\n \"items\": {\n \"$ref\": \"#/definitions/AppEnvironmentVariable\"\n },\n \"description\": \"The known app variables, not unrelated local variables.\"\n },\n \"content\": {\n \"type\": \"string\",\n \"description\": \"The complete native dotenv content, preserving existing variables and comments.\"\n }\n },\n \"required\": [\n \"path\",\n \"status\",\n \"changed\",\n \"variables\",\n \"content\"\n ],\n \"additionalProperties\": false,\n \"title\": \"AppEnvPullResult\",\n \"definitions\": {\n \"AppEnvironmentVariable\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"minLength\": 1,\n \"description\": \"The environment variable name with its original spelling.\"\n },\n \"value\": {\n \"type\": \"string\",\n \"description\": \"The value, included only when known.\"\n },\n \"isSecret\": {\n \"type\": \"boolean\",\n \"description\": \"Whether the value is secret, included only when known.\"\n },\n \"id\": {\n \"type\": \"string\",\n \"minLength\": 1,\n \"description\": \"The upstream variable identifier, included only when known.\"\n },\n \"readOnly\": {\n \"type\": \"boolean\",\n \"description\": \"Whether the variable is read-only, included only when known.\"\n }\n },\n \"required\": [\n \"name\"\n ],\n \"additionalProperties\": false\n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" }, "auth-alias": { "description": "Alias of the Shopify account to use for authentication.", "env": "SHOPIFY_FLAG_AUTH_ALIAS", "name": "auth-alias", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "no-input": { "description": "Disable interactive prompts and browser authentication.", "env": "SHOPIFY_FLAG_NO_INPUT", "name": "no-input", "allowNo": false, "type": "boolean" }, "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. May include sensitive data.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "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" }, "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" }, "env-file": { "description": "Specify an environment file to update if the update flag is set", "env": "SHOPIFY_FLAG_ENV_FILE", "hidden": false, "name": "env-file", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "app:env:pull", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": true, "summary": "Pull app and extensions environment variables.", "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.", "customPluginName": "@shopify/app" }, "app:env:show": { "aliases": [], "args": {}, "description": "Displays environment variables that can be used to deploy apps and app extensions.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `AppEnvShowResult` schema.\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"variables\": {\n \"type\": \"array\",\n \"items\": {\n \"$ref\": \"#/definitions/AppEnvironmentVariable\"\n }\n }\n },\n \"required\": [\n \"variables\"\n ],\n \"additionalProperties\": false,\n \"title\": \"AppEnvShowResult\",\n \"definitions\": {\n \"AppEnvironmentVariable\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"minLength\": 1,\n \"description\": \"The environment variable name with its original spelling.\"\n },\n \"value\": {\n \"type\": \"string\",\n \"description\": \"The value, included only when known.\"\n },\n \"isSecret\": {\n \"type\": \"boolean\",\n \"description\": \"Whether the value is secret, included only when known.\"\n },\n \"id\": {\n \"type\": \"string\",\n \"minLength\": 1,\n \"description\": \"The upstream variable identifier, included only when known.\"\n },\n \"readOnly\": {\n \"type\": \"boolean\",\n \"description\": \"Whether the variable is read-only, included only when known.\"\n }\n },\n \"required\": [\n \"name\"\n ],\n \"additionalProperties\": false\n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" }, "auth-alias": { "description": "Alias of the Shopify account to use for authentication.", "env": "SHOPIFY_FLAG_AUTH_ALIAS", "name": "auth-alias", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "no-input": { "description": "Disable interactive prompts and browser authentication.", "env": "SHOPIFY_FLAG_NO_INPUT", "name": "no-input", "allowNo": false, "type": "boolean" }, "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. May include sensitive data.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "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" }, "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:env:show", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": true, "summary": "Display app and extensions environment variables.", "descriptionWithMarkdown": "Displays environment variables that can be used to deploy apps and app extensions.", "customPluginName": "@shopify/app" }, "app:execute": { "aliases": [], "args": {}, "description": "Executes an Admin API GraphQL query or mutation on the specified store. Mutations are only allowed on dev stores.\n\n For operations that process large amounts of data, use \"`bulk execute`\" (https://shopify.dev/docs/api/shopify-cli/app/app-bulk-execute) instead.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `AppExecuteResult` schema.\n\n```json\n{\n \"anyOf\": [\n {\n \"$ref\": \"#/definitions/AppExecuteGraphQLResult\"\n },\n {\n \"$ref\": \"#/definitions/AppExecuteFileReceipt\"\n }\n ],\n \"title\": \"AppExecuteResult\",\n \"definitions\": {\n \"AppExecuteGraphQLResult\": {\n \"type\": \"object\",\n \"properties\": {\n \"data\": {\n \"anyOf\": [\n {\n \"allOf\": [\n {},\n {\n \"type\": \"object\",\n \"additionalProperties\": {}\n }\n ]\n },\n {\n \"type\": \"null\"\n }\n ],\n \"description\": \"Native GraphQL query data, preserving fields and aliases.\"\n },\n \"extensions\": {\n \"$ref\": \"#/definitions/AppExecuteGraphQLResult/properties/data/anyOf/0\",\n \"description\": \"Native GraphQL response extensions, when supplied.\"\n }\n },\n \"required\": [\n \"data\"\n ],\n \"additionalProperties\": false\n },\n \"AppExecuteFileReceipt\": {\n \"type\": \"object\",\n \"properties\": {\n \"path\": {\n \"type\": \"string\"\n },\n \"format\": {\n \"type\": \"string\",\n \"const\": \"json\"\n }\n },\n \"required\": [\n \"path\",\n \"format\"\n ],\n \"additionalProperties\": false,\n \"description\": \"Receipt for a written JSON file containing the GraphQL result, including data and optional extensions.\"\n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" }, "auth-alias": { "description": "Alias of the Shopify account to use for authentication.", "env": "SHOPIFY_FLAG_AUTH_ALIAS", "name": "auth-alias", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "no-input": { "description": "Disable interactive prompts and browser authentication.", "env": "SHOPIFY_FLAG_NO_INPUT", "name": "no-input", "allowNo": false, "type": "boolean" }, "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. May include sensitive data.", "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" }, "query": { "char": "q", "description": "The GraphQL query or mutation, as a string.", "env": "SHOPIFY_FLAG_QUERY", "name": "query", "required": false, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "query-file": { "description": "Path to a file containing the GraphQL query or mutation. Can't be used with --query.", "env": "SHOPIFY_FLAG_QUERY_FILE", "name": "query-file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "variables": { "char": "v", "description": "The values for any GraphQL variables in your query or mutation, in JSON format.", "env": "SHOPIFY_FLAG_VARIABLES", "exclusive": [ "variable-file" ], "name": "variables", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "variable-file": { "description": "Path to a file containing GraphQL variables in JSON format. Can't be used with --variables.", "env": "SHOPIFY_FLAG_VARIABLE_FILE", "exclusive": [ "variables" ], "name": "variable-file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "store": { "char": "s", "description": "The myshopify.com domain of the store to execute against. The app must be installed on the store. If not specified, you will be prompted to select a store.", "env": "SHOPIFY_FLAG_STORE", "name": "store", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "version": { "description": "The API version to use for the query or mutation. Defaults to the latest stable version.", "env": "SHOPIFY_FLAG_VERSION", "name": "version", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "output-file": { "description": "The file name where results should be written, instead of STDOUT.", "env": "SHOPIFY_FLAG_OUTPUT_FILE", "name": "output-file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "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:execute", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": true, "summary": "Execute GraphQL queries and mutations.", "descriptionWithMarkdown": "Executes an Admin API GraphQL query or mutation on the specified store. Mutations are only allowed on dev stores.\n\n For operations that process large amounts of data, use [`bulk execute`](https://shopify.dev/docs/api/shopify-cli/app/app-bulk-execute) instead.", "customPluginName": "@shopify/app" }, "app:graphiql": { "aliases": [], "args": {}, "description": "Opens an authenticated Admin API GraphiQL UI for your app and selected store.\n\nThe app must be installed on the store.", "examples": [ "<%= config.bin %> <%= command.id %> --store shop.myshopify.com", "<%= config.bin %> <%= command.id %> --store shop.myshopify.com --port 9123" ], "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" }, "auth-alias": { "description": "Alias of the Shopify account to use for authentication.", "env": "SHOPIFY_FLAG_AUTH_ALIAS", "name": "auth-alias", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "no-input": { "description": "Disable interactive prompts and browser authentication.", "env": "SHOPIFY_FLAG_NO_INPUT", "name": "no-input", "allowNo": false, "type": "boolean" }, "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. May include sensitive data.", "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": "The myshopify.com domain of the store to open GraphiQL against. The app must be installed on the store. If not specified, you will be prompted to select a store.", "env": "SHOPIFY_FLAG_STORE", "name": "store", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "port": { "description": "Local port for the GraphiQL server. Must be between 1 and 65535.", "env": "SHOPIFY_FLAG_PORT", "name": "port", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "variables": { "char": "v", "description": "The values for any GraphQL variables in your query or mutation, in JSON format.", "env": "SHOPIFY_FLAG_VARIABLES", "name": "variables", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "version": { "description": "The API version to use in GraphiQL. Defaults to the latest stable version.", "env": "SHOPIFY_FLAG_VERSION", "name": "version", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "app:graphiql", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": true, "summary": "Open a local GraphiQL UI for your app and store.", "descriptionWithMarkdown": "Opens an authenticated Admin API GraphiQL UI for your app and selected store.\n\nThe app must be installed on the store.", "customPluginName": "@shopify/app" }, "app:bulk:execute": { "aliases": [], "args": {}, "description": "Executes an Admin API GraphQL query or mutation on the specified store, as a bulk operation. Mutations are only allowed on dev stores.\n\n Bulk operations allow you to process large amounts of data asynchronously. Learn more about \"bulk query operations\" (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 status`\" (https://shopify.dev/docs/api/shopify-cli/app/app-bulk-status) to check the status of your bulk operations.\n\n With `--watch`, completed results are written as JSONL to stdout or `--output-file`. With `--json`, stdout contains one result object with operation details and downloaded JSONL in `resultsJsonl`. With `--json --output-file`, stdout contains only an absolute file receipt with `path` and `format`.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `ExecuteBulkOperationResult` schema.\n\n```json\n{\n \"anyOf\": [\n {\n \"$ref\": \"#/definitions/ExecuteBulkOperationResult\"\n },\n {\n \"$ref\": \"#/definitions/BulkOperationFile\"\n }\n ],\n \"title\": \"ExecuteBulkOperationResult\",\n \"definitions\": {\n \"BulkOperation\": {\n \"type\": \"object\",\n \"properties\": {\n \"gid\": {\n \"type\": \"string\",\n \"pattern\": \"^gid:\\\\/\\\\/shopify\\\\/BulkOperation\\\\/[^/]+$\",\n \"description\": \"The Shopify global ID of a bulk operation.\"\n },\n \"type\": {\n \"type\": \"string\"\n },\n \"status\": {\n \"type\": \"string\"\n },\n \"errorCode\": {\n \"type\": [\n \"string\",\n \"null\"\n ]\n },\n \"createdAt\": {\n \"type\": \"string\",\n \"format\": \"date-time\",\n \"pattern\": \"^\\\\d{4}-\\\\d{2}-\\\\d{2}T\\\\d{2}:\\\\d{2}:\\\\d{2}Z$\",\n \"description\": \"A UTC ISO 8601 instant with whole seconds and the Z timezone marker.\"\n },\n \"completedAt\": {\n \"anyOf\": [\n {\n \"$ref\": \"#/definitions/BulkOperation/properties/createdAt\"\n },\n {\n \"type\": \"null\"\n }\n ],\n \"description\": \"A UTC ISO 8601 instant with whole seconds and the Z timezone marker.\"\n },\n \"objectCount\": {\n \"type\": \"string\",\n \"pattern\": \"^\\\\d+$\",\n \"description\": \"A nonnegative decimal count, without loss of integer precision.\"\n },\n \"url\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"format\": \"uri\"\n },\n {\n \"type\": \"null\"\n }\n ]\n },\n \"partialDataUrl\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"format\": \"uri\"\n },\n {\n \"type\": \"null\"\n }\n ]\n }\n },\n \"required\": [\n \"gid\",\n \"type\",\n \"status\",\n \"errorCode\",\n \"createdAt\",\n \"completedAt\",\n \"objectCount\",\n \"url\",\n \"partialDataUrl\"\n ],\n \"additionalProperties\": false\n },\n \"ExecuteBulkOperationResult\": {\n \"type\": \"object\",\n \"properties\": {\n \"storeDomain\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"pattern\": \"^[^.]+\\\\.myshopify\\\\.com$\"\n },\n {\n \"type\": \"null\"\n }\n ]\n },\n \"apiVersion\": {\n \"type\": [\n \"string\",\n \"null\"\n ],\n \"description\": \"The API version selected for the request.\"\n },\n \"status\": {\n \"type\": \"string\",\n \"enum\": [\n \"success\",\n \"partial\",\n \"cancelled\"\n ]\n },\n \"reason\": {\n \"type\": \"string\",\n \"const\": \"watch-aborted\"\n },\n \"operation\": {\n \"$ref\": \"#/definitions/BulkOperation\"\n },\n \"resultsJsonl\": {\n \"type\": \"string\",\n \"description\": \"Downloaded results in their native JSONL format.\"\n }\n },\n \"required\": [\n \"storeDomain\",\n \"apiVersion\",\n \"status\",\n \"operation\"\n ],\n \"additionalProperties\": false\n },\n \"BulkOperationFile\": {\n \"type\": \"object\",\n \"properties\": {\n \"path\": {\n \"type\": \"string\",\n \"description\": \"The absolute path of the downloaded results file.\"\n },\n \"format\": {\n \"type\": \"string\",\n \"const\": \"jsonl\"\n }\n },\n \"required\": [\n \"path\",\n \"format\"\n ],\n \"additionalProperties\": false\n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" }, "auth-alias": { "description": "Alias of the Shopify account to use for authentication.", "env": "SHOPIFY_FLAG_AUTH_ALIAS", "name": "auth-alias", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "no-input": { "description": "Disable interactive prompts and browser authentication.", "env": "SHOPIFY_FLAG_NO_INPUT", "name": "no-input", "allowNo": false, "type": "boolean" }, "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. May include sensitive data.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "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" }, "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" }, "query": { "char": "q", "description": "The GraphQL query or mutation to run as a bulk operation.", "env": "SHOPIFY_FLAG_QUERY", "name": "query", "required": false, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "query-file": { "description": "Path to a file containing the GraphQL query or mutation. Can't be used with --query.", "env": "SHOPIFY_FLAG_QUERY_FILE", "name": "query-file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "variables": { "char": "v", "description": "The values for any GraphQL variables in your mutation, in JSON format. Can be specified multiple times.", "env": "SHOPIFY_FLAG_VARIABLES", "exclusive": [ "variable-file" ], "name": "variables", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "variable-file": { "description": "Path to a file containing GraphQL variables in JSONL format (one JSON object per line). Can't be used with --variables.", "env": "SHOPIFY_FLAG_VARIABLE_FILE", "exclusive": [ "variables" ], "name": "variable-file", "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" }, "watch": { "description": "Wait for bulk operation results before exiting. Defaults to false.", "env": "SHOPIFY_FLAG_WATCH", "name": "watch", "allowNo": false, "type": "boolean" }, "output-file": { "dependsOn": [ "watch" ], "description": "The file path where results should be written if --watch is specified. If not specified, results will be written to STDOUT.", "env": "SHOPIFY_FLAG_OUTPUT_FILE", "name": "output-file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "version": { "description": "The API version to use for the bulk operation. If not specified, uses the latest stable version.", "env": "SHOPIFY_FLAG_VERSION", "name": "version", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "app:bulk:execute", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": true, "summary": "Execute bulk operations.", "descriptionWithMarkdown": "Executes an Admin API GraphQL query or mutation on the specified store, as a bulk operation. Mutations are only allowed on dev stores.\n\n Bulk operations allow you to process large amounts of data asynchronously. Learn more about [bulk query operations](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 status`](https://shopify.dev/docs/api/shopify-cli/app/app-bulk-status) to check the status of your bulk operations.\n\n With `--watch`, completed results are written as JSONL to stdout or `--output-file`. With `--json`, stdout contains one result object with operation details and downloaded JSONL in `resultsJsonl`. With `--json --output-file`, stdout contains only an absolute file receipt with `path` and `format`.", "customPluginName": "@shopify/app" }, "app:function:build": { "aliases": [], "args": {}, "description": "Compiles the function in your current directory to WebAssembly (Wasm) for testing purposes.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `FunctionBuildResult` schema.\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"const\": \"success\"\n },\n \"function\": {\n \"$ref\": \"#/definitions/FunctionBuild\"\n }\n },\n \"required\": [\n \"status\",\n \"function\"\n ],\n \"additionalProperties\": false,\n \"title\": \"FunctionBuildResult\",\n \"definitions\": {\n \"FunctionBuild\": {\n \"type\": \"object\",\n \"properties\": {\n \"handle\": {\n \"type\": [\n \"string\",\n \"null\"\n ],\n \"description\": \"Null when the extension does not configure a handle.\"\n },\n \"name\": {\n \"type\": \"string\"\n },\n \"directory\": {\n \"type\": \"string\",\n \"pattern\": \"^(?:\\\\/|[a-zA-Z]:[\\\\\\\\/]|\\\\\\\\\\\\\\\\)\",\n \"description\": \"An absolute native filesystem path.\"\n },\n \"wasmPath\": {\n \"anyOf\": [\n {\n \"$ref\": \"#/definitions/FunctionBuild/properties/directory\"\n },\n {\n \"type\": \"null\"\n }\n ],\n \"description\": \"The built Wasm file, or null when the build produced no file.\"\n }\n },\n \"required\": [\n \"handle\",\n \"name\",\n \"directory\",\n \"wasmPath\"\n ],\n \"additionalProperties\": false\n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" }, "auth-alias": { "description": "Alias of the Shopify account to use for authentication.", "env": "SHOPIFY_FLAG_AUTH_ALIAS", "name": "auth-alias", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "no-input": { "description": "Disable interactive prompts and browser authentication.", "env": "SHOPIFY_FLAG_NO_INPUT", "name": "no-input", "allowNo": false, "type": "boolean" }, "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. May include sensitive data.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "allowNo": false, "type": "boolean" }, "path": { "description": "The path to your function directory.", "env": "SHOPIFY_FLAG_PATH", "hidden": false, "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:function:build", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": true, "summary": "Compile a function to wasm.", "descriptionWithMarkdown": "Compiles the function in your current directory to WebAssembly (Wasm) for testing purposes.", "customPluginName": "@shopify/app" }, "app:function:replay": { "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).\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `FunctionRunResult` schema.\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"size\": {\n \"type\": \"integer\",\n \"minimum\": 0,\n \"description\": \"Module size in kilobytes, as reported by Function runner.\"\n },\n \"memory_usage\": {\n \"type\": \"integer\",\n \"minimum\": 0,\n \"description\": \"Linear memory usage in kilobytes, as reported by Function runner.\"\n },\n \"instructions\": {\n \"type\": \"integer\",\n \"minimum\": 0\n },\n \"logs\": {\n \"type\": \"string\"\n },\n \"input\": {\n \"description\": \"Native Function input; query keys and values are preserved.\"\n },\n \"output\": {\n \"description\": \"Native Function output, including the runner-specific invalid-output representation.\"\n },\n \"success\": {\n \"type\": \"boolean\",\n \"description\": \"False for a completed Function execution that failed; the command exits nonzero.\"\n }\n },\n \"required\": [\n \"name\",\n \"size\",\n \"memory_usage\",\n \"instructions\",\n \"logs\",\n \"input\",\n \"output\",\n \"success\"\n ],\n \"additionalProperties\": true,\n \"description\": \"The native JSON object produced by Function runner 7.x and 9.x. Extra upstream fields are preserved.\",\n \"title\": \"FunctionRunResult\",\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" }, "auth-alias": { "description": "Alias of the Shopify account to use for authentication.", "env": "SHOPIFY_FLAG_AUTH_ALIAS", "name": "auth-alias", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "no-input": { "description": "Disable interactive prompts and browser authentication.", "env": "SHOPIFY_FLAG_NO_INPUT", "name": "no-input", "allowNo": false, "type": "boolean" }, "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. May include sensitive data.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "allowNo": false, "type": "boolean" }, "path": { "description": "The path to your function directory.", "env": "SHOPIFY_FLAG_PATH", "hidden": false, "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" }, "log": { "char": "l", "description": "Specifies a log identifier to replay instead of selecting from a list. The identifier is provided in the output of `shopify app dev` and is the suffix of the log file name. Required if non interactive.", "env": "SHOPIFY_FLAG_LOG", "name": "log", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "watch": { "char": "w", "description": "Re-run the function when the source code changes.", "env": "SHOPIFY_FLAG_WATCH", "hidden": false, "name": "watch", "allowNo": true, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "app:function:replay", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": true, "summary": "Replays a function run from an app log.", "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).", "customPluginName": "@shopify/app" }, "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).\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `FunctionRunResult` schema.\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"size\": {\n \"type\": \"integer\",\n \"minimum\": 0,\n \"description\": \"Module size in kilobytes, as reported by Function runner.\"\n },\n \"memory_usage\": {\n \"type\": \"integer\",\n \"minimum\": 0,\n \"description\": \"Linear memory usage in kilobytes, as reported by Function runner.\"\n },\n \"instructions\": {\n \"type\": \"integer\",\n \"minimum\": 0\n },\n \"logs\": {\n \"type\": \"string\"\n },\n \"input\": {\n \"description\": \"Native Function input; query keys and values are preserved.\"\n },\n \"output\": {\n \"description\": \"Native Function output, including the runner-specific invalid-output representation.\"\n },\n \"success\": {\n \"type\": \"boolean\",\n \"description\": \"False for a completed Function execution that failed; the command exits nonzero.\"\n }\n },\n \"required\": [\n \"name\",\n \"size\",\n \"memory_usage\",\n \"instructions\",\n \"logs\",\n \"input\",\n \"output\",\n \"success\"\n ],\n \"additionalProperties\": true,\n \"description\": \"The native JSON object produced by Function runner 7.x and 9.x. Extra upstream fields are preserved.\",\n \"title\": \"FunctionRunResult\",\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" }, "auth-alias": { "description": "Alias of the Shopify account to use for authentication.", "env": "SHOPIFY_FLAG_AUTH_ALIAS", "name": "auth-alias", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "no-input": { "description": "Disable interactive prompts and browser authentication.", "env": "SHOPIFY_FLAG_NO_INPUT", "name": "no-input", "allowNo": false, "type": "boolean" }, "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. May include sensitive data.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "allowNo": false, "type": "boolean" }, "path": { "description": "The path to your function directory.", "env": "SHOPIFY_FLAG_PATH", "hidden": false, "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" }, "input": { "char": "i", "description": "The input JSON to pass to the function. If omitted, standard input is used.", "env": "SHOPIFY_FLAG_INPUT", "name": "input", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "export": { "char": "e", "description": "Name of the WebAssembly export to invoke.", "env": "SHOPIFY_FLAG_EXPORT", "hidden": false, "name": "export", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "description": "Generate a WebAssembly performance profile for the function run. The profile can be viewed in Speedscope.", "env": "SHOPIFY_FLAG_PROFILE", "name": "profile", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "app:function:run", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": true, "summary": "Run a function locally for testing.", "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).", "customPluginName": "@shopify/app" }, "app:function:info": { "aliases": [], "args": {}, "description": "The information returned includes the following:\n\n - The function handle\n - The function name\n - The function API version\n - The targeting configuration\n - The schema path\n - The WASM path\n - The function runner path\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `FunctionInfoResult` schema.\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"function\": {\n \"$ref\": \"#/definitions/FunctionInfo\"\n }\n },\n \"required\": [\n \"function\"\n ],\n \"additionalProperties\": false,\n \"title\": \"FunctionInfoResult\",\n \"definitions\": {\n \"FunctionInfo\": {\n \"type\": \"object\",\n \"properties\": {\n \"handle\": {\n \"type\": [\n \"string\",\n \"null\"\n ],\n \"description\": \"Null when the extension does not configure a handle.\"\n },\n \"name\": {\n \"type\": \"string\"\n },\n \"apiVersion\": {\n \"type\": [\n \"string\",\n \"null\"\n ],\n \"description\": \"The configured API version, or null when unavailable.\"\n },\n \"directory\": {\n \"type\": \"string\",\n \"pattern\": \"^(?:\\\\/|[a-zA-Z]:[\\\\\\\\/]|\\\\\\\\\\\\\\\\)\",\n \"description\": \"An absolute native filesystem path.\"\n },\n \"targets\": {\n \"type\": \"array\",\n \"items\": {\n \"$ref\": \"#/definitions/FunctionTarget\"\n },\n \"description\": \"All configured targets; empty when none are configured.\"\n },\n \"schemaPath\": {\n \"anyOf\": [\n {\n \"$ref\": \"#/definitions/FunctionInfo/properties/directory\"\n },\n {\n \"type\": \"null\"\n }\n ],\n \"description\": \"Null when a GraphQL schema is unavailable.\"\n },\n \"wasmPath\": {\n \"$ref\": \"#/definitions/FunctionInfo/properties/directory\"\n },\n \"functionRunnerPath\": {\n \"$ref\": \"#/definitions/FunctionInfo/properties/directory\"\n }\n },\n \"required\": [\n \"handle\",\n \"name\",\n \"apiVersion\",\n \"directory\",\n \"targets\",\n \"schemaPath\",\n \"wasmPath\",\n \"functionRunnerPath\"\n ],\n \"additionalProperties\": false\n },\n \"FunctionTarget\": {\n \"type\": \"object\",\n \"properties\": {\n \"target\": {\n \"type\": \"string\",\n \"minLength\": 1\n },\n \"inputQueryPath\": {\n \"anyOf\": [\n {\n \"$ref\": \"#/definitions/FunctionInfo/properties/directory\"\n },\n {\n \"type\": \"null\"\n }\n ],\n \"description\": \"Null when no input query is configured.\"\n },\n \"export\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"minLength\": 1\n },\n {\n \"type\": \"null\"\n }\n ],\n \"description\": \"Null when no WebAssembly export is configured.\"\n }\n },\n \"required\": [\n \"target\",\n \"inputQueryPath\",\n \"export\"\n ],\n \"additionalProperties\": false\n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" }, "auth-alias": { "description": "Alias of the Shopify account to use for authentication.", "env": "SHOPIFY_FLAG_AUTH_ALIAS", "name": "auth-alias", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "no-input": { "description": "Disable interactive prompts and browser authentication.", "env": "SHOPIFY_FLAG_NO_INPUT", "name": "no-input", "allowNo": false, "type": "boolean" }, "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. May include sensitive data.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "allowNo": false, "type": "boolean" }, "path": { "description": "The path to your function directory.", "env": "SHOPIFY_FLAG_PATH", "hidden": false, "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:function:info", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": true, "summary": "Print basic information about your function.", "descriptionWithMarkdown": "The information returned includes the following:\n\n - The function handle\n - The function name\n - The function API version\n - The targeting configuration\n - The schema path\n - The WASM path\n - The function runner path", "customPluginName": "@shopify/app" }, "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.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `FunctionSchemaResult` schema.\n\n```json\n{\n \"anyOf\": [\n {\n \"$ref\": \"#/definitions/FunctionSchemaFile\"\n },\n {\n \"$ref\": \"#/definitions/FunctionSchemaContent\"\n }\n ],\n \"title\": \"FunctionSchemaResult\",\n \"definitions\": {\n \"FunctionSchemaFile\": {\n \"type\": \"object\",\n \"properties\": {\n \"path\": {\n \"type\": \"string\",\n \"pattern\": \"^(?:\\\\/|[a-zA-Z]:[\\\\\\\\/]|\\\\\\\\\\\\\\\\)\",\n \"description\": \"An absolute native filesystem path.\"\n },\n \"format\": {\n \"type\": \"string\",\n \"const\": \"graphql\",\n \"description\": \"The file contains native GraphQL SDL with the API-version header.\"\n }\n },\n \"required\": [\n \"path\",\n \"format\"\n ],\n \"additionalProperties\": false\n },\n \"FunctionSchemaContent\": {\n \"type\": \"object\",\n \"properties\": {\n \"schema\": {\n \"type\": \"string\",\n \"description\": \"Native GraphQL SDL with the API-version header, returned with --stdout --json.\"\n }\n },\n \"required\": [\n \"schema\"\n ],\n \"additionalProperties\": false\n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" }, "auth-alias": { "description": "Alias of the Shopify account to use for authentication.", "env": "SHOPIFY_FLAG_AUTH_ALIAS", "name": "auth-alias", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "no-input": { "description": "Disable interactive prompts and browser authentication.", "env": "SHOPIFY_FLAG_NO_INPUT", "name": "no-input", "allowNo": false, "type": "boolean" }, "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. May include sensitive data.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "allowNo": false, "type": "boolean" }, "path": { "description": "The path to your function directory.", "env": "SHOPIFY_FLAG_PATH", "hidden": false, "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" }, "stdout": { "description": "Output the schema to stdout instead of writing to a file.", "env": "SHOPIFY_FLAG_STDOUT", "name": "stdout", "required": false, "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "app:function:schema", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": true, "summary": "Fetch the latest GraphQL schema for a function.", "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.", "customPluginName": "@shopify/app" }, "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. Supports JavaScript functions out of the box, or any language via the `build.typegen_command` configuration.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `FunctionTypegenResult` schema.\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"const\": \"success\"\n },\n \"function\": {\n \"$ref\": \"#/definitions/Function\"\n }\n },\n \"required\": [\n \"status\",\n \"function\"\n ],\n \"additionalProperties\": false,\n \"title\": \"FunctionTypegenResult\",\n \"definitions\": {\n \"Function\": {\n \"type\": \"object\",\n \"properties\": {\n \"handle\": {\n \"type\": [\n \"string\",\n \"null\"\n ],\n \"description\": \"Null when the extension does not configure a handle.\"\n },\n \"name\": {\n \"type\": \"string\"\n },\n \"directory\": {\n \"type\": \"string\",\n \"pattern\": \"^(?:\\\\/|[a-zA-Z]:[\\\\\\\\/]|\\\\\\\\\\\\\\\\)\",\n \"description\": \"An absolute native filesystem path.\"\n }\n },\n \"required\": [\n \"handle\",\n \"name\",\n \"directory\"\n ],\n \"additionalProperties\": false\n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" }, "auth-alias": { "description": "Alias of the Shopify account to use for authentication.", "env": "SHOPIFY_FLAG_AUTH_ALIAS", "name": "auth-alias", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "no-input": { "description": "Disable interactive prompts and browser authentication.", "env": "SHOPIFY_FLAG_NO_INPUT", "name": "no-input", "allowNo": false, "type": "boolean" }, "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. May include sensitive data.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "allowNo": false, "type": "boolean" }, "path": { "description": "The path to your function directory.", "env": "SHOPIFY_FLAG_PATH", "hidden": false, "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:function:typegen", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": true, "summary": "Generate GraphQL types for a function.", "descriptionWithMarkdown": "Creates GraphQL types based on your [input query](https://shopify.dev/docs/apps/functions/input-output#input) for a function. Supports JavaScript functions out of the box, or any language via the `build.typegen_command` configuration.", "customPluginName": "@shopify/app" }, "app:generate:extension": { "aliases": [], "args": {}, "description": "Generates a new \"app extension\" (https://shopify.dev/docs/apps/build/app-extensions). For a list of app extensions that you can generate using this command, refer to \"Supported extensions\" (https://shopify.dev/docs/apps/build/app-extensions/list-of-app-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/build/cli-for-apps/app-structure) and the documentation for your extension.\n \n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `AppGenerateExtensionResult` schema.\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"const\": \"success\"\n },\n \"extension\": {\n \"$ref\": \"#/definitions/GeneratedExtension\"\n }\n },\n \"required\": [\n \"status\",\n \"extension\"\n ],\n \"additionalProperties\": false,\n \"title\": \"AppGenerateExtensionResult\",\n \"definitions\": {\n \"GeneratedExtension\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"minLength\": 1,\n \"description\": \"The name selected for the generated extension.\"\n },\n \"type\": {\n \"type\": \"string\",\n \"minLength\": 1,\n \"description\": \"The extension type, such as function, theme, or ui_extension.\"\n },\n \"template\": {\n \"type\": \"string\",\n \"minLength\": 1,\n \"description\": \"The identifier of the selected extension template.\"\n },\n \"flavor\": {\n \"type\": [\n \"string\",\n \"null\"\n ],\n \"description\": \"The selected template flavor, or null when the template has no flavors.\"\n },\n \"directory\": {\n \"type\": \"string\",\n \"description\": \"The absolute native filesystem path of the generated extension directory.\"\n }\n },\n \"required\": [\n \"name\",\n \"type\",\n \"template\",\n \"flavor\",\n \"directory\"\n ],\n \"additionalProperties\": false\n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" }, "auth-alias": { "description": "Alias of the Shopify account to use for authentication.", "env": "SHOPIFY_FLAG_AUTH_ALIAS", "name": "auth-alias", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "no-input": { "description": "Disable interactive prompts and browser authentication.", "env": "SHOPIFY_FLAG_NO_INPUT", "name": "no-input", "allowNo": false, "type": "boolean" }, "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. May include sensitive data.", "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" }, "template": { "char": "t", "description": "Extension template. Required if non interactive.", "env": "SHOPIFY_FLAG_EXTENSION_TEMPLATE", "hidden": false, "name": "template", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "name": { "char": "n", "description": "name of your Extension. Required if non interactive.", "env": "SHOPIFY_FLAG_NAME", "hidden": false, "name": "name", "hasDynamicHelp": false, "multiple": false, "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", "hidden": true, "name": "clone-url", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "flavor": { "description": "Choose a starting template for your extension, where applicable. Supported flavors depend on the selected extension template. Required if non interactive when the selected extension template supports multiple flavors.", "env": "SHOPIFY_FLAG_FLAVOR", "hidden": false, "name": "flavor", "hasDynamicHelp": false, "multiple": false, "options": [ "vanilla-js", "preact", "react", "typescript", "typescript-react", "rust", "wasm", "liquid", "config-only" ], "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "app:generate:extension", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": true, "summary": "Generate a new app Extension.", "descriptionWithMarkdown": "Generates a new [app extension](https://shopify.dev/docs/apps/build/app-extensions). For a list of app extensions that you can generate using this command, refer to [Supported extensions](https://shopify.dev/docs/apps/build/app-extensions/list-of-app-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/build/cli-for-apps/app-structure) and the documentation for your extension.\n ", "customPluginName": "@shopify/app" }, "app:versions:list": { "aliases": [], "args": {}, "description": "Lists the deployed app versions. An app version is a snapshot of your app extensions.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `AppVersionsListResult` schema.\n\n```json\n{\n \"type\": \"array\",\n \"items\": {\n \"$ref\": \"#/definitions/AppVersion\"\n },\n \"title\": \"AppVersionsListResult\",\n \"definitions\": {\n \"AppVersion\": {\n \"type\": \"object\",\n \"properties\": {\n \"createdAt\": {\n \"type\": \"string\"\n },\n \"createdBy\": {\n \"type\": \"string\"\n },\n \"versionTag\": {\n \"type\": [\n \"string\",\n \"null\"\n ]\n },\n \"status\": {\n \"type\": \"string\"\n },\n \"versionId\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"createdAt\",\n \"createdBy\",\n \"status\",\n \"versionId\",\n \"message\"\n ],\n \"additionalProperties\": false\n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" }, "auth-alias": { "description": "Alias of the Shopify account to use for authentication.", "env": "SHOPIFY_FLAG_AUTH_ALIAS", "name": "auth-alias", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "no-input": { "description": "Disable interactive prompts and browser authentication.", "env": "SHOPIFY_FLAG_NO_INPUT", "name": "no-input", "allowNo": false, "type": "boolean" }, "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. May include sensitive data.", "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:versions:list", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": true, "summary": "List deployed versions of your app.", "descriptionWithMarkdown": "Lists the deployed app versions. An app version is a snapshot of your app extensions.", "customPluginName": "@shopify/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 \n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `AppWebhookTriggerResult` schema.\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"const\": \"success\"\n },\n \"delivery\": {\n \"$ref\": \"#/definitions/AppWebhookDelivery\"\n }\n },\n \"required\": [\n \"status\",\n \"delivery\"\n ],\n \"additionalProperties\": false,\n \"title\": \"AppWebhookTriggerResult\",\n \"definitions\": {\n \"AppWebhookDelivery\": {\n \"type\": \"object\",\n \"properties\": {\n \"topic\": {\n \"type\": \"string\"\n },\n \"apiVersion\": {\n \"type\": \"string\"\n },\n \"deliveryMethod\": {\n \"type\": \"string\",\n \"enum\": [\n \"localhost\",\n \"http\",\n \"google-pub-sub\",\n \"event-bridge\"\n ]\n },\n \"address\": {\n \"type\": \"string\"\n },\n \"status\": {\n \"type\": \"string\",\n \"enum\": [\n \"delivered\",\n \"enqueued\"\n ],\n \"description\": \"Remote delivery is enqueued, not confirmed received.\"\n }\n },\n \"required\": [\n \"topic\",\n \"apiVersion\",\n \"deliveryMethod\",\n \"address\",\n \"status\"\n ],\n \"additionalProperties\": false\n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" }, "auth-alias": { "description": "Alias of the Shopify account to use for authentication.", "env": "SHOPIFY_FLAG_AUTH_ALIAS", "name": "auth-alias", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "no-input": { "description": "Disable interactive prompts and browser authentication.", "env": "SHOPIFY_FLAG_NO_INPUT", "name": "no-input", "allowNo": false, "type": "boolean" }, "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. May include sensitive data.", "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" }, "help": { "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, "allowNo": false, "type": "boolean" }, "topic": { "description": "The requested webhook topic. Required if non interactive.", "env": "SHOPIFY_FLAG_TOPIC", "hidden": false, "name": "topic", "required": false, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "api-version": { "description": "The API Version of the webhook topic. Required if non interactive.", "env": "SHOPIFY_FLAG_API_VERSION", "hidden": false, "name": "api-version", "required": false, "hasDynamicHelp": false, "multiple": 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", "hidden": false, "name": "delivery-method", "required": false, "hasDynamicHelp": false, "multiple": false, "options": [ "http", "google-pub-sub", "event-bridge" ], "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", "hidden": false, "name": "client-secret", "required": false, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "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:. Required if non interactive.", "env": "SHOPIFY_FLAG_ADDRESS", "hidden": false, "name": "address", "required": false, "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "app:webhook:trigger", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": true, "summary": "Trigger delivery of a sample webhook topic payload to a designated address.", "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 ", "customPluginName": "@shopify/app" }, "demo:watcher": { "aliases": [], "args": {}, "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" }, "auth-alias": { "description": "Alias of the Shopify account to use for authentication.", "env": "SHOPIFY_FLAG_AUTH_ALIAS", "name": "auth-alias", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "no-input": { "description": "Disable interactive prompts and browser authentication.", "env": "SHOPIFY_FLAG_NO_INPUT", "name": "no-input", "allowNo": false, "type": "boolean" }, "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. May include sensitive data.", "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, "hidden": true, "hiddenAliases": [], "id": "demo:watcher", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": true, "summary": "Watch and prints out changes to an app.", "customPluginName": "@shopify/app" }, "organization:list": { "aliases": [], "args": {}, "description": "Lists the Shopify organizations that you have access to, along with their organization IDs.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `OrganizationListResult` schema.\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"organizations\": {\n \"type\": \"array\",\n \"items\": {\n \"$ref\": \"#/definitions/OrganizationListEntry\"\n }\n }\n },\n \"required\": [\n \"organizations\"\n ],\n \"additionalProperties\": false,\n \"title\": \"OrganizationListResult\",\n \"definitions\": {\n \"OrganizationListEntry\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"type\": \"string\"\n },\n \"gid\": {\n \"type\": \"string\"\n },\n \"name\": {\n \"type\": \"string\"\n },\n \"status\": {\n \"type\": \"string\",\n \"enum\": [\n \"ACTIVE\",\n \"LOCKED\"\n ]\n },\n \"shopCount\": {\n \"type\": [\n \"number\",\n \"null\"\n ]\n },\n \"url\": {\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"id\",\n \"gid\",\n \"name\",\n \"status\",\n \"shopCount\",\n \"url\"\n ],\n \"additionalProperties\": false\n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" }, "auth-alias": { "description": "Alias of the Shopify account to use for authentication.", "env": "SHOPIFY_FLAG_AUTH_ALIAS", "name": "auth-alias", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "no-input": { "description": "Disable interactive prompts and browser authentication.", "env": "SHOPIFY_FLAG_NO_INPUT", "name": "no-input", "allowNo": false, "type": "boolean" }, "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. May include sensitive data.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "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": "organization:list", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": true, "summary": "List Shopify organizations you have access to.", "enableJsonFlag": false, "descriptionWithMarkdown": "Lists the Shopify organizations that you have access to, along with their organization IDs.", "customPluginName": "@shopify/app" }, "theme:init": { "aliases": [], "args": { "name": { "description": "Name of the new theme", "name": "name", "required": false } }, "description": "Clones a Git repository to your local machine to use as the starting point for building a theme.\n\n If no Git repository is specified, then this command creates a copy of Shopify's \"Skeleton theme\" (https://github.com/Shopify/skeleton-theme.git), with the specified name in the current folder. If no name is provided, then you're prompted to enter one.\n\n > Caution: If you're building a theme for the Shopify Theme Store, then you can use our example theme as a starting point. However, the theme that you submit needs to be \"substantively different from existing themes\" (https://shopify.dev/docs/themes/store/requirements#uniqueness) so that it provides added value for users.\n \n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `ThemeInitResult` schema.\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"enum\": [\n \"success\",\n \"partial\"\n ]\n },\n \"changed\": {\n \"type\": \"boolean\",\n \"const\": true\n },\n \"directory\": {\n \"$ref\": \"#/definitions/AbsolutePath\"\n },\n \"repoUrl\": {\n \"type\": \"string\",\n \"minLength\": 1,\n \"description\": \"The source Git remote (including HTTPS, SSH, or SCP-style Git URLs).\"\n },\n \"latest\": {\n \"type\": \"boolean\"\n },\n \"aiInstructions\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"enum\": [\n \"all\",\n \"github\",\n \"cursor\",\n \"claude\"\n ]\n },\n {\n \"type\": \"null\"\n }\n ]\n },\n \"instructionFilePaths\": {\n \"anyOf\": [\n {\n \"type\": \"array\",\n \"items\": {\n \"$ref\": \"#/definitions/AbsolutePath\"\n }\n },\n {\n \"type\": \"null\"\n }\n ],\n \"description\": \"Created instruction files, or null when setup failed before their completion could be established.\"\n },\n \"reason\": {\n \"type\": [\n \"string\",\n \"null\"\n ],\n \"description\": \"The reason for incomplete setup, or null when setup completed.\"\n }\n },\n \"required\": [\n \"status\",\n \"changed\",\n \"directory\",\n \"repoUrl\",\n \"latest\",\n \"aiInstructions\",\n \"instructionFilePaths\",\n \"reason\"\n ],\n \"additionalProperties\": false,\n \"title\": \"ThemeInitResult\",\n \"definitions\": {\n \"AbsolutePath\": {\n \"type\": \"string\",\n \"description\": \"An absolute native filesystem path.\"\n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" }, "auth-alias": { "description": "Alias of the Shopify account to use for authentication.", "env": "SHOPIFY_FLAG_AUTH_ALIAS", "name": "auth-alias", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "no-input": { "description": "Disable interactive prompts and browser authentication.", "env": "SHOPIFY_FLAG_NO_INPUT", "name": "no-input", "allowNo": false, "type": "boolean" }, "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. May include sensitive data.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "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" }, "path": { "description": "The path where you want to run the command. Defaults to the current working directory.", "env": "SHOPIFY_FLAG_PATH", "name": "path", "noCacheDefault": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "clone-url": { "char": "u", "description": "The Git URL to clone from. Defaults to Shopify's Skeleton theme.", "env": "SHOPIFY_FLAG_CLONE_URL", "name": "clone-url", "default": "https://github.com/Shopify/skeleton-theme.git", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "latest": { "char": "l", "description": "Downloads the latest release of the `clone-url`", "env": "SHOPIFY_FLAG_LATEST", "name": "latest", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "theme:init", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": true, "summary": "Clones a Git repository to use as a starting point for building a new theme.", "usage": "theme init [name] [flags]", "enableJsonFlag": false, "descriptionWithMarkdown": "Clones a Git repository to your local machine to use as the starting point for building a theme.\n\n If no Git repository is specified, then this command creates a copy of Shopify's [Skeleton theme](https://github.com/Shopify/skeleton-theme.git), with the specified name in the current folder. If no name is provided, then you're prompted to enter one.\n\n > Caution: If you're building a theme for the Shopify Theme Store, then you can use our example theme as a starting point. However, the theme that you submit needs to be [substantively different from existing themes](https://shopify.dev/docs/themes/store/requirements#uniqueness) so that it provides added value for users.\n ", "multiEnvironmentsFlags": null, "customPluginName": "@shopify/theme" }, "theme:check": { "aliases": [], "args": {}, "description": "Calls and runs \"Theme Check\" (https://shopify.dev/docs/themes/tools/theme-check) to analyze your theme code for errors and to ensure that it follows theme and Liquid best practices. \"Learn more about the checks that Theme Check runs.\" (https://shopify.dev/docs/themes/tools/theme-check/checks)\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `ThemeCheckResult` schema.\n\n```json\n{\n \"anyOf\": [\n {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/0/properties/result\"\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"environments\": {\n \"type\": \"array\",\n \"items\": {\n \"$ref\": \"#/definitions/ThemeEnvironment\"\n }\n }\n },\n \"required\": [\n \"environments\"\n ],\n \"additionalProperties\": false\n }\n ],\n \"title\": \"ThemeCheckResult\",\n \"definitions\": {\n \"ThemeCheckIssue\": {\n \"type\": \"object\",\n \"properties\": {\n \"filePath\": {\n \"type\": \"string\",\n \"description\": \"The absolute native path of the file.\"\n },\n \"check\": {\n \"type\": \"string\"\n },\n \"severity\": {\n \"type\": \"string\",\n \"enum\": [\n \"error\",\n \"warning\",\n \"info\"\n ]\n },\n \"startRow\": {\n \"type\": \"integer\",\n \"exclusiveMinimum\": 0,\n \"description\": \"The one-based starting line.\"\n },\n \"startColumn\": {\n \"type\": \"integer\",\n \"exclusiveMinimum\": 0,\n \"description\": \"The one-based starting column.\"\n },\n \"endRow\": {\n \"type\": \"integer\",\n \"exclusiveMinimum\": 0,\n \"description\": \"The one-based ending line.\"\n },\n \"endColumn\": {\n \"type\": \"integer\",\n \"exclusiveMinimum\": 0,\n \"description\": \"The one-based ending column.\"\n },\n \"message\": {\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"filePath\",\n \"check\",\n \"severity\",\n \"startRow\",\n \"startColumn\",\n \"endRow\",\n \"endColumn\",\n \"message\"\n ],\n \"additionalProperties\": false\n },\n \"ThemeEnvironment\": {\n \"anyOf\": [\n {\n \"type\": \"object\",\n \"properties\": {\n \"environment\": {\n \"type\": \"string\"\n },\n \"result\": {\n \"anyOf\": [\n {\n \"type\": \"object\",\n \"properties\": {\n \"valid\": {\n \"type\": \"boolean\",\n \"description\": \"Whether the validation passes the selected blocking policy.\"\n },\n \"issues\": {\n \"type\": \"array\",\n \"items\": {\n \"$ref\": \"#/definitions/ThemeCheckIssue\"\n }\n },\n \"errorCount\": {\n \"type\": \"integer\",\n \"minimum\": 0\n },\n \"warningCount\": {\n \"type\": \"integer\",\n \"minimum\": 0\n },\n \"infoCount\": {\n \"type\": \"integer\",\n \"minimum\": 0\n }\n },\n \"required\": [\n \"valid\",\n \"issues\",\n \"errorCount\",\n \"warningCount\",\n \"infoCount\"\n ],\n \"additionalProperties\": false\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"const\": \"cancelled\"\n }\n },\n \"required\": [\n \"status\"\n ],\n \"additionalProperties\": false\n }\n ]\n }\n },\n \"required\": [\n \"environment\",\n \"result\"\n ],\n \"additionalProperties\": false\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"environment\": {\n \"type\": \"string\"\n },\n \"error\": {\n \"anyOf\": [\n {\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"const\": \"abort\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"code\": {\n \"type\": \"string\",\n \"minLength\": 1,\n \"description\": \"A stable error code, included only when known.\"\n },\n \"tryMessage\": {\n \"type\": \"string\"\n },\n \"nextSteps\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n },\n \"customSections\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"title\": {\n \"type\": \"string\"\n },\n \"body\": {\n \"anyOf\": [\n {\n \"type\": \"string\"\n },\n {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n }\n ]\n }\n },\n \"required\": [\n \"body\"\n ],\n \"additionalProperties\": false\n }\n },\n \"details\": {\n \"description\": \"Selected domain details, preserving native API payloads such as GraphQL errors, extensions, and data.\"\n }\n },\n \"required\": [\n \"type\",\n \"message\"\n ],\n \"additionalProperties\": false\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"const\": \"bug\"\n },\n \"message\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/message\"\n },\n \"code\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/code\"\n },\n \"tryMessage\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/tryMessage\"\n },\n \"nextSteps\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/nextSteps\"\n },\n \"customSections\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/customSections\"\n },\n \"details\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/details\"\n },\n \"stack\": {\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"type\",\n \"message\"\n ],\n \"additionalProperties\": false\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"const\": \"external\"\n },\n \"message\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/message\"\n },\n \"code\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/code\"\n },\n \"tryMessage\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/tryMessage\"\n },\n \"nextSteps\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/nextSteps\"\n },\n \"customSections\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/customSections\"\n },\n \"details\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/details\"\n },\n \"command\": {\n \"type\": \"string\"\n },\n \"args\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n },\n \"required\": [\n \"type\",\n \"message\",\n \"command\",\n \"args\"\n ],\n \"additionalProperties\": false\n }\n ]\n }\n },\n \"required\": [\n \"environment\",\n \"error\"\n ],\n \"additionalProperties\": false\n }\n ]\n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" }, "auth-alias": { "description": "Alias of the Shopify account to use for authentication.", "env": "SHOPIFY_FLAG_AUTH_ALIAS", "name": "auth-alias", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "no-input": { "description": "Disable interactive prompts and browser authentication.", "env": "SHOPIFY_FLAG_NO_INPUT", "name": "no-input", "allowNo": false, "type": "boolean" }, "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. May include sensitive data.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "allowNo": false, "type": "boolean" }, "json": { "char": "j", "description": "Output the result as JSON. Automatically disables color output.", "env": "SHOPIFY_FLAG_JSON", "exclusive": [ "init", "version", "print", "list" ], "hidden": false, "name": "json", "allowNo": false, "type": "boolean" }, "path": { "description": "The path where you want to run the command. Defaults to the current working directory.", "env": "SHOPIFY_FLAG_PATH", "name": "path", "noCacheDefault": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "auto-correct": { "char": "a", "description": "Automatically fix offenses", "env": "SHOPIFY_FLAG_AUTO_CORRECT", "name": "auto-correct", "required": false, "allowNo": false, "type": "boolean" }, "config": { "char": "C", "description": "Path to a config file to use, overriding .theme-check.yml if present\n Use --path to set the theme directory\n Supports all theme-check: config values, e.g., theme-check:theme-app-extension,\n theme-check:recommended, theme-check:all\n For backwards compatibility, :theme_app_extension is also supported ", "env": "SHOPIFY_FLAG_CONFIG", "name": "config", "required": false, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "fail-level": { "description": "Minimum severity for exit with error code", "env": "SHOPIFY_FLAG_FAIL_LEVEL", "name": "fail-level", "required": false, "default": "error", "hasDynamicHelp": false, "multiple": false, "options": [ "crash", "error", "suggestion", "style", "warning", "info" ], "type": "option" }, "init": { "description": "Generate a .theme-check.yml file", "env": "SHOPIFY_FLAG_INIT", "name": "init", "required": false, "allowNo": false, "type": "boolean" }, "list": { "description": "List enabled checks", "env": "SHOPIFY_FLAG_LIST", "name": "list", "required": false, "allowNo": false, "type": "boolean" }, "output": { "char": "o", "description": "The output format to use", "env": "SHOPIFY_FLAG_OUTPUT", "name": "output", "required": false, "default": "text", "hasDynamicHelp": false, "multiple": false, "options": [ "text", "json" ], "type": "option" }, "print": { "description": "Output active config to STDOUT", "env": "SHOPIFY_FLAG_PRINT", "name": "print", "required": false, "allowNo": false, "type": "boolean" }, "version": { "char": "v", "description": "Print Theme Check version", "env": "SHOPIFY_FLAG_VERSION", "name": "version", "required": false, "allowNo": false, "type": "boolean" }, "environment": { "char": "e", "description": "The environment to apply to the current command.", "env": "SHOPIFY_FLAG_ENVIRONMENT", "name": "environment", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "theme:check", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": true, "summary": "Validate the theme.", "enableJsonFlag": false, "descriptionWithMarkdown": "Calls and runs [Theme Check](https://shopify.dev/docs/themes/tools/theme-check) to analyze your theme code for errors and to ensure that it follows theme and Liquid best practices. [Learn more about the checks that Theme Check runs.](https://shopify.dev/docs/themes/tools/theme-check/checks)", "multiEnvironmentsFlags": [ "path" ], "customPluginName": "@shopify/theme" }, "theme:console": { "aliases": [], "args": {}, "description": "Starts the Shopify Liquid REPL (read-eval-print loop) tool. This tool provides an interactive terminal interface for evaluating Liquid code and exploring Liquid objects, filters, and tags using real store data.\n\n You can also provide context to the console using a URL, as some Liquid objects are context-specific", "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" }, "auth-alias": { "description": "Alias of the Shopify account to use for authentication.", "env": "SHOPIFY_FLAG_AUTH_ALIAS", "name": "auth-alias", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "no-input": { "description": "Disable interactive prompts and browser authentication.", "env": "SHOPIFY_FLAG_NO_INPUT", "name": "no-input", "allowNo": false, "type": "boolean" }, "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. May include sensitive data.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "allowNo": false, "type": "boolean" }, "path": { "description": "The path where you want to run the command. Defaults to the current working directory.", "env": "SHOPIFY_FLAG_PATH", "name": "path", "noCacheDefault": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "password": { "description": "Password generated from the Theme Access app or an Admin API token.", "env": "SHOPIFY_CLI_THEME_TOKEN", "name": "password", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "store": { "char": "s", "description": "Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).", "env": "SHOPIFY_FLAG_STORE", "name": "store", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "environment": { "char": "e", "description": "The environment to apply to the current command.", "env": "SHOPIFY_FLAG_ENVIRONMENT", "name": "environment", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "url": { "description": "The url to be used as context", "env": "SHOPIFY_FLAG_URL", "name": "url", "default": "/", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "store-password": { "description": "The password for storefronts with password protection.", "env": "SHOPIFY_FLAG_STORE_PASSWORD", "name": "store-password", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "theme:console", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": true, "summary": "Shopify Liquid REPL (read-eval-print loop) tool", "usage": [ "theme console", "theme console --url /products/classic-leather-jacket" ], "enableJsonFlag": false, "descriptionWithMarkdown": "Starts the Shopify Liquid REPL (read-eval-print loop) tool. This tool provides an interactive terminal interface for evaluating Liquid code and exploring Liquid objects, filters, and tags using real store data.\n\n You can also provide context to the console using a URL, as some Liquid objects are context-specific", "multiEnvironmentsFlags": null, "customPluginName": "@shopify/theme" }, "theme:delete": { "aliases": [], "args": {}, "description": "Deletes a theme from your store.\n\n You can specify multiple themes by ID. If no theme is specified, then you're prompted to select the theme that you want to delete from the list of themes in your store.\n\n You're asked to confirm that you want to delete the specified themes before they are deleted. You can skip this confirmation using the `--force` flag.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `ThemeDeleteResult` schema.\n\n```json\n{\n \"anyOf\": [\n {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/0/properties/result\"\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"environments\": {\n \"type\": \"array\",\n \"items\": {\n \"$ref\": \"#/definitions/ThemeEnvironment\"\n }\n }\n },\n \"required\": [\n \"environments\"\n ],\n \"additionalProperties\": false\n }\n ],\n \"title\": \"ThemeDeleteResult\",\n \"definitions\": {\n \"Theme\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"type\": \"string\",\n \"pattern\": \"^\\\\d+$\",\n \"description\": \"The decimal Online Store theme ID, not a Shopify GID.\"\n },\n \"name\": {\n \"type\": \"string\"\n },\n \"role\": {\n \"type\": \"string\",\n \"description\": \"The upstream theme role; known values include live, unpublished, and development.\"\n },\n \"storeDomain\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"pattern\": \"^[a-z0-9][a-z0-9-]*\\\\.myshopify\\\\.com$\"\n },\n {\n \"type\": \"null\"\n }\n ]\n },\n \"processing\": {\n \"type\": \"boolean\"\n },\n \"sourceUrl\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"format\": \"uri\"\n },\n {\n \"type\": \"null\"\n }\n ]\n }\n },\n \"required\": [\n \"id\",\n \"name\",\n \"role\",\n \"storeDomain\",\n \"processing\",\n \"sourceUrl\"\n ],\n \"additionalProperties\": false,\n \"description\": \"The selected theme projection; sourceUrl is null when the upstream source URL is unavailable.\"\n },\n \"ThemeEnvironment\": {\n \"anyOf\": [\n {\n \"type\": \"object\",\n \"properties\": {\n \"environment\": {\n \"type\": \"string\"\n },\n \"result\": {\n \"anyOf\": [\n {\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"enum\": [\n \"success\",\n \"partial\"\n ]\n },\n \"changed\": {\n \"type\": \"boolean\"\n },\n \"themes\": {\n \"type\": \"array\",\n \"items\": {\n \"$ref\": \"#/definitions/Theme\"\n }\n },\n \"errors\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"themeId\": {\n \"type\": \"string\",\n \"pattern\": \"^\\\\d+$\"\n },\n \"error\": {\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"const\": \"abort\"\n },\n \"message\": {\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"type\",\n \"message\"\n ],\n \"additionalProperties\": false\n }\n },\n \"required\": [\n \"themeId\",\n \"error\"\n ],\n \"additionalProperties\": false\n }\n }\n },\n \"required\": [\n \"status\",\n \"changed\",\n \"themes\"\n ],\n \"additionalProperties\": false\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"const\": \"cancelled\"\n }\n },\n \"required\": [\n \"status\"\n ],\n \"additionalProperties\": false\n }\n ]\n }\n },\n \"required\": [\n \"environment\",\n \"result\"\n ],\n \"additionalProperties\": false\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"environment\": {\n \"type\": \"string\"\n },\n \"error\": {\n \"anyOf\": [\n {\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"const\": \"abort\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"code\": {\n \"type\": \"string\",\n \"minLength\": 1,\n \"description\": \"A stable error code, included only when known.\"\n },\n \"tryMessage\": {\n \"type\": \"string\"\n },\n \"nextSteps\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n },\n \"customSections\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"title\": {\n \"type\": \"string\"\n },\n \"body\": {\n \"anyOf\": [\n {\n \"type\": \"string\"\n },\n {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n }\n ]\n }\n },\n \"required\": [\n \"body\"\n ],\n \"additionalProperties\": false\n }\n },\n \"details\": {\n \"description\": \"Selected domain details, preserving native API payloads such as GraphQL errors, extensions, and data.\"\n }\n },\n \"required\": [\n \"type\",\n \"message\"\n ],\n \"additionalProperties\": false\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"const\": \"bug\"\n },\n \"message\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/message\"\n },\n \"code\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/code\"\n },\n \"tryMessage\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/tryMessage\"\n },\n \"nextSteps\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/nextSteps\"\n },\n \"customSections\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/customSections\"\n },\n \"details\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/details\"\n },\n \"stack\": {\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"type\",\n \"message\"\n ],\n \"additionalProperties\": false\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"const\": \"external\"\n },\n \"message\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/message\"\n },\n \"code\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/code\"\n },\n \"tryMessage\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/tryMessage\"\n },\n \"nextSteps\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/nextSteps\"\n },\n \"customSections\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/customSections\"\n },\n \"details\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/details\"\n },\n \"command\": {\n \"type\": \"string\"\n },\n \"args\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n },\n \"required\": [\n \"type\",\n \"message\",\n \"command\",\n \"args\"\n ],\n \"additionalProperties\": false\n }\n ]\n }\n },\n \"required\": [\n \"environment\",\n \"error\"\n ],\n \"additionalProperties\": false\n }\n ]\n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" }, "auth-alias": { "description": "Alias of the Shopify account to use for authentication.", "env": "SHOPIFY_FLAG_AUTH_ALIAS", "name": "auth-alias", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "no-input": { "description": "Disable interactive prompts and browser authentication.", "env": "SHOPIFY_FLAG_NO_INPUT", "name": "no-input", "allowNo": false, "type": "boolean" }, "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. May include sensitive data.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "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" }, "path": { "description": "The path where you want to run the command. Defaults to the current working directory.", "env": "SHOPIFY_FLAG_PATH", "name": "path", "noCacheDefault": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "password": { "description": "Password generated from the Theme Access app or an Admin API token.", "env": "SHOPIFY_CLI_THEME_TOKEN", "name": "password", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "store": { "char": "s", "description": "Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).", "env": "SHOPIFY_FLAG_STORE", "name": "store", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "environment": { "char": "e", "description": "The environment to apply to the current command.", "env": "SHOPIFY_FLAG_ENVIRONMENT", "name": "environment", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "development": { "char": "d", "description": "Delete your development theme. Use --show-all, --development, or --theme in non-interactive environments.", "env": "SHOPIFY_FLAG_DEVELOPMENT", "name": "development", "allowNo": false, "type": "boolean" }, "show-all": { "char": "a", "description": "Include other development themes in the theme list. Use --show-all, --development, or --theme in non-interactive environments.", "env": "SHOPIFY_FLAG_SHOW_ALL", "name": "show-all", "allowNo": false, "type": "boolean" }, "force": { "char": "f", "description": "Skip confirmation. Required if non interactive.", "env": "SHOPIFY_FLAG_FORCE", "name": "force", "allowNo": false, "type": "boolean" }, "theme": { "char": "t", "description": "Theme ID or name of the remote theme. Use --show-all, --development, or --theme in non-interactive environments.", "env": "SHOPIFY_FLAG_THEME_ID", "name": "theme", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "theme:delete", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": true, "summary": "Delete remote themes from the connected store. This command can't be undone.", "enableJsonFlag": false, "descriptionWithMarkdown": "Deletes a theme from your store.\n\n You can specify multiple themes by ID. If no theme is specified, then you're prompted to select the theme that you want to delete from the list of themes in your store.\n\n You're asked to confirm that you want to delete the specified themes before they are deleted. You can skip this confirmation using the `--force` flag.", "multiEnvironmentsFlags": [ "store", "password", [ "development", "theme", "show-all" ] ], "customPluginName": "@shopify/theme" }, "theme:dev": { "aliases": [], "args": {}, "description": "\n Uploads the current theme as the specified theme, or a \"development theme\" (https://shopify.dev/docs/themes/tools/cli#development-themes), to a store so you can preview it.\n\nThis command returns the following information:\n\n- A link to your development theme at http://127.0.0.1:9292. This URL can hot reload local changes to CSS and sections, or refresh the entire page when a file changes, enabling you to preview changes in real time using the store's data.\n\n You can specify a different network interface and port using `--host` and `--port`.\n\n- A link to the \"editor\" (https://shopify.dev/docs/themes/tools/online-editor) for the theme in the Shopify admin.\n\n- A \"preview link\" (https://help.shopify.com/manual/online-store/themes/adding-themes#share-a-theme-preview-with-others) that you can share with other developers.\n\nIf you already have a development theme for your current environment, then this command replaces the development theme with your local theme. You can override this using the `--theme-editor-sync` flag.\n\n> Note: You can't preview checkout customizations using http://127.0.0.1:9292.\n\nDevelopment themes are deleted when you run `shopify auth logout`. If you need a preview link that can be used after you log out, then you should \"share\" (https://shopify.dev/docs/api/shopify-cli/theme/theme-share) your theme or \"push\" (https://shopify.dev/docs/api/shopify-cli/theme/theme-push) to an unpublished theme on your store.\n\nYou can run this command only in a directory that matches the \"default Shopify theme folder structure\" (https://shopify.dev/docs/themes/tools/cli#directory-structure).", "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" }, "auth-alias": { "description": "Alias of the Shopify account to use for authentication.", "env": "SHOPIFY_FLAG_AUTH_ALIAS", "name": "auth-alias", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "no-input": { "description": "Disable interactive prompts and browser authentication.", "env": "SHOPIFY_FLAG_NO_INPUT", "name": "no-input", "allowNo": false, "type": "boolean" }, "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. May include sensitive data.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "allowNo": false, "type": "boolean" }, "path": { "description": "The path where you want to run the command. Defaults to the current working directory.", "env": "SHOPIFY_FLAG_PATH", "name": "path", "noCacheDefault": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "password": { "description": "Password generated from the Theme Access app or an Admin API token.", "env": "SHOPIFY_CLI_THEME_TOKEN", "name": "password", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "store": { "char": "s", "description": "Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).", "env": "SHOPIFY_FLAG_STORE", "name": "store", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "environment": { "char": "e", "description": "The environment to apply to the current command.", "env": "SHOPIFY_FLAG_ENVIRONMENT", "name": "environment", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "host": { "description": "Set which network interface the web server listens on. The default value is 127.0.0.1.", "env": "SHOPIFY_FLAG_HOST", "name": "host", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "live-reload": { "description": "The live reload mode switches the server behavior when a file is modified:\n- hot-reload Hot reloads local changes to CSS and sections (default)\n- full-page Always refreshes the entire page\n- off Deactivate live reload", "env": "SHOPIFY_FLAG_LIVE_RELOAD", "name": "live-reload", "default": "hot-reload", "hasDynamicHelp": false, "multiple": false, "options": [ "hot-reload", "full-page", "off" ], "type": "option" }, "error-overlay": { "description": "Controls the visibility of the error overlay when an theme asset upload fails:\n- silent Prevents the error overlay from appearing.\n- default Displays the error overlay.\n ", "env": "SHOPIFY_FLAG_ERROR_OVERLAY", "name": "error-overlay", "default": "default", "hasDynamicHelp": false, "multiple": false, "options": [ "silent", "default" ], "type": "option" }, "theme-editor-sync": { "description": "Synchronize Theme Editor updates in the local theme files.", "env": "SHOPIFY_FLAG_THEME_EDITOR_SYNC", "name": "theme-editor-sync", "allowNo": false, "type": "boolean" }, "standard-events-inspector": { "description": "Inject the standard events inspector into storefront HTML.", "env": "SHOPIFY_FLAG_STANDARD_EVENTS_INSPECTOR", "name": "standard-events-inspector", "allowNo": false, "type": "boolean" }, "reconciliation-strategy": { "dependsOn": [ "theme-editor-sync" ], "description": "How to resolve JSON conflicts when --theme-editor-sync is enabled. Use keep-local to keep local files, keep-remote to keep remote files, or abort to fail instead of prompting.", "env": "SHOPIFY_FLAG_RECONCILIATION_STRATEGY", "name": "reconciliation-strategy", "hasDynamicHelp": false, "multiple": false, "options": [ "keep-local", "keep-remote", "abort" ], "type": "option" }, "port": { "description": "Local port to serve theme preview from. Must be between 1 and 65535.", "env": "SHOPIFY_FLAG_PORT", "name": "port", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "theme": { "char": "t", "description": "Theme ID or name of the remote theme.", "env": "SHOPIFY_FLAG_THEME_ID", "name": "theme", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "listing": { "description": "The listing preset to use for multi-preset themes. Applies preset files from listings/[preset-name] directory.", "env": "SHOPIFY_FLAG_LISTING", "name": "listing", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "nodelete": { "char": "n", "description": "Prevents files from being deleted in the remote theme when a file has been deleted locally. This applies to files that are deleted while the command is running, and files that have been deleted locally before the command is run.", "env": "SHOPIFY_FLAG_NODELETE", "name": "nodelete", "allowNo": false, "type": "boolean" }, "only": { "char": "o", "description": "Hot reload only files that match the specified pattern.", "env": "SHOPIFY_FLAG_ONLY", "name": "only", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "ignore": { "char": "x", "description": "Skip hot reloading any files that match the specified pattern.", "env": "SHOPIFY_FLAG_IGNORE", "name": "ignore", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "force": { "char": "f", "description": "Proceed without confirmation, if current directory does not seem to be theme directory.", "env": "SHOPIFY_FLAG_FORCE", "hidden": true, "name": "force", "allowNo": false, "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", "name": "notify", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "open": { "description": "Automatically launch the theme preview in your default web browser.", "env": "SHOPIFY_FLAG_OPEN", "name": "open", "allowNo": false, "type": "boolean" }, "store-password": { "description": "The password for storefronts with password protection.", "env": "SHOPIFY_FLAG_STORE_PASSWORD", "name": "store-password", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "allow-live": { "char": "a", "description": "Allow development on a live theme.", "env": "SHOPIFY_FLAG_ALLOW_LIVE", "name": "allow-live", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "theme:dev", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": true, "summary": "Uploads the current theme as a development theme to the connected store, then prints theme editor and preview URLs to your terminal. While running, changes will push to the store in real time.", "enableJsonFlag": false, "descriptionWithMarkdown": "\n Uploads the current theme as the specified theme, or a [development theme](https://shopify.dev/docs/themes/tools/cli#development-themes), to a store so you can preview it.\n\nThis command returns the following information:\n\n- A link to your development theme at http://127.0.0.1:9292. This URL can hot reload local changes to CSS and sections, or refresh the entire page when a file changes, enabling you to preview changes in real time using the store's data.\n\n You can specify a different network interface and port using `--host` and `--port`.\n\n- A link to the [editor](https://shopify.dev/docs/themes/tools/online-editor) for the theme in the Shopify admin.\n\n- A [preview link](https://help.shopify.com/manual/online-store/themes/adding-themes#share-a-theme-preview-with-others) that you can share with other developers.\n\nIf you already have a development theme for your current environment, then this command replaces the development theme with your local theme. You can override this using the `--theme-editor-sync` flag.\n\n> Note: You can't preview checkout customizations using http://127.0.0.1:9292.\n\nDevelopment themes are deleted when you run `shopify auth logout`. If you need a preview link that can be used after you log out, then you should [share](https://shopify.dev/docs/api/shopify-cli/theme/theme-share) your theme or [push](https://shopify.dev/docs/api/shopify-cli/theme/theme-push) to an unpublished theme on your store.\n\nYou can run this command only in a directory that matches the [default Shopify theme folder structure](https://shopify.dev/docs/themes/tools/cli#directory-structure).", "multiEnvironmentsFlags": null, "customPluginName": "@shopify/theme" }, "theme:duplicate": { "aliases": [], "args": {}, "description": "If you want to duplicate your local theme, you need to run `shopify theme push` first.\n\nIf no theme ID is specified, you're prompted to select the theme that you want to duplicate from the list of themes in your store. You're asked to confirm that you want to duplicate the specified theme.\n\nPrompts and confirmations are not shown when duplicate is run in a CI environment or the `--force` flag is used, therefore you must specify a theme ID using the `--theme` flag.\n\nYou can optionally name the duplicated theme using the `--name` flag.\n\nIf you use the `--json` flag, then theme information is returned in JSON format, which can be used as a machine-readable input for scripts or continuous integration.\n\nSuccessful JSON results include `status`, `changed`, and explicit `originalTheme` and `theme` resources with decimal string IDs. Failures use the shared `{error}` document.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `ThemeDuplicateResult` schema.\n\n```json\n{\n \"anyOf\": [\n {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/0/properties/result\"\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"environments\": {\n \"type\": \"array\",\n \"items\": {\n \"$ref\": \"#/definitions/ThemeEnvironment\"\n }\n }\n },\n \"required\": [\n \"environments\"\n ],\n \"additionalProperties\": false\n }\n ],\n \"title\": \"ThemeDuplicateResult\",\n \"definitions\": {\n \"Theme\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"type\": \"string\",\n \"pattern\": \"^\\\\d+$\",\n \"description\": \"The decimal Online Store theme ID, not a Shopify GID.\"\n },\n \"name\": {\n \"type\": \"string\"\n },\n \"role\": {\n \"type\": \"string\",\n \"description\": \"The upstream theme role; known values include live, unpublished, and development.\"\n }\n },\n \"required\": [\n \"id\",\n \"name\",\n \"role\"\n ],\n \"additionalProperties\": false\n },\n \"ThemeEnvironment\": {\n \"anyOf\": [\n {\n \"type\": \"object\",\n \"properties\": {\n \"environment\": {\n \"type\": \"string\"\n },\n \"result\": {\n \"anyOf\": [\n {\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"const\": \"success\"\n },\n \"changed\": {\n \"type\": \"boolean\"\n },\n \"originalTheme\": {\n \"$ref\": \"#/definitions/Theme\"\n },\n \"theme\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"$ref\": \"#/definitions/Theme/properties/id\"\n },\n \"name\": {\n \"$ref\": \"#/definitions/Theme/properties/name\"\n },\n \"role\": {\n \"$ref\": \"#/definitions/Theme/properties/role\"\n },\n \"storeDomain\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"pattern\": \"^[a-z0-9][a-z0-9-]*\\\\.myshopify\\\\.com$\"\n },\n {\n \"type\": \"null\"\n }\n ]\n },\n \"previewUrl\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"format\": \"uri\"\n },\n {\n \"type\": \"null\"\n }\n ]\n }\n },\n \"required\": [\n \"id\",\n \"name\",\n \"role\",\n \"storeDomain\",\n \"previewUrl\"\n ],\n \"additionalProperties\": false\n }\n },\n \"required\": [\n \"status\",\n \"changed\",\n \"originalTheme\",\n \"theme\"\n ],\n \"additionalProperties\": false\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"const\": \"cancelled\"\n }\n },\n \"required\": [\n \"status\"\n ],\n \"additionalProperties\": false\n }\n ]\n }\n },\n \"required\": [\n \"environment\",\n \"result\"\n ],\n \"additionalProperties\": false\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"environment\": {\n \"type\": \"string\"\n },\n \"error\": {\n \"anyOf\": [\n {\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"const\": \"abort\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"code\": {\n \"type\": \"string\",\n \"minLength\": 1,\n \"description\": \"A stable error code, included only when known.\"\n },\n \"tryMessage\": {\n \"type\": \"string\"\n },\n \"nextSteps\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n },\n \"customSections\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"title\": {\n \"type\": \"string\"\n },\n \"body\": {\n \"anyOf\": [\n {\n \"type\": \"string\"\n },\n {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n }\n ]\n }\n },\n \"required\": [\n \"body\"\n ],\n \"additionalProperties\": false\n }\n },\n \"details\": {\n \"description\": \"Selected domain details, preserving native API payloads such as GraphQL errors, extensions, and data.\"\n }\n },\n \"required\": [\n \"type\",\n \"message\"\n ],\n \"additionalProperties\": false\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"const\": \"bug\"\n },\n \"message\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/message\"\n },\n \"code\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/code\"\n },\n \"tryMessage\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/tryMessage\"\n },\n \"nextSteps\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/nextSteps\"\n },\n \"customSections\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/customSections\"\n },\n \"details\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/details\"\n },\n \"stack\": {\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"type\",\n \"message\"\n ],\n \"additionalProperties\": false\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"const\": \"external\"\n },\n \"message\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/message\"\n },\n \"code\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/code\"\n },\n \"tryMessage\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/tryMessage\"\n },\n \"nextSteps\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/nextSteps\"\n },\n \"customSections\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/customSections\"\n },\n \"details\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/details\"\n },\n \"command\": {\n \"type\": \"string\"\n },\n \"args\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n },\n \"required\": [\n \"type\",\n \"message\",\n \"command\",\n \"args\"\n ],\n \"additionalProperties\": false\n }\n ]\n }\n },\n \"required\": [\n \"environment\",\n \"error\"\n ],\n \"additionalProperties\": false\n }\n ]\n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" }, "auth-alias": { "description": "Alias of the Shopify account to use for authentication.", "env": "SHOPIFY_FLAG_AUTH_ALIAS", "name": "auth-alias", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "no-input": { "description": "Disable interactive prompts and browser authentication.", "env": "SHOPIFY_FLAG_NO_INPUT", "name": "no-input", "allowNo": false, "type": "boolean" }, "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. May include sensitive data.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "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" }, "password": { "description": "Password generated from the Theme Access app or an Admin API token.", "env": "SHOPIFY_CLI_THEME_TOKEN", "name": "password", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "theme": { "char": "t", "description": "Theme ID or name of the remote theme. Required if non interactive.", "env": "SHOPIFY_FLAG_THEME_ID", "name": "theme", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "name": { "char": "n", "description": "Name of the newly duplicated theme.", "env": "SHOPIFY_FLAG_NAME", "name": "name", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "store": { "char": "s", "description": "Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).", "env": "SHOPIFY_FLAG_STORE", "name": "store", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "environment": { "char": "e", "description": "The environment to apply to the current command.", "env": "SHOPIFY_FLAG_ENVIRONMENT", "name": "environment", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "force": { "char": "f", "description": "Force the duplicate operation to run without prompts or confirmations. Required if non interactive outside CI.", "env": "SHOPIFY_FLAG_FORCE", "name": "force", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "theme:duplicate", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": true, "summary": "Duplicates a theme from your theme library.", "usage": [ "theme duplicate", "theme duplicate --theme 10 --name 'New Theme'" ], "enableJsonFlag": false, "descriptionWithMarkdown": "If you want to duplicate your local theme, you need to run `shopify theme push` first.\n\nIf no theme ID is specified, you're prompted to select the theme that you want to duplicate from the list of themes in your store. You're asked to confirm that you want to duplicate the specified theme.\n\nPrompts and confirmations are not shown when duplicate is run in a CI environment or the `--force` flag is used, therefore you must specify a theme ID using the `--theme` flag.\n\nYou can optionally name the duplicated theme using the `--name` flag.\n\nIf you use the `--json` flag, then theme information is returned in JSON format, which can be used as a machine-readable input for scripts or continuous integration.\n\nSuccessful JSON results include `status`, `changed`, and explicit `originalTheme` and `theme` resources with decimal string IDs. Failures use the shared `{error}` document.", "multiEnvironmentsFlags": [ "store", "password", "theme" ], "customPluginName": "@shopify/theme" }, "theme:info": { "aliases": [], "args": {}, "description": "Displays information about your theme environment, including your current store. Can also retrieve information about a specific theme.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `ThemeInfoResult` schema.\n\n```json\n{\n \"anyOf\": [\n {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/0/properties/result\"\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"environments\": {\n \"type\": \"array\",\n \"items\": {\n \"$ref\": \"#/definitions/ThemeEnvironment\"\n }\n }\n },\n \"required\": [\n \"environments\"\n ],\n \"additionalProperties\": false\n }\n ],\n \"title\": \"ThemeInfoResult\",\n \"definitions\": {\n \"Theme\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"type\": \"string\",\n \"pattern\": \"^\\\\d+$\",\n \"description\": \"The decimal Online Store theme ID, not a Shopify GID.\"\n },\n \"name\": {\n \"type\": \"string\"\n },\n \"role\": {\n \"type\": \"string\",\n \"description\": \"The upstream theme role; known values include live, unpublished, and development.\"\n },\n \"storeDomain\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"pattern\": \"^[a-z0-9][a-z0-9-]*\\\\.myshopify\\\\.com$\"\n },\n {\n \"type\": \"null\"\n }\n ]\n },\n \"previewUrl\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"format\": \"uri\"\n },\n {\n \"type\": \"null\"\n }\n ]\n },\n \"editorUrl\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"format\": \"uri\"\n },\n {\n \"type\": \"null\"\n }\n ]\n }\n },\n \"required\": [\n \"id\",\n \"name\",\n \"role\",\n \"storeDomain\",\n \"previewUrl\",\n \"editorUrl\"\n ],\n \"additionalProperties\": false\n },\n \"ThemeEnvironmentInfo\": {\n \"type\": \"object\",\n \"properties\": {\n \"storeDomain\": {\n \"$ref\": \"#/definitions/Theme/properties/storeDomain\"\n },\n \"developmentThemeId\": {\n \"anyOf\": [\n {\n \"$ref\": \"#/definitions/Theme/properties/id\"\n },\n {\n \"type\": \"null\"\n }\n ],\n \"description\": \"The decimal Online Store theme ID, not a Shopify GID.\"\n },\n \"cliVersion\": {\n \"type\": \"string\"\n },\n \"os\": {\n \"type\": \"string\"\n },\n \"shell\": {\n \"type\": [\n \"string\",\n \"null\"\n ]\n },\n \"nodeVersion\": {\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"storeDomain\",\n \"developmentThemeId\",\n \"cliVersion\",\n \"os\",\n \"shell\",\n \"nodeVersion\"\n ],\n \"additionalProperties\": false\n },\n \"ThemeEnvironment\": {\n \"anyOf\": [\n {\n \"type\": \"object\",\n \"properties\": {\n \"environment\": {\n \"type\": \"string\"\n },\n \"result\": {\n \"anyOf\": [\n {\n \"anyOf\": [\n {\n \"type\": \"object\",\n \"properties\": {\n \"theme\": {\n \"$ref\": \"#/definitions/Theme\"\n }\n },\n \"required\": [\n \"theme\"\n ],\n \"additionalProperties\": false\n },\n {\n \"$ref\": \"#/definitions/ThemeEnvironmentInfo\"\n }\n ]\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"const\": \"cancelled\"\n }\n },\n \"required\": [\n \"status\"\n ],\n \"additionalProperties\": false\n }\n ]\n }\n },\n \"required\": [\n \"environment\",\n \"result\"\n ],\n \"additionalProperties\": false\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"environment\": {\n \"type\": \"string\"\n },\n \"error\": {\n \"anyOf\": [\n {\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"const\": \"abort\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"code\": {\n \"type\": \"string\",\n \"minLength\": 1,\n \"description\": \"A stable error code, included only when known.\"\n },\n \"tryMessage\": {\n \"type\": \"string\"\n },\n \"nextSteps\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n },\n \"customSections\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"title\": {\n \"type\": \"string\"\n },\n \"body\": {\n \"anyOf\": [\n {\n \"type\": \"string\"\n },\n {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n }\n ]\n }\n },\n \"required\": [\n \"body\"\n ],\n \"additionalProperties\": false\n }\n },\n \"details\": {\n \"description\": \"Selected domain details, preserving native API payloads such as GraphQL errors, extensions, and data.\"\n }\n },\n \"required\": [\n \"type\",\n \"message\"\n ],\n \"additionalProperties\": false\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"const\": \"bug\"\n },\n \"message\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/message\"\n },\n \"code\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/code\"\n },\n \"tryMessage\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/tryMessage\"\n },\n \"nextSteps\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/nextSteps\"\n },\n \"customSections\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/customSections\"\n },\n \"details\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/details\"\n },\n \"stack\": {\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"type\",\n \"message\"\n ],\n \"additionalProperties\": false\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"const\": \"external\"\n },\n \"message\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/message\"\n },\n \"code\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/code\"\n },\n \"tryMessage\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/tryMessage\"\n },\n \"nextSteps\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/nextSteps\"\n },\n \"customSections\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/customSections\"\n },\n \"details\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/details\"\n },\n \"command\": {\n \"type\": \"string\"\n },\n \"args\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n },\n \"required\": [\n \"type\",\n \"message\",\n \"command\",\n \"args\"\n ],\n \"additionalProperties\": false\n }\n ]\n }\n },\n \"required\": [\n \"environment\",\n \"error\"\n ],\n \"additionalProperties\": false\n }\n ]\n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" }, "auth-alias": { "description": "Alias of the Shopify account to use for authentication.", "env": "SHOPIFY_FLAG_AUTH_ALIAS", "name": "auth-alias", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "no-input": { "description": "Disable interactive prompts and browser authentication.", "env": "SHOPIFY_FLAG_NO_INPUT", "name": "no-input", "allowNo": false, "type": "boolean" }, "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. May include sensitive data.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "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" }, "path": { "description": "The path where you want to run the command. Defaults to the current working directory.", "env": "SHOPIFY_FLAG_PATH", "name": "path", "noCacheDefault": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "password": { "description": "Password generated from the Theme Access app or an Admin API token.", "env": "SHOPIFY_CLI_THEME_TOKEN", "name": "password", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "store": { "char": "s", "description": "Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).", "env": "SHOPIFY_FLAG_STORE", "name": "store", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "environment": { "char": "e", "description": "The environment to apply to the current command.", "env": "SHOPIFY_FLAG_ENVIRONMENT", "name": "environment", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "development": { "char": "d", "description": "Retrieve info from your development theme.", "env": "SHOPIFY_FLAG_DEVELOPMENT", "name": "development", "allowNo": false, "type": "boolean" }, "theme": { "char": "t", "description": "Theme ID or name of the remote theme.", "env": "SHOPIFY_FLAG_THEME_ID", "name": "theme", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "theme:info", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": true, "enableJsonFlag": false, "descriptionWithMarkdown": "Displays information about your theme environment, including your current store. Can also retrieve information about a specific theme.", "multiEnvironmentsFlags": [ "store", "password" ], "customPluginName": "@shopify/theme" }, "theme:language-server": { "aliases": [], "args": {}, "description": "Starts the \"Language Server\" (https://shopify.dev/docs/themes/tools/cli/language-server).", "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" }, "auth-alias": { "description": "Alias of the Shopify account to use for authentication.", "env": "SHOPIFY_FLAG_AUTH_ALIAS", "name": "auth-alias", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "no-input": { "description": "Disable interactive prompts and browser authentication.", "env": "SHOPIFY_FLAG_NO_INPUT", "name": "no-input", "allowNo": false, "type": "boolean" }, "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. May include sensitive data.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "theme:language-server", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": true, "summary": "Start a Language Server Protocol server.", "enableJsonFlag": false, "descriptionWithMarkdown": "Starts the [Language Server](https://shopify.dev/docs/themes/tools/cli/language-server).", "multiEnvironmentsFlags": null, "customPluginName": "@shopify/theme" }, "theme:list": { "aliases": [], "args": {}, "description": "Lists the themes in your store, along with their IDs and statuses.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `ThemeListResult` schema.\n\n```json\n{\n \"anyOf\": [\n {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/0/properties/result\"\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"environments\": {\n \"type\": \"array\",\n \"items\": {\n \"$ref\": \"#/definitions/ThemeEnvironment\"\n }\n }\n },\n \"required\": [\n \"environments\"\n ],\n \"additionalProperties\": false\n }\n ],\n \"title\": \"ThemeListResult\",\n \"definitions\": {\n \"Theme\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"type\": \"string\",\n \"pattern\": \"^\\\\d+$\",\n \"description\": \"The decimal Online Store theme ID, not a Shopify GID.\"\n },\n \"name\": {\n \"type\": \"string\"\n },\n \"role\": {\n \"type\": \"string\",\n \"description\": \"The upstream theme role; known values include live, unpublished, and development.\"\n }\n },\n \"required\": [\n \"id\",\n \"name\",\n \"role\"\n ],\n \"additionalProperties\": false\n },\n \"ThemeEnvironment\": {\n \"anyOf\": [\n {\n \"type\": \"object\",\n \"properties\": {\n \"environment\": {\n \"type\": \"string\"\n },\n \"result\": {\n \"anyOf\": [\n {\n \"type\": \"object\",\n \"properties\": {\n \"themes\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"$ref\": \"#/definitions/Theme/properties/id\"\n },\n \"name\": {\n \"$ref\": \"#/definitions/Theme/properties/name\"\n },\n \"role\": {\n \"$ref\": \"#/definitions/Theme/properties/role\"\n },\n \"processing\": {\n \"type\": \"boolean\"\n }\n },\n \"required\": [\n \"id\",\n \"name\",\n \"role\",\n \"processing\"\n ],\n \"additionalProperties\": false\n }\n }\n },\n \"required\": [\n \"themes\"\n ],\n \"additionalProperties\": false,\n \"description\": \"The complete theme library after applying the requested filters.\"\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"const\": \"cancelled\"\n }\n },\n \"required\": [\n \"status\"\n ],\n \"additionalProperties\": false\n }\n ]\n }\n },\n \"required\": [\n \"environment\",\n \"result\"\n ],\n \"additionalProperties\": false\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"environment\": {\n \"type\": \"string\"\n },\n \"error\": {\n \"anyOf\": [\n {\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"const\": \"abort\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"code\": {\n \"type\": \"string\",\n \"minLength\": 1,\n \"description\": \"A stable error code, included only when known.\"\n },\n \"tryMessage\": {\n \"type\": \"string\"\n },\n \"nextSteps\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n },\n \"customSections\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"title\": {\n \"type\": \"string\"\n },\n \"body\": {\n \"anyOf\": [\n {\n \"type\": \"string\"\n },\n {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n }\n ]\n }\n },\n \"required\": [\n \"body\"\n ],\n \"additionalProperties\": false\n }\n },\n \"details\": {\n \"description\": \"Selected domain details, preserving native API payloads such as GraphQL errors, extensions, and data.\"\n }\n },\n \"required\": [\n \"type\",\n \"message\"\n ],\n \"additionalProperties\": false\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"const\": \"bug\"\n },\n \"message\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/message\"\n },\n \"code\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/code\"\n },\n \"tryMessage\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/tryMessage\"\n },\n \"nextSteps\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/nextSteps\"\n },\n \"customSections\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/customSections\"\n },\n \"details\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/details\"\n },\n \"stack\": {\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"type\",\n \"message\"\n ],\n \"additionalProperties\": false\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"const\": \"external\"\n },\n \"message\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/message\"\n },\n \"code\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/code\"\n },\n \"tryMessage\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/tryMessage\"\n },\n \"nextSteps\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/nextSteps\"\n },\n \"customSections\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/customSections\"\n },\n \"details\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/details\"\n },\n \"command\": {\n \"type\": \"string\"\n },\n \"args\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n },\n \"required\": [\n \"type\",\n \"message\",\n \"command\",\n \"args\"\n ],\n \"additionalProperties\": false\n }\n ]\n }\n },\n \"required\": [\n \"environment\",\n \"error\"\n ],\n \"additionalProperties\": false\n }\n ]\n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" }, "auth-alias": { "description": "Alias of the Shopify account to use for authentication.", "env": "SHOPIFY_FLAG_AUTH_ALIAS", "name": "auth-alias", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "no-input": { "description": "Disable interactive prompts and browser authentication.", "env": "SHOPIFY_FLAG_NO_INPUT", "name": "no-input", "allowNo": false, "type": "boolean" }, "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. May include sensitive data.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "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" }, "path": { "description": "The path where you want to run the command. Defaults to the current working directory.", "env": "SHOPIFY_FLAG_PATH", "name": "path", "noCacheDefault": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "password": { "description": "Password generated from the Theme Access app or an Admin API token.", "env": "SHOPIFY_CLI_THEME_TOKEN", "name": "password", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "store": { "char": "s", "description": "Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).", "env": "SHOPIFY_FLAG_STORE", "name": "store", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "environment": { "char": "e", "description": "The environment to apply to the current command.", "env": "SHOPIFY_FLAG_ENVIRONMENT", "name": "environment", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "role": { "description": "Only list themes with the given role.", "env": "SHOPIFY_FLAG_ROLE", "name": "role", "hasDynamicHelp": false, "multiple": false, "options": [ "live", "unpublished", "development" ], "type": "option" }, "name": { "description": "Only list themes that contain the given name.", "env": "SHOPIFY_FLAG_NAME", "name": "name", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "id": { "description": "Only list theme with the given ID.", "env": "SHOPIFY_FLAG_ID", "name": "id", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "theme:list", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": true, "enableJsonFlag": false, "descriptionWithMarkdown": "Lists the themes in your store, along with their IDs and statuses.", "multiEnvironmentsFlags": [ "store", "password" ], "customPluginName": "@shopify/theme" }, "theme:metafields:pull": { "aliases": [], "args": {}, "description": "Retrieves metafields from Shopify Admin.\n\nIf the metafields file already exists, it will be overwritten.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `ThemeMetafieldsPullResult` schema.\n\n```json\n{\n \"anyOf\": [\n {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/0/properties/result\"\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"environments\": {\n \"type\": \"array\",\n \"items\": {\n \"$ref\": \"#/definitions/ThemeEnvironment\"\n }\n }\n },\n \"required\": [\n \"environments\"\n ],\n \"additionalProperties\": false\n }\n ],\n \"title\": \"ThemeMetafieldsPullResult\",\n \"definitions\": {\n \"MetafieldDefinition\": {\n \"type\": \"object\",\n \"properties\": {\n \"ownerType\": {\n \"type\": \"string\",\n \"description\": \"The upstream owner type, such as PRODUCT or COMPANY_LOCATION.\"\n },\n \"key\": {\n \"type\": \"string\"\n },\n \"namespace\": {\n \"type\": \"string\"\n },\n \"name\": {\n \"type\": \"string\"\n },\n \"description\": {\n \"type\": [\n \"string\",\n \"null\"\n ]\n },\n \"type\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"description\": \"The upstream metafield type, such as single_line_text_field.\"\n },\n \"category\": {\n \"type\": \"string\",\n \"description\": \"The upstream metafield category.\"\n }\n },\n \"required\": [\n \"name\",\n \"category\"\n ],\n \"additionalProperties\": false\n }\n },\n \"required\": [\n \"ownerType\",\n \"key\",\n \"namespace\",\n \"name\",\n \"description\",\n \"type\"\n ],\n \"additionalProperties\": false\n },\n \"ThemeEnvironment\": {\n \"anyOf\": [\n {\n \"type\": \"object\",\n \"properties\": {\n \"environment\": {\n \"type\": \"string\"\n },\n \"result\": {\n \"anyOf\": [\n {\n \"anyOf\": [\n {\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"enum\": [\n \"success\",\n \"partial\"\n ]\n },\n \"changed\": {\n \"type\": \"boolean\",\n \"const\": true\n },\n \"path\": {\n \"type\": \"string\",\n \"description\": \"The absolute path of the native language-server metafields JSON artifact.\"\n },\n \"definitions\": {\n \"type\": \"array\",\n \"items\": {\n \"$ref\": \"#/definitions/MetafieldDefinition\"\n },\n \"description\": \"All fetched definitions, flattened across owner types.\"\n },\n \"failedOwnerTypes\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n },\n \"description\": \"Upstream owner types whose fetch failed.\"\n }\n },\n \"required\": [\n \"status\",\n \"changed\",\n \"path\",\n \"definitions\",\n \"failedOwnerTypes\"\n ],\n \"additionalProperties\": false\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"const\": \"skipped\"\n },\n \"reason\": {\n \"type\": \"string\",\n \"const\": \"not-a-theme\"\n }\n },\n \"required\": [\n \"status\",\n \"reason\"\n ],\n \"additionalProperties\": false\n }\n ]\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"const\": \"cancelled\"\n }\n },\n \"required\": [\n \"status\"\n ],\n \"additionalProperties\": false\n }\n ]\n }\n },\n \"required\": [\n \"environment\",\n \"result\"\n ],\n \"additionalProperties\": false\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"environment\": {\n \"type\": \"string\"\n },\n \"error\": {\n \"anyOf\": [\n {\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"const\": \"abort\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"code\": {\n \"type\": \"string\",\n \"minLength\": 1,\n \"description\": \"A stable error code, included only when known.\"\n },\n \"tryMessage\": {\n \"type\": \"string\"\n },\n \"nextSteps\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n },\n \"customSections\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"title\": {\n \"type\": \"string\"\n },\n \"body\": {\n \"anyOf\": [\n {\n \"type\": \"string\"\n },\n {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n }\n ]\n }\n },\n \"required\": [\n \"body\"\n ],\n \"additionalProperties\": false\n }\n },\n \"details\": {\n \"description\": \"Selected domain details, preserving native API payloads such as GraphQL errors, extensions, and data.\"\n }\n },\n \"required\": [\n \"type\",\n \"message\"\n ],\n \"additionalProperties\": false\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"const\": \"bug\"\n },\n \"message\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/message\"\n },\n \"code\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/code\"\n },\n \"tryMessage\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/tryMessage\"\n },\n \"nextSteps\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/nextSteps\"\n },\n \"customSections\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/customSections\"\n },\n \"details\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/details\"\n },\n \"stack\": {\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"type\",\n \"message\"\n ],\n \"additionalProperties\": false\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"const\": \"external\"\n },\n \"message\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/message\"\n },\n \"code\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/code\"\n },\n \"tryMessage\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/tryMessage\"\n },\n \"nextSteps\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/nextSteps\"\n },\n \"customSections\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/customSections\"\n },\n \"details\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/details\"\n },\n \"command\": {\n \"type\": \"string\"\n },\n \"args\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n },\n \"required\": [\n \"type\",\n \"message\",\n \"command\",\n \"args\"\n ],\n \"additionalProperties\": false\n }\n ]\n }\n },\n \"required\": [\n \"environment\",\n \"error\"\n ],\n \"additionalProperties\": false\n }\n ]\n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" }, "auth-alias": { "description": "Alias of the Shopify account to use for authentication.", "env": "SHOPIFY_FLAG_AUTH_ALIAS", "name": "auth-alias", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "no-input": { "description": "Disable interactive prompts and browser authentication.", "env": "SHOPIFY_FLAG_NO_INPUT", "name": "no-input", "allowNo": false, "type": "boolean" }, "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. May include sensitive data.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "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" }, "path": { "description": "The path where you want to run the command. Defaults to the current working directory.", "env": "SHOPIFY_FLAG_PATH", "name": "path", "noCacheDefault": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "password": { "description": "Password generated from the Theme Access app or an Admin API token.", "env": "SHOPIFY_CLI_THEME_TOKEN", "name": "password", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "store": { "char": "s", "description": "Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).", "env": "SHOPIFY_FLAG_STORE", "name": "store", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "environment": { "char": "e", "description": "The environment to apply to the current command.", "env": "SHOPIFY_FLAG_ENVIRONMENT", "name": "environment", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "force": { "char": "f", "description": "Proceed without confirmation, if current directory does not seem to be theme directory.", "env": "SHOPIFY_FLAG_FORCE", "hidden": true, "name": "force", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "theme:metafields:pull", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": true, "summary": "Download metafields definitions from your shop into a local file.", "enableJsonFlag": false, "descriptionWithMarkdown": "Retrieves metafields from Shopify Admin.\n\nIf the metafields file already exists, it will be overwritten.", "multiEnvironmentsFlags": null, "customPluginName": "@shopify/theme" }, "theme:open": { "aliases": [], "args": {}, "description": "Returns links that let you preview the specified theme. The following links are returned:\n\n - A link to the \"editor\" (https://shopify.dev/docs/themes/tools/online-editor) for the theme in the Shopify admin.\n - A \"preview link\" (https://help.shopify.com/manual/online-store/themes/adding-themes#share-a-theme-preview-with-others) that you can share with other developers.\n\n If you don't specify a theme, then you're prompted to select the theme to open from the list of the themes in your store.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `ThemeOpenResult` schema.\n\n```json\n{\n \"anyOf\": [\n {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/0/properties/result\"\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"environments\": {\n \"type\": \"array\",\n \"items\": {\n \"$ref\": \"#/definitions/ThemeEnvironment\"\n }\n }\n },\n \"required\": [\n \"environments\"\n ],\n \"additionalProperties\": false\n }\n ],\n \"title\": \"ThemeOpenResult\",\n \"definitions\": {\n \"Theme\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"type\": \"string\",\n \"pattern\": \"^\\\\d+$\",\n \"description\": \"The decimal Online Store theme ID, not a Shopify GID.\"\n },\n \"name\": {\n \"type\": \"string\"\n },\n \"role\": {\n \"type\": \"string\",\n \"description\": \"The upstream theme role; known values include live, unpublished, and development.\"\n }\n },\n \"required\": [\n \"id\",\n \"name\",\n \"role\"\n ],\n \"additionalProperties\": false\n },\n \"ThemeEnvironment\": {\n \"anyOf\": [\n {\n \"type\": \"object\",\n \"properties\": {\n \"environment\": {\n \"type\": \"string\"\n },\n \"result\": {\n \"anyOf\": [\n {\n \"type\": \"object\",\n \"properties\": {\n \"theme\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"$ref\": \"#/definitions/Theme/properties/id\"\n },\n \"name\": {\n \"$ref\": \"#/definitions/Theme/properties/name\"\n },\n \"role\": {\n \"$ref\": \"#/definitions/Theme/properties/role\"\n },\n \"storeDomain\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"pattern\": \"^[a-z0-9][a-z0-9-]*\\\\.myshopify\\\\.com$\"\n },\n {\n \"type\": \"null\"\n }\n ]\n },\n \"previewUrl\": {\n \"type\": \"string\",\n \"format\": \"uri\"\n },\n \"editorUrl\": {\n \"type\": \"string\",\n \"format\": \"uri\"\n },\n \"processing\": {\n \"type\": \"boolean\"\n },\n \"sourceUrl\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"format\": \"uri\"\n },\n {\n \"type\": \"null\"\n }\n ]\n }\n },\n \"required\": [\n \"id\",\n \"name\",\n \"role\",\n \"storeDomain\",\n \"previewUrl\",\n \"editorUrl\",\n \"processing\",\n \"sourceUrl\"\n ],\n \"additionalProperties\": false\n }\n },\n \"required\": [\n \"theme\"\n ],\n \"additionalProperties\": false\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"const\": \"cancelled\"\n }\n },\n \"required\": [\n \"status\"\n ],\n \"additionalProperties\": false\n }\n ]\n }\n },\n \"required\": [\n \"environment\",\n \"result\"\n ],\n \"additionalProperties\": false\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"environment\": {\n \"type\": \"string\"\n },\n \"error\": {\n \"anyOf\": [\n {\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"const\": \"abort\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"code\": {\n \"type\": \"string\",\n \"minLength\": 1,\n \"description\": \"A stable error code, included only when known.\"\n },\n \"tryMessage\": {\n \"type\": \"string\"\n },\n \"nextSteps\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n },\n \"customSections\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"title\": {\n \"type\": \"string\"\n },\n \"body\": {\n \"anyOf\": [\n {\n \"type\": \"string\"\n },\n {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n }\n ]\n }\n },\n \"required\": [\n \"body\"\n ],\n \"additionalProperties\": false\n }\n },\n \"details\": {\n \"description\": \"Selected domain details, preserving native API payloads such as GraphQL errors, extensions, and data.\"\n }\n },\n \"required\": [\n \"type\",\n \"message\"\n ],\n \"additionalProperties\": false\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"const\": \"bug\"\n },\n \"message\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/message\"\n },\n \"code\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/code\"\n },\n \"tryMessage\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/tryMessage\"\n },\n \"nextSteps\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/nextSteps\"\n },\n \"customSections\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/customSections\"\n },\n \"details\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/details\"\n },\n \"stack\": {\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"type\",\n \"message\"\n ],\n \"additionalProperties\": false\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"const\": \"external\"\n },\n \"message\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/message\"\n },\n \"code\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/code\"\n },\n \"tryMessage\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/tryMessage\"\n },\n \"nextSteps\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/nextSteps\"\n },\n \"customSections\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/customSections\"\n },\n \"details\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/details\"\n },\n \"command\": {\n \"type\": \"string\"\n },\n \"args\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n },\n \"required\": [\n \"type\",\n \"message\",\n \"command\",\n \"args\"\n ],\n \"additionalProperties\": false\n }\n ]\n }\n },\n \"required\": [\n \"environment\",\n \"error\"\n ],\n \"additionalProperties\": false\n }\n ]\n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" }, "auth-alias": { "description": "Alias of the Shopify account to use for authentication.", "env": "SHOPIFY_FLAG_AUTH_ALIAS", "name": "auth-alias", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "no-input": { "description": "Disable interactive prompts and browser authentication.", "env": "SHOPIFY_FLAG_NO_INPUT", "name": "no-input", "allowNo": false, "type": "boolean" }, "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. May include sensitive data.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "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" }, "path": { "description": "The path where you want to run the command. Defaults to the current working directory.", "env": "SHOPIFY_FLAG_PATH", "name": "path", "noCacheDefault": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "password": { "description": "Password generated from the Theme Access app or an Admin API token.", "env": "SHOPIFY_CLI_THEME_TOKEN", "name": "password", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "store": { "char": "s", "description": "Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).", "env": "SHOPIFY_FLAG_STORE", "name": "store", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "environment": { "char": "e", "description": "The environment to apply to the current command.", "env": "SHOPIFY_FLAG_ENVIRONMENT", "name": "environment", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "development": { "char": "d", "description": "Open your development theme. Use --development, --live, or --theme in non-interactive environments.", "env": "SHOPIFY_FLAG_DEVELOPMENT", "name": "development", "allowNo": false, "type": "boolean" }, "editor": { "char": "E", "description": "Open the theme editor for the specified theme in the browser.", "env": "SHOPIFY_FLAG_EDITOR", "name": "editor", "allowNo": false, "type": "boolean" }, "live": { "char": "l", "description": "Open your live (published) theme. Use --development, --live, or --theme in non-interactive environments.", "env": "SHOPIFY_FLAG_LIVE", "name": "live", "allowNo": false, "type": "boolean" }, "theme": { "char": "t", "description": "Theme ID or name of the remote theme. Use --development, --live, or --theme in non-interactive environments.", "env": "SHOPIFY_FLAG_THEME_ID", "name": "theme", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "theme:open", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": true, "summary": "Opens the preview of your remote theme.", "enableJsonFlag": false, "descriptionWithMarkdown": "Returns links that let you preview the specified theme. The following links are returned:\n\n - A link to the [editor](https://shopify.dev/docs/themes/tools/online-editor) for the theme in the Shopify admin.\n - A [preview link](https://help.shopify.com/manual/online-store/themes/adding-themes#share-a-theme-preview-with-others) that you can share with other developers.\n\n If you don't specify a theme, then you're prompted to select the theme to open from the list of the themes in your store.", "multiEnvironmentsFlags": [ "store", "password", [ "theme", "live", "development" ] ], "customPluginName": "@shopify/theme" }, "theme:package": { "aliases": [], "args": {}, "description": "Packages your local theme files into a ZIP file that can be uploaded to Shopify.\n\n Only folders that match the \"default Shopify theme folder structure\" (https://shopify.dev/docs/storefronts/themes/tools/cli#directory-structure) are included in the package.\n\n The package includes the `listings` directory if present (required for multi-preset themes per \"Theme Store requirements\" (https://shopify.dev/docs/storefronts/themes/store/requirements#adding-presets-to-your-theme-zip-submission)).\n\n The ZIP file uses the name `theme_name-theme_version.zip`, based on parameters in your \"settings_schema.json\" (https://shopify.dev/docs/storefronts/themes/architecture/config/settings-schema-json) file.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `ThemePackageResult` schema.\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"path\": {\n \"type\": \"string\",\n \"description\": \"The absolute native path of the ZIP archive.\"\n }\n },\n \"required\": [\n \"path\"\n ],\n \"additionalProperties\": false,\n \"title\": \"ThemePackageResult\",\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" }, "auth-alias": { "description": "Alias of the Shopify account to use for authentication.", "env": "SHOPIFY_FLAG_AUTH_ALIAS", "name": "auth-alias", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "no-input": { "description": "Disable interactive prompts and browser authentication.", "env": "SHOPIFY_FLAG_NO_INPUT", "name": "no-input", "allowNo": false, "type": "boolean" }, "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. May include sensitive data.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "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" }, "path": { "description": "The path where you want to run the command. Defaults to the current working directory.", "env": "SHOPIFY_FLAG_PATH", "name": "path", "noCacheDefault": true, "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "theme:package", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": true, "summary": "Package your theme into a .zip file, ready to upload to the Online Store.", "enableJsonFlag": false, "descriptionWithMarkdown": "Packages your local theme files into a ZIP file that can be uploaded to Shopify.\n\n Only folders that match the [default Shopify theme folder structure](https://shopify.dev/docs/storefronts/themes/tools/cli#directory-structure) are included in the package.\n\n The package includes the `listings` directory if present (required for multi-preset themes per [Theme Store requirements](https://shopify.dev/docs/storefronts/themes/store/requirements#adding-presets-to-your-theme-zip-submission)).\n\n The ZIP file uses the name `theme_name-theme_version.zip`, based on parameters in your [settings_schema.json](https://shopify.dev/docs/storefronts/themes/architecture/config/settings-schema-json) file.", "multiEnvironmentsFlags": null, "customPluginName": "@shopify/theme" }, "theme:profile": { "aliases": [], "args": {}, "description": "Profile the Shopify Liquid on a given page.\n\n This command will open a web page with the Speedscope profiler detailing the time spent executing Liquid on the given page.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `ThemeProfileResult` schema.\n\n```json\n{\n \"anyOf\": [\n {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/0/properties/result\"\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"environments\": {\n \"type\": \"array\",\n \"items\": {\n \"$ref\": \"#/definitions/ThemeEnvironment\"\n }\n }\n },\n \"required\": [\n \"environments\"\n ],\n \"additionalProperties\": false\n }\n ],\n \"title\": \"ThemeProfileResult\",\n \"definitions\": {\n \"ProfileFrame\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"file\": {\n \"type\": \"string\"\n },\n \"line\": {\n \"type\": \"number\"\n },\n \"col\": {\n \"type\": \"number\"\n }\n },\n \"required\": [\n \"name\"\n ],\n \"additionalProperties\": true\n },\n \"ProfileEvent\": {\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"O\",\n \"C\"\n ]\n },\n \"at\": {\n \"type\": \"number\"\n },\n \"frame\": {\n \"type\": \"number\"\n }\n },\n \"required\": [\n \"type\",\n \"at\",\n \"frame\"\n ],\n \"additionalProperties\": true\n },\n \"ProfileShared\": {\n \"type\": \"object\",\n \"properties\": {\n \"frames\": {\n \"type\": \"array\",\n \"items\": {\n \"$ref\": \"#/definitions/ProfileFrame\"\n }\n }\n },\n \"required\": [\n \"frames\"\n ],\n \"additionalProperties\": true\n },\n \"EventedProfile\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"unit\": {\n \"type\": \"string\",\n \"enum\": [\n \"bytes\",\n \"microseconds\",\n \"milliseconds\",\n \"nanoseconds\",\n \"none\",\n \"seconds\"\n ]\n },\n \"startValue\": {\n \"type\": \"number\"\n },\n \"endValue\": {\n \"type\": \"number\"\n },\n \"type\": {\n \"type\": \"string\",\n \"const\": \"evented\"\n },\n \"events\": {\n \"type\": \"array\",\n \"items\": {\n \"$ref\": \"#/definitions/ProfileEvent\"\n }\n }\n },\n \"required\": [\n \"name\",\n \"unit\",\n \"startValue\",\n \"endValue\",\n \"type\",\n \"events\"\n ],\n \"additionalProperties\": true\n },\n \"SampledProfile\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"$ref\": \"#/definitions/EventedProfile/properties/name\"\n },\n \"unit\": {\n \"$ref\": \"#/definitions/EventedProfile/properties/unit\"\n },\n \"startValue\": {\n \"$ref\": \"#/definitions/EventedProfile/properties/startValue\"\n },\n \"endValue\": {\n \"$ref\": \"#/definitions/EventedProfile/properties/endValue\"\n },\n \"type\": {\n \"type\": \"string\",\n \"const\": \"sampled\"\n },\n \"samples\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"number\"\n }\n }\n },\n \"weights\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"number\"\n }\n }\n },\n \"required\": [\n \"name\",\n \"unit\",\n \"startValue\",\n \"endValue\",\n \"type\",\n \"samples\",\n \"weights\"\n ],\n \"additionalProperties\": true\n },\n \"ThemeEnvironment\": {\n \"anyOf\": [\n {\n \"type\": \"object\",\n \"properties\": {\n \"environment\": {\n \"type\": \"string\"\n },\n \"result\": {\n \"anyOf\": [\n {\n \"type\": \"object\",\n \"properties\": {\n \"$schema\": {\n \"type\": \"string\",\n \"const\": \"https://www.speedscope.app/file-format-schema.json\"\n },\n \"shared\": {\n \"$ref\": \"#/definitions/ProfileShared\"\n },\n \"profiles\": {\n \"type\": \"array\",\n \"items\": {\n \"anyOf\": [\n {\n \"$ref\": \"#/definitions/EventedProfile\"\n },\n {\n \"$ref\": \"#/definitions/SampledProfile\"\n }\n ]\n }\n },\n \"name\": {\n \"type\": \"string\"\n },\n \"exporter\": {\n \"type\": \"string\"\n },\n \"activeProfileIndex\": {\n \"type\": \"number\"\n }\n },\n \"required\": [\n \"$schema\",\n \"shared\",\n \"profiles\"\n ],\n \"additionalProperties\": true,\n \"description\": \"The native Speedscope file format, defined by its $schema URL. Original keys and extension fields are preserved.\"\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"const\": \"cancelled\"\n }\n },\n \"required\": [\n \"status\"\n ],\n \"additionalProperties\": false\n }\n ]\n }\n },\n \"required\": [\n \"environment\",\n \"result\"\n ],\n \"additionalProperties\": false\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"environment\": {\n \"type\": \"string\"\n },\n \"error\": {\n \"anyOf\": [\n {\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"const\": \"abort\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"code\": {\n \"type\": \"string\",\n \"minLength\": 1,\n \"description\": \"A stable error code, included only when known.\"\n },\n \"tryMessage\": {\n \"type\": \"string\"\n },\n \"nextSteps\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n },\n \"customSections\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"title\": {\n \"type\": \"string\"\n },\n \"body\": {\n \"anyOf\": [\n {\n \"type\": \"string\"\n },\n {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n }\n ]\n }\n },\n \"required\": [\n \"body\"\n ],\n \"additionalProperties\": false\n }\n },\n \"details\": {\n \"description\": \"Selected domain details, preserving native API payloads such as GraphQL errors, extensions, and data.\"\n }\n },\n \"required\": [\n \"type\",\n \"message\"\n ],\n \"additionalProperties\": false\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"const\": \"bug\"\n },\n \"message\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/message\"\n },\n \"code\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/code\"\n },\n \"tryMessage\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/tryMessage\"\n },\n \"nextSteps\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/nextSteps\"\n },\n \"customSections\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/customSections\"\n },\n \"details\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/details\"\n },\n \"stack\": {\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"type\",\n \"message\"\n ],\n \"additionalProperties\": false\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"const\": \"external\"\n },\n \"message\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/message\"\n },\n \"code\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/code\"\n },\n \"tryMessage\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/tryMessage\"\n },\n \"nextSteps\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/nextSteps\"\n },\n \"customSections\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/customSections\"\n },\n \"details\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/details\"\n },\n \"command\": {\n \"type\": \"string\"\n },\n \"args\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n },\n \"required\": [\n \"type\",\n \"message\",\n \"command\",\n \"args\"\n ],\n \"additionalProperties\": false\n }\n ]\n }\n },\n \"required\": [\n \"environment\",\n \"error\"\n ],\n \"additionalProperties\": false\n }\n ]\n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" }, "auth-alias": { "description": "Alias of the Shopify account to use for authentication.", "env": "SHOPIFY_FLAG_AUTH_ALIAS", "name": "auth-alias", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "no-input": { "description": "Disable interactive prompts and browser authentication.", "env": "SHOPIFY_FLAG_NO_INPUT", "name": "no-input", "allowNo": false, "type": "boolean" }, "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. May include sensitive data.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "allowNo": false, "type": "boolean" }, "path": { "description": "The path where you want to run the command. Defaults to the current working directory.", "env": "SHOPIFY_FLAG_PATH", "name": "path", "noCacheDefault": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "password": { "description": "Password generated from the Theme Access app or an Admin API token.", "env": "SHOPIFY_CLI_THEME_TOKEN", "name": "password", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "store": { "char": "s", "description": "Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).", "env": "SHOPIFY_FLAG_STORE", "name": "store", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "environment": { "char": "e", "description": "The environment to apply to the current command.", "env": "SHOPIFY_FLAG_ENVIRONMENT", "name": "environment", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "theme": { "char": "t", "description": "Theme ID or name of the remote theme.", "env": "SHOPIFY_FLAG_THEME_ID", "name": "theme", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "url": { "description": "The path of the page to profile, with an optional query string. For a full URL, only the path and query string are used.", "env": "SHOPIFY_FLAG_URL", "name": "url", "default": "/", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "store-password": { "description": "The password for storefronts with password protection.", "env": "SHOPIFY_FLAG_STORE_PASSWORD", "name": "store-password", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "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": "theme:profile", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": true, "summary": "Profile the Liquid rendering of a theme page.", "usage": [ "theme profile", "theme profile --url /products/classic-leather-jacket" ], "enableJsonFlag": false, "descriptionWithMarkdown": "Profile the Shopify Liquid on a given page.\n\n This command will open a web page with the Speedscope profiler detailing the time spent executing Liquid on the given page.", "multiEnvironmentsFlags": null, "customPluginName": "@shopify/theme" }, "theme:publish": { "aliases": [], "args": {}, "description": "Publishes an unpublished theme from your theme library.\n\nIf no theme ID is specified, then you're prompted to select the theme that you want to publish from the list of themes in your store.\n\nYou can run this command only in a directory that matches the \"default Shopify theme folder structure\" (https://shopify.dev/docs/themes/tools/cli#directory-structure).\n\nIf you want to publish your local theme, then you need to run `shopify theme push` first. You're asked to confirm that you want to publish the specified theme. You can skip this confirmation using the `--force` flag.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `ThemePublishResult` schema.\n\n```json\n{\n \"anyOf\": [\n {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/0/properties/result\"\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"environments\": {\n \"type\": \"array\",\n \"items\": {\n \"$ref\": \"#/definitions/ThemeEnvironment\"\n }\n }\n },\n \"required\": [\n \"environments\"\n ],\n \"additionalProperties\": false\n }\n ],\n \"title\": \"ThemePublishResult\",\n \"definitions\": {\n \"Theme\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"type\": \"string\",\n \"pattern\": \"^\\\\d+$\",\n \"description\": \"The decimal Online Store theme ID, not a Shopify GID.\"\n },\n \"name\": {\n \"type\": \"string\"\n },\n \"role\": {\n \"type\": \"string\",\n \"description\": \"The upstream theme role; known values include live, unpublished, and development.\"\n },\n \"storeDomain\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"pattern\": \"^[a-z0-9][a-z0-9-]*\\\\.myshopify\\\\.com$\"\n },\n {\n \"type\": \"null\"\n }\n ]\n },\n \"processing\": {\n \"type\": \"boolean\"\n },\n \"sourceUrl\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"format\": \"uri\"\n },\n {\n \"type\": \"null\"\n }\n ]\n }\n },\n \"required\": [\n \"id\",\n \"name\",\n \"role\",\n \"storeDomain\",\n \"processing\",\n \"sourceUrl\"\n ],\n \"additionalProperties\": false,\n \"description\": \"The selected theme projection; sourceUrl is null when the upstream source URL is unavailable.\"\n },\n \"ThemeEnvironment\": {\n \"anyOf\": [\n {\n \"type\": \"object\",\n \"properties\": {\n \"environment\": {\n \"type\": \"string\"\n },\n \"result\": {\n \"anyOf\": [\n {\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"const\": \"success\"\n },\n \"changed\": {\n \"type\": \"boolean\"\n },\n \"theme\": {\n \"$ref\": \"#/definitions/Theme\"\n }\n },\n \"required\": [\n \"status\",\n \"changed\",\n \"theme\"\n ],\n \"additionalProperties\": false\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"const\": \"cancelled\"\n }\n },\n \"required\": [\n \"status\"\n ],\n \"additionalProperties\": false\n }\n ]\n }\n },\n \"required\": [\n \"environment\",\n \"result\"\n ],\n \"additionalProperties\": false\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"environment\": {\n \"type\": \"string\"\n },\n \"error\": {\n \"anyOf\": [\n {\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"const\": \"abort\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"code\": {\n \"type\": \"string\",\n \"minLength\": 1,\n \"description\": \"A stable error code, included only when known.\"\n },\n \"tryMessage\": {\n \"type\": \"string\"\n },\n \"nextSteps\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n },\n \"customSections\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"title\": {\n \"type\": \"string\"\n },\n \"body\": {\n \"anyOf\": [\n {\n \"type\": \"string\"\n },\n {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n }\n ]\n }\n },\n \"required\": [\n \"body\"\n ],\n \"additionalProperties\": false\n }\n },\n \"details\": {\n \"description\": \"Selected domain details, preserving native API payloads such as GraphQL errors, extensions, and data.\"\n }\n },\n \"required\": [\n \"type\",\n \"message\"\n ],\n \"additionalProperties\": false\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"const\": \"bug\"\n },\n \"message\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/message\"\n },\n \"code\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/code\"\n },\n \"tryMessage\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/tryMessage\"\n },\n \"nextSteps\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/nextSteps\"\n },\n \"customSections\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/customSections\"\n },\n \"details\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/details\"\n },\n \"stack\": {\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"type\",\n \"message\"\n ],\n \"additionalProperties\": false\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"const\": \"external\"\n },\n \"message\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/message\"\n },\n \"code\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/code\"\n },\n \"tryMessage\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/tryMessage\"\n },\n \"nextSteps\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/nextSteps\"\n },\n \"customSections\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/customSections\"\n },\n \"details\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/details\"\n },\n \"command\": {\n \"type\": \"string\"\n },\n \"args\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n },\n \"required\": [\n \"type\",\n \"message\",\n \"command\",\n \"args\"\n ],\n \"additionalProperties\": false\n }\n ]\n }\n },\n \"required\": [\n \"environment\",\n \"error\"\n ],\n \"additionalProperties\": false\n }\n ]\n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" }, "auth-alias": { "description": "Alias of the Shopify account to use for authentication.", "env": "SHOPIFY_FLAG_AUTH_ALIAS", "name": "auth-alias", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "no-input": { "description": "Disable interactive prompts and browser authentication.", "env": "SHOPIFY_FLAG_NO_INPUT", "name": "no-input", "allowNo": false, "type": "boolean" }, "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. May include sensitive data.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "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" }, "path": { "description": "The path where you want to run the command. Defaults to the current working directory.", "env": "SHOPIFY_FLAG_PATH", "name": "path", "noCacheDefault": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "password": { "description": "Password generated from the Theme Access app or an Admin API token.", "env": "SHOPIFY_CLI_THEME_TOKEN", "name": "password", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "store": { "char": "s", "description": "Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).", "env": "SHOPIFY_FLAG_STORE", "name": "store", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "environment": { "char": "e", "description": "The environment to apply to the current command.", "env": "SHOPIFY_FLAG_ENVIRONMENT", "name": "environment", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "force": { "char": "f", "description": "Skip confirmation. Required if non interactive.", "env": "SHOPIFY_FLAG_FORCE", "name": "force", "allowNo": false, "type": "boolean" }, "theme": { "char": "t", "description": "Theme ID or name of the remote theme. Required if non interactive.", "env": "SHOPIFY_FLAG_THEME_ID", "name": "theme", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "theme:publish", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": true, "summary": "Set a remote theme as the live theme.", "enableJsonFlag": false, "descriptionWithMarkdown": "Publishes an unpublished theme from your theme library.\n\nIf no theme ID is specified, then you're prompted to select the theme that you want to publish from the list of themes in your store.\n\nYou can run this command only in a directory that matches the [default Shopify theme folder structure](https://shopify.dev/docs/themes/tools/cli#directory-structure).\n\nIf you want to publish your local theme, then you need to run `shopify theme push` first. You're asked to confirm that you want to publish the specified theme. You can skip this confirmation using the `--force` flag.", "multiEnvironmentsFlags": [ "store", "password", "theme" ], "customPluginName": "@shopify/theme" }, "theme:preview": { "aliases": [], "args": {}, "description": "Applies a JSON overrides file to a theme and creates or updates a preview. This lets you quickly preview changes.\n\n The command returns a preview URL and a preview identifier. You can reuse the preview identifier with `--preview-id` to update an existing preview instead of creating a new one.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `ThemePreviewResult` schema.\n\n```json\n{\n \"anyOf\": [\n {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/0/properties/result\"\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"environments\": {\n \"type\": \"array\",\n \"items\": {\n \"$ref\": \"#/definitions/ThemeEnvironment\"\n }\n }\n },\n \"required\": [\n \"environments\"\n ],\n \"additionalProperties\": false\n }\n ],\n \"title\": \"ThemePreviewResult\",\n \"definitions\": {\n \"ThemePreview\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"type\": \"string\",\n \"minLength\": 1,\n \"description\": \"The opaque Storefront preview identifier, not a theme ID or Shopify GID.\"\n },\n \"url\": {\n \"type\": \"string\",\n \"format\": \"uri\"\n }\n },\n \"required\": [\n \"id\",\n \"url\"\n ],\n \"additionalProperties\": false\n },\n \"ThemeEnvironment\": {\n \"anyOf\": [\n {\n \"type\": \"object\",\n \"properties\": {\n \"environment\": {\n \"type\": \"string\"\n },\n \"result\": {\n \"anyOf\": [\n {\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"const\": \"success\"\n },\n \"preview\": {\n \"$ref\": \"#/definitions/ThemePreview\"\n }\n },\n \"required\": [\n \"status\",\n \"preview\"\n ],\n \"additionalProperties\": false\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"const\": \"cancelled\"\n }\n },\n \"required\": [\n \"status\"\n ],\n \"additionalProperties\": false\n }\n ]\n }\n },\n \"required\": [\n \"environment\",\n \"result\"\n ],\n \"additionalProperties\": false\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"environment\": {\n \"type\": \"string\"\n },\n \"error\": {\n \"anyOf\": [\n {\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"const\": \"abort\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"code\": {\n \"type\": \"string\",\n \"minLength\": 1,\n \"description\": \"A stable error code, included only when known.\"\n },\n \"tryMessage\": {\n \"type\": \"string\"\n },\n \"nextSteps\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n },\n \"customSections\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"title\": {\n \"type\": \"string\"\n },\n \"body\": {\n \"anyOf\": [\n {\n \"type\": \"string\"\n },\n {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n }\n ]\n }\n },\n \"required\": [\n \"body\"\n ],\n \"additionalProperties\": false\n }\n },\n \"details\": {\n \"description\": \"Selected domain details, preserving native API payloads such as GraphQL errors, extensions, and data.\"\n }\n },\n \"required\": [\n \"type\",\n \"message\"\n ],\n \"additionalProperties\": false\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"const\": \"bug\"\n },\n \"message\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/message\"\n },\n \"code\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/code\"\n },\n \"tryMessage\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/tryMessage\"\n },\n \"nextSteps\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/nextSteps\"\n },\n \"customSections\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/customSections\"\n },\n \"details\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/details\"\n },\n \"stack\": {\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"type\",\n \"message\"\n ],\n \"additionalProperties\": false\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"const\": \"external\"\n },\n \"message\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/message\"\n },\n \"code\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/code\"\n },\n \"tryMessage\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/tryMessage\"\n },\n \"nextSteps\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/nextSteps\"\n },\n \"customSections\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/customSections\"\n },\n \"details\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/details\"\n },\n \"command\": {\n \"type\": \"string\"\n },\n \"args\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n },\n \"required\": [\n \"type\",\n \"message\",\n \"command\",\n \"args\"\n ],\n \"additionalProperties\": false\n }\n ]\n }\n },\n \"required\": [\n \"environment\",\n \"error\"\n ],\n \"additionalProperties\": false\n }\n ]\n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" }, "auth-alias": { "description": "Alias of the Shopify account to use for authentication.", "env": "SHOPIFY_FLAG_AUTH_ALIAS", "name": "auth-alias", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "no-input": { "description": "Disable interactive prompts and browser authentication.", "env": "SHOPIFY_FLAG_NO_INPUT", "name": "no-input", "allowNo": false, "type": "boolean" }, "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. May include sensitive data.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "allowNo": false, "type": "boolean" }, "json": { "char": "j", "description": "Output the preview URL and identifier as JSON.", "env": "SHOPIFY_FLAG_JSON", "hidden": false, "name": "json", "allowNo": false, "type": "boolean" }, "path": { "description": "The path where you want to run the command. Defaults to the current working directory.", "env": "SHOPIFY_FLAG_PATH", "name": "path", "noCacheDefault": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "password": { "description": "Password generated from the Theme Access app or an Admin API token.", "env": "SHOPIFY_CLI_THEME_TOKEN", "name": "password", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "store": { "char": "s", "description": "Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).", "env": "SHOPIFY_FLAG_STORE", "name": "store", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "environment": { "char": "e", "description": "The environment to apply to the current command.", "env": "SHOPIFY_FLAG_ENVIRONMENT", "name": "environment", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "theme": { "char": "t", "description": "Theme ID or name of the remote theme.", "env": "SHOPIFY_FLAG_THEME_ID", "name": "theme", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "overrides": { "description": "Path to a JSON overrides file.", "env": "SHOPIFY_FLAG_OVERRIDES", "name": "overrides", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "preview-id": { "description": "An existing preview identifier to update instead of creating a new preview.", "env": "SHOPIFY_FLAG_PREVIEW_ID", "name": "preview-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "open": { "description": "Automatically launch the theme preview in your default web browser.", "env": "SHOPIFY_FLAG_OPEN", "name": "open", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "theme:preview", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": true, "summary": "Applies JSON overrides to a theme and returns a preview URL.", "enableJsonFlag": false, "descriptionWithMarkdown": "Applies a JSON overrides file to a theme and creates or updates a preview. This lets you quickly preview changes.\n\n The command returns a preview URL and a preview identifier. You can reuse the preview identifier with `--preview-id` to update an existing preview instead of creating a new one.", "multiEnvironmentsFlags": [ "store", "password", "theme", "overrides" ], "customPluginName": "@shopify/theme" }, "theme:pull": { "aliases": [], "args": {}, "description": "Retrieves theme files from Shopify.\n\nIf no theme is specified, then you're prompted to select the theme to pull from the list of the themes in your store.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `ThemePullResult` schema.\n\n```json\n{\n \"anyOf\": [\n {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/0/properties/result\"\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"environments\": {\n \"type\": \"array\",\n \"items\": {\n \"$ref\": \"#/definitions/ThemeEnvironment\"\n }\n }\n },\n \"required\": [\n \"environments\"\n ],\n \"additionalProperties\": false\n }\n ],\n \"title\": \"ThemePullResult\",\n \"definitions\": {\n \"ThemePullTheme\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"type\": \"string\",\n \"pattern\": \"^\\\\d+$\",\n \"description\": \"The decimal Online Store theme ID, not a Shopify GID.\"\n },\n \"name\": {\n \"type\": \"string\"\n },\n \"role\": {\n \"type\": \"string\",\n \"description\": \"The upstream theme role; known values include live, unpublished, and development.\"\n },\n \"storeDomain\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"pattern\": \"^[a-z0-9][a-z0-9-]*\\\\.myshopify\\\\.com$\"\n },\n {\n \"type\": \"null\"\n }\n ]\n },\n \"previewUrl\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"format\": \"uri\"\n },\n {\n \"type\": \"null\"\n }\n ]\n },\n \"editorUrl\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"format\": \"uri\"\n },\n {\n \"type\": \"null\"\n }\n ]\n },\n \"processing\": {\n \"type\": \"boolean\"\n },\n \"sourceUrl\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"format\": \"uri\"\n },\n {\n \"type\": \"null\"\n }\n ]\n }\n },\n \"required\": [\n \"id\",\n \"name\",\n \"role\",\n \"storeDomain\",\n \"previewUrl\",\n \"editorUrl\",\n \"processing\",\n \"sourceUrl\"\n ],\n \"additionalProperties\": false\n },\n \"ThemeEnvironment\": {\n \"anyOf\": [\n {\n \"type\": \"object\",\n \"properties\": {\n \"environment\": {\n \"type\": \"string\"\n },\n \"result\": {\n \"anyOf\": [\n {\n \"anyOf\": [\n {\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"const\": \"success\"\n },\n \"changed\": {\n \"type\": \"boolean\"\n },\n \"directory\": {\n \"type\": \"string\"\n },\n \"theme\": {\n \"$ref\": \"#/definitions/ThemePullTheme\"\n }\n },\n \"required\": [\n \"status\",\n \"changed\",\n \"directory\",\n \"theme\"\n ],\n \"additionalProperties\": false\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"const\": \"skipped\"\n },\n \"reason\": {\n \"type\": \"string\",\n \"const\": \"unsafe-directory\"\n }\n },\n \"required\": [\n \"status\",\n \"reason\"\n ],\n \"additionalProperties\": false\n }\n ]\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"const\": \"cancelled\"\n }\n },\n \"required\": [\n \"status\"\n ],\n \"additionalProperties\": false\n }\n ]\n }\n },\n \"required\": [\n \"environment\",\n \"result\"\n ],\n \"additionalProperties\": false\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"environment\": {\n \"type\": \"string\"\n },\n \"error\": {\n \"anyOf\": [\n {\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"const\": \"abort\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"code\": {\n \"type\": \"string\",\n \"minLength\": 1,\n \"description\": \"A stable error code, included only when known.\"\n },\n \"tryMessage\": {\n \"type\": \"string\"\n },\n \"nextSteps\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n },\n \"customSections\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"title\": {\n \"type\": \"string\"\n },\n \"body\": {\n \"anyOf\": [\n {\n \"type\": \"string\"\n },\n {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n }\n ]\n }\n },\n \"required\": [\n \"body\"\n ],\n \"additionalProperties\": false\n }\n },\n \"details\": {\n \"description\": \"Selected domain details, preserving native API payloads such as GraphQL errors, extensions, and data.\"\n }\n },\n \"required\": [\n \"type\",\n \"message\"\n ],\n \"additionalProperties\": false\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"const\": \"bug\"\n },\n \"message\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/message\"\n },\n \"code\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/code\"\n },\n \"tryMessage\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/tryMessage\"\n },\n \"nextSteps\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/nextSteps\"\n },\n \"customSections\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/customSections\"\n },\n \"details\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/details\"\n },\n \"stack\": {\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"type\",\n \"message\"\n ],\n \"additionalProperties\": false\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"const\": \"external\"\n },\n \"message\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/message\"\n },\n \"code\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/code\"\n },\n \"tryMessage\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/tryMessage\"\n },\n \"nextSteps\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/nextSteps\"\n },\n \"customSections\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/customSections\"\n },\n \"details\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/details\"\n },\n \"command\": {\n \"type\": \"string\"\n },\n \"args\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n },\n \"required\": [\n \"type\",\n \"message\",\n \"command\",\n \"args\"\n ],\n \"additionalProperties\": false\n }\n ]\n }\n },\n \"required\": [\n \"environment\",\n \"error\"\n ],\n \"additionalProperties\": false\n }\n ]\n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" }, "auth-alias": { "description": "Alias of the Shopify account to use for authentication.", "env": "SHOPIFY_FLAG_AUTH_ALIAS", "name": "auth-alias", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "no-input": { "description": "Disable interactive prompts and browser authentication.", "env": "SHOPIFY_FLAG_NO_INPUT", "name": "no-input", "allowNo": false, "type": "boolean" }, "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. May include sensitive data.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "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" }, "path": { "description": "The path where you want to run the command. Defaults to the current working directory.", "env": "SHOPIFY_FLAG_PATH", "name": "path", "noCacheDefault": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "password": { "description": "Password generated from the Theme Access app or an Admin API token.", "env": "SHOPIFY_CLI_THEME_TOKEN", "name": "password", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "store": { "char": "s", "description": "Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).", "env": "SHOPIFY_FLAG_STORE", "name": "store", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "environment": { "char": "e", "description": "The environment to apply to the current command.", "env": "SHOPIFY_FLAG_ENVIRONMENT", "name": "environment", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "only": { "char": "o", "description": "Download only the specified files (Multiple flags allowed). Wrap the value in double quotes if you're using wildcards.", "env": "SHOPIFY_FLAG_ONLY", "name": "only", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "ignore": { "char": "x", "description": "Skip downloading the specified files (Multiple flags allowed). Wrap the value in double quotes if you're using wildcards.", "env": "SHOPIFY_FLAG_IGNORE", "name": "ignore", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "theme": { "char": "t", "description": "Theme ID or name of the remote theme. Use --development, --live, or --theme in non-interactive environments.", "env": "SHOPIFY_FLAG_THEME_ID", "name": "theme", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "development": { "char": "d", "description": "Pull theme files from your remote development theme. Use --development, --live, or --theme in non-interactive environments.", "env": "SHOPIFY_FLAG_DEVELOPMENT", "name": "development", "allowNo": false, "type": "boolean" }, "live": { "char": "l", "description": "Pull theme files from your remote live theme. Use --development, --live, or --theme in non-interactive environments.", "env": "SHOPIFY_FLAG_LIVE", "name": "live", "allowNo": false, "type": "boolean" }, "nodelete": { "char": "n", "description": "Prevent deleting local files that don't exist remotely.", "env": "SHOPIFY_FLAG_NODELETE", "name": "nodelete", "allowNo": false, "type": "boolean" }, "force": { "char": "f", "description": "Proceed without confirmation, if current directory does not seem to be theme directory.", "env": "SHOPIFY_FLAG_FORCE", "hidden": true, "name": "force", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "theme:pull", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": true, "summary": "Download your remote theme files locally.", "enableJsonFlag": false, "descriptionWithMarkdown": "Retrieves theme files from Shopify.\n\nIf no theme is specified, then you're prompted to select the theme to pull from the list of the themes in your store.", "multiEnvironmentsFlags": [ "store", "password", "path", [ "live", "development", "theme" ] ], "customPluginName": "@shopify/theme" }, "theme:push": { "aliases": [], "args": {}, "description": "Uploads your local theme files to Shopify, overwriting the remote version if specified.\n\n If no theme is specified, then you're prompted to select the theme to overwrite from the list of the themes in your store.\n\n You can run this command only in a directory that matches the \"default Shopify theme folder structure\" (https://shopify.dev/docs/themes/tools/cli#directory-structure).\n\n This command returns the following information:\n\n - A link to the \"editor\" (https://shopify.dev/docs/themes/tools/online-editor) for the theme in the Shopify admin.\n - A \"preview link\" (https://help.shopify.com/manual/online-store/themes/adding-themes#share-a-theme-preview-with-others) that you can share with others.\n\n If you use the `--json` flag, then theme information is returned in JSON format, which can be used as a machine-readable input for scripts or continuous integration.\n\n Sample output:\n\n ```json\n {\n \"status\": \"success\",\n \"changed\": true,\n \"issues\": [],\n \"theme\": {\n \"id\": \"108267175958\",\n \"name\": \"MyTheme\",\n \"role\": \"unpublished\",\n \"storeDomain\": \"mystore.myshopify.com\",\n \"editorUrl\": \"https://mystore.myshopify.com/admin/themes/108267175958/editor\",\n \"previewUrl\": \"https://mystore.myshopify.com/?preview_theme_id=108267175958\"\n }\n }\n ```\n \n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `ThemePushJsonResult` schema.\n\n```json\n{\n \"anyOf\": [\n {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/0/properties/result\"\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"environments\": {\n \"type\": \"array\",\n \"items\": {\n \"$ref\": \"#/definitions/ThemeEnvironment\"\n }\n }\n },\n \"required\": [\n \"environments\"\n ],\n \"additionalProperties\": false\n }\n ],\n \"title\": \"ThemePushJsonResult\",\n \"definitions\": {\n \"ThemePushTheme\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"type\": \"string\",\n \"pattern\": \"^\\\\d+$\",\n \"description\": \"The decimal Online Store theme ID, not a Shopify GID.\"\n },\n \"name\": {\n \"type\": \"string\"\n },\n \"role\": {\n \"type\": \"string\",\n \"description\": \"The upstream theme role; known values include live, unpublished, and development.\"\n },\n \"storeDomain\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"pattern\": \"^[a-z0-9][a-z0-9-]*\\\\.myshopify\\\\.com$\"\n },\n {\n \"type\": \"null\"\n }\n ]\n },\n \"previewUrl\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"format\": \"uri\"\n },\n {\n \"type\": \"null\"\n }\n ]\n },\n \"editorUrl\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"format\": \"uri\"\n },\n {\n \"type\": \"null\"\n }\n ]\n }\n },\n \"required\": [\n \"id\",\n \"name\",\n \"role\",\n \"storeDomain\",\n \"previewUrl\",\n \"editorUrl\"\n ],\n \"additionalProperties\": false\n },\n \"ThemeEnvironment\": {\n \"anyOf\": [\n {\n \"type\": \"object\",\n \"properties\": {\n \"environment\": {\n \"type\": \"string\"\n },\n \"result\": {\n \"anyOf\": [\n {\n \"anyOf\": [\n {\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"enum\": [\n \"success\",\n \"partial\"\n ]\n },\n \"changed\": {\n \"type\": \"boolean\"\n },\n \"theme\": {\n \"$ref\": \"#/definitions/ThemePushTheme\"\n },\n \"issues\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"filePath\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"filePath\",\n \"message\"\n ],\n \"additionalProperties\": false\n }\n }\n },\n \"required\": [\n \"status\",\n \"changed\",\n \"theme\",\n \"issues\"\n ],\n \"additionalProperties\": false\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"const\": \"skipped\"\n },\n \"reason\": {\n \"type\": \"string\",\n \"const\": \"unsafe-directory\"\n }\n },\n \"required\": [\n \"status\",\n \"reason\"\n ],\n \"additionalProperties\": false\n }\n ]\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"const\": \"cancelled\"\n }\n },\n \"required\": [\n \"status\"\n ],\n \"additionalProperties\": false\n }\n ]\n }\n },\n \"required\": [\n \"environment\",\n \"result\"\n ],\n \"additionalProperties\": false\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"environment\": {\n \"type\": \"string\"\n },\n \"error\": {\n \"anyOf\": [\n {\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"const\": \"abort\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"code\": {\n \"type\": \"string\",\n \"minLength\": 1,\n \"description\": \"A stable error code, included only when known.\"\n },\n \"tryMessage\": {\n \"type\": \"string\"\n },\n \"nextSteps\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n },\n \"customSections\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"title\": {\n \"type\": \"string\"\n },\n \"body\": {\n \"anyOf\": [\n {\n \"type\": \"string\"\n },\n {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n }\n ]\n }\n },\n \"required\": [\n \"body\"\n ],\n \"additionalProperties\": false\n }\n },\n \"details\": {\n \"description\": \"Selected domain details, preserving native API payloads such as GraphQL errors, extensions, and data.\"\n }\n },\n \"required\": [\n \"type\",\n \"message\"\n ],\n \"additionalProperties\": false\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"const\": \"bug\"\n },\n \"message\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/message\"\n },\n \"code\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/code\"\n },\n \"tryMessage\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/tryMessage\"\n },\n \"nextSteps\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/nextSteps\"\n },\n \"customSections\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/customSections\"\n },\n \"details\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/details\"\n },\n \"stack\": {\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"type\",\n \"message\"\n ],\n \"additionalProperties\": false\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"const\": \"external\"\n },\n \"message\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/message\"\n },\n \"code\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/code\"\n },\n \"tryMessage\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/tryMessage\"\n },\n \"nextSteps\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/nextSteps\"\n },\n \"customSections\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/customSections\"\n },\n \"details\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/details\"\n },\n \"command\": {\n \"type\": \"string\"\n },\n \"args\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n },\n \"required\": [\n \"type\",\n \"message\",\n \"command\",\n \"args\"\n ],\n \"additionalProperties\": false\n }\n ]\n }\n },\n \"required\": [\n \"environment\",\n \"error\"\n ],\n \"additionalProperties\": false\n }\n ]\n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" }, "auth-alias": { "description": "Alias of the Shopify account to use for authentication.", "env": "SHOPIFY_FLAG_AUTH_ALIAS", "name": "auth-alias", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "no-input": { "description": "Disable interactive prompts and browser authentication.", "env": "SHOPIFY_FLAG_NO_INPUT", "name": "no-input", "allowNo": false, "type": "boolean" }, "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. May include sensitive data.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "allowNo": false, "type": "boolean" }, "path": { "description": "The path where you want to run the command. Defaults to the current working directory.", "env": "SHOPIFY_FLAG_PATH", "name": "path", "noCacheDefault": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "password": { "description": "Password generated from the Theme Access app or an Admin API token.", "env": "SHOPIFY_CLI_THEME_TOKEN", "name": "password", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "store": { "char": "s", "description": "Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).", "env": "SHOPIFY_FLAG_STORE", "name": "store", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "environment": { "char": "e", "description": "The environment to apply to the current command.", "env": "SHOPIFY_FLAG_ENVIRONMENT", "name": "environment", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "only": { "char": "o", "description": "Upload only the specified files (Multiple flags allowed). Wrap the value in double quotes if you're using wildcards.", "env": "SHOPIFY_FLAG_ONLY", "name": "only", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "ignore": { "char": "x", "description": "Skip uploading the specified files (Multiple flags allowed). Wrap the value in double quotes if you're using wildcards.", "env": "SHOPIFY_FLAG_IGNORE", "name": "ignore", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "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" }, "theme": { "char": "t", "description": "Theme ID or name of the remote theme. Use --development, --live, --theme, or --unpublished in non-interactive environments. When using --unpublished without --development, use --theme to provide the new theme name.", "env": "SHOPIFY_FLAG_THEME_ID", "name": "theme", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "development": { "char": "d", "description": "Push theme files from your remote development theme. Use --development, --live, --theme, or --unpublished in non-interactive environments.", "env": "SHOPIFY_FLAG_DEVELOPMENT", "name": "development", "allowNo": false, "type": "boolean" }, "development-context": { "char": "c", "dependsOn": [ "development" ], "description": "Unique identifier for a development theme context (e.g., PR number, branch name). Reuses an existing development theme with this context name, or creates one if none exists.", "env": "SHOPIFY_FLAG_DEVELOPMENT_CONTEXT", "exclusive": [ "theme" ], "name": "development-context", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "live": { "char": "l", "description": "Push theme files from your remote live theme. Use --development, --live, --theme, or --unpublished in non-interactive environments.", "env": "SHOPIFY_FLAG_LIVE", "name": "live", "allowNo": false, "type": "boolean" }, "unpublished": { "char": "u", "description": "Create a new unpublished theme and push to it. Use --development, --live, --theme, or --unpublished in non-interactive environments. When using --unpublished without --development, use --theme to provide the new theme name.", "env": "SHOPIFY_FLAG_UNPUBLISHED", "name": "unpublished", "allowNo": false, "type": "boolean" }, "nodelete": { "char": "n", "description": "Prevent deleting remote files that don't exist locally.", "env": "SHOPIFY_FLAG_NODELETE", "name": "nodelete", "allowNo": false, "type": "boolean" }, "allow-live": { "char": "a", "description": "Allow push to a live theme. Required in non-interactive environments when targeting the live theme.", "env": "SHOPIFY_FLAG_ALLOW_LIVE", "name": "allow-live", "allowNo": false, "type": "boolean" }, "publish": { "char": "p", "description": "Publish as the live theme after uploading.", "env": "SHOPIFY_FLAG_PUBLISH", "name": "publish", "allowNo": false, "type": "boolean" }, "force": { "char": "f", "description": "Proceed without confirmation, if current directory does not seem to be theme directory.", "env": "SHOPIFY_FLAG_FORCE", "hidden": true, "name": "force", "allowNo": false, "type": "boolean" }, "strict": { "description": "Require theme check to pass without errors before pushing. Warnings are allowed.", "env": "SHOPIFY_FLAG_STRICT_PUSH", "name": "strict", "allowNo": false, "type": "boolean" }, "listing": { "description": "The listing preset to use for multi-preset themes. Applies preset files from listings/[preset-name] directory.", "env": "SHOPIFY_FLAG_LISTING", "name": "listing", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "theme:push", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": true, "summary": "Uploads your local theme files to the connected store, overwriting the remote version if specified.", "usage": [ "theme push", "theme push --unpublished --json" ], "enableJsonFlag": false, "descriptionWithMarkdown": "Uploads your local theme files to Shopify, overwriting the remote version if specified.\n\n If no theme is specified, then you're prompted to select the theme to overwrite from the list of the themes in your store.\n\n You can run this command only in a directory that matches the [default Shopify theme folder structure](https://shopify.dev/docs/themes/tools/cli#directory-structure).\n\n This command returns the following information:\n\n - A link to the [editor](https://shopify.dev/docs/themes/tools/online-editor) for the theme in the Shopify admin.\n - A [preview link](https://help.shopify.com/manual/online-store/themes/adding-themes#share-a-theme-preview-with-others) that you can share with others.\n\n If you use the `--json` flag, then theme information is returned in JSON format, which can be used as a machine-readable input for scripts or continuous integration.\n\n Sample output:\n\n ```json\n {\n \"status\": \"success\",\n \"changed\": true,\n \"issues\": [],\n \"theme\": {\n \"id\": \"108267175958\",\n \"name\": \"MyTheme\",\n \"role\": \"unpublished\",\n \"storeDomain\": \"mystore.myshopify.com\",\n \"editorUrl\": \"https://mystore.myshopify.com/admin/themes/108267175958/editor\",\n \"previewUrl\": \"https://mystore.myshopify.com/?preview_theme_id=108267175958\"\n }\n }\n ```\n ", "multiEnvironmentsFlags": [ "store", "password", "path", [ "live", "development", "theme" ] ], "customPluginName": "@shopify/theme" }, "theme:rename": { "aliases": [], "args": {}, "description": "Renames a theme in your store.\n\n If no theme is specified, then you're prompted to select the theme that you want to rename from the list of themes in your store.\n \n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `ThemeRenameResult` schema.\n\n```json\n{\n \"anyOf\": [\n {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/0/properties/result\"\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"environments\": {\n \"type\": \"array\",\n \"items\": {\n \"$ref\": \"#/definitions/ThemeEnvironment\"\n }\n }\n },\n \"required\": [\n \"environments\"\n ],\n \"additionalProperties\": false\n }\n ],\n \"title\": \"ThemeRenameResult\",\n \"definitions\": {\n \"Theme\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"type\": \"string\",\n \"pattern\": \"^\\\\d+$\",\n \"description\": \"The decimal Online Store theme ID, not a Shopify GID.\"\n },\n \"name\": {\n \"type\": \"string\"\n },\n \"role\": {\n \"type\": \"string\",\n \"description\": \"The upstream theme role; known values include live, unpublished, and development.\"\n },\n \"storeDomain\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"pattern\": \"^[a-z0-9][a-z0-9-]*\\\\.myshopify\\\\.com$\"\n },\n {\n \"type\": \"null\"\n }\n ]\n },\n \"processing\": {\n \"type\": \"boolean\"\n },\n \"sourceUrl\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"format\": \"uri\"\n },\n {\n \"type\": \"null\"\n }\n ]\n }\n },\n \"required\": [\n \"id\",\n \"name\",\n \"role\",\n \"storeDomain\",\n \"processing\",\n \"sourceUrl\"\n ],\n \"additionalProperties\": false,\n \"description\": \"The selected theme projection; sourceUrl is null when the upstream source URL is unavailable.\"\n },\n \"ThemeEnvironment\": {\n \"anyOf\": [\n {\n \"type\": \"object\",\n \"properties\": {\n \"environment\": {\n \"type\": \"string\"\n },\n \"result\": {\n \"anyOf\": [\n {\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"const\": \"success\"\n },\n \"changed\": {\n \"type\": \"boolean\"\n },\n \"originalName\": {\n \"type\": \"string\"\n },\n \"theme\": {\n \"$ref\": \"#/definitions/Theme\"\n }\n },\n \"required\": [\n \"status\",\n \"changed\",\n \"originalName\",\n \"theme\"\n ],\n \"additionalProperties\": false\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"const\": \"cancelled\"\n }\n },\n \"required\": [\n \"status\"\n ],\n \"additionalProperties\": false\n }\n ]\n }\n },\n \"required\": [\n \"environment\",\n \"result\"\n ],\n \"additionalProperties\": false\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"environment\": {\n \"type\": \"string\"\n },\n \"error\": {\n \"anyOf\": [\n {\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"const\": \"abort\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"code\": {\n \"type\": \"string\",\n \"minLength\": 1,\n \"description\": \"A stable error code, included only when known.\"\n },\n \"tryMessage\": {\n \"type\": \"string\"\n },\n \"nextSteps\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n },\n \"customSections\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"title\": {\n \"type\": \"string\"\n },\n \"body\": {\n \"anyOf\": [\n {\n \"type\": \"string\"\n },\n {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n }\n ]\n }\n },\n \"required\": [\n \"body\"\n ],\n \"additionalProperties\": false\n }\n },\n \"details\": {\n \"description\": \"Selected domain details, preserving native API payloads such as GraphQL errors, extensions, and data.\"\n }\n },\n \"required\": [\n \"type\",\n \"message\"\n ],\n \"additionalProperties\": false\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"const\": \"bug\"\n },\n \"message\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/message\"\n },\n \"code\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/code\"\n },\n \"tryMessage\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/tryMessage\"\n },\n \"nextSteps\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/nextSteps\"\n },\n \"customSections\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/customSections\"\n },\n \"details\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/details\"\n },\n \"stack\": {\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"type\",\n \"message\"\n ],\n \"additionalProperties\": false\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"const\": \"external\"\n },\n \"message\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/message\"\n },\n \"code\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/code\"\n },\n \"tryMessage\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/tryMessage\"\n },\n \"nextSteps\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/nextSteps\"\n },\n \"customSections\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/customSections\"\n },\n \"details\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/details\"\n },\n \"command\": {\n \"type\": \"string\"\n },\n \"args\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n },\n \"required\": [\n \"type\",\n \"message\",\n \"command\",\n \"args\"\n ],\n \"additionalProperties\": false\n }\n ]\n }\n },\n \"required\": [\n \"environment\",\n \"error\"\n ],\n \"additionalProperties\": false\n }\n ]\n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" }, "auth-alias": { "description": "Alias of the Shopify account to use for authentication.", "env": "SHOPIFY_FLAG_AUTH_ALIAS", "name": "auth-alias", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "no-input": { "description": "Disable interactive prompts and browser authentication.", "env": "SHOPIFY_FLAG_NO_INPUT", "name": "no-input", "allowNo": false, "type": "boolean" }, "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. May include sensitive data.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "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" }, "path": { "description": "The path where you want to run the command. Defaults to the current working directory.", "env": "SHOPIFY_FLAG_PATH", "name": "path", "noCacheDefault": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "password": { "description": "Password generated from the Theme Access app or an Admin API token.", "env": "SHOPIFY_CLI_THEME_TOKEN", "name": "password", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "store": { "char": "s", "description": "Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).", "env": "SHOPIFY_FLAG_STORE", "name": "store", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "environment": { "char": "e", "description": "The environment to apply to the current command.", "env": "SHOPIFY_FLAG_ENVIRONMENT", "name": "environment", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "name": { "char": "n", "description": "The new name for the theme. Required if non interactive.", "env": "SHOPIFY_FLAG_NEW_NAME", "name": "name", "required": false, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "development": { "char": "d", "description": "Rename your development theme. Use --development, --live, or --theme in non-interactive environments.", "env": "SHOPIFY_FLAG_DEVELOPMENT", "name": "development", "allowNo": false, "type": "boolean" }, "theme": { "char": "t", "description": "Theme ID or name of the remote theme. Use --development, --live, or --theme in non-interactive environments.", "env": "SHOPIFY_FLAG_THEME_ID", "name": "theme", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "live": { "char": "l", "description": "Rename your remote live theme. Use --development, --live, or --theme in non-interactive environments.", "env": "SHOPIFY_FLAG_LIVE", "name": "live", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "theme:rename", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": true, "summary": "Renames an existing theme.", "enableJsonFlag": false, "descriptionWithMarkdown": "Renames a theme in your store.\n\n If no theme is specified, then you're prompted to select the theme that you want to rename from the list of themes in your store.\n ", "multiEnvironmentsFlags": [ "store", "password", "name", [ "live", "development", "theme" ] ], "customPluginName": "@shopify/theme" }, "theme:share": { "aliases": [], "args": {}, "description": "Uploads your theme as a new, unpublished theme in your theme library. The theme is given a randomized name.\n\n This command returns a \"preview link\" (https://help.shopify.com/manual/online-store/themes/adding-themes#share-a-theme-preview-with-others) that you can share with others.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `ThemeShareResult` schema.\n\n```json\n{\n \"anyOf\": [\n {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/0/properties/result\"\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"environments\": {\n \"type\": \"array\",\n \"items\": {\n \"$ref\": \"#/definitions/ThemeEnvironment\"\n }\n }\n },\n \"required\": [\n \"environments\"\n ],\n \"additionalProperties\": false\n }\n ],\n \"title\": \"ThemeShareResult\",\n \"definitions\": {\n \"ThemePushTheme\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"type\": \"string\",\n \"pattern\": \"^\\\\d+$\",\n \"description\": \"The decimal Online Store theme ID, not a Shopify GID.\"\n },\n \"name\": {\n \"type\": \"string\"\n },\n \"role\": {\n \"type\": \"string\",\n \"description\": \"The upstream theme role; known values include live, unpublished, and development.\"\n },\n \"storeDomain\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"pattern\": \"^[a-z0-9][a-z0-9-]*\\\\.myshopify\\\\.com$\"\n },\n {\n \"type\": \"null\"\n }\n ]\n },\n \"previewUrl\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"format\": \"uri\"\n },\n {\n \"type\": \"null\"\n }\n ]\n },\n \"editorUrl\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"format\": \"uri\"\n },\n {\n \"type\": \"null\"\n }\n ]\n }\n },\n \"required\": [\n \"id\",\n \"name\",\n \"role\",\n \"storeDomain\",\n \"previewUrl\",\n \"editorUrl\"\n ],\n \"additionalProperties\": false\n },\n \"ThemeEnvironment\": {\n \"anyOf\": [\n {\n \"type\": \"object\",\n \"properties\": {\n \"environment\": {\n \"type\": \"string\"\n },\n \"result\": {\n \"anyOf\": [\n {\n \"anyOf\": [\n {\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"enum\": [\n \"success\",\n \"partial\"\n ]\n },\n \"changed\": {\n \"type\": \"boolean\"\n },\n \"theme\": {\n \"$ref\": \"#/definitions/ThemePushTheme\"\n },\n \"issues\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"filePath\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"filePath\",\n \"message\"\n ],\n \"additionalProperties\": false\n }\n }\n },\n \"required\": [\n \"status\",\n \"changed\",\n \"theme\",\n \"issues\"\n ],\n \"additionalProperties\": false\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"const\": \"skipped\"\n },\n \"reason\": {\n \"type\": \"string\",\n \"const\": \"unsafe-directory\"\n }\n },\n \"required\": [\n \"status\",\n \"reason\"\n ],\n \"additionalProperties\": false\n }\n ]\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"const\": \"cancelled\"\n }\n },\n \"required\": [\n \"status\"\n ],\n \"additionalProperties\": false\n }\n ]\n }\n },\n \"required\": [\n \"environment\",\n \"result\"\n ],\n \"additionalProperties\": false\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"environment\": {\n \"type\": \"string\"\n },\n \"error\": {\n \"anyOf\": [\n {\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"const\": \"abort\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"code\": {\n \"type\": \"string\",\n \"minLength\": 1,\n \"description\": \"A stable error code, included only when known.\"\n },\n \"tryMessage\": {\n \"type\": \"string\"\n },\n \"nextSteps\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n },\n \"customSections\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"title\": {\n \"type\": \"string\"\n },\n \"body\": {\n \"anyOf\": [\n {\n \"type\": \"string\"\n },\n {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n }\n ]\n }\n },\n \"required\": [\n \"body\"\n ],\n \"additionalProperties\": false\n }\n },\n \"details\": {\n \"description\": \"Selected domain details, preserving native API payloads such as GraphQL errors, extensions, and data.\"\n }\n },\n \"required\": [\n \"type\",\n \"message\"\n ],\n \"additionalProperties\": false\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"const\": \"bug\"\n },\n \"message\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/message\"\n },\n \"code\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/code\"\n },\n \"tryMessage\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/tryMessage\"\n },\n \"nextSteps\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/nextSteps\"\n },\n \"customSections\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/customSections\"\n },\n \"details\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/details\"\n },\n \"stack\": {\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"type\",\n \"message\"\n ],\n \"additionalProperties\": false\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"const\": \"external\"\n },\n \"message\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/message\"\n },\n \"code\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/code\"\n },\n \"tryMessage\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/tryMessage\"\n },\n \"nextSteps\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/nextSteps\"\n },\n \"customSections\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/customSections\"\n },\n \"details\": {\n \"$ref\": \"#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/details\"\n },\n \"command\": {\n \"type\": \"string\"\n },\n \"args\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n },\n \"required\": [\n \"type\",\n \"message\",\n \"command\",\n \"args\"\n ],\n \"additionalProperties\": false\n }\n ]\n }\n },\n \"required\": [\n \"environment\",\n \"error\"\n ],\n \"additionalProperties\": false\n }\n ]\n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" }, "auth-alias": { "description": "Alias of the Shopify account to use for authentication.", "env": "SHOPIFY_FLAG_AUTH_ALIAS", "name": "auth-alias", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "no-input": { "description": "Disable interactive prompts and browser authentication.", "env": "SHOPIFY_FLAG_NO_INPUT", "name": "no-input", "allowNo": false, "type": "boolean" }, "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. May include sensitive data.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "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" }, "path": { "description": "The path where you want to run the command. Defaults to the current working directory.", "env": "SHOPIFY_FLAG_PATH", "name": "path", "noCacheDefault": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "password": { "description": "Password generated from the Theme Access app or an Admin API token.", "env": "SHOPIFY_CLI_THEME_TOKEN", "name": "password", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "store": { "char": "s", "description": "Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).", "env": "SHOPIFY_FLAG_STORE", "name": "store", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "environment": { "char": "e", "description": "The environment to apply to the current command.", "env": "SHOPIFY_FLAG_ENVIRONMENT", "name": "environment", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "force": { "char": "f", "description": "Proceed without confirmation, if current directory does not seem to be theme directory.", "env": "SHOPIFY_FLAG_FORCE", "hidden": true, "name": "force", "allowNo": false, "type": "boolean" }, "listing": { "description": "The listing preset to use for multi-preset themes. Applies preset files from listings/[preset-name] directory.", "env": "SHOPIFY_FLAG_LISTING", "name": "listing", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "theme:share", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": true, "summary": "Creates a shareable, unpublished, and new theme on your theme library with a randomized name.", "enableJsonFlag": false, "descriptionWithMarkdown": "Uploads your theme as a new, unpublished theme in your theme library. The theme is given a randomized name.\n\n This command returns a [preview link](https://help.shopify.com/manual/online-store/themes/adding-themes#share-a-theme-preview-with-others) that you can share with others.", "multiEnvironmentsFlags": [ "store", "password", "path" ], "customPluginName": "@shopify/theme" }, "plugins": { "aliases": [], "args": {}, "description": "List installed plugins.", "examples": [ "<%= config.bin %> <%= command.id %>" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "core": { "description": "Show core plugins.", "name": "core", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hidden": true, "hiddenAliases": [], "id": "plugins", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": true, "enableJsonFlag": true, "customPluginName": "@oclif/plugin-plugins" }, "plugins:inspect": { "aliases": [], "args": { "plugin": { "default": ".", "description": "Plugin to inspect.", "name": "plugin", "required": true } }, "description": "Displays installation properties of a plugin.", "examples": [ "<%= config.bin %> <%= command.id %> <%- config.pjson.oclif.examplePlugin || \"myplugin\" %> " ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "help": { "char": "h", "description": "Show CLI help.", "name": "help", "allowNo": false, "type": "boolean" }, "verbose": { "char": "v", "name": "verbose", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "plugins:inspect", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": false, "usage": "plugins:inspect PLUGIN...", "enableJsonFlag": true, "customPluginName": "@oclif/plugin-plugins" }, "plugins:install": { "aliases": [ "plugins:add" ], "args": { "plugin": { "description": "Plugin to install.", "name": "plugin", "required": true } }, "description": "", "examples": [ { "command": "<%= config.bin %> <%= command.id %> <%- config.pjson.oclif.examplePlugin || \"myplugin\" %> ", "description": "Install a plugin from npm registry." }, { "command": "<%= config.bin %> <%= command.id %> https://github.com/someuser/someplugin", "description": "Install a plugin from a github url." }, { "command": "<%= config.bin %> <%= command.id %> someuser/someplugin", "description": "Install a plugin from a github slug." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "force": { "char": "f", "description": "Force npm to fetch remote resources even if a local copy exists on disk.", "name": "force", "allowNo": false, "type": "boolean" }, "help": { "char": "h", "description": "Show CLI help.", "name": "help", "allowNo": false, "type": "boolean" }, "jit": { "hidden": true, "name": "jit", "allowNo": false, "type": "boolean" }, "silent": { "char": "s", "description": "Silences npm output.", "exclusive": [ "verbose" ], "name": "silent", "allowNo": false, "type": "boolean" }, "verbose": { "char": "v", "description": "Show verbose npm output.", "exclusive": [ "silent" ], "name": "verbose", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "plugins:install", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": false, "summary": "Installs a plugin into <%= config.bin %>.", "enableJsonFlag": true, "customPluginName": "@oclif/plugin-plugins" }, "plugins:link": { "aliases": [], "args": { "path": { "default": ".", "description": "path to plugin", "name": "path", "required": true } }, "description": "Installation of a linked plugin will override a user-installed or core plugin.\n\ne.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello' command will override the user-installed or core plugin implementation. This is useful for development work.\n", "examples": [ "<%= config.bin %> <%= command.id %> <%- config.pjson.oclif.examplePlugin || \"myplugin\" %> " ], "flags": { "help": { "char": "h", "description": "Show CLI help.", "name": "help", "allowNo": false, "type": "boolean" }, "install": { "description": "Install dependencies after linking the plugin.", "name": "install", "allowNo": true, "type": "boolean" }, "verbose": { "char": "v", "name": "verbose", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "plugins:link", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": true, "summary": "Links a plugin into the CLI for development.", "enableJsonFlag": false, "customPluginName": "@oclif/plugin-plugins" }, "plugins:reset": { "aliases": [], "args": {}, "flags": { "hard": { "name": "hard", "summary": "Delete node_modules and package manager related files in addition to uninstalling plugins.", "allowNo": false, "type": "boolean" }, "reinstall": { "name": "reinstall", "summary": "Reinstall all plugins after uninstalling.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "plugins:reset", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": true, "summary": "Remove all user-installed and linked plugins.", "enableJsonFlag": false, "customPluginName": "@oclif/plugin-plugins" }, "plugins:uninstall": { "aliases": [ "plugins:unlink", "plugins:remove" ], "args": { "plugin": { "description": "plugin to uninstall", "name": "plugin" } }, "description": "Removes a plugin from the CLI.", "examples": [ "<%= config.bin %> <%= command.id %> <%- config.pjson.oclif.examplePlugin || \"myplugin\" %>" ], "flags": { "help": { "char": "h", "description": "Show CLI help.", "name": "help", "allowNo": false, "type": "boolean" }, "verbose": { "char": "v", "name": "verbose", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "plugins:uninstall", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": false, "enableJsonFlag": false, "customPluginName": "@oclif/plugin-plugins" }, "plugins:update": { "aliases": [], "args": {}, "description": "Update installed plugins.", "flags": { "help": { "char": "h", "description": "Show CLI help.", "name": "help", "allowNo": false, "type": "boolean" }, "verbose": { "char": "v", "name": "verbose", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "plugins:update", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": true, "enableJsonFlag": false, "customPluginName": "@oclif/plugin-plugins" }, "config:autocorrect:off": { "aliases": [], "args": {}, "description": "Disable autocorrect. Off by default.\n\n When autocorrection is enabled, Shopify CLI automatically runs a corrected version of your command if a correction is available.\n\n When autocorrection is disabled, you need to confirm that you want to run corrections for mistyped commands.\n\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `AutocorrectResult` schema.\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"enabled\": {\n \"type\": \"boolean\"\n }\n },\n \"required\": [\n \"enabled\"\n ],\n \"additionalProperties\": false,\n \"title\": \"AutocorrectResult\",\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" }, "no-input": { "description": "Disable interactive prompts and browser authentication.", "env": "SHOPIFY_FLAG_NO_INPUT", "name": "no-input", "allowNo": false, "type": "boolean" }, "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. May include sensitive data.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "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": "config:autocorrect:off", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": true, "summary": "Disable autocorrect. Off by default.", "enableJsonFlag": false, "descriptionWithMarkdown": "Disable autocorrect. Off by default.\n\n When autocorrection is enabled, Shopify CLI automatically runs a corrected version of your command if a correction is available.\n\n When autocorrection is disabled, you need to confirm that you want to run corrections for mistyped commands.\n", "customPluginName": "@shopify/plugin-did-you-mean" }, "config:autocorrect:status": { "aliases": [], "args": {}, "description": "Check whether autocorrect is enabled or disabled. On by default.\n\n When autocorrection is enabled, Shopify CLI automatically runs a corrected version of your command if a correction is available.\n\n When autocorrection is disabled, you need to confirm that you want to run corrections for mistyped commands.\n\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `AutocorrectResult` schema.\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"enabled\": {\n \"type\": \"boolean\"\n }\n },\n \"required\": [\n \"enabled\"\n ],\n \"additionalProperties\": false,\n \"title\": \"AutocorrectResult\",\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" }, "no-input": { "description": "Disable interactive prompts and browser authentication.", "env": "SHOPIFY_FLAG_NO_INPUT", "name": "no-input", "allowNo": false, "type": "boolean" }, "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. May include sensitive data.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "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": "config:autocorrect:status", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": true, "summary": "Check whether autocorrect is enabled or disabled. On by default.", "enableJsonFlag": false, "descriptionWithMarkdown": "Check whether autocorrect is enabled or disabled. On by default.\n\n When autocorrection is enabled, Shopify CLI automatically runs a corrected version of your command if a correction is available.\n\n When autocorrection is disabled, you need to confirm that you want to run corrections for mistyped commands.\n", "customPluginName": "@shopify/plugin-did-you-mean" }, "config:autocorrect:on": { "aliases": [], "args": {}, "description": "Enable autocorrect. Off by default.\n\n When autocorrection is enabled, Shopify CLI automatically runs a corrected version of your command if a correction is available.\n\n When autocorrection is disabled, you need to confirm that you want to run corrections for mistyped commands.\n\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `AutocorrectResult` schema.\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"enabled\": {\n \"type\": \"boolean\"\n }\n },\n \"required\": [\n \"enabled\"\n ],\n \"additionalProperties\": false,\n \"title\": \"AutocorrectResult\",\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" }, "no-input": { "description": "Disable interactive prompts and browser authentication.", "env": "SHOPIFY_FLAG_NO_INPUT", "name": "no-input", "allowNo": false, "type": "boolean" }, "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. May include sensitive data.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "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": "config:autocorrect:on", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": true, "summary": "Enable autocorrect. Off by default.", "enableJsonFlag": false, "descriptionWithMarkdown": "Enable autocorrect. Off by default.\n\n When autocorrection is enabled, Shopify CLI automatically runs a corrected version of your command if a correction is available.\n\n When autocorrection is disabled, you need to confirm that you want to run corrections for mistyped commands.\n", "customPluginName": "@shopify/plugin-did-you-mean" }, "commands": { "aliases": [], "args": {}, "description": "List all <%= config.bin %> commands.", "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "columns": { "char": "c", "description": "Only show provided columns (comma-separated).", "exclusive": [ "tree" ], "name": "columns", "delimiter": ",", "hasDynamicHelp": false, "multiple": true, "options": [ "id", "plugin", "summary", "type" ], "type": "option" }, "deprecated": { "description": "Show deprecated commands.", "name": "deprecated", "allowNo": false, "type": "boolean" }, "extended": { "char": "x", "description": "Show extra columns.", "exclusive": [ "tree" ], "name": "extended", "allowNo": false, "type": "boolean" }, "hidden": { "description": "Show hidden commands.", "name": "hidden", "allowNo": false, "type": "boolean" }, "no-truncate": { "description": "Do not truncate output.", "exclusive": [ "tree" ], "name": "no-truncate", "allowNo": false, "type": "boolean" }, "sort": { "description": "Property to sort by.", "exclusive": [ "tree" ], "name": "sort", "default": "id", "hasDynamicHelp": false, "multiple": false, "options": [ "id", "plugin", "summary", "type" ], "type": "option" }, "tree": { "description": "Show tree of commands.", "name": "tree", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "commands", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": true, "enableJsonFlag": true, "customPluginName": "@oclif/plugin-commands" }, "hydrogen:dev": { "aliases": [], "args": {}, "description": "Runs Hydrogen storefront in an Oxygen worker for development.", "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" }, "no-input": { "description": "Disable interactive prompts and browser authentication.", "env": "SHOPIFY_FLAG_NO_INPUT", "name": "no-input", "allowNo": false, "type": "boolean" }, "no-color": { "description": "Disable color output.", "env": "SHOPIFY_FLAG_NO_COLOR", "hidden": false, "name": "no-color", "allowNo": false, "type": "boolean" }, "verbose": { "description": "Outputs more information about the command's execution.", "env": "SHOPIFY_HYDROGEN_FLAG_VERBOSE", "name": "verbose", "required": false, "allowNo": false, "type": "boolean" }, "path": { "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.", "env": "SHOPIFY_HYDROGEN_FLAG_PATH", "name": "path", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "entry": { "description": "Entry file for the worker. Defaults to `./server`.", "env": "SHOPIFY_HYDROGEN_FLAG_ENTRY", "name": "entry", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "port": { "description": "The port to run the server on. Defaults to 3000.", "env": "SHOPIFY_HYDROGEN_FLAG_PORT", "name": "port", "required": false, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "codegen": { "description": "Automatically generates GraphQL types for your project’s Storefront API queries.", "name": "codegen", "required": false, "allowNo": false, "type": "boolean" }, "codegen-config-path": { "dependsOn": [ "codegen" ], "description": "Specifies a path to a codegen configuration file. Defaults to `/codegen.ts` if this file exists.", "name": "codegen-config-path", "required": false, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "disable-virtual-routes": { "description": "Disable rendering fallback routes when a route file doesn't exist.", "env": "SHOPIFY_HYDROGEN_FLAG_DISABLE_VIRTUAL_ROUTES", "name": "disable-virtual-routes", "allowNo": false, "type": "boolean" }, "debug": { "description": "Enables inspector connections to the server with a debugger such as Visual Studio Code or Chrome DevTools.", "env": "SHOPIFY_HYDROGEN_FLAG_DEBUG", "name": "debug", "allowNo": false, "type": "boolean" }, "inspector-port": { "description": "The port where the inspector is available. Defaults to 9229.", "env": "SHOPIFY_HYDROGEN_FLAG_INSPECTOR_PORT", "name": "inspector-port", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "env": { "description": "Specifies the environment to perform the operation using its handle. Fetch the handle using the `env list` command.", "exclusive": [ "env-branch" ], "name": "env", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "env-branch": { "deprecated": { "to": "env", "message": "--env-branch is deprecated. Use --env instead." }, "description": "Specifies the environment to perform the operation using its Git branch name.", "env": "SHOPIFY_HYDROGEN_ENVIRONMENT_BRANCH", "name": "env-branch", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "env-file": { "description": "Path to an environment file to override existing environment variables. Defaults to the '.env' located in your project path `--path`.", "name": "env-file", "required": false, "default": ".env", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "disable-version-check": { "description": "Skip the version check when running `hydrogen dev`", "name": "disable-version-check", "required": false, "allowNo": false, "type": "boolean" }, "customer-account-push": { "description": "Use tunneling for local development and push the tunneling domain to admin. Required to use Customer Account API's OAuth flow", "env": "SHOPIFY_HYDROGEN_FLAG_CUSTOMER_ACCOUNT_PUSH", "name": "customer-account-push", "required": false, "allowNo": false, "type": "boolean" }, "host": { "description": "Expose the server to the local network", "name": "host", "required": false, "allowNo": false, "type": "boolean" }, "disable-deps-optimizer": { "description": "Disable adding dependencies to Vite's `ssr.optimizeDeps.include` automatically", "env": "SHOPIFY_HYDROGEN_FLAG_DISABLE_DEPS_OPTIMIZER", "name": "disable-deps-optimizer", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "hydrogen:dev", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": true, "enableJsonFlag": false, "descriptionWithMarkdown": "Runs a Hydrogen storefront in a local runtime that emulates an Oxygen worker for development.\n\n If your project is [linked](https://shopify.dev/docs/api/shopify-cli/hydrogen/hydrogen-link) to a Hydrogen storefront, then its environment variables will be loaded with the runtime.", "customPluginName": "@shopify/cli-hydrogen" }, "hydrogen:build": { "aliases": [], "args": {}, "description": "Builds a Hydrogen storefront for production. The client and app worker files are compiled to a `/dist` folder in your Hydrogen project directory.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `HydrogenBuildResult` schema.\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"directory\": {\n \"$ref\": \"#/definitions/AbsolutePath\"\n },\n \"clientDirectory\": {\n \"$ref\": \"#/definitions/AbsolutePath\"\n },\n \"serverDirectory\": {\n \"$ref\": \"#/definitions/AbsolutePath\"\n },\n \"serverPath\": {\n \"$ref\": \"#/definitions/AbsolutePath\"\n }\n },\n \"required\": [\n \"directory\",\n \"clientDirectory\",\n \"serverDirectory\",\n \"serverPath\"\n ],\n \"additionalProperties\": false,\n \"title\": \"HydrogenBuildResult\",\n \"definitions\": {\n \"AbsolutePath\": {\n \"type\": \"string\"\n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" }, "no-input": { "description": "Disable interactive prompts and browser authentication.", "env": "SHOPIFY_FLAG_NO_INPUT", "name": "no-input", "allowNo": false, "type": "boolean" }, "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. May include sensitive data.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "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" }, "path": { "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.", "env": "SHOPIFY_HYDROGEN_FLAG_PATH", "name": "path", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "entry": { "description": "Entry file for the worker. Defaults to `./server`.", "env": "SHOPIFY_HYDROGEN_FLAG_ENTRY", "name": "entry", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "sourcemap": { "description": "Controls whether server sourcemaps are generated. Default to `true`. Deactivate `--no-sourcemaps`.", "env": "SHOPIFY_HYDROGEN_FLAG_SOURCEMAP", "name": "sourcemap", "allowNo": true, "type": "boolean" }, "lockfile-check": { "description": "Checks that there is exactly one valid lockfile in the project. Defaults to `true`. Deactivate with `--no-lockfile-check`.", "env": "SHOPIFY_HYDROGEN_FLAG_LOCKFILE_CHECK", "name": "lockfile-check", "allowNo": true, "type": "boolean" }, "disable-route-warning": { "description": "Disables any warnings about missing standard routes.", "env": "SHOPIFY_HYDROGEN_FLAG_DISABLE_ROUTE_WARNING", "name": "disable-route-warning", "allowNo": false, "type": "boolean" }, "codegen": { "description": "Automatically generates GraphQL types for your project’s Storefront API queries.", "name": "codegen", "required": false, "allowNo": false, "type": "boolean" }, "codegen-config-path": { "dependsOn": [ "codegen" ], "description": "Specifies a path to a codegen configuration file. Defaults to `/codegen.ts` if this file exists.", "name": "codegen-config-path", "required": false, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "watch": { "description": "Watches for changes and rebuilds the project writing output to disk.", "env": "SHOPIFY_HYDROGEN_FLAG_WATCH", "name": "watch", "allowNo": false, "type": "boolean" }, "bundle-stats": { "description": "Show a bundle size summary after building. Defaults to true, use `--no-bundle-stats` to disable.", "name": "bundle-stats", "allowNo": true, "type": "boolean" }, "force-client-sourcemap": { "description": "Client sourcemapping is avoided by default because it makes backend code visible in the browser. Use this flag to force enabling it.", "env": "SHOPIFY_HYDROGEN_FLAG_FORCE_CLIENT_SOURCEMAP", "name": "force-client-sourcemap", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "hydrogen:build", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": true, "enableJsonFlag": false, "descriptionWithMarkdown": "Builds a Hydrogen storefront for production. The client and app worker files are compiled to a `/dist` folder in your Hydrogen project directory.", "customPluginName": "@shopify/cli-hydrogen" }, "hydrogen:check": { "aliases": [], "args": { "resource": { "description": "The resource to check. Currently only 'routes' is supported.", "name": "resource", "options": [ "routes" ], "required": true } }, "description": "Checks whether your Hydrogen app includes a set of standard Shopify routes.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `HydrogenCheckResult` schema.\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"valid\": {\n \"type\": \"boolean\"\n },\n \"missingRoutes\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n },\n \"reservedRoutes\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n },\n \"required\": [\n \"valid\",\n \"missingRoutes\",\n \"reservedRoutes\"\n ],\n \"additionalProperties\": false,\n \"title\": \"HydrogenCheckResult\",\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" }, "no-input": { "description": "Disable interactive prompts and browser authentication.", "env": "SHOPIFY_FLAG_NO_INPUT", "name": "no-input", "allowNo": false, "type": "boolean" }, "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. May include sensitive data.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "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" }, "path": { "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.", "env": "SHOPIFY_HYDROGEN_FLAG_PATH", "name": "path", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "hydrogen:check", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": true, "enableJsonFlag": false, "descriptionWithMarkdown": "Checks whether your Hydrogen app includes a set of standard Shopify routes.", "customPluginName": "@shopify/cli-hydrogen" }, "hydrogen:codegen": { "aliases": [], "args": {}, "description": "Automatically generates GraphQL types for your project’s Storefront API queries.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `HydrogenCodegenResult` schema.\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"files\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"path\": {\n \"type\": \"string\"\n },\n \"sources\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n },\n \"description\": \"Source patterns from the GraphQL codegen configuration.\"\n }\n },\n \"required\": [\n \"path\",\n \"sources\"\n ],\n \"additionalProperties\": false\n }\n }\n },\n \"required\": [\n \"files\"\n ],\n \"additionalProperties\": false,\n \"title\": \"HydrogenCodegenResult\",\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" }, "no-input": { "description": "Disable interactive prompts and browser authentication.", "env": "SHOPIFY_FLAG_NO_INPUT", "name": "no-input", "allowNo": false, "type": "boolean" }, "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. May include sensitive data.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "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" }, "path": { "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.", "env": "SHOPIFY_HYDROGEN_FLAG_PATH", "name": "path", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "codegen-config-path": { "description": "Specify a path to a codegen configuration file. Defaults to `/codegen.ts` if it exists.", "name": "codegen-config-path", "required": false, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "force-sfapi-version": { "description": "Force generating Storefront API types for a specific version instead of using the one provided in Hydrogen. A token can also be provided with this format: `:`.", "hidden": true, "name": "force-sfapi-version", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "watch": { "description": "Watch the project for changes to update types on file save.", "name": "watch", "required": false, "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "hydrogen:codegen", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": true, "enableJsonFlag": false, "descriptionWithMarkdown": "Automatically generates GraphQL types for your project’s Storefront API queries.", "customPluginName": "@shopify/cli-hydrogen" }, "hydrogen:deploy": { "aliases": [], "args": {}, "description": "Builds and deploys your Hydrogen storefront to Oxygen. Requires an Oxygen deployment token to be set with the `--token` flag or an environment variable (`SHOPIFY_HYDROGEN_DEPLOYMENT_TOKEN`). If the storefront is \"linked\" (https://shopify.dev/docs/api/shopify-cli/hydrogen/hydrogen-link) then the Oxygen deployment token for the linked storefront will be used automatically.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `HydrogenDeployResult` schema.\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"enum\": [\n \"success\",\n \"cancelled\"\n ]\n },\n \"deployment\": {\n \"anyOf\": [\n {\n \"$ref\": \"#/definitions/Deployment\"\n },\n {\n \"type\": \"null\"\n }\n ]\n }\n },\n \"required\": [\n \"status\",\n \"deployment\"\n ],\n \"additionalProperties\": false,\n \"description\": \"The command result. The existing h2_deploy_log.json file retains Oxygen CompletedDeployment format, independently of this result.\",\n \"title\": \"HydrogenDeployResult\",\n \"definitions\": {\n \"Deployment\": {\n \"type\": \"object\",\n \"properties\": {\n \"url\": {\n \"type\": \"string\",\n \"format\": \"uri\"\n },\n \"authBypassToken\": {\n \"type\": [\n \"string\",\n \"null\"\n ]\n }\n },\n \"required\": [\n \"url\",\n \"authBypassToken\"\n ],\n \"additionalProperties\": false\n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" }, "no-input": { "description": "Disable interactive prompts and browser authentication.", "env": "SHOPIFY_FLAG_NO_INPUT", "name": "no-input", "allowNo": false, "type": "boolean" }, "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. May include sensitive data.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "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" }, "entry": { "description": "Entry file for the worker. Defaults to `./server`.", "env": "SHOPIFY_HYDROGEN_FLAG_ENTRY", "name": "entry", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "env": { "description": "Specifies the environment to perform the operation using its handle. Fetch the handle using the `env list` command.", "exclusive": [ "env-branch" ], "name": "env", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "env-branch": { "deprecated": { "to": "env", "message": "--env-branch is deprecated. Use --env instead." }, "description": "Specifies the environment to perform the operation using its Git branch name.", "env": "SHOPIFY_HYDROGEN_ENVIRONMENT_BRANCH", "name": "env-branch", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "env-file": { "description": "Path to an environment file to override existing environment variables for the deployment.", "name": "env-file", "required": false, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "preview": { "description": "Deploys to the Preview environment.", "name": "preview", "required": false, "allowNo": false, "type": "boolean" }, "force": { "char": "f", "description": "Forces a deployment to proceed if there are uncommitted changes in its Git repository, and skips confirmation prompts for non-preview environments.", "env": "SHOPIFY_HYDROGEN_FLAG_FORCE", "name": "force", "required": false, "allowNo": false, "type": "boolean" }, "no-verify": { "description": "Skip the routability verification step after deployment.", "name": "no-verify", "required": false, "allowNo": false, "type": "boolean" }, "auth-bypass-token": { "description": "Generate an authentication bypass token, which can be used to perform end-to-end tests against the deployment.", "env": "AUTH_BYPASS_TOKEN", "name": "auth-bypass-token", "required": false, "allowNo": false, "type": "boolean" }, "auth-bypass-token-duration": { "dependsOn": [ "auth-bypass-token" ], "description": "Specify the duration (in hours) up to 12 hours for the authentication bypass token. Defaults to `2`", "env": "AUTH_BYPASS_TOKEN_DURATION", "name": "auth-bypass-token-duration", "required": false, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "build-command": { "description": "Specify a build command to run before deploying. If not specified, the Hydrogen build pipeline will be used. When custom output directories are configured, defaults to `node --run build`.", "name": "build-command", "required": false, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "assets-dir": { "description": "Directory containing the client assets to deploy, relative to the project root. Defaults to the detected Vite client output directory, then falls back to `dist/client`.", "env": "SHOPIFY_HYDROGEN_FLAG_ASSETS_DIR", "name": "assets-dir", "required": false, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "worker-dir": { "description": "Directory containing the Oxygen worker entry point (`index.js` or `index.mjs`), relative to the project root. Defaults to the detected Vite server output directory, then falls back to `dist/server`.", "env": "SHOPIFY_HYDROGEN_FLAG_WORKER_DIR", "name": "worker-dir", "required": false, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "lockfile-check": { "description": "Checks that there is exactly one valid lockfile in the project. Defaults to `true`. Deactivate with `--no-lockfile-check`.", "env": "SHOPIFY_HYDROGEN_FLAG_LOCKFILE_CHECK", "name": "lockfile-check", "allowNo": true, "type": "boolean" }, "path": { "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.", "env": "SHOPIFY_HYDROGEN_FLAG_PATH", "name": "path", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "shop": { "char": "s", "description": "Shop URL. It can be the shop prefix (janes-apparel) or the full myshopify.com URL (janes-apparel.myshopify.com, https://janes-apparel.myshopify.com).", "env": "SHOPIFY_SHOP", "name": "shop", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "json-output": { "description": "Create a JSON file containing the deployment details in CI environments. Defaults to true, use `--no-json-output` to disable.", "name": "json-output", "required": false, "allowNo": true, "type": "boolean" }, "token": { "char": "t", "description": "Oxygen deployment token. Defaults to the linked storefront's token if available.", "env": "SHOPIFY_HYDROGEN_DEPLOYMENT_TOKEN", "name": "token", "required": false, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "metadata-description": { "description": "Description of the changes in the deployment. Defaults to the commit message of the latest commit if there are no uncommitted changes.", "env": "SHOPIFY_HYDROGEN_FLAG_METADATA_DESCRIPTION", "name": "metadata-description", "required": false, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "metadata-url": { "env": "SHOPIFY_HYDROGEN_FLAG_METADATA_URL", "hidden": true, "name": "metadata-url", "required": false, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "metadata-user": { "description": "User that initiated the deployment. Will be saved and displayed in the Shopify admin", "env": "SHOPIFY_HYDROGEN_FLAG_METADATA_USER", "name": "metadata-user", "required": false, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "metadata-version": { "env": "SHOPIFY_HYDROGEN_FLAG_METADATA_VERSION", "hidden": true, "name": "metadata-version", "required": false, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "force-client-sourcemap": { "description": "Client sourcemapping is avoided by default because it makes backend code visible in the browser. Use this flag to force enabling it.", "env": "SHOPIFY_HYDROGEN_FLAG_FORCE_CLIENT_SOURCEMAP", "name": "force-client-sourcemap", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "hydrogen:deploy", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": true, "enableJsonFlag": false, "descriptionWithMarkdown": "Builds and deploys your Hydrogen storefront to Oxygen. Requires an Oxygen deployment token to be set with the `--token` flag or an environment variable (`SHOPIFY_HYDROGEN_DEPLOYMENT_TOKEN`). If the storefront is [linked](https://shopify.dev/docs/api/shopify-cli/hydrogen/hydrogen-link) then the Oxygen deployment token for the linked storefront will be used automatically.", "customPluginName": "@shopify/cli-hydrogen" }, "hydrogen:g": { "aliases": [], "args": {}, "description": "Shortcut for `hydrogen generate`. See `hydrogen generate --help` for more information.", "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" }, "no-input": { "description": "Disable interactive prompts and browser authentication.", "env": "SHOPIFY_FLAG_NO_INPUT", "name": "no-input", "allowNo": false, "type": "boolean" }, "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. May include sensitive data.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hidden": true, "hiddenAliases": [], "id": "hydrogen:g", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": false, "enableJsonFlag": false, "customPluginName": "@shopify/cli-hydrogen" }, "hydrogen:init": { "aliases": [], "args": {}, "description": "Creates a new Hydrogen storefront.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `HydrogenInitResult` schema.\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"enum\": [\n \"success\",\n \"partial\",\n \"skipped\",\n \"cancelled\"\n ]\n },\n \"project\": {\n \"anyOf\": [\n {\n \"$ref\": \"#/definitions/Project\"\n },\n {\n \"type\": \"null\"\n }\n ],\n \"description\": \"All projected fields are present; unavailable settings are null. Route values are relative route names.\"\n },\n \"failures\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\",\n \"enum\": [\n \"dependencies\",\n \"markets\",\n \"routes\"\n ]\n }\n }\n },\n \"required\": [\n \"status\",\n \"project\",\n \"failures\"\n ],\n \"additionalProperties\": false,\n \"title\": \"HydrogenInitResult\",\n \"definitions\": {\n \"Project\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"directory\": {\n \"type\": \"string\"\n },\n \"storefrontName\": {\n \"type\": [\n \"string\",\n \"null\"\n ]\n },\n \"language\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"enum\": [\n \"js\",\n \"ts\"\n ]\n },\n {\n \"type\": \"null\"\n }\n ]\n },\n \"packageManager\": {\n \"type\": \"string\",\n \"enum\": [\n \"npm\",\n \"pnpm\",\n \"yarn\",\n \"bun\",\n \"unknown\"\n ]\n },\n \"dependenciesInstalled\": {\n \"type\": \"boolean\"\n },\n \"cssStrategy\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"enum\": [\n \"none\",\n \"tailwind\",\n \"vanilla-extract\",\n \"css-modules\",\n \"postcss\"\n ]\n },\n {\n \"type\": \"null\"\n }\n ]\n },\n \"i18n\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"enum\": [\n \"none\",\n \"subfolders\",\n \"domains\",\n \"subdomains\"\n ]\n },\n {\n \"type\": \"null\"\n }\n ]\n },\n \"routes\": {\n \"anyOf\": [\n {\n \"type\": \"object\",\n \"additionalProperties\": {\n \"anyOf\": [\n {\n \"type\": \"string\"\n },\n {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n ]\n }\n },\n {\n \"type\": \"null\"\n }\n ]\n }\n },\n \"required\": [\n \"name\",\n \"directory\",\n \"storefrontName\",\n \"language\",\n \"packageManager\",\n \"dependenciesInstalled\",\n \"cssStrategy\",\n \"i18n\",\n \"routes\"\n ],\n \"additionalProperties\": false,\n \"description\": \"All projected fields are present; unavailable settings are null. Route values are relative route names.\"\n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" }, "no-input": { "description": "Disable interactive prompts and browser authentication.", "env": "SHOPIFY_FLAG_NO_INPUT", "name": "no-input", "allowNo": false, "type": "boolean" }, "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. May include sensitive data.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "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" }, "force": { "char": "f", "description": "Overwrites the destination directory and files if they already exist.", "env": "SHOPIFY_HYDROGEN_FLAG_FORCE", "name": "force", "allowNo": false, "type": "boolean" }, "path": { "description": "The path to the directory of the new Hydrogen storefront.", "env": "SHOPIFY_HYDROGEN_FLAG_PATH", "name": "path", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "language": { "description": "Sets the template language to use. One of `js` or `ts`.", "env": "SHOPIFY_HYDROGEN_FLAG_LANGUAGE", "name": "language", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "template": { "description": "Scaffolds project based on a template: `skeleton` (the default), `demo-store` or a URL to a git repository.", "env": "SHOPIFY_HYDROGEN_FLAG_TEMPLATE", "name": "template", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "install-deps": { "description": "Auto installs dependencies using the active package manager.", "env": "SHOPIFY_HYDROGEN_FLAG_INSTALL_DEPS", "name": "install-deps", "allowNo": true, "type": "boolean" }, "mock-shop": { "description": "Use mock.shop as the data source for the storefront.", "env": "SHOPIFY_HYDROGEN_FLAG_MOCK_DATA", "name": "mock-shop", "allowNo": false, "type": "boolean" }, "styling": { "description": "Sets the styling strategy to use. One of `tailwind`, `vanilla-extract`, `css-modules`, `postcss`, `none`.", "env": "SHOPIFY_HYDROGEN_FLAG_STYLING", "name": "styling", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "markets": { "description": "Sets the URL structure to support multiple markets. Must be one of: `subfolders`, `domains`, `subdomains`, `none`. Example: `--markets subfolders`.", "env": "SHOPIFY_HYDROGEN_FLAG_I18N", "name": "markets", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "shortcut": { "description": "Creates a global h2 shortcut for Shopify CLI using shell aliases. Deactivate with `--no-shortcut`.", "env": "SHOPIFY_HYDROGEN_FLAG_SHORTCUT", "name": "shortcut", "allowNo": true, "type": "boolean" }, "git": { "description": "Init Git and create initial commits.", "env": "SHOPIFY_HYDROGEN_FLAG_GIT", "name": "git", "allowNo": true, "type": "boolean" }, "quickstart": { "description": "Scaffolds a new Hydrogen project with a set of sensible defaults. Equivalent to `shopify hydrogen init --path hydrogen-quickstart --mock-shop --language js --shortcut --markets none`", "env": "SHOPIFY_HYDROGEN_FLAG_QUICKSTART", "name": "quickstart", "allowNo": false, "type": "boolean" }, "package-manager": { "env": "SHOPIFY_HYDROGEN_FLAG_PACKAGE_MANAGER", "hidden": true, "name": "package-manager", "hasDynamicHelp": false, "multiple": false, "options": [ "npm", "yarn", "pnpm", "unknown" ], "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "hydrogen:init", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": true, "enableJsonFlag": false, "descriptionWithMarkdown": "Creates a new Hydrogen storefront.", "customPluginName": "@shopify/cli-hydrogen" }, "hydrogen:link": { "aliases": [], "args": {}, "description": "Links your local development environment to a remote Hydrogen storefront. You can link an unlimited number of development environments to a single Hydrogen storefront.\n\n Linking to a Hydrogen storefront enables you to run \"dev\" (https://shopify.dev/docs/api/shopify-cli/hydrogen/hydrogen-dev) and automatically inject your linked Hydrogen storefront's environment variables directly into the server runtime.\n\n After you run the `link` command, you can access the \"env list\" (https://shopify.dev/docs/api/shopify-cli/hydrogen/hydrogen-env-list), \"env pull\" (https://shopify.dev/docs/api/shopify-cli/hydrogen/hydrogen-env-pull), and \"unlink\" (https://shopify.dev/docs/api/shopify-cli/hydrogen/hydrogen-unlink) commands.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `HydrogenLinkResult` schema.\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"enum\": [\n \"success\",\n \"partial\",\n \"skipped\",\n \"cancelled\"\n ]\n },\n \"changed\": {\n \"type\": \"boolean\"\n },\n \"storeDomain\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"pattern\": \"^[a-z0-9][a-z0-9-]*\\\\.myshopify\\\\.com$\"\n },\n {\n \"type\": \"null\"\n }\n ]\n },\n \"storefront\": {\n \"anyOf\": [\n {\n \"$ref\": \"#/definitions/Storefront\"\n },\n {\n \"type\": \"null\"\n }\n ],\n \"description\": \"All projected fields are present; unavailable productionUrl is null.\"\n }\n },\n \"required\": [\n \"status\",\n \"changed\",\n \"storeDomain\",\n \"storefront\"\n ],\n \"additionalProperties\": false,\n \"title\": \"HydrogenLinkResult\",\n \"definitions\": {\n \"Storefront\": {\n \"type\": \"object\",\n \"properties\": {\n \"gid\": {\n \"type\": \"string\",\n \"pattern\": \"^gid:\\\\/\\\\/shopify\\\\/HydrogenStorefront\\\\/\\\\d+$\",\n \"description\": \"A Shopify HydrogenStorefront GID.\"\n },\n \"name\": {\n \"type\": \"string\"\n },\n \"productionUrl\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"format\": \"uri\"\n },\n {\n \"type\": \"null\"\n }\n ]\n }\n },\n \"required\": [\n \"gid\",\n \"name\",\n \"productionUrl\"\n ],\n \"additionalProperties\": false,\n \"description\": \"All projected fields are present; unavailable productionUrl is null.\"\n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" }, "no-input": { "description": "Disable interactive prompts and browser authentication.", "env": "SHOPIFY_FLAG_NO_INPUT", "name": "no-input", "allowNo": false, "type": "boolean" }, "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. May include sensitive data.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "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" }, "force": { "char": "f", "description": "Overwrites the destination directory and files if they already exist.", "env": "SHOPIFY_HYDROGEN_FLAG_FORCE", "name": "force", "allowNo": false, "type": "boolean" }, "path": { "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.", "env": "SHOPIFY_HYDROGEN_FLAG_PATH", "name": "path", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "shop": { "char": "s", "description": "Shop URL. It can be the shop prefix (janes-apparel) or the full myshopify.com URL (janes-apparel.myshopify.com, https://janes-apparel.myshopify.com).", "env": "SHOPIFY_SHOP", "name": "shop", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "storefront": { "description": "The name of a Hydrogen Storefront (e.g. \"Jane's Apparel\")", "env": "SHOPIFY_HYDROGEN_STOREFRONT", "exclusive": [ "create-storefront", "name" ], "name": "storefront", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "create-storefront": { "description": "Create a new Hydrogen storefront.", "env": "SHOPIFY_HYDROGEN_FLAG_CREATE_STOREFRONT", "exclusive": [ "storefront" ], "name": "create-storefront", "allowNo": false, "type": "boolean" }, "name": { "description": "The name to use when creating a new Hydrogen storefront.", "env": "SHOPIFY_HYDROGEN_FLAG_NAME", "exclusive": [ "storefront" ], "name": "name", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "hydrogen:link", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": true, "enableJsonFlag": false, "descriptionWithMarkdown": "Links your local development environment to a remote Hydrogen storefront. You can link an unlimited number of development environments to a single Hydrogen storefront.\n\n Linking to a Hydrogen storefront enables you to run [dev](https://shopify.dev/docs/api/shopify-cli/hydrogen/hydrogen-dev) and automatically inject your linked Hydrogen storefront's environment variables directly into the server runtime.\n\n After you run the `link` command, you can access the [env list](https://shopify.dev/docs/api/shopify-cli/hydrogen/hydrogen-env-list), [env pull](https://shopify.dev/docs/api/shopify-cli/hydrogen/hydrogen-env-pull), and [unlink](https://shopify.dev/docs/api/shopify-cli/hydrogen/hydrogen-unlink) commands.", "customPluginName": "@shopify/cli-hydrogen" }, "hydrogen:list": { "aliases": [], "args": {}, "description": "Lists all remote Hydrogen storefronts available to link to your local development environment.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `HydrogenListResult` schema.\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"storeDomain\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"pattern\": \"^[a-z0-9][a-z0-9-]*\\\\.myshopify\\\\.com$\"\n },\n {\n \"type\": \"null\"\n }\n ]\n },\n \"storefronts\": {\n \"type\": \"array\",\n \"items\": {\n \"$ref\": \"#/definitions/Storefront\"\n }\n }\n },\n \"required\": [\n \"storeDomain\",\n \"storefronts\"\n ],\n \"additionalProperties\": false,\n \"description\": \"The complete list of Hydrogen storefronts for the store.\",\n \"title\": \"HydrogenListResult\",\n \"definitions\": {\n \"Storefront\": {\n \"type\": \"object\",\n \"properties\": {\n \"gid\": {\n \"type\": \"string\",\n \"pattern\": \"^gid:\\\\/\\\\/shopify\\\\/HydrogenStorefront\\\\/\\\\d+$\",\n \"description\": \"A Shopify HydrogenStorefront GID.\"\n },\n \"name\": {\n \"type\": \"string\"\n },\n \"productionUrl\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"format\": \"uri\"\n },\n {\n \"type\": \"null\"\n }\n ]\n },\n \"currentProductionDeployment\": {\n \"anyOf\": [\n {\n \"$ref\": \"#/definitions/Deployment\"\n },\n {\n \"type\": \"null\"\n }\n ]\n }\n },\n \"required\": [\n \"gid\",\n \"name\",\n \"productionUrl\",\n \"currentProductionDeployment\"\n ],\n \"additionalProperties\": false,\n \"description\": \"All projected fields are present; unavailable productionUrl is null.\"\n },\n \"Deployment\": {\n \"type\": \"object\",\n \"properties\": {\n \"gid\": {\n \"type\": \"string\",\n \"pattern\": \"^gid:\\\\/\\\\/shopify\\\\/HydrogenStorefrontDeployment\\\\/\\\\d+$\",\n \"description\": \"A Shopify HydrogenStorefrontDeployment GID.\"\n },\n \"createdAt\": {\n \"type\": \"string\",\n \"format\": \"date-time\"\n },\n \"commitMessage\": {\n \"type\": [\n \"string\",\n \"null\"\n ]\n }\n },\n \"required\": [\n \"gid\",\n \"createdAt\",\n \"commitMessage\"\n ],\n \"additionalProperties\": false\n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" }, "no-input": { "description": "Disable interactive prompts and browser authentication.", "env": "SHOPIFY_FLAG_NO_INPUT", "name": "no-input", "allowNo": false, "type": "boolean" }, "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. May include sensitive data.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "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" }, "path": { "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.", "env": "SHOPIFY_HYDROGEN_FLAG_PATH", "name": "path", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "hydrogen:list", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": true, "enableJsonFlag": false, "descriptionWithMarkdown": "Lists all remote Hydrogen storefronts available to link to your local development environment.", "customPluginName": "@shopify/cli-hydrogen" }, "hydrogen:login": { "aliases": [], "args": {}, "description": "Logs in to the specified shop and saves the shop domain to the project.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `HydrogenLoginResult` schema.\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"storeDomain\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"pattern\": \"^[a-z0-9][a-z0-9-]*\\\\.myshopify\\\\.com$\"\n },\n {\n \"type\": \"null\"\n }\n ]\n },\n \"name\": {\n \"type\": [\n \"string\",\n \"null\"\n ]\n },\n \"email\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"format\": \"email\"\n },\n {\n \"type\": \"null\"\n }\n ]\n }\n },\n \"required\": [\n \"storeDomain\",\n \"name\",\n \"email\"\n ],\n \"additionalProperties\": false,\n \"title\": \"HydrogenLoginResult\",\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" }, "no-input": { "description": "Disable interactive prompts and browser authentication.", "env": "SHOPIFY_FLAG_NO_INPUT", "name": "no-input", "allowNo": false, "type": "boolean" }, "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. May include sensitive data.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "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" }, "path": { "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.", "env": "SHOPIFY_HYDROGEN_FLAG_PATH", "name": "path", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "shop": { "char": "s", "description": "Shop URL. It can be the shop prefix (janes-apparel) or the full myshopify.com URL (janes-apparel.myshopify.com, https://janes-apparel.myshopify.com).", "env": "SHOPIFY_SHOP", "name": "shop", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "hydrogen:login", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": true, "enableJsonFlag": false, "descriptionWithMarkdown": "Logs in to the specified shop and saves the shop domain to the project.", "customPluginName": "@shopify/cli-hydrogen" }, "hydrogen:logout": { "aliases": [], "args": {}, "description": "Log out from the current shop.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `HydrogenLogoutResult` schema.\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"const\": \"success\"\n },\n \"loggedOut\": {\n \"type\": \"boolean\",\n \"const\": true\n }\n },\n \"required\": [\n \"status\",\n \"loggedOut\"\n ],\n \"additionalProperties\": false,\n \"title\": \"HydrogenLogoutResult\",\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" }, "no-input": { "description": "Disable interactive prompts and browser authentication.", "env": "SHOPIFY_FLAG_NO_INPUT", "name": "no-input", "allowNo": false, "type": "boolean" }, "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. May include sensitive data.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "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" }, "path": { "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.", "env": "SHOPIFY_HYDROGEN_FLAG_PATH", "name": "path", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "hydrogen:logout", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": true, "enableJsonFlag": false, "descriptionWithMarkdown": "Log out from the current shop.", "customPluginName": "@shopify/cli-hydrogen" }, "hydrogen:preview": { "aliases": [], "args": {}, "description": "Runs a Hydrogen storefront in an Oxygen worker for production.", "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" }, "no-input": { "description": "Disable interactive prompts and browser authentication.", "env": "SHOPIFY_FLAG_NO_INPUT", "name": "no-input", "allowNo": false, "type": "boolean" }, "no-color": { "description": "Disable color output.", "env": "SHOPIFY_FLAG_NO_COLOR", "hidden": false, "name": "no-color", "allowNo": false, "type": "boolean" }, "verbose": { "description": "Outputs more information about the command's execution.", "env": "SHOPIFY_HYDROGEN_FLAG_VERBOSE", "name": "verbose", "required": false, "allowNo": false, "type": "boolean" }, "path": { "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.", "env": "SHOPIFY_HYDROGEN_FLAG_PATH", "name": "path", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "port": { "description": "The port to run the server on. Defaults to 3000.", "env": "SHOPIFY_HYDROGEN_FLAG_PORT", "name": "port", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "env": { "description": "Specifies the environment to perform the operation using its handle. Fetch the handle using the `env list` command.", "exclusive": [ "env-branch" ], "name": "env", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "env-branch": { "deprecated": { "to": "env", "message": "--env-branch is deprecated. Use --env instead." }, "description": "Specifies the environment to perform the operation using its Git branch name.", "env": "SHOPIFY_HYDROGEN_ENVIRONMENT_BRANCH", "name": "env-branch", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "env-file": { "description": "Path to an environment file to override existing environment variables. Defaults to the '.env' located in your project path `--path`.", "name": "env-file", "required": false, "default": ".env", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "inspector-port": { "description": "The port where the inspector is available. Defaults to 9229.", "env": "SHOPIFY_HYDROGEN_FLAG_INSPECTOR_PORT", "name": "inspector-port", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "debug": { "description": "Enables inspector connections to the server with a debugger such as Visual Studio Code or Chrome DevTools.", "env": "SHOPIFY_HYDROGEN_FLAG_DEBUG", "name": "debug", "allowNo": false, "type": "boolean" }, "build": { "description": "Builds the app before starting the preview server.", "name": "build", "allowNo": false, "type": "boolean" }, "watch": { "dependsOn": [ "build" ], "description": "Watches for changes and rebuilds the project.", "name": "watch", "allowNo": false, "type": "boolean" }, "entry": { "dependsOn": [ "build" ], "description": "Entry file for the worker. Defaults to `./server`.", "env": "SHOPIFY_HYDROGEN_FLAG_ENTRY", "name": "entry", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "codegen": { "dependsOn": [ "build" ], "description": "Automatically generates GraphQL types for your project’s Storefront API queries.", "name": "codegen", "required": false, "allowNo": false, "type": "boolean" }, "codegen-config-path": { "dependsOn": [ "codegen" ], "description": "Specifies a path to a codegen configuration file. Defaults to `/codegen.ts` if this file exists.", "name": "codegen-config-path", "required": false, "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "hydrogen:preview", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": true, "enableJsonFlag": false, "descriptionWithMarkdown": "Runs a server in your local development environment that serves your Hydrogen app's production build. Requires running the [build](https://shopify.dev/docs/api/shopify-cli/hydrogen/hydrogen-build) command first.", "customPluginName": "@shopify/cli-hydrogen" }, "hydrogen:setup": { "aliases": [], "args": {}, "description": "Scaffold routes and core functionality.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `HydrogenSetupResult` schema.\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"const\": \"success\"\n },\n \"changed\": {\n \"type\": \"boolean\"\n },\n \"directory\": {\n \"type\": \"string\"\n },\n \"name\": {\n \"type\": \"string\"\n },\n \"i18n\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"enum\": [\n \"subfolders\",\n \"domains\",\n \"subdomains\"\n ]\n },\n {\n \"type\": \"null\"\n }\n ]\n },\n \"routes\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"sourceRoute\": {\n \"type\": \"string\"\n },\n \"destinationRoute\": {\n \"type\": \"string\"\n },\n \"operation\": {\n \"type\": \"string\",\n \"enum\": [\n \"created\",\n \"skipped\",\n \"replaced\"\n ]\n },\n \"skipReason\": {\n \"type\": \"string\",\n \"enum\": [\n \"declined\",\n \"exists\"\n ]\n }\n },\n \"required\": [\n \"sourceRoute\",\n \"destinationRoute\",\n \"operation\"\n ],\n \"additionalProperties\": false\n }\n },\n \"routeGroups\": {\n \"type\": \"object\",\n \"additionalProperties\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n },\n \"shortcut\": {\n \"type\": \"boolean\"\n }\n },\n \"required\": [\n \"status\",\n \"changed\",\n \"directory\",\n \"name\",\n \"i18n\",\n \"routes\",\n \"routeGroups\",\n \"shortcut\"\n ],\n \"additionalProperties\": false,\n \"title\": \"HydrogenSetupResult\",\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" }, "no-input": { "description": "Disable interactive prompts and browser authentication.", "env": "SHOPIFY_FLAG_NO_INPUT", "name": "no-input", "allowNo": false, "type": "boolean" }, "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. May include sensitive data.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "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" }, "path": { "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.", "env": "SHOPIFY_HYDROGEN_FLAG_PATH", "name": "path", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "force": { "char": "f", "description": "Overwrites the destination directory and files if they already exist.", "env": "SHOPIFY_HYDROGEN_FLAG_FORCE", "name": "force", "allowNo": false, "type": "boolean" }, "markets": { "description": "Sets the URL structure to support multiple markets. Must be one of: `subfolders`, `domains`, `subdomains`, `none`. Example: `--markets subfolders`.", "env": "SHOPIFY_HYDROGEN_FLAG_I18N", "name": "markets", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "shortcut": { "description": "Creates a global h2 shortcut for Shopify CLI using shell aliases. Deactivate with `--no-shortcut`.", "env": "SHOPIFY_HYDROGEN_FLAG_SHORTCUT", "name": "shortcut", "allowNo": true, "type": "boolean" }, "install-deps": { "description": "Auto installs dependencies using the active package manager.", "env": "SHOPIFY_HYDROGEN_FLAG_INSTALL_DEPS", "name": "install-deps", "allowNo": true, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "hydrogen:setup", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": true, "enableJsonFlag": false, "descriptionWithMarkdown": "Scaffold routes and core functionality.", "customPluginName": "@shopify/cli-hydrogen" }, "hydrogen:shortcut": { "aliases": [], "args": {}, "description": "Creates a global h2 shortcut for Shopify CLI using shell aliases.\n\n The following shells are supported:\n\n - Bash (using `~/.bashrc`)\n - ZSH (using `~/.zshrc`)\n - Fish (using `~/.config/fish/functions`)\n - PowerShell (added to `$PROFILE`)\n\n After the alias is created, you can call Shopify CLI from anywhere in your project using `h2 `.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `HydrogenShortcutResult` schema.\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"const\": \"success\"\n },\n \"changed\": {\n \"type\": \"boolean\"\n },\n \"alias\": {\n \"type\": \"string\"\n },\n \"shells\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\",\n \"enum\": [\n \"bash\",\n \"zsh\",\n \"fish\",\n \"powershell\",\n \"powershell-7\",\n \"cmd\"\n ]\n },\n \"minItems\": 1\n }\n },\n \"required\": [\n \"status\",\n \"changed\",\n \"alias\",\n \"shells\"\n ],\n \"additionalProperties\": false,\n \"title\": \"HydrogenShortcutResult\",\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" }, "no-input": { "description": "Disable interactive prompts and browser authentication.", "env": "SHOPIFY_FLAG_NO_INPUT", "name": "no-input", "allowNo": false, "type": "boolean" }, "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. May include sensitive data.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "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": "hydrogen:shortcut", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": true, "enableJsonFlag": false, "descriptionWithMarkdown": "Creates a global h2 shortcut for Shopify CLI using shell aliases.\n\n The following shells are supported:\n\n - Bash (using `~/.bashrc`)\n - ZSH (using `~/.zshrc`)\n - Fish (using `~/.config/fish/functions`)\n - PowerShell (added to `$PROFILE`)\n\n After the alias is created, you can call Shopify CLI from anywhere in your project using `h2 `.", "customPluginName": "@shopify/cli-hydrogen" }, "hydrogen:unlink": { "aliases": [], "args": {}, "description": "Unlinks your local development environment from a remote Hydrogen storefront.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `HydrogenUnlinkResult` schema.\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"const\": \"success\"\n },\n \"changed\": {\n \"type\": \"boolean\"\n },\n \"storefront\": {\n \"anyOf\": [\n {\n \"type\": \"object\",\n \"properties\": {\n \"gid\": {\n \"type\": \"string\",\n \"pattern\": \"^gid:\\\\/\\\\/shopify\\\\/HydrogenStorefront\\\\/\\\\d+$\",\n \"description\": \"A Shopify HydrogenStorefront GID.\"\n },\n \"name\": {\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"gid\",\n \"name\"\n ],\n \"additionalProperties\": false\n },\n {\n \"type\": \"null\"\n }\n ]\n }\n },\n \"required\": [\n \"status\",\n \"changed\",\n \"storefront\"\n ],\n \"additionalProperties\": false,\n \"title\": \"HydrogenUnlinkResult\",\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" }, "no-input": { "description": "Disable interactive prompts and browser authentication.", "env": "SHOPIFY_FLAG_NO_INPUT", "name": "no-input", "allowNo": false, "type": "boolean" }, "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. May include sensitive data.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "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" }, "path": { "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.", "env": "SHOPIFY_HYDROGEN_FLAG_PATH", "name": "path", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "hydrogen:unlink", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": true, "enableJsonFlag": false, "descriptionWithMarkdown": "Unlinks your local development environment from a remote Hydrogen storefront.", "customPluginName": "@shopify/cli-hydrogen" }, "hydrogen:upgrade": { "aliases": [], "args": {}, "description": "Upgrade Hydrogen project dependencies, preview features, fixes and breaking changes. The command also generates an instruction file for each upgrade.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `HydrogenUpgradeResult` schema.\n\n```json\n{\n \"anyOf\": [\n {\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"const\": \"success\"\n },\n \"directory\": {\n \"$ref\": \"#/definitions/AbsolutePath\"\n },\n \"previousVersion\": {\n \"type\": \"string\"\n },\n \"version\": {\n \"type\": \"string\"\n },\n \"changed\": {\n \"type\": \"boolean\",\n \"const\": true\n },\n \"packages\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n },\n \"removedPackages\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n },\n \"instructionsPath\": {\n \"anyOf\": [\n {\n \"$ref\": \"#/definitions/AbsolutePath\"\n },\n {\n \"type\": \"null\"\n }\n ]\n }\n },\n \"required\": [\n \"status\",\n \"directory\",\n \"previousVersion\",\n \"version\",\n \"changed\",\n \"packages\",\n \"removedPackages\",\n \"instructionsPath\"\n ],\n \"additionalProperties\": false\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"const\": \"success\"\n },\n \"directory\": {\n \"$ref\": \"#/definitions/AbsolutePath\"\n },\n \"previousVersion\": {\n \"type\": \"string\"\n },\n \"version\": {\n \"type\": \"string\"\n },\n \"changed\": {\n \"type\": \"boolean\",\n \"const\": false\n },\n \"packages\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n },\n \"minItems\": 0,\n \"maxItems\": 0\n },\n \"removedPackages\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n },\n \"minItems\": 0,\n \"maxItems\": 0\n },\n \"instructionsPath\": {\n \"type\": \"null\"\n }\n },\n \"required\": [\n \"status\",\n \"directory\",\n \"previousVersion\",\n \"version\",\n \"changed\",\n \"packages\",\n \"removedPackages\",\n \"instructionsPath\"\n ],\n \"additionalProperties\": false\n }\n ],\n \"title\": \"HydrogenUpgradeResult\",\n \"definitions\": {\n \"AbsolutePath\": {\n \"type\": \"string\"\n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" }, "no-input": { "description": "Disable interactive prompts and browser authentication.", "env": "SHOPIFY_FLAG_NO_INPUT", "name": "no-input", "allowNo": false, "type": "boolean" }, "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. May include sensitive data.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "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" }, "path": { "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.", "env": "SHOPIFY_HYDROGEN_FLAG_PATH", "name": "path", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "version": { "char": "v", "description": "A target hydrogen version to update to", "name": "version", "required": false, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "force": { "char": "f", "description": "Ignore warnings and force the upgrade to the target version", "env": "SHOPIFY_HYDROGEN_FLAG_FORCE", "name": "force", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "hydrogen:upgrade", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": true, "enableJsonFlag": false, "descriptionWithMarkdown": "Upgrade Hydrogen project dependencies, preview features, fixes and breaking changes. The command also generates an instruction file for each upgrade.", "customPluginName": "@shopify/cli-hydrogen" }, "hydrogen:customer-account-push": { "aliases": [], "args": {}, "description": "Push project configuration to admin\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `HydrogenCustomerAccountPushResult` schema.\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"storefrontGid\": {\n \"type\": \"string\",\n \"pattern\": \"^gid:\\\\/\\\\/shopify\\\\/HydrogenStorefront\\\\/\\\\d+$\",\n \"description\": \"A Shopify HydrogenStorefront GID.\"\n },\n \"redirectUri\": {\n \"type\": \"string\",\n \"format\": \"uri\"\n },\n \"javascriptOrigin\": {\n \"type\": \"string\",\n \"format\": \"uri\"\n },\n \"logoutUri\": {\n \"type\": \"string\",\n \"format\": \"uri\"\n }\n },\n \"required\": [\n \"storefrontGid\",\n \"redirectUri\",\n \"javascriptOrigin\",\n \"logoutUri\"\n ],\n \"additionalProperties\": false,\n \"title\": \"HydrogenCustomerAccountPushResult\",\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" }, "no-input": { "description": "Disable interactive prompts and browser authentication.", "env": "SHOPIFY_FLAG_NO_INPUT", "name": "no-input", "allowNo": false, "type": "boolean" }, "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. May include sensitive data.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "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" }, "path": { "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.", "env": "SHOPIFY_HYDROGEN_FLAG_PATH", "name": "path", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "storefront-id": { "description": "The id of the storefront the configuration should be pushed to. Must start with 'gid://shopify/HydrogenStorefront/'", "name": "storefront-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "dev-origin": { "description": "The development domain of your application.", "name": "dev-origin", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "javascript-origin": { "description": "The origin to register as the allowed JavaScript origin for the Customer Account API OAuth flow. Defaults to --dev-origin. Must not include a port (Shopify rejects origins with ports); use this to register a portless origin while keeping a portful --dev-origin.", "name": "javascript-origin", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "relative-redirect-uri": { "description": "The relative url of allowed callback url for Customer Account API OAuth flow. Default is '/account/authorize'", "name": "relative-redirect-uri", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "relative-logout-uri": { "description": "The relative url of allowed url that will be redirected to post-logout for Customer Account API OAuth flow. Default to nothing.", "name": "relative-logout-uri", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "hydrogen:customer-account-push", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": true, "enableJsonFlag": false, "descriptionWithMarkdown": "Push project configuration to admin", "customPluginName": "@shopify/cli-hydrogen" }, "hydrogen:debug:cpu": { "aliases": [], "args": {}, "description": "Builds and profiles the server startup time the app.", "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" }, "no-input": { "description": "Disable interactive prompts and browser authentication.", "env": "SHOPIFY_FLAG_NO_INPUT", "name": "no-input", "allowNo": false, "type": "boolean" }, "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. May include sensitive data.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "allowNo": false, "type": "boolean" }, "path": { "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.", "env": "SHOPIFY_HYDROGEN_FLAG_PATH", "name": "path", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "entry": { "description": "Entry file for the worker. Defaults to `./server`.", "env": "SHOPIFY_HYDROGEN_FLAG_ENTRY", "name": "entry", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "output": { "description": "Specify a path to generate the profile file. Defaults to \"startup.cpuprofile\".", "name": "output", "required": false, "default": "startup.cpuprofile", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "hydrogen:debug:cpu", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": true, "enableJsonFlag": false, "descriptionWithMarkdown": "Builds the app and runs the resulting code to profile the server startup time, watching for changes. This command can be used to [debug slow app startup times](https://shopify.dev/docs/custom-storefronts/hydrogen/debugging/cpu-startup) that cause failed deployments in Oxygen.\n\n The profiling results are written to a `.cpuprofile` file that can be viewed with certain tools such as [Flame Chart Visualizer for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=ms-vscode.vscode-js-profile-flame).", "customPluginName": "@shopify/cli-hydrogen" }, "hydrogen:env:list": { "aliases": [], "args": {}, "description": "Lists all environments available on the linked Hydrogen storefront.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `HydrogenEnvListResult` schema.\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"enum\": [\n \"success\",\n \"cancelled\"\n ]\n },\n \"storefront\": {\n \"anyOf\": [\n {\n \"$ref\": \"#/definitions/Storefront\"\n },\n {\n \"type\": \"null\"\n }\n ]\n },\n \"environments\": {\n \"type\": \"array\",\n \"items\": {\n \"$ref\": \"#/definitions/Environment\"\n }\n }\n },\n \"required\": [\n \"status\",\n \"storefront\",\n \"environments\"\n ],\n \"additionalProperties\": false,\n \"description\": \"The complete environment list for the linked storefront.\",\n \"title\": \"HydrogenEnvListResult\",\n \"definitions\": {\n \"Environment\": {\n \"type\": \"object\",\n \"properties\": {\n \"gid\": {\n \"type\": \"string\",\n \"pattern\": \"^gid:\\\\/\\\\/shopify\\\\/HydrogenStorefrontEnvironment\\\\/\\\\d+$\",\n \"description\": \"A Shopify HydrogenStorefrontEnvironment GID.\"\n },\n \"name\": {\n \"type\": \"string\"\n },\n \"handle\": {\n \"type\": \"string\"\n },\n \"branch\": {\n \"type\": [\n \"string\",\n \"null\"\n ]\n },\n \"createdAt\": {\n \"type\": \"string\",\n \"format\": \"date-time\"\n },\n \"type\": {\n \"type\": \"string\",\n \"description\": \"Upstream environment type; known values are PREVIEW, PRODUCTION, CUSTOM.\"\n },\n \"url\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"format\": \"uri\"\n },\n {\n \"type\": \"null\"\n }\n ]\n }\n },\n \"required\": [\n \"gid\",\n \"name\",\n \"handle\",\n \"branch\",\n \"createdAt\",\n \"type\",\n \"url\"\n ],\n \"additionalProperties\": false\n },\n \"Storefront\": {\n \"type\": \"object\",\n \"properties\": {\n \"gid\": {\n \"type\": \"string\",\n \"pattern\": \"^gid:\\\\/\\\\/shopify\\\\/HydrogenStorefront\\\\/\\\\d+$\",\n \"description\": \"A Shopify HydrogenStorefront GID.\"\n },\n \"name\": {\n \"type\": \"string\"\n },\n \"productionUrl\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"format\": \"uri\"\n },\n {\n \"type\": \"null\"\n }\n ]\n }\n },\n \"required\": [\n \"gid\",\n \"name\",\n \"productionUrl\"\n ],\n \"additionalProperties\": false\n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" }, "no-input": { "description": "Disable interactive prompts and browser authentication.", "env": "SHOPIFY_FLAG_NO_INPUT", "name": "no-input", "allowNo": false, "type": "boolean" }, "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. May include sensitive data.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "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" }, "path": { "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.", "env": "SHOPIFY_HYDROGEN_FLAG_PATH", "name": "path", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "hydrogen:env:list", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": true, "enableJsonFlag": false, "descriptionWithMarkdown": "Lists all environments available on the linked Hydrogen storefront.", "customPluginName": "@shopify/cli-hydrogen" }, "hydrogen:env:pull": { "aliases": [], "args": {}, "description": "Pulls environment variables from the linked Hydrogen storefront and writes them to an `.env` file.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `HydrogenEnvPullResult` schema.\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"enum\": [\n \"success\",\n \"cancelled\"\n ]\n },\n \"changed\": {\n \"type\": \"boolean\"\n },\n \"path\": {\n \"type\": \"string\"\n },\n \"storefrontGid\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"pattern\": \"^gid:\\\\/\\\\/shopify\\\\/HydrogenStorefront\\\\/\\\\d+$\",\n \"description\": \"A Shopify HydrogenStorefront GID.\"\n },\n {\n \"type\": \"null\"\n }\n ],\n \"description\": \"A Shopify HydrogenStorefront GID.\"\n },\n \"storefrontName\": {\n \"type\": [\n \"string\",\n \"null\"\n ]\n },\n \"environment\": {\n \"anyOf\": [\n {\n \"$ref\": \"#/definitions/Environment\"\n },\n {\n \"type\": \"null\"\n }\n ]\n },\n \"variables\": {\n \"type\": \"array\",\n \"items\": {\n \"$ref\": \"#/definitions/Variable\"\n }\n }\n },\n \"required\": [\n \"status\",\n \"changed\",\n \"path\",\n \"storefrontGid\",\n \"storefrontName\",\n \"environment\",\n \"variables\"\n ],\n \"additionalProperties\": false,\n \"description\": \"The dotenv file keeps its native format. The result reports variable metadata without values.\",\n \"title\": \"HydrogenEnvPullResult\",\n \"definitions\": {\n \"Environment\": {\n \"type\": \"object\",\n \"properties\": {\n \"gid\": {\n \"type\": \"string\",\n \"pattern\": \"^gid:\\\\/\\\\/shopify\\\\/HydrogenStorefrontEnvironment\\\\/\\\\d+$\",\n \"description\": \"A Shopify HydrogenStorefrontEnvironment GID.\"\n },\n \"name\": {\n \"type\": \"string\"\n },\n \"handle\": {\n \"type\": \"string\"\n },\n \"branch\": {\n \"type\": [\n \"string\",\n \"null\"\n ]\n },\n \"createdAt\": {\n \"type\": \"string\",\n \"format\": \"date-time\"\n },\n \"type\": {\n \"type\": \"string\",\n \"description\": \"Upstream environment type; known values are PREVIEW, PRODUCTION, CUSTOM.\"\n },\n \"url\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"format\": \"uri\"\n },\n {\n \"type\": \"null\"\n }\n ]\n }\n },\n \"required\": [\n \"gid\",\n \"name\",\n \"handle\",\n \"branch\",\n \"createdAt\",\n \"type\",\n \"url\"\n ],\n \"additionalProperties\": false\n },\n \"Variable\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"id\": {\n \"type\": \"string\",\n \"pattern\": \"^\\\\d+$\",\n \"description\": \"The decimal HydrogenStorefrontEnvironmentVariable ID, not a GID.\"\n },\n \"isSecret\": {\n \"type\": \"boolean\"\n },\n \"readOnly\": {\n \"type\": \"boolean\"\n }\n },\n \"required\": [\n \"name\"\n ],\n \"additionalProperties\": false,\n \"description\": \"Metadata only: variable spelling is preserved and values are never included. Unknown metadata is omitted.\"\n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" }, "no-input": { "description": "Disable interactive prompts and browser authentication.", "env": "SHOPIFY_FLAG_NO_INPUT", "name": "no-input", "allowNo": false, "type": "boolean" }, "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. May include sensitive data.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "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" }, "env": { "description": "Specifies the environment to perform the operation using its handle. Fetch the handle using the `env list` command.", "exclusive": [ "env-branch" ], "name": "env", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "env-branch": { "deprecated": { "to": "env", "message": "--env-branch is deprecated. Use --env instead." }, "description": "Specifies the environment to perform the operation using its Git branch name.", "env": "SHOPIFY_HYDROGEN_ENVIRONMENT_BRANCH", "name": "env-branch", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "env-file": { "description": "Path to an environment file to override existing environment variables. Defaults to the '.env' located in your project path `--path`.", "name": "env-file", "required": false, "default": ".env", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "path": { "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.", "env": "SHOPIFY_HYDROGEN_FLAG_PATH", "name": "path", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "force": { "char": "f", "description": "Overwrites the destination directory and files if they already exist.", "env": "SHOPIFY_HYDROGEN_FLAG_FORCE", "name": "force", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "hydrogen:env:pull", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": true, "enableJsonFlag": false, "descriptionWithMarkdown": "Pulls environment variables from the linked Hydrogen storefront and writes them to an `.env` file.", "customPluginName": "@shopify/cli-hydrogen" }, "hydrogen:env:push": { "aliases": [], "args": {}, "description": "Push environment variables from the local .env file to your linked Hydrogen storefront.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `HydrogenEnvPushResult` schema.\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"enum\": [\n \"success\",\n \"cancelled\"\n ]\n },\n \"changed\": {\n \"type\": \"boolean\"\n },\n \"wouldChange\": {\n \"type\": \"boolean\",\n \"description\": \"Whether the compared local and remote variables differ, excluding protected variables.\"\n },\n \"dryRun\": {\n \"type\": \"boolean\"\n },\n \"path\": {\n \"type\": \"string\"\n },\n \"environment\": {\n \"anyOf\": [\n {\n \"$ref\": \"#/definitions/Environment\"\n },\n {\n \"type\": \"null\"\n }\n ]\n },\n \"variables\": {\n \"type\": \"array\",\n \"items\": {\n \"$ref\": \"#/definitions/Variable\"\n }\n },\n \"skipped\": {\n \"type\": \"array\",\n \"items\": {\n \"$ref\": \"#/definitions/Variable\"\n }\n }\n },\n \"required\": [\n \"status\",\n \"changed\",\n \"wouldChange\",\n \"dryRun\",\n \"path\",\n \"environment\",\n \"variables\",\n \"skipped\"\n ],\n \"additionalProperties\": false,\n \"title\": \"HydrogenEnvPushResult\",\n \"definitions\": {\n \"Environment\": {\n \"type\": \"object\",\n \"properties\": {\n \"gid\": {\n \"type\": \"string\",\n \"pattern\": \"^gid:\\\\/\\\\/shopify\\\\/HydrogenStorefrontEnvironment\\\\/\\\\d+$\",\n \"description\": \"A Shopify HydrogenStorefrontEnvironment GID.\"\n },\n \"name\": {\n \"type\": \"string\"\n },\n \"handle\": {\n \"type\": \"string\"\n },\n \"branch\": {\n \"type\": [\n \"string\",\n \"null\"\n ]\n },\n \"createdAt\": {\n \"type\": \"string\",\n \"format\": \"date-time\"\n },\n \"type\": {\n \"type\": \"string\",\n \"description\": \"Upstream environment type; known values are PREVIEW, PRODUCTION, CUSTOM.\"\n },\n \"url\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"format\": \"uri\"\n },\n {\n \"type\": \"null\"\n }\n ]\n }\n },\n \"required\": [\n \"gid\",\n \"name\",\n \"handle\",\n \"branch\",\n \"createdAt\",\n \"type\",\n \"url\"\n ],\n \"additionalProperties\": false\n },\n \"Variable\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"id\": {\n \"type\": \"string\",\n \"pattern\": \"^\\\\d+$\",\n \"description\": \"The decimal HydrogenStorefrontEnvironmentVariable ID, not a GID.\"\n },\n \"isSecret\": {\n \"type\": \"boolean\"\n },\n \"readOnly\": {\n \"type\": \"boolean\"\n }\n },\n \"required\": [\n \"name\"\n ],\n \"additionalProperties\": false,\n \"description\": \"Metadata only: variable spelling is preserved and values are never included. Unknown metadata is omitted.\"\n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" }, "no-input": { "description": "Disable interactive prompts and browser authentication.", "env": "SHOPIFY_FLAG_NO_INPUT", "name": "no-input", "allowNo": false, "type": "boolean" }, "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. May include sensitive data.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "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" }, "env": { "description": "Specifies the environment to perform the operation using its handle. Fetch the handle using the `env list` command.", "exclusive": [ "env-branch" ], "name": "env", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "env-file": { "description": "Path to an environment file to override existing environment variables. Defaults to the '.env' located in your project path `--path`.", "name": "env-file", "required": false, "default": ".env", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "path": { "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.", "env": "SHOPIFY_HYDROGEN_FLAG_PATH", "name": "path", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "force": { "char": "f", "description": "Push environment variable changes without confirmation.", "env": "SHOPIFY_HYDROGEN_FLAG_FORCE", "name": "force", "allowNo": false, "type": "boolean" }, "dry-run": { "description": "Preview environment variable changes without pushing them.", "env": "SHOPIFY_HYDROGEN_FLAG_DRY_RUN", "exclusive": [ "force" ], "name": "dry-run", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "hydrogen:env:push", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": true, "enableJsonFlag": false, "descriptionWithMarkdown": "Push environment variables from the local .env file to your linked Hydrogen storefront.", "customPluginName": "@shopify/cli-hydrogen" }, "hydrogen:generate:route": { "aliases": [], "args": { "routeName": { "description": "The route to generate. One of home,page,cart,products,collections,policies,blogs,account,search,robots,sitemap,all.", "name": "routeName", "options": [ "home", "page", "cart", "products", "collections", "policies", "blogs", "account", "search", "robots", "sitemap", "all" ], "required": true } }, "description": "Generates a set of default routes from the starter template.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `HydrogenGenerateRoutesResult` schema.\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"enum\": [\n \"success\",\n \"skipped\"\n ]\n },\n \"changed\": {\n \"type\": \"boolean\"\n },\n \"routes\": {\n \"type\": \"array\",\n \"items\": {\n \"$ref\": \"#/definitions/Route\"\n }\n },\n \"routeGroups\": {\n \"type\": \"object\",\n \"additionalProperties\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n },\n \"isTypescript\": {\n \"type\": \"boolean\"\n }\n },\n \"required\": [\n \"status\",\n \"changed\",\n \"routes\",\n \"routeGroups\",\n \"isTypescript\"\n ],\n \"additionalProperties\": false,\n \"title\": \"HydrogenGenerateRoutesResult\",\n \"definitions\": {\n \"Route\": {\n \"type\": \"object\",\n \"properties\": {\n \"sourceRoute\": {\n \"type\": \"string\"\n },\n \"destinationRoute\": {\n \"type\": \"string\"\n },\n \"operation\": {\n \"type\": \"string\",\n \"enum\": [\n \"created\",\n \"skipped\",\n \"replaced\"\n ]\n },\n \"skipReason\": {\n \"type\": \"string\",\n \"enum\": [\n \"declined\",\n \"exists\"\n ]\n }\n },\n \"required\": [\n \"sourceRoute\",\n \"destinationRoute\",\n \"operation\"\n ],\n \"additionalProperties\": false\n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" }, "no-input": { "description": "Disable interactive prompts and browser authentication.", "env": "SHOPIFY_FLAG_NO_INPUT", "name": "no-input", "allowNo": false, "type": "boolean" }, "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. May include sensitive data.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "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" }, "adapter": { "description": "React Router adapter used in the route. The default is `react-router`.", "env": "SHOPIFY_HYDROGEN_FLAG_ADAPTER", "name": "adapter", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "typescript": { "description": "Generate TypeScript files", "env": "SHOPIFY_HYDROGEN_FLAG_TYPESCRIPT", "name": "typescript", "allowNo": false, "type": "boolean" }, "locale-param": { "description": "The param name in Remix routes for the i18n locale, if any. Example: `locale` becomes ($locale).", "env": "SHOPIFY_HYDROGEN_FLAG_ADAPTER", "name": "locale-param", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "force": { "char": "f", "description": "Overwrites the destination directory and files if they already exist.", "env": "SHOPIFY_HYDROGEN_FLAG_FORCE", "name": "force", "allowNo": false, "type": "boolean" }, "path": { "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.", "env": "SHOPIFY_HYDROGEN_FLAG_PATH", "name": "path", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "hydrogen:generate:route", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": true, "enableJsonFlag": false, "descriptionWithMarkdown": "Generates a set of default routes from the starter template.", "customPluginName": "@shopify/cli-hydrogen" }, "hydrogen:generate:routes": { "aliases": [], "args": {}, "description": "Generates all supported standard shopify routes.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `HydrogenGenerateRoutesResult` schema.\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"enum\": [\n \"success\",\n \"skipped\"\n ]\n },\n \"changed\": {\n \"type\": \"boolean\"\n },\n \"routes\": {\n \"type\": \"array\",\n \"items\": {\n \"$ref\": \"#/definitions/Route\"\n }\n },\n \"routeGroups\": {\n \"type\": \"object\",\n \"additionalProperties\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n },\n \"isTypescript\": {\n \"type\": \"boolean\"\n }\n },\n \"required\": [\n \"status\",\n \"changed\",\n \"routes\",\n \"routeGroups\",\n \"isTypescript\"\n ],\n \"additionalProperties\": false,\n \"title\": \"HydrogenGenerateRoutesResult\",\n \"definitions\": {\n \"Route\": {\n \"type\": \"object\",\n \"properties\": {\n \"sourceRoute\": {\n \"type\": \"string\"\n },\n \"destinationRoute\": {\n \"type\": \"string\"\n },\n \"operation\": {\n \"type\": \"string\",\n \"enum\": [\n \"created\",\n \"skipped\",\n \"replaced\"\n ]\n },\n \"skipReason\": {\n \"type\": \"string\",\n \"enum\": [\n \"declined\",\n \"exists\"\n ]\n }\n },\n \"required\": [\n \"sourceRoute\",\n \"destinationRoute\",\n \"operation\"\n ],\n \"additionalProperties\": false\n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" }, "no-input": { "description": "Disable interactive prompts and browser authentication.", "env": "SHOPIFY_FLAG_NO_INPUT", "name": "no-input", "allowNo": false, "type": "boolean" }, "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. May include sensitive data.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "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" }, "adapter": { "description": "React Router adapter used in the route. The default is `react-router`.", "env": "SHOPIFY_HYDROGEN_FLAG_ADAPTER", "name": "adapter", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "typescript": { "description": "Generate TypeScript files", "env": "SHOPIFY_HYDROGEN_FLAG_TYPESCRIPT", "name": "typescript", "allowNo": false, "type": "boolean" }, "locale-param": { "description": "The param name in Remix routes for the i18n locale, if any. Example: `locale` becomes ($locale).", "env": "SHOPIFY_HYDROGEN_FLAG_ADAPTER", "name": "locale-param", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "force": { "char": "f", "description": "Overwrites the destination directory and files if they already exist.", "env": "SHOPIFY_HYDROGEN_FLAG_FORCE", "name": "force", "allowNo": false, "type": "boolean" }, "path": { "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.", "env": "SHOPIFY_HYDROGEN_FLAG_PATH", "name": "path", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "hydrogen:generate:routes", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": true, "enableJsonFlag": false, "descriptionWithMarkdown": "Generates all supported standard shopify routes.", "customPluginName": "@shopify/cli-hydrogen" }, "hydrogen:setup:css": { "aliases": [], "args": { "strategy": { "description": "The CSS strategy to setup. One of tailwind,vanilla-extract,css-modules,postcss", "name": "strategy", "options": [ "tailwind", "vanilla-extract", "css-modules", "postcss" ] } }, "description": "Adds support for certain CSS strategies to your project.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `HydrogenSetupCssResult` schema.\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"enum\": [\n \"success\",\n \"cancelled\"\n ]\n },\n \"changed\": {\n \"type\": \"boolean\"\n },\n \"directory\": {\n \"$ref\": \"#/definitions/AbsolutePath\"\n },\n \"strategy\": {\n \"type\": \"string\",\n \"enum\": [\n \"tailwind\",\n \"vanilla-extract\",\n \"css-modules\",\n \"postcss\"\n ]\n },\n \"filePaths\": {\n \"type\": \"array\",\n \"items\": {\n \"$ref\": \"#/definitions/AbsolutePath\"\n }\n },\n \"dependenciesInstalled\": {\n \"type\": \"boolean\"\n },\n \"needsNpmReinstall\": {\n \"type\": \"boolean\"\n }\n },\n \"required\": [\n \"status\",\n \"changed\",\n \"directory\",\n \"strategy\",\n \"filePaths\",\n \"dependenciesInstalled\",\n \"needsNpmReinstall\"\n ],\n \"additionalProperties\": false,\n \"title\": \"HydrogenSetupCssResult\",\n \"definitions\": {\n \"AbsolutePath\": {\n \"type\": \"string\"\n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" }, "no-input": { "description": "Disable interactive prompts and browser authentication.", "env": "SHOPIFY_FLAG_NO_INPUT", "name": "no-input", "allowNo": false, "type": "boolean" }, "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. May include sensitive data.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "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" }, "path": { "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.", "env": "SHOPIFY_HYDROGEN_FLAG_PATH", "name": "path", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "force": { "char": "f", "description": "Overwrites the destination directory and files if they already exist.", "env": "SHOPIFY_HYDROGEN_FLAG_FORCE", "name": "force", "allowNo": false, "type": "boolean" }, "install-deps": { "description": "Auto installs dependencies using the active package manager.", "env": "SHOPIFY_HYDROGEN_FLAG_INSTALL_DEPS", "name": "install-deps", "allowNo": true, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "hydrogen:setup:css", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": true, "enableJsonFlag": false, "descriptionWithMarkdown": "Adds support for certain CSS strategies to your project.", "customPluginName": "@shopify/cli-hydrogen" }, "hydrogen:setup:markets": { "aliases": [], "args": { "strategy": { "description": "The URL structure strategy to setup multiple markets. One of subfolders,domains,subdomains", "name": "strategy", "options": [ "subfolders", "domains", "subdomains" ] } }, "description": "Adds support for multiple \"markets\" (https://shopify.dev/docs/custom-storefronts/hydrogen/markets) to your project by using the URL structure.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `HydrogenSetupMarketsResult` schema.\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"const\": \"success\"\n },\n \"changed\": {\n \"type\": \"boolean\",\n \"const\": true\n },\n \"directory\": {\n \"$ref\": \"#/definitions/AbsolutePath\"\n },\n \"strategy\": {\n \"type\": \"string\",\n \"enum\": [\n \"subfolders\",\n \"domains\",\n \"subdomains\"\n ]\n },\n \"serverPath\": {\n \"anyOf\": [\n {\n \"$ref\": \"#/definitions/AbsolutePath\"\n },\n {\n \"type\": \"null\"\n }\n ]\n }\n },\n \"required\": [\n \"status\",\n \"changed\",\n \"directory\",\n \"strategy\",\n \"serverPath\"\n ],\n \"additionalProperties\": false,\n \"title\": \"HydrogenSetupMarketsResult\",\n \"definitions\": {\n \"AbsolutePath\": {\n \"type\": \"string\"\n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" }, "no-input": { "description": "Disable interactive prompts and browser authentication.", "env": "SHOPIFY_FLAG_NO_INPUT", "name": "no-input", "allowNo": false, "type": "boolean" }, "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. May include sensitive data.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "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" }, "path": { "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.", "env": "SHOPIFY_HYDROGEN_FLAG_PATH", "name": "path", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "hydrogen:setup:markets", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": true, "enableJsonFlag": false, "descriptionWithMarkdown": "Adds support for multiple [markets](https://shopify.dev/docs/custom-storefronts/hydrogen/markets) to your project by using the URL structure.", "customPluginName": "@shopify/cli-hydrogen" }, "hydrogen:setup:vite": { "aliases": [], "args": {}, "description": "EXPERIMENTAL: Upgrades the project to use Vite.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `HydrogenSetupViteResult` schema.\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"const\": \"success\"\n },\n \"changed\": {\n \"type\": \"boolean\",\n \"const\": true\n },\n \"directory\": {\n \"$ref\": \"#/definitions/AbsolutePath\"\n },\n \"viteConfigPath\": {\n \"$ref\": \"#/definitions/AbsolutePath\"\n },\n \"serverPath\": {\n \"$ref\": \"#/definitions/AbsolutePath\"\n },\n \"dependenciesInstalled\": {\n \"type\": \"boolean\",\n \"const\": true\n },\n \"needsMdxSetup\": {\n \"type\": \"boolean\"\n }\n },\n \"required\": [\n \"status\",\n \"changed\",\n \"directory\",\n \"viteConfigPath\",\n \"serverPath\",\n \"dependenciesInstalled\",\n \"needsMdxSetup\"\n ],\n \"additionalProperties\": false,\n \"title\": \"HydrogenSetupViteResult\",\n \"definitions\": {\n \"AbsolutePath\": {\n \"type\": \"string\"\n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" }, "no-input": { "description": "Disable interactive prompts and browser authentication.", "env": "SHOPIFY_FLAG_NO_INPUT", "name": "no-input", "allowNo": false, "type": "boolean" }, "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. May include sensitive data.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "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" }, "path": { "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.", "env": "SHOPIFY_HYDROGEN_FLAG_PATH", "name": "path", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "hydrogen:setup:vite", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": true, "enableJsonFlag": false, "descriptionWithMarkdown": "EXPERIMENTAL: Upgrades the project to use Vite.", "customPluginName": "@shopify/cli-hydrogen" }, "store:auth:list": { "aliases": [], "args": {}, "description": "Lists stores authenticated directly on this machine with `shopify store auth`.\n\nUse this command to find stores that can be used with store-authenticated commands such as `shopify store execute`.\nTo list stores in a Shopify organization, run `shopify store list`.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `StoreAuthListResult` schema.\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"sessions\": {\n \"type\": \"array\",\n \"items\": {\n \"$ref\": \"#/definitions/StoreAuthListSession\"\n }\n },\n \"message\": {\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"sessions\"\n ],\n \"additionalProperties\": false,\n \"title\": \"StoreAuthListResult\",\n \"definitions\": {\n \"StoreAuthListSession\": {\n \"type\": \"object\",\n \"properties\": {\n \"subdomain\": {\n \"type\": \"string\"\n },\n \"connected\": {\n \"type\": \"string\"\n },\n \"store\": {\n \"type\": \"string\"\n },\n \"userId\": {\n \"type\": \"string\"\n },\n \"scopes\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n },\n \"acquiredAt\": {\n \"type\": \"string\",\n \"description\": \"When the stored token was acquired, in ISO 8601 format.\"\n },\n \"expiresAt\": {\n \"type\": \"string\",\n \"description\": \"When the stored access token expires, in ISO 8601 format.\"\n },\n \"refreshTokenExpiresAt\": {\n \"type\": \"string\",\n \"description\": \"When the stored refresh token expires, in ISO 8601 format.\"\n },\n \"associatedUser\": {\n \"$ref\": \"#/definitions/StoreAuthAssociatedUser\"\n }\n },\n \"required\": [\n \"subdomain\",\n \"connected\"\n ],\n \"additionalProperties\": false\n },\n \"StoreAuthAssociatedUser\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"type\": \"number\"\n },\n \"email\": {\n \"type\": \"string\"\n },\n \"firstName\": {\n \"type\": \"string\"\n },\n \"lastName\": {\n \"type\": \"string\"\n },\n \"accountOwner\": {\n \"type\": \"boolean\"\n }\n },\n \"required\": [\n \"id\"\n ],\n \"additionalProperties\": false\n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "examples": [ "<%= config.bin %> <%= command.id %>", "<%= config.bin %> <%= command.id %> --json" ], "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" }, "no-input": { "description": "Disable interactive prompts and browser authentication.", "env": "SHOPIFY_FLAG_NO_INPUT", "name": "no-input", "allowNo": false, "type": "boolean" }, "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. May include sensitive data.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "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": "store:auth:list", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": true, "summary": "List stores authenticated directly with store auth.", "enableJsonFlag": false, "descriptionWithMarkdown": "Lists stores authenticated directly on this machine with `shopify store auth`.\n\nUse this command to find stores that can be used with store-authenticated commands such as `shopify store execute`.\nTo list stores in a Shopify organization, run `shopify store list`.", "customPluginName": "@shopify/store" }, "store:auth": { "aliases": [], "args": {}, "description": "Authenticates the app against the specified store for store commands and stores an online access token for later reuse.\n\nRe-run this command if the stored token is missing, expires, or no longer has the scopes you need.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `StoreAuthResult` schema.\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"store\": {\n \"type\": \"string\"\n },\n \"userId\": {\n \"type\": \"string\"\n },\n \"scopes\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n },\n \"acquiredAt\": {\n \"type\": \"string\"\n },\n \"expiresAt\": {\n \"type\": \"string\"\n },\n \"refreshTokenExpiresAt\": {\n \"type\": \"string\"\n },\n \"hasRefreshToken\": {\n \"type\": \"boolean\"\n },\n \"associatedUser\": {\n \"$ref\": \"#/definitions/StoreAuthAssociatedUser\"\n }\n },\n \"required\": [\n \"store\",\n \"userId\",\n \"scopes\",\n \"acquiredAt\",\n \"hasRefreshToken\"\n ],\n \"additionalProperties\": false,\n \"title\": \"StoreAuthResult\",\n \"definitions\": {\n \"StoreAuthAssociatedUser\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"type\": \"number\"\n },\n \"email\": {\n \"type\": \"string\"\n },\n \"firstName\": {\n \"type\": \"string\"\n },\n \"lastName\": {\n \"type\": \"string\"\n },\n \"accountOwner\": {\n \"type\": \"boolean\"\n }\n },\n \"required\": [\n \"id\"\n ],\n \"additionalProperties\": false\n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "examples": [ "<%= config.bin %> <%= command.id %> --store shop.myshopify.com --scopes read_products,write_products", "<%= config.bin %> <%= command.id %> --store shop.myshopify.com --scopes read_products,write_products --json" ], "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" }, "no-input": { "description": "Disable interactive prompts and browser authentication.", "env": "SHOPIFY_FLAG_NO_INPUT", "name": "no-input", "allowNo": false, "type": "boolean" }, "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. May include sensitive data.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "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": "The myshopify.com domain of the store.", "env": "SHOPIFY_FLAG_STORE", "name": "store", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "scopes": { "description": "Comma-separated Admin API scopes to request for the app.", "env": "SHOPIFY_FLAG_SCOPES", "name": "scopes", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "store:auth", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": true, "summary": "Authenticate an app against a store for store commands.", "descriptionWithMarkdown": "Authenticates the app against the specified store for store commands and stores an online access token for later reuse.\n\nRe-run this command if the stored token is missing, expires, or no longer has the scopes you need.", "customPluginName": "@shopify/store" }, "store:bulk:cancel": { "aliases": [], "args": {}, "description": "Cancels a running bulk operation by ID, using previously stored app authentication.\n\n Run `shopify store auth` first to create stored auth for the store.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `CancelBulkOperationResult` schema.\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"storeDomain\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"pattern\": \"^[^.]+\\\\.myshopify\\\\.com$\"\n },\n {\n \"type\": \"null\"\n }\n ]\n },\n \"apiVersion\": {\n \"type\": [\n \"string\",\n \"null\"\n ],\n \"description\": \"The API version selected for the request.\"\n },\n \"status\": {\n \"type\": \"string\",\n \"const\": \"success\"\n },\n \"operation\": {\n \"$ref\": \"#/definitions/BulkOperation\"\n }\n },\n \"required\": [\n \"storeDomain\",\n \"apiVersion\",\n \"status\",\n \"operation\"\n ],\n \"additionalProperties\": false,\n \"title\": \"CancelBulkOperationResult\",\n \"definitions\": {\n \"BulkOperation\": {\n \"type\": \"object\",\n \"properties\": {\n \"gid\": {\n \"type\": \"string\",\n \"pattern\": \"^gid:\\\\/\\\\/shopify\\\\/BulkOperation\\\\/[^/]+$\",\n \"description\": \"The Shopify global ID of a bulk operation.\"\n },\n \"type\": {\n \"type\": \"string\"\n },\n \"status\": {\n \"type\": \"string\"\n },\n \"errorCode\": {\n \"type\": [\n \"string\",\n \"null\"\n ]\n },\n \"createdAt\": {\n \"type\": \"string\",\n \"format\": \"date-time\",\n \"pattern\": \"^\\\\d{4}-\\\\d{2}-\\\\d{2}T\\\\d{2}:\\\\d{2}:\\\\d{2}Z$\",\n \"description\": \"A UTC ISO 8601 instant with whole seconds and the Z timezone marker.\"\n },\n \"completedAt\": {\n \"anyOf\": [\n {\n \"$ref\": \"#/definitions/BulkOperation/properties/createdAt\"\n },\n {\n \"type\": \"null\"\n }\n ],\n \"description\": \"A UTC ISO 8601 instant with whole seconds and the Z timezone marker.\"\n },\n \"objectCount\": {\n \"type\": \"string\",\n \"pattern\": \"^\\\\d+$\",\n \"description\": \"A nonnegative decimal count, without loss of integer precision.\"\n },\n \"url\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"format\": \"uri\"\n },\n {\n \"type\": \"null\"\n }\n ]\n },\n \"partialDataUrl\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"format\": \"uri\"\n },\n {\n \"type\": \"null\"\n }\n ]\n }\n },\n \"required\": [\n \"gid\",\n \"type\",\n \"status\",\n \"errorCode\",\n \"createdAt\",\n \"completedAt\",\n \"objectCount\",\n \"url\",\n \"partialDataUrl\"\n ],\n \"additionalProperties\": false\n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "examples": [ "<%= config.bin %> <%= command.id %> --store shop.myshopify.com --id 123456789" ], "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" }, "no-input": { "description": "Disable interactive prompts and browser authentication.", "env": "SHOPIFY_FLAG_NO_INPUT", "name": "no-input", "allowNo": false, "type": "boolean" }, "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. May include sensitive data.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "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": "The myshopify.com domain of the store.", "env": "SHOPIFY_FLAG_STORE", "name": "store", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "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" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "store:bulk:cancel", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": true, "summary": "Cancel a bulk operation on a store.", "descriptionWithMarkdown": "Cancels a running bulk operation by ID, using previously stored app authentication.\n\n Run `shopify store auth` first to create stored auth for the store.", "customPluginName": "@shopify/store" }, "store:bulk:execute": { "aliases": [], "args": {}, "description": "Executes an Admin API GraphQL query or mutation on the specified store as a bulk operation, using previously stored app authentication.\n\n Run `shopify store auth` first to create stored auth for the store.\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 Mutations are disabled by default. Re-run with `--allow-mutations` if you intend to modify store data.\n\n Use \"`store bulk status`\" (https://shopify.dev/docs/api/shopify-cli/store/store-bulk-status) to check the status of your bulk operations.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `ExecuteBulkOperationResult` schema.\n\n```json\n{\n \"anyOf\": [\n {\n \"$ref\": \"#/definitions/ExecuteBulkOperationResult\"\n },\n {\n \"$ref\": \"#/definitions/BulkOperationFile\"\n }\n ],\n \"title\": \"ExecuteBulkOperationResult\",\n \"definitions\": {\n \"BulkOperation\": {\n \"type\": \"object\",\n \"properties\": {\n \"gid\": {\n \"type\": \"string\",\n \"pattern\": \"^gid:\\\\/\\\\/shopify\\\\/BulkOperation\\\\/[^/]+$\",\n \"description\": \"The Shopify global ID of a bulk operation.\"\n },\n \"type\": {\n \"type\": \"string\"\n },\n \"status\": {\n \"type\": \"string\"\n },\n \"errorCode\": {\n \"type\": [\n \"string\",\n \"null\"\n ]\n },\n \"createdAt\": {\n \"type\": \"string\",\n \"format\": \"date-time\",\n \"pattern\": \"^\\\\d{4}-\\\\d{2}-\\\\d{2}T\\\\d{2}:\\\\d{2}:\\\\d{2}Z$\",\n \"description\": \"A UTC ISO 8601 instant with whole seconds and the Z timezone marker.\"\n },\n \"completedAt\": {\n \"anyOf\": [\n {\n \"$ref\": \"#/definitions/BulkOperation/properties/createdAt\"\n },\n {\n \"type\": \"null\"\n }\n ],\n \"description\": \"A UTC ISO 8601 instant with whole seconds and the Z timezone marker.\"\n },\n \"objectCount\": {\n \"type\": \"string\",\n \"pattern\": \"^\\\\d+$\",\n \"description\": \"A nonnegative decimal count, without loss of integer precision.\"\n },\n \"url\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"format\": \"uri\"\n },\n {\n \"type\": \"null\"\n }\n ]\n },\n \"partialDataUrl\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"format\": \"uri\"\n },\n {\n \"type\": \"null\"\n }\n ]\n }\n },\n \"required\": [\n \"gid\",\n \"type\",\n \"status\",\n \"errorCode\",\n \"createdAt\",\n \"completedAt\",\n \"objectCount\",\n \"url\",\n \"partialDataUrl\"\n ],\n \"additionalProperties\": false\n },\n \"ExecuteBulkOperationResult\": {\n \"type\": \"object\",\n \"properties\": {\n \"storeDomain\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"pattern\": \"^[^.]+\\\\.myshopify\\\\.com$\"\n },\n {\n \"type\": \"null\"\n }\n ]\n },\n \"apiVersion\": {\n \"type\": [\n \"string\",\n \"null\"\n ],\n \"description\": \"The API version selected for the request.\"\n },\n \"status\": {\n \"type\": \"string\",\n \"enum\": [\n \"success\",\n \"partial\",\n \"cancelled\"\n ]\n },\n \"reason\": {\n \"type\": \"string\",\n \"const\": \"watch-aborted\"\n },\n \"operation\": {\n \"$ref\": \"#/definitions/BulkOperation\"\n },\n \"resultsJsonl\": {\n \"type\": \"string\",\n \"description\": \"Downloaded results in their native JSONL format.\"\n }\n },\n \"required\": [\n \"storeDomain\",\n \"apiVersion\",\n \"status\",\n \"operation\"\n ],\n \"additionalProperties\": false\n },\n \"BulkOperationFile\": {\n \"type\": \"object\",\n \"properties\": {\n \"path\": {\n \"type\": \"string\",\n \"description\": \"The absolute path of the downloaded results file.\"\n },\n \"format\": {\n \"type\": \"string\",\n \"const\": \"jsonl\"\n }\n },\n \"required\": [\n \"path\",\n \"format\"\n ],\n \"additionalProperties\": false\n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "examples": [ "<%= config.bin %> <%= command.id %> --store shop.myshopify.com --query \"query { products { edges { node { id } } } }\"", "<%= config.bin %> <%= command.id %> --store shop.myshopify.com --query-file ./operation.graphql --watch", "<%= config.bin %> <%= command.id %> --store shop.myshopify.com --query-file ./mutation.graphql --variable-file ./variables.jsonl --allow-mutations" ], "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" }, "no-input": { "description": "Disable interactive prompts and browser authentication.", "env": "SHOPIFY_FLAG_NO_INPUT", "name": "no-input", "allowNo": false, "type": "boolean" }, "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. May include sensitive data.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "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": "The myshopify.com domain of the store.", "env": "SHOPIFY_FLAG_STORE", "name": "store", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "query": { "char": "q", "description": "The GraphQL query or mutation to run as a bulk operation.", "env": "SHOPIFY_FLAG_QUERY", "name": "query", "required": false, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "query-file": { "description": "Path to a file containing the GraphQL query or mutation. Can't be used with --query.", "env": "SHOPIFY_FLAG_QUERY_FILE", "name": "query-file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "variables": { "char": "v", "description": "The values for any GraphQL variables in your mutation, in JSON format. Can be specified multiple times.", "env": "SHOPIFY_FLAG_VARIABLES", "exclusive": [ "variable-file" ], "name": "variables", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "variable-file": { "description": "Path to a file containing GraphQL variables in JSONL format (one JSON object per line). Can't be used with --variables.", "env": "SHOPIFY_FLAG_VARIABLE_FILE", "exclusive": [ "variables" ], "name": "variable-file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "watch": { "description": "Wait for bulk operation results before exiting. Defaults to false.", "env": "SHOPIFY_FLAG_WATCH", "name": "watch", "allowNo": false, "type": "boolean" }, "output-file": { "dependsOn": [ "watch" ], "description": "The file path where results should be written if --watch is specified. If not specified, results will be written to STDOUT.", "env": "SHOPIFY_FLAG_OUTPUT_FILE", "name": "output-file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "version": { "description": "The API version to use for the bulk operation. If not specified, uses the latest stable version.", "env": "SHOPIFY_FLAG_VERSION", "name": "version", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "allow-mutations": { "description": "Allow GraphQL mutations to run against the target store.", "env": "SHOPIFY_FLAG_ALLOW_MUTATIONS", "name": "allow-mutations", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "store:bulk:execute", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": true, "summary": "Execute bulk operations on a store.", "descriptionWithMarkdown": "Executes an Admin API GraphQL query or mutation on the specified store as a bulk operation, using previously stored app authentication.\n\n Run `shopify store auth` first to create stored auth for the store.\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 Mutations are disabled by default. Re-run with `--allow-mutations` if you intend to modify store data.\n\n Use [`store bulk status`](https://shopify.dev/docs/api/shopify-cli/store/store-bulk-status) to check the status of your bulk operations.", "customPluginName": "@shopify/store" }, "store:bulk:status": { "aliases": [], "args": {}, "description": "Check the status of a specific bulk operation by ID, or list all bulk operations on this store in the last 7 days, using previously stored app authentication.\n\n Run `shopify store auth` first to create stored auth for the store.\n\n Use \"`store bulk execute`\" (https://shopify.dev/docs/api/shopify-cli/store/store-bulk-execute) to start a new bulk operation.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `BulkOperationStatusResult` schema.\n\n```json\n{\n \"anyOf\": [\n {\n \"$ref\": \"#/definitions/GetBulkOperationStatusResult\"\n },\n {\n \"$ref\": \"#/definitions/ListBulkOperationsResult\"\n }\n ],\n \"title\": \"BulkOperationStatusResult\",\n \"definitions\": {\n \"GetBulkOperationStatusResult\": {\n \"type\": \"object\",\n \"properties\": {\n \"storeDomain\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"pattern\": \"^[^.]+\\\\.myshopify\\\\.com$\"\n },\n {\n \"type\": \"null\"\n }\n ]\n },\n \"apiVersion\": {\n \"type\": [\n \"string\",\n \"null\"\n ],\n \"description\": \"The API version selected for the request.\"\n },\n \"operationGid\": {\n \"type\": \"string\",\n \"pattern\": \"^gid:\\\\/\\\\/shopify\\\\/BulkOperation\\\\/[^/]+$\",\n \"description\": \"The Shopify global ID of a bulk operation.\"\n },\n \"operation\": {\n \"anyOf\": [\n {\n \"$ref\": \"#/definitions/BulkOperation\"\n },\n {\n \"type\": \"null\"\n }\n ]\n }\n },\n \"required\": [\n \"storeDomain\",\n \"apiVersion\",\n \"operationGid\",\n \"operation\"\n ],\n \"additionalProperties\": false\n },\n \"ListBulkOperationsResult\": {\n \"type\": \"object\",\n \"properties\": {\n \"storeDomain\": {\n \"$ref\": \"#/definitions/GetBulkOperationStatusResult/properties/storeDomain\"\n },\n \"apiVersion\": {\n \"$ref\": \"#/definitions/GetBulkOperationStatusResult/properties/apiVersion\"\n },\n \"operations\": {\n \"type\": \"array\",\n \"items\": {\n \"$ref\": \"#/definitions/ListedBulkOperation\"\n }\n },\n \"pageInfo\": {\n \"type\": \"object\",\n \"properties\": {\n \"hasNextPage\": {\n \"type\": [\n \"boolean\",\n \"null\"\n ],\n \"description\": \"Unknown when the API result reaches the fetch limit.\"\n }\n },\n \"required\": [\n \"hasNextPage\"\n ],\n \"additionalProperties\": false\n }\n },\n \"required\": [\n \"storeDomain\",\n \"apiVersion\",\n \"operations\",\n \"pageInfo\"\n ],\n \"additionalProperties\": false\n },\n \"BulkOperation\": {\n \"type\": \"object\",\n \"properties\": {\n \"gid\": {\n \"$ref\": \"#/definitions/GetBulkOperationStatusResult/properties/operationGid\"\n },\n \"type\": {\n \"type\": \"string\"\n },\n \"status\": {\n \"type\": \"string\"\n },\n \"errorCode\": {\n \"type\": [\n \"string\",\n \"null\"\n ]\n },\n \"createdAt\": {\n \"type\": \"string\",\n \"format\": \"date-time\",\n \"pattern\": \"^\\\\d{4}-\\\\d{2}-\\\\d{2}T\\\\d{2}:\\\\d{2}:\\\\d{2}Z$\",\n \"description\": \"A UTC ISO 8601 instant with whole seconds and the Z timezone marker.\"\n },\n \"completedAt\": {\n \"anyOf\": [\n {\n \"$ref\": \"#/definitions/BulkOperation/properties/createdAt\"\n },\n {\n \"type\": \"null\"\n }\n ],\n \"description\": \"A UTC ISO 8601 instant with whole seconds and the Z timezone marker.\"\n },\n \"objectCount\": {\n \"type\": \"string\",\n \"pattern\": \"^\\\\d+$\",\n \"description\": \"A nonnegative decimal count, without loss of integer precision.\"\n },\n \"url\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"format\": \"uri\"\n },\n {\n \"type\": \"null\"\n }\n ]\n },\n \"partialDataUrl\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"format\": \"uri\"\n },\n {\n \"type\": \"null\"\n }\n ]\n }\n },\n \"required\": [\n \"gid\",\n \"type\",\n \"status\",\n \"errorCode\",\n \"createdAt\",\n \"completedAt\",\n \"objectCount\",\n \"url\",\n \"partialDataUrl\"\n ],\n \"additionalProperties\": false\n },\n \"ListedBulkOperation\": {\n \"type\": \"object\",\n \"properties\": {\n \"gid\": {\n \"$ref\": \"#/definitions/GetBulkOperationStatusResult/properties/operationGid\"\n },\n \"status\": {\n \"$ref\": \"#/definitions/BulkOperation/properties/status\"\n },\n \"errorCode\": {\n \"$ref\": \"#/definitions/BulkOperation/properties/errorCode\"\n },\n \"createdAt\": {\n \"$ref\": \"#/definitions/BulkOperation/properties/createdAt\"\n },\n \"completedAt\": {\n \"$ref\": \"#/definitions/BulkOperation/properties/completedAt\"\n },\n \"objectCount\": {\n \"$ref\": \"#/definitions/BulkOperation/properties/objectCount\"\n },\n \"url\": {\n \"$ref\": \"#/definitions/BulkOperation/properties/url\"\n },\n \"partialDataUrl\": {\n \"$ref\": \"#/definitions/BulkOperation/properties/partialDataUrl\"\n }\n },\n \"required\": [\n \"gid\",\n \"status\",\n \"errorCode\",\n \"createdAt\",\n \"completedAt\",\n \"objectCount\",\n \"url\",\n \"partialDataUrl\"\n ],\n \"additionalProperties\": false\n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "examples": [ "<%= config.bin %> <%= command.id %> --store shop.myshopify.com", "<%= config.bin %> <%= command.id %> --store shop.myshopify.com --id 123456789" ], "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" }, "no-input": { "description": "Disable interactive prompts and browser authentication.", "env": "SHOPIFY_FLAG_NO_INPUT", "name": "no-input", "allowNo": false, "type": "boolean" }, "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. May include sensitive data.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "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": "The myshopify.com domain of the store.", "env": "SHOPIFY_FLAG_STORE", "name": "store", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "id": { "description": "The bulk operation ID (numeric ID or full GID). If not provided, lists all bulk operations on this store in the last 7 days.", "env": "SHOPIFY_FLAG_ID", "name": "id", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "store:bulk:status", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": true, "summary": "Check the status of bulk operations on a store.", "descriptionWithMarkdown": "Check the status of a specific bulk operation by ID, or list all bulk operations on this store in the last 7 days, using previously stored app authentication.\n\n Run `shopify store auth` first to create stored auth for the store.\n\n Use [`store bulk execute`](https://shopify.dev/docs/api/shopify-cli/store/store-bulk-execute) to start a new bulk operation.", "customPluginName": "@shopify/store" }, "store:stripe-auth": { "aliases": [], "args": {}, "description": "Authenticates to a store then stores an online access token for later reuse. Pass the provided JWT to --signup or stdin.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `StoreAuthResult` schema.\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"store\": {\n \"type\": \"string\"\n },\n \"userId\": {\n \"type\": \"string\"\n },\n \"scopes\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n },\n \"acquiredAt\": {\n \"type\": \"string\"\n },\n \"expiresAt\": {\n \"type\": \"string\"\n },\n \"refreshTokenExpiresAt\": {\n \"type\": \"string\"\n },\n \"hasRefreshToken\": {\n \"type\": \"boolean\"\n },\n \"associatedUser\": {\n \"$ref\": \"#/definitions/StoreAuthAssociatedUser\"\n }\n },\n \"required\": [\n \"store\",\n \"userId\",\n \"scopes\",\n \"acquiredAt\",\n \"hasRefreshToken\"\n ],\n \"additionalProperties\": false,\n \"title\": \"StoreAuthResult\",\n \"definitions\": {\n \"StoreAuthAssociatedUser\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"type\": \"number\"\n },\n \"email\": {\n \"type\": \"string\"\n },\n \"firstName\": {\n \"type\": \"string\"\n },\n \"lastName\": {\n \"type\": \"string\"\n },\n \"accountOwner\": {\n \"type\": \"boolean\"\n }\n },\n \"required\": [\n \"id\"\n ],\n \"additionalProperties\": false\n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "examples": [ "<%= config.bin %> <%= command.id %> --store shop.myshopify.com --scopes read_products,write_products --signup ", "printf %s | <%= config.bin %> <%= command.id %> --store shop.myshopify.com --scopes read_products,write_products", "<%= config.bin %> <%= command.id %> --store shop.myshopify.com --scopes read_products,write_products --signup --json" ], "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" }, "no-input": { "description": "Disable interactive prompts and browser authentication.", "env": "SHOPIFY_FLAG_NO_INPUT", "name": "no-input", "allowNo": false, "type": "boolean" }, "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. May include sensitive data.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "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": "The myshopify.com domain of the store.", "env": "SHOPIFY_FLAG_STORE", "name": "store", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "scopes": { "description": "Comma-separated Admin API scopes to request for the app.", "env": "SHOPIFY_FLAG_SCOPES", "name": "scopes", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "signup": { "description": "Provide JWT for the store. When omitted, the JWT is read from stdin.", "env": "SHOPIFY_FLAG_SIGNUP", "name": "signup", "required": false, "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hidden": true, "hiddenAliases": [], "id": "store:stripe-auth", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": true, "summary": "Authenticate for store commands.", "descriptionWithMarkdown": "Authenticates to a store then stores an online access token for later reuse. Pass the provided JWT to --signup or stdin.", "customPluginName": "@shopify/store" }, "store:create:dev": { "aliases": [], "args": {}, "description": "Creates a new dev store in your organization.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `CreateDevStoreResult` schema.\n\n```json\n{\n \"anyOf\": [\n {\n \"type\": \"object\",\n \"properties\": {\n \"store\": {\n \"$ref\": \"#/definitions/CreatedDevStore\"\n },\n \"organization\": {\n \"$ref\": \"#/definitions/StoreOrganization\"\n }\n },\n \"required\": [\n \"store\",\n \"organization\"\n ],\n \"additionalProperties\": false\n },\n {\n \"$ref\": \"#/definitions/StoreCommandError\"\n }\n ],\n \"title\": \"CreateDevStoreResult\",\n \"definitions\": {\n \"CreatedDevStore\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"domain\": {\n \"type\": \"string\"\n },\n \"adminUrl\": {\n \"type\": [\n \"string\",\n \"null\"\n ]\n },\n \"plan\": {\n \"type\": \"string\",\n \"enum\": [\n \"basic\",\n \"grow\",\n \"advanced\",\n \"plus\"\n ]\n },\n \"featurePreview\": {\n \"type\": \"string\"\n },\n \"country\": {\n \"type\": \"string\"\n },\n \"demoData\": {\n \"type\": \"boolean\"\n }\n },\n \"required\": [\n \"name\",\n \"domain\",\n \"plan\",\n \"demoData\"\n ],\n \"additionalProperties\": false\n },\n \"StoreOrganization\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"type\": \"string\"\n },\n \"name\": {\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"id\",\n \"name\"\n ],\n \"additionalProperties\": false\n },\n \"StoreCommandError\": {\n \"type\": \"object\",\n \"properties\": {\n \"error\": {\n \"type\": \"boolean\",\n \"const\": true\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"nextSteps\": {\n \"type\": \"array\",\n \"items\": {},\n \"description\": \"Suggested next steps, as text or formatted UI tokens.\"\n },\n \"exitCode\": {\n \"type\": \"number\",\n \"const\": 1\n }\n },\n \"required\": [\n \"error\",\n \"message\",\n \"nextSteps\",\n \"exitCode\"\n ],\n \"additionalProperties\": false\n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "examples": [ "<%= config.bin %> <%= command.id %>", "<%= config.bin %> <%= command.id %> --name \"Lavender Candles\" --organization-id 1234567 --plan basic", "<%= config.bin %> <%= command.id %> --name \"Lavender Candles\" --organization-id 1234567 --plan basic --demo-data", "<%= config.bin %> <%= command.id %> --name \"Lavender Candles\" --organization-id 1234567 --plan basic --json" ], "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" }, "no-input": { "description": "Disable interactive prompts and browser authentication.", "env": "SHOPIFY_FLAG_NO_INPUT", "name": "no-input", "allowNo": false, "type": "boolean" }, "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. May include sensitive data.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "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" }, "name": { "description": "Name for the new dev store. Required if non interactive.", "env": "SHOPIFY_FLAG_STORE_NAME", "name": "name", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "organization-id": { "description": "The numeric organization ID. Auto-selects if you belong to a single organization. Required if non interactive.", "env": "SHOPIFY_FLAG_ORGANIZATION_ID", "name": "organization-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "plan": { "description": "The Shopify plan to use for the new dev store. Required if non interactive.", "env": "SHOPIFY_FLAG_STORE_PLAN", "name": "plan", "hasDynamicHelp": false, "multiple": false, "options": [ "basic", "grow", "advanced", "plus" ], "type": "option" }, "feature-preview": { "description": "The handle of a feature preview to enable on the new dev store.", "env": "SHOPIFY_FLAG_STORE_FEATURE_PREVIEW", "name": "feature-preview", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "demo-data": { "description": "Populate the new dev store with demo data.", "env": "SHOPIFY_FLAG_STORE_DEMO_DATA", "name": "demo-data", "allowNo": true, "type": "boolean" }, "country": { "description": "Two-letter country code for the store, such as US, CA, or GB. Follows the ISO 3166-1 alpha-2 standard.", "env": "SHOPIFY_FLAG_STORE_COUNTRY", "name": "country", "required": false, "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "store:create:dev", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": true, "summary": "Create a new dev store.", "enableJsonFlag": false, "descriptionWithMarkdown": "Creates a new dev store in your organization.", "customPluginName": "@shopify/store" }, "store:create:preview": { "aliases": [], "args": {}, "description": "Creates a new Shopify store, with no need for an existing account.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `CreatePreviewStoreResult` schema.\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"const\": \"success\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"store\": {\n \"$ref\": \"#/definitions/PreviewStore\"\n },\n \"next_steps\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n },\n \"required\": [\n \"status\",\n \"message\",\n \"store\",\n \"next_steps\"\n ],\n \"additionalProperties\": false,\n \"title\": \"CreatePreviewStoreResult\",\n \"definitions\": {\n \"PreviewStore\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"type\": \"string\"\n },\n \"name\": {\n \"type\": \"string\"\n },\n \"subdomain\": {\n \"type\": \"string\"\n },\n \"country\": {\n \"type\": \"string\"\n },\n \"storefrontUrl\": {\n \"type\": \"string\"\n },\n \"type\": {\n \"type\": \"string\",\n \"const\": \"preview\"\n },\n \"authScopes\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n },\n \"description\": \"Preapproved Admin API scopes for the preview store.\"\n }\n },\n \"required\": [\n \"id\",\n \"name\",\n \"subdomain\",\n \"storefrontUrl\"\n ],\n \"additionalProperties\": false\n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "examples": [ "<%= config.bin %> <%= command.id %> --name \"Lavender Candles\"", "<%= config.bin %> <%= command.id %> --name \"Lavender Candles\" --country US", "<%= config.bin %> <%= command.id %> --name \"Lavender Candles\" --json" ], "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" }, "no-input": { "description": "Disable interactive prompts and browser authentication.", "env": "SHOPIFY_FLAG_NO_INPUT", "name": "no-input", "allowNo": false, "type": "boolean" }, "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. May include sensitive data.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "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" }, "name": { "description": "The name of the store.", "env": "SHOPIFY_FLAG_PREVIEW_STORE_NAME", "name": "name", "required": false, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "country": { "description": "Two-letter country code for the store, such as US, CA, or GB. Follows the ISO 3166-1 alpha-2 standard.", "env": "SHOPIFY_FLAG_STORE_COUNTRY", "name": "country", "required": false, "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "store:create:preview", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": true, "summary": "Create a preview Shopify store.", "descriptionWithMarkdown": "Creates a new Shopify store, with no need for an existing account.", "customPluginName": "@shopify/store" }, "store:delete": { "aliases": [], "args": {}, "description": "Deletes a dev store from your organization.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `DeleteDevStoreResult` schema.\n\n```json\n{\n \"anyOf\": [\n {\n \"type\": \"object\",\n \"properties\": {\n \"store\": {\n \"$ref\": \"#/definitions/DeletedStore\"\n },\n \"organization\": {\n \"$ref\": \"#/definitions/StoreOrganization\"\n },\n \"message\": {\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"store\",\n \"organization\"\n ],\n \"additionalProperties\": false\n },\n {\n \"$ref\": \"#/definitions/StoreCommandError\"\n }\n ],\n \"title\": \"DeleteDevStoreResult\",\n \"definitions\": {\n \"DeletedStore\": {\n \"type\": \"object\",\n \"properties\": {\n \"domain\": {\n \"type\": \"string\"\n },\n \"deletionRequested\": {\n \"type\": \"boolean\",\n \"const\": true\n },\n \"deletionConfirmed\": {\n \"type\": \"boolean\"\n }\n },\n \"required\": [\n \"domain\",\n \"deletionRequested\",\n \"deletionConfirmed\"\n ],\n \"additionalProperties\": false\n },\n \"StoreOrganization\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"type\": \"string\"\n },\n \"name\": {\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"id\",\n \"name\"\n ],\n \"additionalProperties\": false\n },\n \"StoreCommandError\": {\n \"type\": \"object\",\n \"properties\": {\n \"error\": {\n \"type\": \"boolean\",\n \"const\": true\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"nextSteps\": {\n \"type\": \"array\",\n \"items\": {},\n \"description\": \"Suggested next steps, as text or formatted UI tokens.\"\n },\n \"exitCode\": {\n \"type\": \"number\",\n \"const\": 1\n }\n },\n \"required\": [\n \"error\",\n \"message\",\n \"nextSteps\",\n \"exitCode\"\n ],\n \"additionalProperties\": false\n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "examples": [ "<%= config.bin %> <%= command.id %> --store shop.myshopify.com --organization-id 1234567", "<%= config.bin %> <%= command.id %> --store shop.myshopify.com --organization-id 1234567 --json", "<%= config.bin %> <%= command.id %> --store shop.myshopify.com --organization-id 1234567 --force" ], "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" }, "no-input": { "description": "Disable interactive prompts and browser authentication.", "env": "SHOPIFY_FLAG_NO_INPUT", "name": "no-input", "allowNo": false, "type": "boolean" }, "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. May include sensitive data.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "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": "The myshopify.com domain of the store.", "env": "SHOPIFY_FLAG_STORE", "name": "store", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "organization-id": { "description": "The numeric organization ID. Auto-selects if you belong to a single organization.", "env": "SHOPIFY_FLAG_ORGANIZATION_ID", "name": "organization-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "force": { "char": "f", "description": "Skip confirmation. Required if non interactive.", "env": "SHOPIFY_FLAG_FORCE", "name": "force", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "store:delete", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": true, "summary": "Delete a dev store.", "enableJsonFlag": false, "descriptionWithMarkdown": "Deletes a dev store from your organization.", "customPluginName": "@shopify/store" }, "store:execute": { "aliases": [], "args": {}, "description": "Executes an Admin API GraphQL query or mutation on the specified store using previously stored app authentication.\n\nRun `shopify store auth` first to create stored auth for the store.\n\nMutations are disabled by default. Re-run with `--allow-mutations` if you intend to modify store data.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `StoreExecuteResult` schema.\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"data\": {\n \"anyOf\": [\n {\n \"type\": \"object\",\n \"additionalProperties\": {}\n },\n {\n \"type\": \"null\"\n }\n ],\n \"description\": \"GraphQL response data, preserving query fields and aliases.\"\n },\n \"extensions\": {\n \"type\": \"object\",\n \"additionalProperties\": {},\n \"description\": \"Response-level GraphQL metadata, when returned by the API.\"\n }\n },\n \"required\": [\n \"data\"\n ],\n \"additionalProperties\": false,\n \"title\": \"StoreExecuteResult\",\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "examples": [ "<%= config.bin %> <%= command.id %> --store shop.myshopify.com --query \"query { shop { name } }\"", "<%= config.bin %> <%= command.id %> --store shop.myshopify.com --query-file ./operation.graphql --variables '{\"id\":\"gid://shopify/Product/1\"}'", "<%= config.bin %> <%= command.id %> --store shop.myshopify.com --query \"mutation { shop { id } }\" --allow-mutations", "<%= config.bin %> <%= command.id %> --store shop.myshopify.com --query \"query { shop { name } }\" --json" ], "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" }, "no-input": { "description": "Disable interactive prompts and browser authentication.", "env": "SHOPIFY_FLAG_NO_INPUT", "name": "no-input", "allowNo": false, "type": "boolean" }, "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. May include sensitive data.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "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" }, "query": { "char": "q", "description": "The GraphQL query or mutation, as a string.", "env": "SHOPIFY_FLAG_QUERY", "name": "query", "required": false, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "query-file": { "description": "Path to a file containing the GraphQL query or mutation. Can't be used with --query.", "env": "SHOPIFY_FLAG_QUERY_FILE", "name": "query-file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "variables": { "char": "v", "description": "The values for any GraphQL variables in your query or mutation, in JSON format.", "env": "SHOPIFY_FLAG_VARIABLES", "exclusive": [ "variable-file" ], "name": "variables", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "variable-file": { "description": "Path to a file containing GraphQL variables in JSON format. Can't be used with --variables.", "env": "SHOPIFY_FLAG_VARIABLE_FILE", "exclusive": [ "variables" ], "name": "variable-file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "store": { "char": "s", "description": "The myshopify.com domain of the store.", "env": "SHOPIFY_FLAG_STORE", "name": "store", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "version": { "description": "The API version to use for the query or mutation. Defaults to the latest stable version.", "env": "SHOPIFY_FLAG_VERSION", "name": "version", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "output-file": { "description": "The file name where results should be written, instead of STDOUT.", "env": "SHOPIFY_FLAG_OUTPUT_FILE", "name": "output-file", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "allow-mutations": { "description": "Allow GraphQL mutations to run against the target store.", "env": "SHOPIFY_FLAG_ALLOW_MUTATIONS", "name": "allow-mutations", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "store:execute", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": true, "summary": "Execute GraphQL queries and mutations on a store.", "descriptionWithMarkdown": "Executes an Admin API GraphQL query or mutation on the specified store using previously stored app authentication.\n\nRun `shopify store auth` first to create stored auth for the store.\n\nMutations are disabled by default. Re-run with `--allow-mutations` if you intend to modify store data.", "customPluginName": "@shopify/store" }, "store:graphiql": { "aliases": [], "args": {}, "description": "Opens an authenticated Admin API GraphiQL UI for the specified store using previously stored app authentication.\n\nRun `shopify store auth` first to create stored auth for the store.\n\nMutations are disabled by default. Re-run with `--allow-mutations` if you intend to modify store data.", "examples": [ "<%= config.bin %> <%= command.id %> --store shop.myshopify.com", "<%= config.bin %> <%= command.id %> --store shop.myshopify.com --allow-mutations", "<%= config.bin %> <%= command.id %> --store shop.myshopify.com --port 9123" ], "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" }, "no-input": { "description": "Disable interactive prompts and browser authentication.", "env": "SHOPIFY_FLAG_NO_INPUT", "name": "no-input", "allowNo": false, "type": "boolean" }, "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. May include sensitive data.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "allowNo": false, "type": "boolean" }, "store": { "char": "s", "description": "The myshopify.com domain of the store.", "env": "SHOPIFY_FLAG_STORE", "name": "store", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "port": { "description": "Local port for the GraphiQL server. Must be between 1 and 65535.", "env": "SHOPIFY_FLAG_PORT", "name": "port", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "allow-mutations": { "description": "Allow GraphQL mutations to run against the target store.", "env": "SHOPIFY_FLAG_ALLOW_MUTATIONS", "name": "allow-mutations", "allowNo": false, "type": "boolean" }, "variables": { "char": "v", "description": "The values for any GraphQL variables in your query or mutation, in JSON format.", "env": "SHOPIFY_FLAG_VARIABLES", "name": "variables", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "version": { "description": "The API version to use in GraphiQL. Defaults to the latest stable version.", "env": "SHOPIFY_FLAG_VERSION", "name": "version", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "store:graphiql", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": true, "summary": "Open a local GraphiQL UI for a store.", "descriptionWithMarkdown": "Opens an authenticated Admin API GraphiQL UI for the specified store using previously stored app authentication.\n\nRun `shopify store auth` first to create stored auth for the store.\n\nMutations are disabled by default. Re-run with `--allow-mutations` if you intend to modify store data.", "customPluginName": "@shopify/store" }, "store:info": { "aliases": [], "args": {}, "description": "Returns available metadata about a store you have access to, such as its id, display name, subdomain, organization, store owner, type, plan, feature preview, admin URL, and access and save URLs for preview stores.\n\nSome details may be omitted when they are not available for the store.\n\nUse `--json` for machine-readable output.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `StoreInfoResult` schema.\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"type\": \"string\"\n },\n \"displayName\": {\n \"type\": \"string\"\n },\n \"subdomain\": {\n \"type\": \"string\"\n },\n \"organizationId\": {\n \"type\": \"string\"\n },\n \"organizationName\": {\n \"type\": \"string\"\n },\n \"storeOwner\": {\n \"$ref\": \"#/definitions/StoreInfoStoreOwner\"\n },\n \"type\": {\n \"type\": \"string\"\n },\n \"country\": {\n \"type\": \"string\",\n \"description\": \"The country selected when creating the preview store, if specified.\"\n },\n \"plan\": {\n \"type\": \"string\"\n },\n \"featurePreview\": {\n \"type\": \"string\"\n },\n \"adminUrl\": {\n \"type\": \"string\"\n },\n \"accessUrl\": {\n \"type\": \"string\"\n },\n \"saveUrl\": {\n \"type\": \"string\"\n },\n \"authScopes\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n },\n \"required\": [\n \"subdomain\"\n ],\n \"additionalProperties\": false,\n \"title\": \"StoreInfoResult\",\n \"definitions\": {\n \"StoreInfoStoreOwner\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"email\": {\n \"type\": \"string\"\n }\n },\n \"additionalProperties\": false\n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "examples": [ "<%= config.bin %> <%= command.id %> --store shop.myshopify.com", "<%= config.bin %> <%= command.id %> --store shop.myshopify.com --json" ], "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" }, "no-input": { "description": "Disable interactive prompts and browser authentication.", "env": "SHOPIFY_FLAG_NO_INPUT", "name": "no-input", "allowNo": false, "type": "boolean" }, "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. May include sensitive data.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "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": "The myshopify.com domain of the store.", "env": "SHOPIFY_FLAG_STORE", "name": "store", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "store:info", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": true, "summary": "Surface metadata about a Shopify store.", "descriptionWithMarkdown": "Returns available metadata about a store you have access to, such as its id, display name, subdomain, organization, store owner, type, plan, feature preview, admin URL, and access and save URLs for preview stores.\n\nSome details may be omitted when they are not available for the store.\n\nUse `--json` for machine-readable output.", "customPluginName": "@shopify/store" }, "store:list": { "aliases": [], "args": {}, "description": "Lists stores in a Shopify organization available to the current CLI account.\n\nWhen more than one organization is available, the command prompts you to pick one unless you provide `--organization-id`. In that case, `--organization-id` is required in non-interactive environments.\n\nRun `<%= config.bin %> organization list` to find organization IDs.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `StoreListResult` schema.\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"stores\": {\n \"type\": \"array\",\n \"items\": {\n \"$ref\": \"#/definitions/StoreListEntry\"\n }\n },\n \"organization\": {\n \"$ref\": \"#/definitions/StoreListOrganization\"\n },\n \"storeType\": {\n \"type\": \"string\",\n \"enum\": [\n \"dev\",\n \"production\",\n \"client-transfer\",\n \"collaborator\"\n ]\n },\n \"notice\": {\n \"type\": \"string\"\n },\n \"truncated\": {\n \"type\": \"boolean\"\n }\n },\n \"required\": [\n \"stores\"\n ],\n \"additionalProperties\": false,\n \"title\": \"StoreListResult\",\n \"definitions\": {\n \"StoreListEntry\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"type\": \"string\"\n },\n \"store\": {\n \"type\": \"string\"\n },\n \"primaryDomain\": {\n \"type\": \"string\",\n \"description\": \"The primary storefront hostname, which may be a custom domain.\"\n },\n \"createdAt\": {\n \"type\": \"string\"\n },\n \"organizationId\": {\n \"type\": \"string\"\n },\n \"organizationName\": {\n \"type\": \"string\"\n },\n \"name\": {\n \"type\": \"string\"\n },\n \"type\": {\n \"type\": \"string\"\n },\n \"plan\": {\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"store\",\n \"createdAt\",\n \"organizationId\",\n \"organizationName\"\n ],\n \"additionalProperties\": false\n },\n \"StoreListOrganization\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"type\": \"string\"\n },\n \"name\": {\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"id\",\n \"name\"\n ],\n \"additionalProperties\": false\n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "examples": [ "<%= config.bin %> <%= command.id %>", "<%= config.bin %> <%= command.id %> --organization-id 1234567", "<%= config.bin %> <%= command.id %> --type dev", "<%= config.bin %> <%= command.id %> --json" ], "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" }, "no-input": { "description": "Disable interactive prompts and browser authentication.", "env": "SHOPIFY_FLAG_NO_INPUT", "name": "no-input", "allowNo": false, "type": "boolean" }, "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. May include sensitive data.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "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" }, "organization-id": { "description": "The numeric organization ID. Auto-selects if you belong to a single organization. Required if non interactive when more than one organization is available.", "env": "SHOPIFY_FLAG_ORGANIZATION_ID", "name": "organization-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "type": { "description": "List only stores of this type.", "env": "SHOPIFY_FLAG_STORE_TYPE", "name": "type", "hasDynamicHelp": false, "multiple": false, "options": [ "dev", "production", "client-transfer", "collaborator" ], "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "store:list", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": true, "summary": "List stores in a Shopify organization.", "descriptionWithMarkdown": "Lists stores in a Shopify organization available to the current CLI account.\n\nWhen more than one organization is available, the command prompts you to pick one unless you provide `--organization-id`. In that case, `--organization-id` is required in non-interactive environments.\n\nRun `<%= config.bin %> organization list` to find organization IDs.", "customPluginName": "@shopify/store" }, "store:open": { "aliases": [], "args": {}, "description": "Opens the storefront for a store you have access to in your default web browser.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `OpenStoreResult` schema.\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"storeDomain\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"pattern\": \"^[^.]+\\\\.myshopify\\\\.com$\"\n },\n {\n \"type\": \"null\"\n }\n ]\n },\n \"url\": {\n \"type\": \"string\",\n \"format\": \"uri\"\n },\n \"opened\": {\n \"type\": \"boolean\"\n }\n },\n \"required\": [\n \"storeDomain\",\n \"url\",\n \"opened\"\n ],\n \"additionalProperties\": false,\n \"title\": \"OpenStoreResult\",\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "examples": [ "<%= config.bin %> <%= command.id %> --store shop.myshopify.com" ], "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" }, "no-input": { "description": "Disable interactive prompts and browser authentication.", "env": "SHOPIFY_FLAG_NO_INPUT", "name": "no-input", "allowNo": false, "type": "boolean" }, "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. May include sensitive data.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "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": "The myshopify.com domain of the store.", "env": "SHOPIFY_FLAG_STORE", "name": "store", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "store:open", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": true, "summary": "Open your Shopify store in the default web browser.", "descriptionWithMarkdown": "Opens the storefront for a store you have access to in your default web browser.", "customPluginName": "@shopify/store" }, "search": { "aliases": [], "args": { "query": { "name": "query" } }, "description": "Search shopify.dev for the most relevant content matching a query. Best for discovery — surfacing the relevant pieces of documentation for a topic, rather than retrieving a whole document. To download a full document verbatim, use `doc fetch`.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `SearchResult` schema.\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"url\": {\n \"type\": \"string\",\n \"format\": \"uri\"\n }\n },\n \"required\": [\n \"url\"\n ],\n \"additionalProperties\": false,\n \"title\": \"SearchResult\",\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "examples": [ "# open the search modal on Shopify.dev\n shopify search\n\n # search for a term on Shopify.dev\n shopify search \n\n # search for a phrase on Shopify.dev\n shopify search \"\"\n " ], "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" }, "no-input": { "description": "Disable interactive prompts and browser authentication.", "env": "SHOPIFY_FLAG_NO_INPUT", "name": "no-input", "allowNo": false, "type": "boolean" }, "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. May include sensitive data.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "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": "search", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": true, "usage": "search [query]", "enableJsonFlag": false, "descriptionWithMarkdown": "Search shopify.dev for the most relevant content matching a query. Best for discovery — surfacing the relevant pieces of documentation for a topic, rather than retrieving a whole document. To download a full document verbatim, use `doc fetch`." }, "upgrade": { "aliases": [], "args": {}, "description": "Upgrades Shopify CLI using your package manager.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `UpgradeResult` schema.\n\n```json\n{\n \"anyOf\": [\n {\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"const\": \"success\"\n },\n \"changed\": {\n \"type\": \"boolean\",\n \"description\": \"Whether the verified installed version differs from previousVersion.\"\n },\n \"scope\": {\n \"type\": \"string\",\n \"const\": \"global\"\n },\n \"previousVersion\": {\n \"type\": \"string\",\n \"minLength\": 1\n },\n \"version\": {\n \"type\": \"string\",\n \"minLength\": 1\n },\n \"packageManager\": {\n \"type\": \"string\",\n \"enum\": [\n \"npm\",\n \"pnpm\",\n \"yarn\",\n \"bun\",\n \"homebrew\"\n ]\n }\n },\n \"required\": [\n \"status\",\n \"changed\",\n \"scope\",\n \"previousVersion\",\n \"version\",\n \"packageManager\"\n ],\n \"additionalProperties\": false\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"const\": \"success\"\n },\n \"changed\": {\n \"type\": \"null\",\n \"description\": \"Null because local dependency changes and installed versions are not verified.\"\n },\n \"scope\": {\n \"type\": \"string\",\n \"const\": \"local\"\n },\n \"directory\": {\n \"type\": \"string\"\n },\n \"previousVersion\": {\n \"type\": \"string\",\n \"minLength\": 1\n },\n \"availableVersion\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"minLength\": 1\n },\n {\n \"type\": \"null\"\n }\n ],\n \"description\": \"The available registry version, or null when unknown.\"\n },\n \"packages\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\",\n \"minLength\": 1\n }\n }\n },\n \"required\": [\n \"status\",\n \"changed\",\n \"scope\",\n \"directory\",\n \"previousVersion\",\n \"availableVersion\",\n \"packages\"\n ],\n \"additionalProperties\": false\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"const\": \"skipped\"\n },\n \"reason\": {\n \"type\": \"string\",\n \"enum\": [\n \"development\",\n \"local-autoupgrade\",\n \"dependency-not-found\"\n ]\n },\n \"scope\": {\n \"type\": \"string\",\n \"enum\": [\n \"global\",\n \"local\"\n ]\n }\n },\n \"required\": [\n \"status\",\n \"reason\",\n \"scope\"\n ],\n \"additionalProperties\": false\n }\n ],\n \"title\": \"UpgradeResult\",\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" }, "no-input": { "description": "Disable interactive prompts and browser authentication.", "env": "SHOPIFY_FLAG_NO_INPUT", "name": "no-input", "allowNo": false, "type": "boolean" }, "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. May include sensitive data.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "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": "upgrade", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": true, "summary": "Upgrades Shopify CLI.", "enableJsonFlag": false, "descriptionWithMarkdown": "Upgrades Shopify CLI using your package manager." }, "version": { "aliases": [], "args": {}, "description": "Shopify CLI version currently installed.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `VersionResult` schema.\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"version\": {\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"version\"\n ],\n \"additionalProperties\": false,\n \"title\": \"VersionResult\",\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" }, "no-input": { "description": "Disable interactive prompts and browser authentication.", "env": "SHOPIFY_FLAG_NO_INPUT", "name": "no-input", "allowNo": false, "type": "boolean" }, "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. May include sensitive data.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "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": "version", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": true, "enableJsonFlag": false, "descriptionWithMarkdown": "Shopify CLI version currently installed." }, "send-analytics": { "aliases": [], "args": {}, "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hidden": true, "hiddenAliases": [], "id": "send-analytics", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": true, "enableJsonFlag": false }, "help": { "aliases": [], "args": { "command": { "description": "Command to show help for.", "name": "command", "required": false } }, "description": "Display help for Shopify CLI\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `HelpResult` schema.\n\n```json\n{\n \"anyOf\": [\n {\n \"type\": \"object\",\n \"properties\": {\n \"kind\": {\n \"type\": \"string\",\n \"const\": \"root\"\n },\n \"commands\": {\n \"type\": \"array\",\n \"items\": {\n \"$ref\": \"#/definitions/HelpCommandSummary\"\n }\n },\n \"topics\": {\n \"type\": \"array\",\n \"items\": {\n \"$ref\": \"#/definitions/HelpTopic\"\n }\n }\n },\n \"required\": [\n \"kind\",\n \"commands\",\n \"topics\"\n ],\n \"additionalProperties\": false\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"kind\": {\n \"type\": \"string\",\n \"const\": \"topic\"\n },\n \"topic\": {\n \"$ref\": \"#/definitions/HelpTopic\"\n },\n \"commands\": {\n \"$ref\": \"#/definitions/HelpResult/anyOf/0/properties/commands\"\n },\n \"topics\": {\n \"$ref\": \"#/definitions/HelpResult/anyOf/0/properties/topics\"\n }\n },\n \"required\": [\n \"kind\",\n \"topic\",\n \"commands\",\n \"topics\"\n ],\n \"additionalProperties\": false\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"kind\": {\n \"type\": \"string\",\n \"const\": \"command\"\n },\n \"command\": {\n \"$ref\": \"#/definitions/HelpCommand\"\n },\n \"commands\": {\n \"$ref\": \"#/definitions/HelpResult/anyOf/0/properties/commands\"\n },\n \"topics\": {\n \"$ref\": \"#/definitions/HelpResult/anyOf/0/properties/topics\"\n }\n },\n \"required\": [\n \"kind\",\n \"command\",\n \"commands\",\n \"topics\"\n ],\n \"additionalProperties\": false\n }\n ],\n \"title\": \"HelpResult\",\n \"definitions\": {\n \"HelpCommandSummary\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"type\": \"string\"\n },\n \"summary\": {\n \"type\": \"string\"\n },\n \"hidden\": {\n \"type\": \"boolean\",\n \"default\": false\n }\n },\n \"required\": [\n \"id\"\n ],\n \"additionalProperties\": false\n },\n \"HelpTopic\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"description\": {\n \"type\": \"string\"\n },\n \"hidden\": {\n \"type\": \"boolean\",\n \"default\": false\n }\n },\n \"required\": [\n \"name\"\n ],\n \"additionalProperties\": false\n },\n \"HelpArgument\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"description\": {\n \"type\": \"string\"\n },\n \"required\": {\n \"type\": \"boolean\",\n \"default\": false\n },\n \"hidden\": {\n \"type\": \"boolean\",\n \"default\": false\n },\n \"options\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n },\n \"default\": {}\n },\n \"required\": [\n \"name\"\n ],\n \"additionalProperties\": false\n },\n \"HelpFlag\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"boolean\",\n \"option\"\n ]\n },\n \"char\": {\n \"type\": \"string\"\n },\n \"summary\": {\n \"type\": \"string\"\n },\n \"description\": {\n \"type\": \"string\"\n },\n \"env\": {\n \"type\": \"string\"\n },\n \"required\": {\n \"type\": \"boolean\",\n \"default\": false\n },\n \"hidden\": {\n \"type\": \"boolean\",\n \"default\": false\n },\n \"options\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n },\n \"default\": {},\n \"multiple\": {\n \"type\": \"boolean\"\n },\n \"allowNo\": {\n \"type\": \"boolean\"\n },\n \"aliases\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n },\n \"dependsOn\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n },\n \"exclusive\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n },\n \"exactlyOne\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n },\n \"required\": [\n \"name\",\n \"type\"\n ],\n \"additionalProperties\": false\n },\n \"HelpCommand\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"$ref\": \"#/definitions/HelpCommandSummary/properties/id\"\n },\n \"summary\": {\n \"$ref\": \"#/definitions/HelpCommandSummary/properties/summary\"\n },\n \"hidden\": {\n \"$ref\": \"#/definitions/HelpCommandSummary/properties/hidden\"\n },\n \"description\": {\n \"type\": \"string\"\n },\n \"aliases\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n },\n \"usage\": {\n \"anyOf\": [\n {\n \"type\": \"string\"\n },\n {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n ]\n },\n \"examples\": {\n \"type\": \"array\",\n \"items\": {\n \"anyOf\": [\n {\n \"type\": \"string\"\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"description\": {\n \"type\": \"string\"\n },\n \"command\": {\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"description\",\n \"command\"\n ],\n \"additionalProperties\": false\n }\n ]\n }\n },\n \"strict\": {\n \"type\": \"boolean\",\n \"default\": true\n },\n \"args\": {\n \"type\": \"object\",\n \"additionalProperties\": {\n \"$ref\": \"#/definitions/HelpArgument\"\n }\n },\n \"flags\": {\n \"type\": \"object\",\n \"additionalProperties\": {\n \"$ref\": \"#/definitions/HelpFlag\"\n }\n }\n },\n \"required\": [\n \"id\",\n \"aliases\",\n \"args\",\n \"flags\"\n ],\n \"additionalProperties\": false\n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "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" }, "nested-commands": { "char": "n", "description": "Include all nested commands in the output.", "env": "SHOPIFY_FLAG_CLI_NESTED_COMMANDS", "name": "nested-commands", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "help", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": false, "usage": "help [command] [flags]", "enableJsonFlag": false, "descriptionWithMarkdown": "Display help for Shopify CLI" }, "auth:logout": { "aliases": [], "args": {}, "description": "Logs you out of the Shopify account or Partner account and store.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `AuthLogoutResult` schema.\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"const\": \"success\"\n }\n },\n \"required\": [\n \"status\"\n ],\n \"additionalProperties\": false,\n \"title\": \"AuthLogoutResult\",\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" }, "no-input": { "description": "Disable interactive prompts and browser authentication.", "env": "SHOPIFY_FLAG_NO_INPUT", "name": "no-input", "allowNo": false, "type": "boolean" }, "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. May include sensitive data.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "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": "auth:logout", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": true, "enableJsonFlag": false, "descriptionWithMarkdown": "Logs you out of the Shopify account or Partner account and store." }, "auth:login": { "aliases": [], "args": {}, "description": "Logs you in to your Shopify account.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `AuthLoginResult` schema.\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"const\": \"success\"\n },\n \"alias\": {\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"status\",\n \"alias\"\n ],\n \"additionalProperties\": false,\n \"title\": \"AuthLoginResult\",\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" }, "no-input": { "description": "Disable interactive prompts and browser authentication.", "env": "SHOPIFY_FLAG_NO_INPUT", "name": "no-input", "allowNo": false, "type": "boolean" }, "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. May include sensitive data.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "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" }, "alias": { "description": "Alias of an existing session you want to use. Required if non interactive.", "env": "SHOPIFY_FLAG_AUTH_ALIAS", "name": "alias", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "auth:login", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": true, "enableJsonFlag": false, "descriptionWithMarkdown": "Logs you in to your Shopify account." }, "debug:command-flags": { "aliases": [], "args": {}, "description": "View all the available command flags", "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" }, "csv": { "description": "Output as CSV", "env": "SHOPIFY_FLAG_OUTPUT_CSV", "name": "csv", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hidden": true, "hiddenAliases": [], "id": "debug:command-flags", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": true, "enableJsonFlag": false }, "kitchen-sink": { "aliases": [], "args": {}, "description": "View all the available UI kit components", "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hidden": true, "hiddenAliases": [ "kitchen-sink all" ], "id": "kitchen-sink", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": true, "enableJsonFlag": false }, "kitchen-sink:async": { "aliases": [], "args": {}, "description": "View the UI kit components that process async tasks", "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hidden": true, "hiddenAliases": [], "id": "kitchen-sink:async", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": true, "enableJsonFlag": false }, "kitchen-sink:prompts": { "aliases": [], "args": {}, "description": "View the UI kit components prompts", "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hidden": true, "hiddenAliases": [], "id": "kitchen-sink:prompts", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": true, "enableJsonFlag": false }, "kitchen-sink:static": { "aliases": [], "args": {}, "description": "View the UI kit components that display static output", "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hidden": true, "hiddenAliases": [], "id": "kitchen-sink:static", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": true, "enableJsonFlag": false }, "doctor-release": { "aliases": [], "args": {}, "description": "Run CLI doctor-release tests", "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hidden": true, "hiddenAliases": [], "id": "doctor-release", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": true, "enableJsonFlag": false }, "doctor-release:theme": { "aliases": [], "args": {}, "description": "Run all theme command doctor-release tests", "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" }, "no-input": { "description": "Disable interactive prompts and browser authentication.", "env": "SHOPIFY_FLAG_NO_INPUT", "name": "no-input", "allowNo": false, "type": "boolean" }, "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. May include sensitive data.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "allowNo": false, "type": "boolean" }, "path": { "char": "p", "description": "The path to run tests in. Defaults to current directory.", "env": "SHOPIFY_FLAG_PATH", "name": "path", "default": "/home/runner/work/cli/cli/packages/cli-copy", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "environment": { "char": "e", "description": "The environment to use from shopify.theme.toml (required for store-connected tests).", "env": "SHOPIFY_FLAG_ENVIRONMENT", "name": "environment", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "store": { "char": "s", "description": "Store URL (overrides environment).", "env": "SHOPIFY_FLAG_STORE", "name": "store", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "password": { "description": "Password from Theme Access app (overrides environment).", "env": "SHOPIFY_FLAG_PASSWORD", "name": "password", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hidden": true, "hiddenAliases": [], "id": "doctor-release:theme", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": true, "enableJsonFlag": false }, "doc:fetch": { "aliases": [], "args": {}, "description": "Download a complete document from shopify.dev. Every page on shopify.dev has a Markdown version, and that is what this tool returns. Use this to pull an entire document verbatim — for example, a set of instructions an agent follows like a centrally-served skill. Pass `--language` for the language of the app you are building so code examples match your stack. For finding the relevant pieces of content across shopify.dev instead, use `doc search`.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `DocFetchResult` schema.\n\n```json\n{\n \"anyOf\": [\n {\n \"type\": \"object\",\n \"properties\": {\n \"document\": {\n \"$ref\": \"#/definitions/Document\"\n }\n },\n \"required\": [\n \"document\"\n ],\n \"additionalProperties\": false\n },\n {\n \"$ref\": \"#/definitions/DocumentFile\"\n }\n ],\n \"title\": \"DocFetchResult\",\n \"definitions\": {\n \"Document\": {\n \"type\": \"object\",\n \"properties\": {\n \"url\": {\n \"type\": \"string\",\n \"format\": \"uri\",\n \"description\": \"The requested shopify.dev document URL.\"\n },\n \"content\": {\n \"type\": \"string\",\n \"description\": \"The document in Markdown, with the requested language filter applied.\"\n }\n },\n \"required\": [\n \"url\",\n \"content\"\n ],\n \"additionalProperties\": false\n },\n \"DocumentFile\": {\n \"type\": \"object\",\n \"properties\": {\n \"path\": {\n \"type\": \"string\",\n \"pattern\": \"^(?:\\\\/|[A-Za-z]:[\\\\\\\\/]|\\\\\\\\\\\\\\\\)\",\n \"description\": \"The absolute native path of the written file.\"\n },\n \"format\": {\n \"type\": \"string\",\n \"const\": \"markdown\",\n \"description\": \"The file contains the original Markdown document, not a JSON wrapper.\"\n }\n },\n \"required\": [\n \"path\",\n \"format\"\n ],\n \"additionalProperties\": false\n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "examples": [ "# fetch the Markdown version of a Shopify.dev page\nshopify doc fetch --url https://shopify.dev/docs/api/shopify-cli", "# filter code examples to the language of the app you are building\nshopify doc fetch --url https://shopify.dev/docs/api/shopify-cli --language ruby", "# save the document to a file instead of printing it\nshopify doc fetch --url https://shopify.dev/docs/api/shopify-cli --output docs/shopify-cli.md", "# return a typed document as JSON\nshopify doc fetch --url https://shopify.dev/docs/api/shopify-cli --json" ], "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" }, "no-input": { "description": "Disable interactive prompts and browser authentication.", "env": "SHOPIFY_FLAG_NO_INPUT", "name": "no-input", "allowNo": false, "type": "boolean" }, "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. May include sensitive data.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "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" }, "url": { "description": "The shopify.dev URL to fetch.", "env": "SHOPIFY_FLAG_URL", "name": "url", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "language": { "description": "Filter code examples in the returned Markdown to this language. Supply the language of the app you are building so examples match your stack. Optional — if omitted, or if shopify.dev does not recognize the language for a given page, the document includes examples in every language.", "env": "SHOPIFY_FLAG_LANGUAGE", "name": "language", "hasDynamicHelp": false, "multiple": false, "options": [ "javascript", "typescript", "python", "ruby", "php", "rust", "curl", "liquid", "graphql", "html" ], "type": "option" }, "output": { "description": "Write the document to this file path instead of printing it to stdout. With --json, stdout contains the absolute path and Markdown format of the written file.", "env": "SHOPIFY_FLAG_OUTPUT", "name": "output", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "doc:fetch", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": true, "enableJsonFlag": false, "descriptionWithMarkdown": "Download a complete document from shopify.dev. Every page on shopify.dev has a Markdown version, and that is what this tool returns. Use this to pull an entire document verbatim — for example, a set of instructions an agent follows like a centrally-served skill. Pass `--language` for the language of the app you are building so code examples match your stack. For finding the relevant pieces of content across shopify.dev instead, use `doc search`." }, "doc:search": { "aliases": [], "args": {}, "description": "Query the shopify.dev vector store and print the most relevant documentation chunks as JSON. Best for programmatic discovery — surfacing the relevant pieces of documentation for a topic, rather than retrieving a whole document. To download a full document verbatim, use `doc fetch`.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `DocSearchResult` schema.\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"results\": {\n \"type\": \"array\",\n \"items\": {\n \"$ref\": \"#/definitions/DocumentationSearchEntry\"\n },\n \"description\": \"The top matching chunks from one search request.\"\n },\n \"pageInfo\": {\n \"$ref\": \"#/definitions/PageInfo\"\n }\n },\n \"required\": [\n \"results\",\n \"pageInfo\"\n ],\n \"additionalProperties\": false,\n \"title\": \"DocSearchResult\",\n \"definitions\": {\n \"DocumentationSearchEntry\": {\n \"type\": \"object\",\n \"properties\": {\n \"score\": {\n \"type\": \"number\",\n \"description\": \"The relevance score returned by shopify.dev.\"\n },\n \"content\": {\n \"type\": \"string\",\n \"description\": \"The matching documentation chunk.\"\n },\n \"url\": {\n \"type\": \"string\",\n \"format\": \"uri\",\n \"description\": \"The URL of the matching document.\"\n },\n \"title\": {\n \"type\": \"string\",\n \"description\": \"The title of the matching document.\"\n },\n \"domain\": {\n \"type\": [\n \"string\",\n \"null\"\n ],\n \"description\": \"The documentation domain, or null when unavailable.\"\n }\n },\n \"required\": [\n \"score\",\n \"content\",\n \"url\",\n \"title\",\n \"domain\"\n ],\n \"additionalProperties\": false\n },\n \"PageInfo\": {\n \"type\": \"object\",\n \"properties\": {\n \"hasNextPage\": {\n \"type\": [\n \"boolean\",\n \"null\"\n ],\n \"description\": \"Whether more results are available, or null when unknown.\"\n }\n },\n \"required\": [\n \"hasNextPage\"\n ],\n \"additionalProperties\": false\n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "examples": [ "# search shopify.dev for a topic\n shopify doc search --query \"subscribe to webhooks\"\n\n # narrow the search to a specific API and version\n shopify doc search --query \"create a product\" --api-name admin --api-version latest", "# return typed documentation results as a JSON object\nshopify doc search --query \"subscribe to webhooks\" --json" ], "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" }, "no-input": { "description": "Disable interactive prompts and browser authentication.", "env": "SHOPIFY_FLAG_NO_INPUT", "name": "no-input", "allowNo": false, "type": "boolean" }, "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. May include sensitive data.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "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" }, "query": { "description": "The search query.", "env": "SHOPIFY_FLAG_QUERY", "name": "query", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "api-name": { "description": "Limit results to a specific API (for example: admin, storefront, hydrogen, functions). Unrecognized values are ignored.", "env": "SHOPIFY_FLAG_API_NAME", "name": "api-name", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "api-version": { "description": "Limit results to a specific API version (for example: 2025-10, latest, current).", "env": "SHOPIFY_FLAG_API_VERSION", "name": "api-version", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "doc:search", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": true, "enableJsonFlag": false, "descriptionWithMarkdown": "Query the shopify.dev vector store and print the most relevant documentation chunks as JSON. Best for programmatic discovery — surfacing the relevant pieces of documentation for a topic, rather than retrieving a whole document. To download a full document verbatim, use `doc fetch`." }, "docs:generate": { "aliases": [], "args": {}, "description": "Generate CLI commands documentation", "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hidden": true, "hiddenAliases": [], "id": "docs:generate", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": true, "enableJsonFlag": false }, "notifications:list": { "aliases": [], "args": {}, "description": "List current notifications configured for the CLI.", "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" }, "ignore-errors": { "description": "Don't fail if an error occurs.", "env": "SHOPIFY_FLAG_IGNORE_ERRORS", "hidden": false, "name": "ignore-errors", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hidden": true, "hiddenAliases": [], "id": "notifications:list", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": true, "enableJsonFlag": false }, "notifications:generate": { "aliases": [], "args": {}, "description": "Generate a notifications.json file for the the CLI, appending a new notification to the current file.", "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hidden": true, "hiddenAliases": [], "id": "notifications:generate", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": true, "enableJsonFlag": false }, "cache:clear": { "aliases": [], "args": {}, "description": "Clear the CLI cache, used to store some API responses and handle notifications status", "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hidden": true, "hiddenAliases": [], "id": "cache:clear", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": true, "enableJsonFlag": false }, "config:autoupgrade:off": { "aliases": [], "args": {}, "description": "Disable automatic upgrades for Shopify CLI.\n\n When auto-upgrade is disabled, Shopify CLI won't automatically update. Run `shopify upgrade` to update manually.\n\n To enable auto-upgrade, run `shopify config autoupgrade on`.\n\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `AutoUpgradeResult` schema.\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"enabled\": {\n \"type\": \"boolean\"\n }\n },\n \"required\": [\n \"enabled\"\n ],\n \"additionalProperties\": false,\n \"title\": \"AutoUpgradeResult\",\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" }, "no-input": { "description": "Disable interactive prompts and browser authentication.", "env": "SHOPIFY_FLAG_NO_INPUT", "name": "no-input", "allowNo": false, "type": "boolean" }, "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. May include sensitive data.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "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": "config:autoupgrade:off", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": true, "summary": "Disable automatic upgrades for Shopify CLI.", "enableJsonFlag": false, "descriptionWithMarkdown": "Disable automatic upgrades for Shopify CLI.\n\n When auto-upgrade is disabled, Shopify CLI won't automatically update. Run `shopify upgrade` to update manually.\n\n To enable auto-upgrade, run `shopify config autoupgrade on`.\n" }, "config:autoupgrade:on": { "aliases": [], "args": {}, "description": "Enable automatic upgrades for Shopify CLI.\n\n When auto-upgrade is enabled, Shopify CLI automatically updates to the latest version once per day. Major version upgrades are skipped and must be done manually.\n\n To disable auto-upgrade, run `shopify config autoupgrade off`.\n\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `AutoUpgradeResult` schema.\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"enabled\": {\n \"type\": \"boolean\"\n }\n },\n \"required\": [\n \"enabled\"\n ],\n \"additionalProperties\": false,\n \"title\": \"AutoUpgradeResult\",\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" }, "no-input": { "description": "Disable interactive prompts and browser authentication.", "env": "SHOPIFY_FLAG_NO_INPUT", "name": "no-input", "allowNo": false, "type": "boolean" }, "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. May include sensitive data.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "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": "config:autoupgrade:on", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": true, "summary": "Enable automatic upgrades for Shopify CLI.", "enableJsonFlag": false, "descriptionWithMarkdown": "Enable automatic upgrades for Shopify CLI.\n\n When auto-upgrade is enabled, Shopify CLI automatically updates to the latest version once per day. Major version upgrades are skipped and must be done manually.\n\n To disable auto-upgrade, run `shopify config autoupgrade off`.\n" }, "config:autoupgrade:status": { "aliases": [], "args": {}, "description": "Check whether auto-upgrade is enabled, disabled, or not yet configured.\n\n When auto-upgrade is enabled, Shopify CLI automatically updates to the latest version after each command.\n\n Run `shopify config autoupgrade on` or `shopify config autoupgrade off` to configure it.\n\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `AutoUpgradeResult` schema.\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"enabled\": {\n \"type\": \"boolean\"\n }\n },\n \"required\": [\n \"enabled\"\n ],\n \"additionalProperties\": false,\n \"title\": \"AutoUpgradeResult\",\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "flags": { "json-schema": { "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "allowNo": false, "type": "boolean" }, "no-input": { "description": "Disable interactive prompts and browser authentication.", "env": "SHOPIFY_FLAG_NO_INPUT", "name": "no-input", "allowNo": false, "type": "boolean" }, "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. May include sensitive data.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "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": "config:autoupgrade:status", "pluginAlias": "shopify", "pluginName": "shopify", "pluginType": "core", "strict": true, "summary": "Check whether auto-upgrade is enabled, disabled, or not yet configured.", "enableJsonFlag": false, "descriptionWithMarkdown": "Check whether auto-upgrade is enabled, disabled, or not yet configured.\n\n When auto-upgrade is enabled, Shopify CLI automatically updates to the latest version after each command.\n\n Run `shopify config autoupgrade on` or `shopify config autoupgrade off` to configure it.\n" } }, "version": "5.0.1" }