diff --git a/.changeset/quiet-json-schema-help.md b/.changeset/quiet-json-schema-help.md new file mode 100644 index 00000000000..e56d6e1725a --- /dev/null +++ b/.changeset/quiet-json-schema-help.md @@ -0,0 +1,6 @@ +--- +'@shopify/cli-kit': minor +'@shopify/cli': minor +--- + +Add `--json-schema` to print a command's result, error, and event schemas. diff --git a/docs-shopify.dev/generated/generated_docs_data_v2.json b/docs-shopify.dev/generated/generated_docs_data_v2.json index 2520c347e81..12be7d76b36 100644 --- a/docs-shopify.dev/generated/generated_docs_data_v2.json +++ b/docs-shopify.dev/generated/generated_docs_data_v2.json @@ -24,6 +24,15 @@ "isOptional": true, "environmentValue": "SHOPIFY_FLAG_CLIENT_ID" }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-build.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--json-schema", + "value": "''", + "description": "Print the command's JSON schemas.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON_SCHEMA" + }, { "filePath": "docs-shopify.dev/commands/interfaces/app-build.interface.ts", "syntaxKind": "PropertySignature", @@ -79,7 +88,7 @@ "environmentValue": "SHOPIFY_FLAG_APP_CONFIG" } ], - "value": "export interface appbuild {\n /**\n * Alias of the Shopify account to use for authentication.\n * @environment SHOPIFY_FLAG_AUTH_ALIAS\n */\n '--auth-alias '?: string\n\n /**\n * The Client ID of your app.\n * @environment SHOPIFY_FLAG_CLIENT_ID\n */\n '--client-id '?: string\n\n /**\n * The name of the app configuration.\n * @environment SHOPIFY_FLAG_APP_CONFIG\n */\n '-c, --config '?: string\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * The path to your app directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Reset all your settings.\n * @environment SHOPIFY_FLAG_RESET\n */\n '--reset'?: ''\n\n /**\n * Skips the installation of dependencies. Deprecated, use workspaces instead.\n * @environment SHOPIFY_FLAG_SKIP_DEPENDENCIES_INSTALLATION\n */\n '--skip-dependencies-installation'?: ''\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" + "value": "export interface appbuild {\n /**\n * Alias of the Shopify account to use for authentication.\n * @environment SHOPIFY_FLAG_AUTH_ALIAS\n */\n '--auth-alias '?: string\n\n /**\n * The Client ID of your app.\n * @environment SHOPIFY_FLAG_CLIENT_ID\n */\n '--client-id '?: string\n\n /**\n * The name of the app configuration.\n * @environment SHOPIFY_FLAG_APP_CONFIG\n */\n '-c, --config '?: string\n\n /**\n * Print the command's JSON schemas.\n * @environment SHOPIFY_FLAG_JSON_SCHEMA\n */\n '--json-schema'?: ''\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * The path to your app directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Reset all your settings.\n * @environment SHOPIFY_FLAG_RESET\n */\n '--reset'?: ''\n\n /**\n * Skips the installation of dependencies. Deprecated, use workspaces instead.\n * @environment SHOPIFY_FLAG_SKIP_DEPENDENCIES_INSTALLATION\n */\n '--skip-dependencies-installation'?: ''\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" } }, "appbulkcancel": { @@ -115,6 +124,15 @@ "description": "The bulk operation ID to cancel (numeric ID or full GID).", "environmentValue": "SHOPIFY_FLAG_ID" }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-bulk-cancel.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--json-schema", + "value": "''", + "description": "Print the command's JSON schemas.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON_SCHEMA" + }, { "filePath": "docs-shopify.dev/commands/interfaces/app-bulk-cancel.interface.ts", "syntaxKind": "PropertySignature", @@ -170,7 +188,7 @@ "environmentValue": "SHOPIFY_FLAG_STORE" } ], - "value": "export interface appbulkcancel {\n /**\n * Alias of the Shopify account to use for authentication.\n * @environment SHOPIFY_FLAG_AUTH_ALIAS\n */\n '--auth-alias '?: string\n\n /**\n * The Client ID of your app.\n * @environment SHOPIFY_FLAG_CLIENT_ID\n */\n '--client-id '?: string\n\n /**\n * The name of the app configuration.\n * @environment SHOPIFY_FLAG_APP_CONFIG\n */\n '-c, --config '?: string\n\n /**\n * The bulk operation ID to cancel (numeric ID or full GID).\n * @environment SHOPIFY_FLAG_ID\n */\n '--id ': string\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * The path to your app directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Reset all your settings.\n * @environment SHOPIFY_FLAG_RESET\n */\n '--reset'?: ''\n\n /**\n * The store domain. Must be an existing dev store.\n * @environment SHOPIFY_FLAG_STORE\n */\n '-s, --store '?: string\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" + "value": "export interface appbulkcancel {\n /**\n * Alias of the Shopify account to use for authentication.\n * @environment SHOPIFY_FLAG_AUTH_ALIAS\n */\n '--auth-alias '?: string\n\n /**\n * The Client ID of your app.\n * @environment SHOPIFY_FLAG_CLIENT_ID\n */\n '--client-id '?: string\n\n /**\n * The name of the app configuration.\n * @environment SHOPIFY_FLAG_APP_CONFIG\n */\n '-c, --config '?: string\n\n /**\n * The bulk operation ID to cancel (numeric ID or full GID).\n * @environment SHOPIFY_FLAG_ID\n */\n '--id ': string\n\n /**\n * Print the command's JSON schemas.\n * @environment SHOPIFY_FLAG_JSON_SCHEMA\n */\n '--json-schema'?: ''\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * The path to your app directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Reset all your settings.\n * @environment SHOPIFY_FLAG_RESET\n */\n '--reset'?: ''\n\n /**\n * The store domain. Must be an existing dev store.\n * @environment SHOPIFY_FLAG_STORE\n */\n '-s, --store '?: string\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" } }, "appbulkexecute": { @@ -198,6 +216,15 @@ "isOptional": true, "environmentValue": "SHOPIFY_FLAG_CLIENT_ID" }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-bulk-execute.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--json-schema", + "value": "''", + "description": "Print the command's JSON schemas.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON_SCHEMA" + }, { "filePath": "docs-shopify.dev/commands/interfaces/app-bulk-execute.interface.ts", "syntaxKind": "PropertySignature", @@ -316,7 +343,7 @@ "environmentValue": "SHOPIFY_FLAG_VARIABLES" } ], - "value": "export interface appbulkexecute {\n /**\n * Alias of the Shopify account to use for authentication.\n * @environment SHOPIFY_FLAG_AUTH_ALIAS\n */\n '--auth-alias '?: string\n\n /**\n * The Client ID of your app.\n * @environment SHOPIFY_FLAG_CLIENT_ID\n */\n '--client-id '?: string\n\n /**\n * The name of the app configuration.\n * @environment SHOPIFY_FLAG_APP_CONFIG\n */\n '-c, --config '?: string\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * The file path where results should be written if --watch is specified. If not specified, results will be written to STDOUT.\n * @environment SHOPIFY_FLAG_OUTPUT_FILE\n */\n '--output-file '?: string\n\n /**\n * The path to your app directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * The GraphQL query or mutation to run as a bulk operation.\n * @environment SHOPIFY_FLAG_QUERY\n */\n '-q, --query '?: string\n\n /**\n * Path to a file containing the GraphQL query or mutation. Can't be used with --query.\n * @environment SHOPIFY_FLAG_QUERY_FILE\n */\n '--query-file '?: string\n\n /**\n * Reset all your settings.\n * @environment SHOPIFY_FLAG_RESET\n */\n '--reset'?: ''\n\n /**\n * The store domain. Must be an existing dev store.\n * @environment SHOPIFY_FLAG_STORE\n */\n '-s, --store '?: string\n\n /**\n * Path to a file containing GraphQL variables in JSONL format (one JSON object per line). Can't be used with --variables.\n * @environment SHOPIFY_FLAG_VARIABLE_FILE\n */\n '--variable-file '?: string\n\n /**\n * The values for any GraphQL variables in your mutation, in JSON format. Can be specified multiple times.\n * @environment SHOPIFY_FLAG_VARIABLES\n */\n '-v, --variables '?: string\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n\n /**\n * The API version to use for the bulk operation. If not specified, uses the latest stable version.\n * @environment SHOPIFY_FLAG_VERSION\n */\n '--version '?: string\n\n /**\n * Wait for bulk operation results before exiting. Defaults to false.\n * @environment SHOPIFY_FLAG_WATCH\n */\n '--watch'?: ''\n}" + "value": "export interface appbulkexecute {\n /**\n * Alias of the Shopify account to use for authentication.\n * @environment SHOPIFY_FLAG_AUTH_ALIAS\n */\n '--auth-alias '?: string\n\n /**\n * The Client ID of your app.\n * @environment SHOPIFY_FLAG_CLIENT_ID\n */\n '--client-id '?: string\n\n /**\n * The name of the app configuration.\n * @environment SHOPIFY_FLAG_APP_CONFIG\n */\n '-c, --config '?: string\n\n /**\n * Print the command's JSON schemas.\n * @environment SHOPIFY_FLAG_JSON_SCHEMA\n */\n '--json-schema'?: ''\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * The file path where results should be written if --watch is specified. If not specified, results will be written to STDOUT.\n * @environment SHOPIFY_FLAG_OUTPUT_FILE\n */\n '--output-file '?: string\n\n /**\n * The path to your app directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * The GraphQL query or mutation to run as a bulk operation.\n * @environment SHOPIFY_FLAG_QUERY\n */\n '-q, --query '?: string\n\n /**\n * Path to a file containing the GraphQL query or mutation. Can't be used with --query.\n * @environment SHOPIFY_FLAG_QUERY_FILE\n */\n '--query-file '?: string\n\n /**\n * Reset all your settings.\n * @environment SHOPIFY_FLAG_RESET\n */\n '--reset'?: ''\n\n /**\n * The store domain. Must be an existing dev store.\n * @environment SHOPIFY_FLAG_STORE\n */\n '-s, --store '?: string\n\n /**\n * Path to a file containing GraphQL variables in JSONL format (one JSON object per line). Can't be used with --variables.\n * @environment SHOPIFY_FLAG_VARIABLE_FILE\n */\n '--variable-file '?: string\n\n /**\n * The values for any GraphQL variables in your mutation, in JSON format. Can be specified multiple times.\n * @environment SHOPIFY_FLAG_VARIABLES\n */\n '-v, --variables '?: string\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n\n /**\n * The API version to use for the bulk operation. If not specified, uses the latest stable version.\n * @environment SHOPIFY_FLAG_VERSION\n */\n '--version '?: string\n\n /**\n * Wait for bulk operation results before exiting. Defaults to false.\n * @environment SHOPIFY_FLAG_WATCH\n */\n '--watch'?: ''\n}" } }, "appbulkstatus": { @@ -353,6 +380,15 @@ "isOptional": true, "environmentValue": "SHOPIFY_FLAG_ID" }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-bulk-status.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--json-schema", + "value": "''", + "description": "Print the command's JSON schemas.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON_SCHEMA" + }, { "filePath": "docs-shopify.dev/commands/interfaces/app-bulk-status.interface.ts", "syntaxKind": "PropertySignature", @@ -408,7 +444,7 @@ "environmentValue": "SHOPIFY_FLAG_STORE" } ], - "value": "export interface appbulkstatus {\n /**\n * Alias of the Shopify account to use for authentication.\n * @environment SHOPIFY_FLAG_AUTH_ALIAS\n */\n '--auth-alias '?: string\n\n /**\n * The Client ID of your app.\n * @environment SHOPIFY_FLAG_CLIENT_ID\n */\n '--client-id '?: string\n\n /**\n * The name of the app configuration.\n * @environment SHOPIFY_FLAG_APP_CONFIG\n */\n '-c, --config '?: string\n\n /**\n * The bulk operation ID (numeric ID or full GID). If not provided, lists all bulk operations belonging to this app on this store in the last 7 days.\n * @environment SHOPIFY_FLAG_ID\n */\n '--id '?: string\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * The path to your app directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Reset all your settings.\n * @environment SHOPIFY_FLAG_RESET\n */\n '--reset'?: ''\n\n /**\n * The store domain. Must be an existing dev store.\n * @environment SHOPIFY_FLAG_STORE\n */\n '-s, --store '?: string\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" + "value": "export interface appbulkstatus {\n /**\n * Alias of the Shopify account to use for authentication.\n * @environment SHOPIFY_FLAG_AUTH_ALIAS\n */\n '--auth-alias '?: string\n\n /**\n * The Client ID of your app.\n * @environment SHOPIFY_FLAG_CLIENT_ID\n */\n '--client-id '?: string\n\n /**\n * The name of the app configuration.\n * @environment SHOPIFY_FLAG_APP_CONFIG\n */\n '-c, --config '?: string\n\n /**\n * The bulk operation ID (numeric ID or full GID). If not provided, lists all bulk operations belonging to this app on this store in the last 7 days.\n * @environment SHOPIFY_FLAG_ID\n */\n '--id '?: string\n\n /**\n * Print the command's JSON schemas.\n * @environment SHOPIFY_FLAG_JSON_SCHEMA\n */\n '--json-schema'?: ''\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * The path to your app directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Reset all your settings.\n * @environment SHOPIFY_FLAG_RESET\n */\n '--reset'?: ''\n\n /**\n * The store domain. Must be an existing dev store.\n * @environment SHOPIFY_FLAG_STORE\n */\n '-s, --store '?: string\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" } }, "appconfiglink": { @@ -454,6 +490,15 @@ "isOptional": true, "environmentValue": "SHOPIFY_FLAG_FORCE" }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-config-link.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--json-schema", + "value": "''", + "description": "Print the command's JSON schemas.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON_SCHEMA" + }, { "filePath": "docs-shopify.dev/commands/interfaces/app-config-link.interface.ts", "syntaxKind": "PropertySignature", @@ -500,7 +545,7 @@ "environmentValue": "SHOPIFY_FLAG_APP_CONFIG" } ], - "value": "export interface appconfiglink {\n /**\n * Alias of the Shopify account to use for authentication.\n * @environment SHOPIFY_FLAG_AUTH_ALIAS\n */\n '--auth-alias '?: string\n\n /**\n * The Client ID of your app. Required if non interactive.\n * @environment SHOPIFY_FLAG_CLIENT_ID\n */\n '--client-id '?: string\n\n /**\n * The name of the app configuration.\n * @environment SHOPIFY_FLAG_APP_CONFIG\n */\n '-c, --config '?: string\n\n /**\n * The name of the app configuration file to create or overwrite.\n * @environment SHOPIFY_FLAG_APP_CONFIG_FILE_NAME\n */\n '--file-name '?: string\n\n /**\n * Overwrite an existing configuration file without prompting.\n * @environment SHOPIFY_FLAG_FORCE\n */\n '--force'?: ''\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * The path to your app directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Reset all your settings.\n * @environment SHOPIFY_FLAG_RESET\n */\n '--reset'?: ''\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" + "value": "export interface appconfiglink {\n /**\n * Alias of the Shopify account to use for authentication.\n * @environment SHOPIFY_FLAG_AUTH_ALIAS\n */\n '--auth-alias '?: string\n\n /**\n * The Client ID of your app. Required if non interactive.\n * @environment SHOPIFY_FLAG_CLIENT_ID\n */\n '--client-id '?: string\n\n /**\n * The name of the app configuration.\n * @environment SHOPIFY_FLAG_APP_CONFIG\n */\n '-c, --config '?: string\n\n /**\n * The name of the app configuration file to create or overwrite.\n * @environment SHOPIFY_FLAG_APP_CONFIG_FILE_NAME\n */\n '--file-name '?: string\n\n /**\n * Overwrite an existing configuration file without prompting.\n * @environment SHOPIFY_FLAG_FORCE\n */\n '--force'?: ''\n\n /**\n * Print the command's JSON schemas.\n * @environment SHOPIFY_FLAG_JSON_SCHEMA\n */\n '--json-schema'?: ''\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * The path to your app directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Reset all your settings.\n * @environment SHOPIFY_FLAG_RESET\n */\n '--reset'?: ''\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" } }, "appconfigpull": { @@ -528,6 +573,15 @@ "isOptional": true, "environmentValue": "SHOPIFY_FLAG_CLIENT_ID" }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-config-pull.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--json-schema", + "value": "''", + "description": "Print the command's JSON schemas.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON_SCHEMA" + }, { "filePath": "docs-shopify.dev/commands/interfaces/app-config-pull.interface.ts", "syntaxKind": "PropertySignature", @@ -574,7 +628,7 @@ "environmentValue": "SHOPIFY_FLAG_APP_CONFIG" } ], - "value": "export interface appconfigpull {\n /**\n * Alias of the Shopify account to use for authentication.\n * @environment SHOPIFY_FLAG_AUTH_ALIAS\n */\n '--auth-alias '?: string\n\n /**\n * The Client ID of your app.\n * @environment SHOPIFY_FLAG_CLIENT_ID\n */\n '--client-id '?: string\n\n /**\n * The name of the app configuration.\n * @environment SHOPIFY_FLAG_APP_CONFIG\n */\n '-c, --config '?: string\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * The path to your app directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Reset all your settings.\n * @environment SHOPIFY_FLAG_RESET\n */\n '--reset'?: ''\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" + "value": "export interface appconfigpull {\n /**\n * Alias of the Shopify account to use for authentication.\n * @environment SHOPIFY_FLAG_AUTH_ALIAS\n */\n '--auth-alias '?: string\n\n /**\n * The Client ID of your app.\n * @environment SHOPIFY_FLAG_CLIENT_ID\n */\n '--client-id '?: string\n\n /**\n * The name of the app configuration.\n * @environment SHOPIFY_FLAG_APP_CONFIG\n */\n '-c, --config '?: string\n\n /**\n * Print the command's JSON schemas.\n * @environment SHOPIFY_FLAG_JSON_SCHEMA\n */\n '--json-schema'?: ''\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * The path to your app directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Reset all your settings.\n * @environment SHOPIFY_FLAG_RESET\n */\n '--reset'?: ''\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" } }, "appconfiguse": { @@ -602,6 +656,15 @@ "isOptional": true, "environmentValue": "SHOPIFY_FLAG_CLIENT_ID" }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-config-use.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--json-schema", + "value": "''", + "description": "Print the command's JSON schemas.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON_SCHEMA" + }, { "filePath": "docs-shopify.dev/commands/interfaces/app-config-use.interface.ts", "syntaxKind": "PropertySignature", @@ -639,7 +702,7 @@ "environmentValue": "SHOPIFY_FLAG_VERBOSE" } ], - "value": "export interface appconfiguse {\n /**\n * Alias of the Shopify account to use for authentication.\n * @environment SHOPIFY_FLAG_AUTH_ALIAS\n */\n '--auth-alias '?: string\n\n /**\n * The Client ID of your app.\n * @environment SHOPIFY_FLAG_CLIENT_ID\n */\n '--client-id '?: string\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * The path to your app directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Reset all your settings.\n * @environment SHOPIFY_FLAG_RESET\n */\n '--reset'?: ''\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" + "value": "export interface appconfiguse {\n /**\n * Alias of the Shopify account to use for authentication.\n * @environment SHOPIFY_FLAG_AUTH_ALIAS\n */\n '--auth-alias '?: string\n\n /**\n * The Client ID of your app.\n * @environment SHOPIFY_FLAG_CLIENT_ID\n */\n '--client-id '?: string\n\n /**\n * Print the command's JSON schemas.\n * @environment SHOPIFY_FLAG_JSON_SCHEMA\n */\n '--json-schema'?: ''\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * The path to your app directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Reset all your settings.\n * @environment SHOPIFY_FLAG_RESET\n */\n '--reset'?: ''\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" } }, "appconfigvalidate": { @@ -667,6 +730,15 @@ "isOptional": true, "environmentValue": "SHOPIFY_FLAG_CLIENT_ID" }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-config-validate.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--json-schema", + "value": "''", + "description": "Print the command's JSON schemas.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON_SCHEMA" + }, { "filePath": "docs-shopify.dev/commands/interfaces/app-config-validate.interface.ts", "syntaxKind": "PropertySignature", @@ -722,7 +794,7 @@ "environmentValue": "SHOPIFY_FLAG_JSON" } ], - "value": "export interface appconfigvalidate {\n /**\n * Alias of the Shopify account to use for authentication.\n * @environment SHOPIFY_FLAG_AUTH_ALIAS\n */\n '--auth-alias '?: string\n\n /**\n * The Client ID of your app.\n * @environment SHOPIFY_FLAG_CLIENT_ID\n */\n '--client-id '?: string\n\n /**\n * The name of the app configuration.\n * @environment SHOPIFY_FLAG_APP_CONFIG\n */\n '-c, --config '?: string\n\n /**\n * Output the result as JSON. Automatically disables color output.\n * @environment SHOPIFY_FLAG_JSON\n */\n '-j, --json'?: ''\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * The path to your app directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Reset all your settings.\n * @environment SHOPIFY_FLAG_RESET\n */\n '--reset'?: ''\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" + "value": "export interface appconfigvalidate {\n /**\n * Alias of the Shopify account to use for authentication.\n * @environment SHOPIFY_FLAG_AUTH_ALIAS\n */\n '--auth-alias '?: string\n\n /**\n * The Client ID of your app.\n * @environment SHOPIFY_FLAG_CLIENT_ID\n */\n '--client-id '?: string\n\n /**\n * The name of the app configuration.\n * @environment SHOPIFY_FLAG_APP_CONFIG\n */\n '-c, --config '?: string\n\n /**\n * Output the result as JSON. Automatically disables color output.\n * @environment SHOPIFY_FLAG_JSON\n */\n '-j, --json'?: ''\n\n /**\n * Print the command's JSON schemas.\n * @environment SHOPIFY_FLAG_JSON_SCHEMA\n */\n '--json-schema'?: ''\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * The path to your app directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Reset all your settings.\n * @environment SHOPIFY_FLAG_RESET\n */\n '--reset'?: ''\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" } }, "appdeploy": { @@ -768,6 +840,15 @@ "isOptional": true, "environmentValue": "SHOPIFY_FLAG_CLIENT_ID" }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-deploy.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--json-schema", + "value": "''", + "description": "Print the command's JSON schemas.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON_SCHEMA" + }, { "filePath": "docs-shopify.dev/commands/interfaces/app-deploy.interface.ts", "syntaxKind": "PropertySignature", @@ -859,7 +940,7 @@ "environmentValue": "SHOPIFY_FLAG_APP_CONFIG" } ], - "value": "export interface appdeploy {\n /**\n * Allows removing extensions and configuration without requiring user confirmation. For CI/CD environments, the recommended flag is --allow-updates. In non-interactive environments, provide this flag, --allow-updates, or --no-release.\n * @environment SHOPIFY_FLAG_ALLOW_DELETES\n */\n '--allow-deletes'?: ''\n\n /**\n * Allows adding and updating extensions and configuration without requiring user confirmation. Recommended option for CI/CD environments. In non-interactive environments, provide this flag, --allow-deletes, or --no-release.\n * @environment SHOPIFY_FLAG_ALLOW_UPDATES\n */\n '--allow-updates'?: ''\n\n /**\n * Alias of the Shopify account to use for authentication.\n * @environment SHOPIFY_FLAG_AUTH_ALIAS\n */\n '--auth-alias '?: string\n\n /**\n * The Client ID of your app.\n * @environment SHOPIFY_FLAG_CLIENT_ID\n */\n '--client-id '?: string\n\n /**\n * The name of the app configuration.\n * @environment SHOPIFY_FLAG_APP_CONFIG\n */\n '-c, --config '?: string\n\n /**\n * Optional message that will be associated with this version. This is for internal use only and won't be available externally.\n * @environment SHOPIFY_FLAG_MESSAGE\n */\n '--message '?: string\n\n /**\n * Use with caution: Skips building any elements of the app that require building. You should ensure your app has been prepared in advance, such as by running `shopify app build` or by caching build artifacts.\n * @environment SHOPIFY_FLAG_NO_BUILD\n */\n '--no-build'?: ''\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * Creates a version but doesn't release it - it's not made available to merchants. With this flag, a user confirmation is not required. In non-interactive environments, provide this flag, --allow-updates, or --allow-deletes.\n * @environment SHOPIFY_FLAG_NO_RELEASE\n */\n '--no-release'?: ''\n\n /**\n * The path to your app directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Reset all your settings.\n * @environment SHOPIFY_FLAG_RESET\n */\n '--reset'?: ''\n\n /**\n * URL associated with the new app version.\n * @environment SHOPIFY_FLAG_SOURCE_CONTROL_URL\n */\n '--source-control-url '?: string\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n\n /**\n * Optional version tag that will be associated with this app version. If not provided, an auto-generated identifier will be generated for this app version.\n * @environment SHOPIFY_FLAG_VERSION\n */\n '--version '?: string\n}" + "value": "export interface appdeploy {\n /**\n * Allows removing extensions and configuration without requiring user confirmation. For CI/CD environments, the recommended flag is --allow-updates. In non-interactive environments, provide this flag, --allow-updates, or --no-release.\n * @environment SHOPIFY_FLAG_ALLOW_DELETES\n */\n '--allow-deletes'?: ''\n\n /**\n * Allows adding and updating extensions and configuration without requiring user confirmation. Recommended option for CI/CD environments. In non-interactive environments, provide this flag, --allow-deletes, or --no-release.\n * @environment SHOPIFY_FLAG_ALLOW_UPDATES\n */\n '--allow-updates'?: ''\n\n /**\n * Alias of the Shopify account to use for authentication.\n * @environment SHOPIFY_FLAG_AUTH_ALIAS\n */\n '--auth-alias '?: string\n\n /**\n * The Client ID of your app.\n * @environment SHOPIFY_FLAG_CLIENT_ID\n */\n '--client-id '?: string\n\n /**\n * The name of the app configuration.\n * @environment SHOPIFY_FLAG_APP_CONFIG\n */\n '-c, --config '?: string\n\n /**\n * Print the command's JSON schemas.\n * @environment SHOPIFY_FLAG_JSON_SCHEMA\n */\n '--json-schema'?: ''\n\n /**\n * Optional message that will be associated with this version. This is for internal use only and won't be available externally.\n * @environment SHOPIFY_FLAG_MESSAGE\n */\n '--message '?: string\n\n /**\n * Use with caution: Skips building any elements of the app that require building. You should ensure your app has been prepared in advance, such as by running `shopify app build` or by caching build artifacts.\n * @environment SHOPIFY_FLAG_NO_BUILD\n */\n '--no-build'?: ''\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * Creates a version but doesn't release it - it's not made available to merchants. With this flag, a user confirmation is not required. In non-interactive environments, provide this flag, --allow-updates, or --allow-deletes.\n * @environment SHOPIFY_FLAG_NO_RELEASE\n */\n '--no-release'?: ''\n\n /**\n * The path to your app directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Reset all your settings.\n * @environment SHOPIFY_FLAG_RESET\n */\n '--reset'?: ''\n\n /**\n * URL associated with the new app version.\n * @environment SHOPIFY_FLAG_SOURCE_CONTROL_URL\n */\n '--source-control-url '?: string\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n\n /**\n * Optional version tag that will be associated with this app version. If not provided, an auto-generated identifier will be generated for this app version.\n * @environment SHOPIFY_FLAG_VERSION\n */\n '--version '?: string\n}" } }, "appdevclean": { @@ -887,6 +968,15 @@ "isOptional": true, "environmentValue": "SHOPIFY_FLAG_CLIENT_ID" }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-dev-clean.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--json-schema", + "value": "''", + "description": "Print the command's JSON schemas.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON_SCHEMA" + }, { "filePath": "docs-shopify.dev/commands/interfaces/app-dev-clean.interface.ts", "syntaxKind": "PropertySignature", @@ -942,7 +1032,7 @@ "environmentValue": "SHOPIFY_FLAG_STORE" } ], - "value": "export interface appdevclean {\n /**\n * Alias of the Shopify account to use for authentication.\n * @environment SHOPIFY_FLAG_AUTH_ALIAS\n */\n '--auth-alias '?: string\n\n /**\n * The Client ID of your app.\n * @environment SHOPIFY_FLAG_CLIENT_ID\n */\n '--client-id '?: string\n\n /**\n * The name of the app configuration.\n * @environment SHOPIFY_FLAG_APP_CONFIG\n */\n '-c, --config '?: string\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * The path to your app directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Reset all your settings.\n * @environment SHOPIFY_FLAG_RESET\n */\n '--reset'?: ''\n\n /**\n * Store URL. Must be an existing development store.\n * @environment SHOPIFY_FLAG_STORE\n */\n '-s, --store '?: string\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" + "value": "export interface appdevclean {\n /**\n * Alias of the Shopify account to use for authentication.\n * @environment SHOPIFY_FLAG_AUTH_ALIAS\n */\n '--auth-alias '?: string\n\n /**\n * The Client ID of your app.\n * @environment SHOPIFY_FLAG_CLIENT_ID\n */\n '--client-id '?: string\n\n /**\n * The name of the app configuration.\n * @environment SHOPIFY_FLAG_APP_CONFIG\n */\n '-c, --config '?: string\n\n /**\n * Print the command's JSON schemas.\n * @environment SHOPIFY_FLAG_JSON_SCHEMA\n */\n '--json-schema'?: ''\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * The path to your app directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Reset all your settings.\n * @environment SHOPIFY_FLAG_RESET\n */\n '--reset'?: ''\n\n /**\n * Store URL. Must be an existing development store.\n * @environment SHOPIFY_FLAG_STORE\n */\n '-s, --store '?: string\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" } }, "appdev": { @@ -988,6 +1078,15 @@ "isOptional": true, "environmentValue": "SHOPIFY_FLAG_INSTALL_MKCERT" }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-dev.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--json-schema", + "value": "''", + "description": "Print the command's JSON schemas.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON_SCHEMA" + }, { "filePath": "docs-shopify.dev/commands/interfaces/app-dev.interface.ts", "syntaxKind": "PropertySignature", @@ -1133,7 +1232,7 @@ "environmentValue": "SHOPIFY_FLAG_THEME" } ], - "value": "export interface appdev {\n /**\n * Alias of the Shopify account to use for authentication.\n * @environment SHOPIFY_FLAG_AUTH_ALIAS\n */\n '--auth-alias '?: string\n\n /**\n * Resource URL for checkout UI extension. Format: \"/cart/{productVariantID}:{productQuantity}\"\n * @environment SHOPIFY_FLAG_CHECKOUT_CART_URL\n */\n '--checkout-cart-url '?: string\n\n /**\n * The Client ID of your app.\n * @environment SHOPIFY_FLAG_CLIENT_ID\n */\n '--client-id '?: string\n\n /**\n * The name of the app configuration.\n * @environment SHOPIFY_FLAG_APP_CONFIG\n */\n '-c, --config '?: string\n\n /**\n * Install and use mkcert to generate localhost certificates when --use-localhost is enabled without prompting.\n * @environment SHOPIFY_FLAG_INSTALL_MKCERT\n */\n '--install-mkcert'?: ''\n\n /**\n * Port to use for localhost. Must be between 1 and 65535.\n * @environment SHOPIFY_FLAG_LOCALHOST_PORT\n */\n '--localhost-port '?: string\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * Uses the app URL from the toml file instead an autogenerated URL for dev.\n * @environment SHOPIFY_FLAG_NO_UPDATE\n */\n '--no-update'?: ''\n\n /**\n * The file path or URL. The file path is to a file that you want updated on idle. The URL path is where you want a webhook posted to report on file changes.\n * @environment SHOPIFY_FLAG_NOTIFY\n */\n '--notify '?: string\n\n /**\n * The path to your app directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Reset all your settings.\n * @environment SHOPIFY_FLAG_RESET\n */\n '--reset'?: ''\n\n /**\n * Skips the installation of dependencies. Deprecated, use workspaces instead.\n * @environment SHOPIFY_FLAG_SKIP_DEPENDENCIES_INSTALLATION\n */\n '--skip-dependencies-installation'?: ''\n\n /**\n * Store URL. Must be an existing development or Shopify Plus sandbox store.\n * @environment SHOPIFY_FLAG_STORE\n */\n '-s, --store '?: string\n\n /**\n * The password for storefronts with password protection.\n * @environment SHOPIFY_FLAG_STORE_PASSWORD\n */\n '--store-password '?: string\n\n /**\n * Resource URL for subscription UI extension. Format: \"/products/{productId}\"\n * @environment SHOPIFY_FLAG_SUBSCRIPTION_PRODUCT_URL\n */\n '--subscription-product-url '?: string\n\n /**\n * Theme ID or name of the theme app extension host theme.\n * @environment SHOPIFY_FLAG_THEME\n */\n '-t, --theme '?: string\n\n /**\n * Local port of the theme app extension development server. Must be between 1 and 65535.\n * @environment SHOPIFY_FLAG_THEME_APP_EXTENSION_PORT\n */\n '--theme-app-extension-port '?: string\n\n /**\n * Use a custom tunnel, it must be running before executing dev. Format: \"https://my-tunnel-url:port\".\n * @environment SHOPIFY_FLAG_TUNNEL_URL\n */\n '--tunnel-url '?: string\n\n /**\n * Service entry point will listen to localhost. A tunnel won't be used. Will work for testing many app features, but not those that directly invoke your app (E.g: Webhooks)\n * @environment SHOPIFY_FLAG_USE_LOCALHOST\n */\n '--use-localhost'?: ''\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" + "value": "export interface appdev {\n /**\n * Alias of the Shopify account to use for authentication.\n * @environment SHOPIFY_FLAG_AUTH_ALIAS\n */\n '--auth-alias '?: string\n\n /**\n * Resource URL for checkout UI extension. Format: \"/cart/{productVariantID}:{productQuantity}\"\n * @environment SHOPIFY_FLAG_CHECKOUT_CART_URL\n */\n '--checkout-cart-url '?: string\n\n /**\n * The Client ID of your app.\n * @environment SHOPIFY_FLAG_CLIENT_ID\n */\n '--client-id '?: string\n\n /**\n * The name of the app configuration.\n * @environment SHOPIFY_FLAG_APP_CONFIG\n */\n '-c, --config '?: string\n\n /**\n * Install and use mkcert to generate localhost certificates when --use-localhost is enabled without prompting.\n * @environment SHOPIFY_FLAG_INSTALL_MKCERT\n */\n '--install-mkcert'?: ''\n\n /**\n * Print the command's JSON schemas.\n * @environment SHOPIFY_FLAG_JSON_SCHEMA\n */\n '--json-schema'?: ''\n\n /**\n * Port to use for localhost. Must be between 1 and 65535.\n * @environment SHOPIFY_FLAG_LOCALHOST_PORT\n */\n '--localhost-port '?: string\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * Uses the app URL from the toml file instead an autogenerated URL for dev.\n * @environment SHOPIFY_FLAG_NO_UPDATE\n */\n '--no-update'?: ''\n\n /**\n * The file path or URL. The file path is to a file that you want updated on idle. The URL path is where you want a webhook posted to report on file changes.\n * @environment SHOPIFY_FLAG_NOTIFY\n */\n '--notify '?: string\n\n /**\n * The path to your app directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Reset all your settings.\n * @environment SHOPIFY_FLAG_RESET\n */\n '--reset'?: ''\n\n /**\n * Skips the installation of dependencies. Deprecated, use workspaces instead.\n * @environment SHOPIFY_FLAG_SKIP_DEPENDENCIES_INSTALLATION\n */\n '--skip-dependencies-installation'?: ''\n\n /**\n * Store URL. Must be an existing development or Shopify Plus sandbox store.\n * @environment SHOPIFY_FLAG_STORE\n */\n '-s, --store '?: string\n\n /**\n * The password for storefronts with password protection.\n * @environment SHOPIFY_FLAG_STORE_PASSWORD\n */\n '--store-password '?: string\n\n /**\n * Resource URL for subscription UI extension. Format: \"/products/{productId}\"\n * @environment SHOPIFY_FLAG_SUBSCRIPTION_PRODUCT_URL\n */\n '--subscription-product-url '?: string\n\n /**\n * Theme ID or name of the theme app extension host theme.\n * @environment SHOPIFY_FLAG_THEME\n */\n '-t, --theme '?: string\n\n /**\n * Local port of the theme app extension development server. Must be between 1 and 65535.\n * @environment SHOPIFY_FLAG_THEME_APP_EXTENSION_PORT\n */\n '--theme-app-extension-port '?: string\n\n /**\n * Use a custom tunnel, it must be running before executing dev. Format: \"https://my-tunnel-url:port\".\n * @environment SHOPIFY_FLAG_TUNNEL_URL\n */\n '--tunnel-url '?: string\n\n /**\n * Service entry point will listen to localhost. A tunnel won't be used. Will work for testing many app features, but not those that directly invoke your app (E.g: Webhooks)\n * @environment SHOPIFY_FLAG_USE_LOCALHOST\n */\n '--use-localhost'?: ''\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" } }, "appenvpull": { @@ -1170,6 +1269,15 @@ "isOptional": true, "environmentValue": "SHOPIFY_FLAG_ENV_FILE" }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-env-pull.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--json-schema", + "value": "''", + "description": "Print the command's JSON schemas.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON_SCHEMA" + }, { "filePath": "docs-shopify.dev/commands/interfaces/app-env-pull.interface.ts", "syntaxKind": "PropertySignature", @@ -1216,7 +1324,7 @@ "environmentValue": "SHOPIFY_FLAG_APP_CONFIG" } ], - "value": "export interface appenvpull {\n /**\n * Alias of the Shopify account to use for authentication.\n * @environment SHOPIFY_FLAG_AUTH_ALIAS\n */\n '--auth-alias '?: string\n\n /**\n * The Client ID of your app.\n * @environment SHOPIFY_FLAG_CLIENT_ID\n */\n '--client-id '?: string\n\n /**\n * The name of the app configuration.\n * @environment SHOPIFY_FLAG_APP_CONFIG\n */\n '-c, --config '?: string\n\n /**\n * Specify an environment file to update if the update flag is set\n * @environment SHOPIFY_FLAG_ENV_FILE\n */\n '--env-file '?: string\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * The path to your app directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Reset all your settings.\n * @environment SHOPIFY_FLAG_RESET\n */\n '--reset'?: ''\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" + "value": "export interface appenvpull {\n /**\n * Alias of the Shopify account to use for authentication.\n * @environment SHOPIFY_FLAG_AUTH_ALIAS\n */\n '--auth-alias '?: string\n\n /**\n * The Client ID of your app.\n * @environment SHOPIFY_FLAG_CLIENT_ID\n */\n '--client-id '?: string\n\n /**\n * The name of the app configuration.\n * @environment SHOPIFY_FLAG_APP_CONFIG\n */\n '-c, --config '?: string\n\n /**\n * Specify an environment file to update if the update flag is set\n * @environment SHOPIFY_FLAG_ENV_FILE\n */\n '--env-file '?: string\n\n /**\n * Print the command's JSON schemas.\n * @environment SHOPIFY_FLAG_JSON_SCHEMA\n */\n '--json-schema'?: ''\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * The path to your app directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Reset all your settings.\n * @environment SHOPIFY_FLAG_RESET\n */\n '--reset'?: ''\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" } }, "appenvshow": { @@ -1244,6 +1352,15 @@ "isOptional": true, "environmentValue": "SHOPIFY_FLAG_CLIENT_ID" }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-env-show.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--json-schema", + "value": "''", + "description": "Print the command's JSON schemas.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON_SCHEMA" + }, { "filePath": "docs-shopify.dev/commands/interfaces/app-env-show.interface.ts", "syntaxKind": "PropertySignature", @@ -1290,7 +1407,7 @@ "environmentValue": "SHOPIFY_FLAG_APP_CONFIG" } ], - "value": "export interface appenvshow {\n /**\n * Alias of the Shopify account to use for authentication.\n * @environment SHOPIFY_FLAG_AUTH_ALIAS\n */\n '--auth-alias '?: string\n\n /**\n * The Client ID of your app.\n * @environment SHOPIFY_FLAG_CLIENT_ID\n */\n '--client-id '?: string\n\n /**\n * The name of the app configuration.\n * @environment SHOPIFY_FLAG_APP_CONFIG\n */\n '-c, --config '?: string\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * The path to your app directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Reset all your settings.\n * @environment SHOPIFY_FLAG_RESET\n */\n '--reset'?: ''\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" + "value": "export interface appenvshow {\n /**\n * Alias of the Shopify account to use for authentication.\n * @environment SHOPIFY_FLAG_AUTH_ALIAS\n */\n '--auth-alias '?: string\n\n /**\n * The Client ID of your app.\n * @environment SHOPIFY_FLAG_CLIENT_ID\n */\n '--client-id '?: string\n\n /**\n * The name of the app configuration.\n * @environment SHOPIFY_FLAG_APP_CONFIG\n */\n '-c, --config '?: string\n\n /**\n * Print the command's JSON schemas.\n * @environment SHOPIFY_FLAG_JSON_SCHEMA\n */\n '--json-schema'?: ''\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * The path to your app directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Reset all your settings.\n * @environment SHOPIFY_FLAG_RESET\n */\n '--reset'?: ''\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" } }, "appexecute": { @@ -1318,6 +1435,15 @@ "isOptional": true, "environmentValue": "SHOPIFY_FLAG_CLIENT_ID" }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-execute.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--json-schema", + "value": "''", + "description": "Print the command's JSON schemas.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON_SCHEMA" + }, { "filePath": "docs-shopify.dev/commands/interfaces/app-execute.interface.ts", "syntaxKind": "PropertySignature", @@ -1427,7 +1553,7 @@ "environmentValue": "SHOPIFY_FLAG_VARIABLES" } ], - "value": "export interface appexecute {\n /**\n * Alias of the Shopify account to use for authentication.\n * @environment SHOPIFY_FLAG_AUTH_ALIAS\n */\n '--auth-alias '?: string\n\n /**\n * The Client ID of your app.\n * @environment SHOPIFY_FLAG_CLIENT_ID\n */\n '--client-id '?: string\n\n /**\n * The name of the app configuration.\n * @environment SHOPIFY_FLAG_APP_CONFIG\n */\n '-c, --config '?: string\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * The file name where results should be written, instead of STDOUT.\n * @environment SHOPIFY_FLAG_OUTPUT_FILE\n */\n '--output-file '?: string\n\n /**\n * The path to your app directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * The GraphQL query or mutation, as a string.\n * @environment SHOPIFY_FLAG_QUERY\n */\n '-q, --query '?: string\n\n /**\n * Path to a file containing the GraphQL query or mutation. Can't be used with --query.\n * @environment SHOPIFY_FLAG_QUERY_FILE\n */\n '--query-file '?: string\n\n /**\n * Reset all your settings.\n * @environment SHOPIFY_FLAG_RESET\n */\n '--reset'?: ''\n\n /**\n * The myshopify.com domain of the store to execute against. The app must be installed on the store. If not specified, you will be prompted to select a store.\n * @environment SHOPIFY_FLAG_STORE\n */\n '-s, --store '?: string\n\n /**\n * Path to a file containing GraphQL variables in JSON format. Can't be used with --variables.\n * @environment SHOPIFY_FLAG_VARIABLE_FILE\n */\n '--variable-file '?: string\n\n /**\n * The values for any GraphQL variables in your query or mutation, in JSON format.\n * @environment SHOPIFY_FLAG_VARIABLES\n */\n '-v, --variables '?: string\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n\n /**\n * The API version to use for the query or mutation. Defaults to the latest stable version.\n * @environment SHOPIFY_FLAG_VERSION\n */\n '--version '?: string\n}" + "value": "export interface appexecute {\n /**\n * Alias of the Shopify account to use for authentication.\n * @environment SHOPIFY_FLAG_AUTH_ALIAS\n */\n '--auth-alias '?: string\n\n /**\n * The Client ID of your app.\n * @environment SHOPIFY_FLAG_CLIENT_ID\n */\n '--client-id '?: string\n\n /**\n * The name of the app configuration.\n * @environment SHOPIFY_FLAG_APP_CONFIG\n */\n '-c, --config '?: string\n\n /**\n * Print the command's JSON schemas.\n * @environment SHOPIFY_FLAG_JSON_SCHEMA\n */\n '--json-schema'?: ''\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * The file name where results should be written, instead of STDOUT.\n * @environment SHOPIFY_FLAG_OUTPUT_FILE\n */\n '--output-file '?: string\n\n /**\n * The path to your app directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * The GraphQL query or mutation, as a string.\n * @environment SHOPIFY_FLAG_QUERY\n */\n '-q, --query '?: string\n\n /**\n * Path to a file containing the GraphQL query or mutation. Can't be used with --query.\n * @environment SHOPIFY_FLAG_QUERY_FILE\n */\n '--query-file '?: string\n\n /**\n * Reset all your settings.\n * @environment SHOPIFY_FLAG_RESET\n */\n '--reset'?: ''\n\n /**\n * The myshopify.com domain of the store to execute against. The app must be installed on the store. If not specified, you will be prompted to select a store.\n * @environment SHOPIFY_FLAG_STORE\n */\n '-s, --store '?: string\n\n /**\n * Path to a file containing GraphQL variables in JSON format. Can't be used with --variables.\n * @environment SHOPIFY_FLAG_VARIABLE_FILE\n */\n '--variable-file '?: string\n\n /**\n * The values for any GraphQL variables in your query or mutation, in JSON format.\n * @environment SHOPIFY_FLAG_VARIABLES\n */\n '-v, --variables '?: string\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n\n /**\n * The API version to use for the query or mutation. Defaults to the latest stable version.\n * @environment SHOPIFY_FLAG_VERSION\n */\n '--version '?: string\n}" } }, "appfunctionbuild": { @@ -1455,6 +1581,15 @@ "isOptional": true, "environmentValue": "SHOPIFY_FLAG_CLIENT_ID" }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-function-build.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--json-schema", + "value": "''", + "description": "Print the command's JSON schemas.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON_SCHEMA" + }, { "filePath": "docs-shopify.dev/commands/interfaces/app-function-build.interface.ts", "syntaxKind": "PropertySignature", @@ -1501,7 +1636,7 @@ "environmentValue": "SHOPIFY_FLAG_APP_CONFIG" } ], - "value": "export interface appfunctionbuild {\n /**\n * Alias of the Shopify account to use for authentication.\n * @environment SHOPIFY_FLAG_AUTH_ALIAS\n */\n '--auth-alias '?: string\n\n /**\n * The Client ID of your app.\n * @environment SHOPIFY_FLAG_CLIENT_ID\n */\n '--client-id '?: string\n\n /**\n * The name of the app configuration.\n * @environment SHOPIFY_FLAG_APP_CONFIG\n */\n '-c, --config '?: string\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * The path to your function directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Reset all your settings.\n * @environment SHOPIFY_FLAG_RESET\n */\n '--reset'?: ''\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" + "value": "export interface appfunctionbuild {\n /**\n * Alias of the Shopify account to use for authentication.\n * @environment SHOPIFY_FLAG_AUTH_ALIAS\n */\n '--auth-alias '?: string\n\n /**\n * The Client ID of your app.\n * @environment SHOPIFY_FLAG_CLIENT_ID\n */\n '--client-id '?: string\n\n /**\n * The name of the app configuration.\n * @environment SHOPIFY_FLAG_APP_CONFIG\n */\n '-c, --config '?: string\n\n /**\n * Print the command's JSON schemas.\n * @environment SHOPIFY_FLAG_JSON_SCHEMA\n */\n '--json-schema'?: ''\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * The path to your function directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Reset all your settings.\n * @environment SHOPIFY_FLAG_RESET\n */\n '--reset'?: ''\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" } }, "appfunctioninfo": { @@ -1529,6 +1664,15 @@ "isOptional": true, "environmentValue": "SHOPIFY_FLAG_CLIENT_ID" }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-function-info.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--json-schema", + "value": "''", + "description": "Print the command's JSON schemas.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON_SCHEMA" + }, { "filePath": "docs-shopify.dev/commands/interfaces/app-function-info.interface.ts", "syntaxKind": "PropertySignature", @@ -1584,7 +1728,7 @@ "environmentValue": "SHOPIFY_FLAG_JSON" } ], - "value": "export interface appfunctioninfo {\n /**\n * Alias of the Shopify account to use for authentication.\n * @environment SHOPIFY_FLAG_AUTH_ALIAS\n */\n '--auth-alias '?: string\n\n /**\n * The Client ID of your app.\n * @environment SHOPIFY_FLAG_CLIENT_ID\n */\n '--client-id '?: string\n\n /**\n * The name of the app configuration.\n * @environment SHOPIFY_FLAG_APP_CONFIG\n */\n '-c, --config '?: string\n\n /**\n * Output the result as JSON. Automatically disables color output.\n * @environment SHOPIFY_FLAG_JSON\n */\n '-j, --json'?: ''\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * The path to your function directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Reset all your settings.\n * @environment SHOPIFY_FLAG_RESET\n */\n '--reset'?: ''\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" + "value": "export interface appfunctioninfo {\n /**\n * Alias of the Shopify account to use for authentication.\n * @environment SHOPIFY_FLAG_AUTH_ALIAS\n */\n '--auth-alias '?: string\n\n /**\n * The Client ID of your app.\n * @environment SHOPIFY_FLAG_CLIENT_ID\n */\n '--client-id '?: string\n\n /**\n * The name of the app configuration.\n * @environment SHOPIFY_FLAG_APP_CONFIG\n */\n '-c, --config '?: string\n\n /**\n * Output the result as JSON. Automatically disables color output.\n * @environment SHOPIFY_FLAG_JSON\n */\n '-j, --json'?: ''\n\n /**\n * Print the command's JSON schemas.\n * @environment SHOPIFY_FLAG_JSON_SCHEMA\n */\n '--json-schema'?: ''\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * The path to your function directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Reset all your settings.\n * @environment SHOPIFY_FLAG_RESET\n */\n '--reset'?: ''\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" } }, "appfunctionreplay": { @@ -1612,6 +1756,15 @@ "isOptional": true, "environmentValue": "SHOPIFY_FLAG_CLIENT_ID" }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-function-replay.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--json-schema", + "value": "''", + "description": "Print the command's JSON schemas.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON_SCHEMA" + }, { "filePath": "docs-shopify.dev/commands/interfaces/app-function-replay.interface.ts", "syntaxKind": "PropertySignature", @@ -1685,7 +1838,7 @@ "environmentValue": "SHOPIFY_FLAG_WATCH" } ], - "value": "export interface appfunctionreplay {\n /**\n * Alias of the Shopify account to use for authentication.\n * @environment SHOPIFY_FLAG_AUTH_ALIAS\n */\n '--auth-alias '?: string\n\n /**\n * The Client ID of your app.\n * @environment SHOPIFY_FLAG_CLIENT_ID\n */\n '--client-id '?: string\n\n /**\n * The name of the app configuration.\n * @environment SHOPIFY_FLAG_APP_CONFIG\n */\n '-c, --config '?: string\n\n /**\n * Output the result as JSON. Automatically disables color output.\n * @environment SHOPIFY_FLAG_JSON\n */\n '-j, --json'?: ''\n\n /**\n * Specifies a log identifier to replay instead of selecting from a list. The identifier is provided in the output of `shopify app dev` and is the suffix of the log file name. Required if non interactive.\n * @environment SHOPIFY_FLAG_LOG\n */\n '-l, --log '?: string\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * The path to your function directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Reset all your settings.\n * @environment SHOPIFY_FLAG_RESET\n */\n '--reset'?: ''\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n\n /**\n * Re-run the function when the source code changes.\n * @environment SHOPIFY_FLAG_WATCH\n */\n '-w, --watch'?: ''\n}" + "value": "export interface appfunctionreplay {\n /**\n * Alias of the Shopify account to use for authentication.\n * @environment SHOPIFY_FLAG_AUTH_ALIAS\n */\n '--auth-alias '?: string\n\n /**\n * The Client ID of your app.\n * @environment SHOPIFY_FLAG_CLIENT_ID\n */\n '--client-id '?: string\n\n /**\n * The name of the app configuration.\n * @environment SHOPIFY_FLAG_APP_CONFIG\n */\n '-c, --config '?: string\n\n /**\n * Output the result as JSON. Automatically disables color output.\n * @environment SHOPIFY_FLAG_JSON\n */\n '-j, --json'?: ''\n\n /**\n * Print the command's JSON schemas.\n * @environment SHOPIFY_FLAG_JSON_SCHEMA\n */\n '--json-schema'?: ''\n\n /**\n * Specifies a log identifier to replay instead of selecting from a list. The identifier is provided in the output of `shopify app dev` and is the suffix of the log file name. Required if non interactive.\n * @environment SHOPIFY_FLAG_LOG\n */\n '-l, --log '?: string\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * The path to your function directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Reset all your settings.\n * @environment SHOPIFY_FLAG_RESET\n */\n '--reset'?: ''\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n\n /**\n * Re-run the function when the source code changes.\n * @environment SHOPIFY_FLAG_WATCH\n */\n '-w, --watch'?: ''\n}" } }, "appfunctionrun": { @@ -1713,6 +1866,15 @@ "isOptional": true, "environmentValue": "SHOPIFY_FLAG_CLIENT_ID" }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-function-run.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--json-schema", + "value": "''", + "description": "Print the command's JSON schemas.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON_SCHEMA" + }, { "filePath": "docs-shopify.dev/commands/interfaces/app-function-run.interface.ts", "syntaxKind": "PropertySignature", @@ -1795,7 +1957,7 @@ "environmentValue": "SHOPIFY_FLAG_JSON" } ], - "value": "export interface appfunctionrun {\n /**\n * Alias of the Shopify account to use for authentication.\n * @environment SHOPIFY_FLAG_AUTH_ALIAS\n */\n '--auth-alias '?: string\n\n /**\n * The Client ID of your app.\n * @environment SHOPIFY_FLAG_CLIENT_ID\n */\n '--client-id '?: string\n\n /**\n * The name of the app configuration.\n * @environment SHOPIFY_FLAG_APP_CONFIG\n */\n '-c, --config '?: string\n\n /**\n * Name of the WebAssembly export to invoke.\n * @environment SHOPIFY_FLAG_EXPORT\n */\n '-e, --export '?: string\n\n /**\n * The input JSON to pass to the function. If omitted, standard input is used.\n * @environment SHOPIFY_FLAG_INPUT\n */\n '-i, --input '?: string\n\n /**\n * Output the result as JSON. Automatically disables color output.\n * @environment SHOPIFY_FLAG_JSON\n */\n '-j, --json'?: ''\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * The path to your function directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Generate a WebAssembly performance profile for the function run. The profile can be viewed in Speedscope.\n * @environment SHOPIFY_FLAG_PROFILE\n */\n '--profile'?: ''\n\n /**\n * Reset all your settings.\n * @environment SHOPIFY_FLAG_RESET\n */\n '--reset'?: ''\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" + "value": "export interface appfunctionrun {\n /**\n * Alias of the Shopify account to use for authentication.\n * @environment SHOPIFY_FLAG_AUTH_ALIAS\n */\n '--auth-alias '?: string\n\n /**\n * The Client ID of your app.\n * @environment SHOPIFY_FLAG_CLIENT_ID\n */\n '--client-id '?: string\n\n /**\n * The name of the app configuration.\n * @environment SHOPIFY_FLAG_APP_CONFIG\n */\n '-c, --config '?: string\n\n /**\n * Name of the WebAssembly export to invoke.\n * @environment SHOPIFY_FLAG_EXPORT\n */\n '-e, --export '?: string\n\n /**\n * The input JSON to pass to the function. If omitted, standard input is used.\n * @environment SHOPIFY_FLAG_INPUT\n */\n '-i, --input '?: string\n\n /**\n * Output the result as JSON. Automatically disables color output.\n * @environment SHOPIFY_FLAG_JSON\n */\n '-j, --json'?: ''\n\n /**\n * Print the command's JSON schemas.\n * @environment SHOPIFY_FLAG_JSON_SCHEMA\n */\n '--json-schema'?: ''\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * The path to your function directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Generate a WebAssembly performance profile for the function run. The profile can be viewed in Speedscope.\n * @environment SHOPIFY_FLAG_PROFILE\n */\n '--profile'?: ''\n\n /**\n * Reset all your settings.\n * @environment SHOPIFY_FLAG_RESET\n */\n '--reset'?: ''\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" } }, "appfunctionschema": { @@ -1823,6 +1985,15 @@ "isOptional": true, "environmentValue": "SHOPIFY_FLAG_CLIENT_ID" }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-function-schema.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--json-schema", + "value": "''", + "description": "Print the command's JSON schemas.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON_SCHEMA" + }, { "filePath": "docs-shopify.dev/commands/interfaces/app-function-schema.interface.ts", "syntaxKind": "PropertySignature", @@ -1878,7 +2049,7 @@ "environmentValue": "SHOPIFY_FLAG_APP_CONFIG" } ], - "value": "export interface appfunctionschema {\n /**\n * Alias of the Shopify account to use for authentication.\n * @environment SHOPIFY_FLAG_AUTH_ALIAS\n */\n '--auth-alias '?: string\n\n /**\n * The Client ID of your app.\n * @environment SHOPIFY_FLAG_CLIENT_ID\n */\n '--client-id '?: string\n\n /**\n * The name of the app configuration.\n * @environment SHOPIFY_FLAG_APP_CONFIG\n */\n '-c, --config '?: string\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * The path to your function directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Reset all your settings.\n * @environment SHOPIFY_FLAG_RESET\n */\n '--reset'?: ''\n\n /**\n * Output the schema to stdout instead of writing to a file.\n * @environment SHOPIFY_FLAG_STDOUT\n */\n '--stdout'?: ''\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" + "value": "export interface appfunctionschema {\n /**\n * Alias of the Shopify account to use for authentication.\n * @environment SHOPIFY_FLAG_AUTH_ALIAS\n */\n '--auth-alias '?: string\n\n /**\n * The Client ID of your app.\n * @environment SHOPIFY_FLAG_CLIENT_ID\n */\n '--client-id '?: string\n\n /**\n * The name of the app configuration.\n * @environment SHOPIFY_FLAG_APP_CONFIG\n */\n '-c, --config '?: string\n\n /**\n * Print the command's JSON schemas.\n * @environment SHOPIFY_FLAG_JSON_SCHEMA\n */\n '--json-schema'?: ''\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * The path to your function directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Reset all your settings.\n * @environment SHOPIFY_FLAG_RESET\n */\n '--reset'?: ''\n\n /**\n * Output the schema to stdout instead of writing to a file.\n * @environment SHOPIFY_FLAG_STDOUT\n */\n '--stdout'?: ''\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" } }, "appfunctiontypegen": { @@ -1906,6 +2077,15 @@ "isOptional": true, "environmentValue": "SHOPIFY_FLAG_CLIENT_ID" }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-function-typegen.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--json-schema", + "value": "''", + "description": "Print the command's JSON schemas.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON_SCHEMA" + }, { "filePath": "docs-shopify.dev/commands/interfaces/app-function-typegen.interface.ts", "syntaxKind": "PropertySignature", @@ -1952,7 +2132,7 @@ "environmentValue": "SHOPIFY_FLAG_APP_CONFIG" } ], - "value": "export interface appfunctiontypegen {\n /**\n * Alias of the Shopify account to use for authentication.\n * @environment SHOPIFY_FLAG_AUTH_ALIAS\n */\n '--auth-alias '?: string\n\n /**\n * The Client ID of your app.\n * @environment SHOPIFY_FLAG_CLIENT_ID\n */\n '--client-id '?: string\n\n /**\n * The name of the app configuration.\n * @environment SHOPIFY_FLAG_APP_CONFIG\n */\n '-c, --config '?: string\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * The path to your function directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Reset all your settings.\n * @environment SHOPIFY_FLAG_RESET\n */\n '--reset'?: ''\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" + "value": "export interface appfunctiontypegen {\n /**\n * Alias of the Shopify account to use for authentication.\n * @environment SHOPIFY_FLAG_AUTH_ALIAS\n */\n '--auth-alias '?: string\n\n /**\n * The Client ID of your app.\n * @environment SHOPIFY_FLAG_CLIENT_ID\n */\n '--client-id '?: string\n\n /**\n * The name of the app configuration.\n * @environment SHOPIFY_FLAG_APP_CONFIG\n */\n '-c, --config '?: string\n\n /**\n * Print the command's JSON schemas.\n * @environment SHOPIFY_FLAG_JSON_SCHEMA\n */\n '--json-schema'?: ''\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * The path to your function directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Reset all your settings.\n * @environment SHOPIFY_FLAG_RESET\n */\n '--reset'?: ''\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" } }, "appgenerateextension": { @@ -1989,6 +2169,15 @@ "isOptional": true, "environmentValue": "SHOPIFY_FLAG_FLAVOR" }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-generate-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--json-schema", + "value": "''", + "description": "Print the command's JSON schemas.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON_SCHEMA" + }, { "filePath": "docs-shopify.dev/commands/interfaces/app-generate-extension.interface.ts", "syntaxKind": "PropertySignature", @@ -2053,7 +2242,7 @@ "environmentValue": "SHOPIFY_FLAG_EXTENSION_TEMPLATE" } ], - "value": "export interface appgenerateextension {\n /**\n * Alias of the Shopify account to use for authentication.\n * @environment SHOPIFY_FLAG_AUTH_ALIAS\n */\n '--auth-alias '?: string\n\n /**\n * The Client ID of your app.\n * @environment SHOPIFY_FLAG_CLIENT_ID\n */\n '--client-id '?: string\n\n /**\n * The name of the app configuration.\n * @environment SHOPIFY_FLAG_APP_CONFIG\n */\n '-c, --config '?: string\n\n /**\n * Choose a starting template for your extension, where applicable. Required if non interactive when the selected extension template supports multiple flavors.\n * @environment SHOPIFY_FLAG_FLAVOR\n */\n '--flavor '?: string\n\n /**\n * name of your Extension. Required if non interactive.\n * @environment SHOPIFY_FLAG_NAME\n */\n '-n, --name '?: string\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * The path to your app directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Reset all your settings.\n * @environment SHOPIFY_FLAG_RESET\n */\n '--reset'?: ''\n\n /**\n * Extension template. Required if non interactive.\n * @environment SHOPIFY_FLAG_EXTENSION_TEMPLATE\n */\n '-t, --template '?: string\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" + "value": "export interface appgenerateextension {\n /**\n * Alias of the Shopify account to use for authentication.\n * @environment SHOPIFY_FLAG_AUTH_ALIAS\n */\n '--auth-alias '?: string\n\n /**\n * The Client ID of your app.\n * @environment SHOPIFY_FLAG_CLIENT_ID\n */\n '--client-id '?: string\n\n /**\n * The name of the app configuration.\n * @environment SHOPIFY_FLAG_APP_CONFIG\n */\n '-c, --config '?: string\n\n /**\n * Choose a starting template for your extension, where applicable. Required if non interactive when the selected extension template supports multiple flavors.\n * @environment SHOPIFY_FLAG_FLAVOR\n */\n '--flavor '?: string\n\n /**\n * Print the command's JSON schemas.\n * @environment SHOPIFY_FLAG_JSON_SCHEMA\n */\n '--json-schema'?: ''\n\n /**\n * name of your Extension. Required if non interactive.\n * @environment SHOPIFY_FLAG_NAME\n */\n '-n, --name '?: string\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * The path to your app directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Reset all your settings.\n * @environment SHOPIFY_FLAG_RESET\n */\n '--reset'?: ''\n\n /**\n * Extension template. Required if non interactive.\n * @environment SHOPIFY_FLAG_EXTENSION_TEMPLATE\n */\n '-t, --template '?: string\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" } }, "appgraphiql": { @@ -2081,6 +2270,15 @@ "isOptional": true, "environmentValue": "SHOPIFY_FLAG_CLIENT_ID" }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-graphiql.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--json-schema", + "value": "''", + "description": "Print the command's JSON schemas.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON_SCHEMA" + }, { "filePath": "docs-shopify.dev/commands/interfaces/app-graphiql.interface.ts", "syntaxKind": "PropertySignature", @@ -2163,7 +2361,7 @@ "environmentValue": "SHOPIFY_FLAG_VARIABLES" } ], - "value": "export interface appgraphiql {\n /**\n * Alias of the Shopify account to use for authentication.\n * @environment SHOPIFY_FLAG_AUTH_ALIAS\n */\n '--auth-alias '?: string\n\n /**\n * The Client ID of your app.\n * @environment SHOPIFY_FLAG_CLIENT_ID\n */\n '--client-id '?: string\n\n /**\n * The name of the app configuration.\n * @environment SHOPIFY_FLAG_APP_CONFIG\n */\n '-c, --config '?: string\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * The path to your app directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Local port for the GraphiQL server. Must be between 1 and 65535.\n * @environment SHOPIFY_FLAG_PORT\n */\n '--port '?: string\n\n /**\n * Reset all your settings.\n * @environment SHOPIFY_FLAG_RESET\n */\n '--reset'?: ''\n\n /**\n * The myshopify.com domain of the store to open GraphiQL against. The app must be installed on the store. If not specified, you will be prompted to select a store.\n * @environment SHOPIFY_FLAG_STORE\n */\n '-s, --store '?: string\n\n /**\n * The values for any GraphQL variables in your query or mutation, in JSON format.\n * @environment SHOPIFY_FLAG_VARIABLES\n */\n '-v, --variables '?: string\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n\n /**\n * The API version to use in GraphiQL. Defaults to the latest stable version.\n * @environment SHOPIFY_FLAG_VERSION\n */\n '--version '?: string\n}" + "value": "export interface appgraphiql {\n /**\n * Alias of the Shopify account to use for authentication.\n * @environment SHOPIFY_FLAG_AUTH_ALIAS\n */\n '--auth-alias '?: string\n\n /**\n * The Client ID of your app.\n * @environment SHOPIFY_FLAG_CLIENT_ID\n */\n '--client-id '?: string\n\n /**\n * The name of the app configuration.\n * @environment SHOPIFY_FLAG_APP_CONFIG\n */\n '-c, --config '?: string\n\n /**\n * Print the command's JSON schemas.\n * @environment SHOPIFY_FLAG_JSON_SCHEMA\n */\n '--json-schema'?: ''\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * The path to your app directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Local port for the GraphiQL server. Must be between 1 and 65535.\n * @environment SHOPIFY_FLAG_PORT\n */\n '--port '?: string\n\n /**\n * Reset all your settings.\n * @environment SHOPIFY_FLAG_RESET\n */\n '--reset'?: ''\n\n /**\n * The myshopify.com domain of the store to open GraphiQL against. The app must be installed on the store. If not specified, you will be prompted to select a store.\n * @environment SHOPIFY_FLAG_STORE\n */\n '-s, --store '?: string\n\n /**\n * The values for any GraphQL variables in your query or mutation, in JSON format.\n * @environment SHOPIFY_FLAG_VARIABLES\n */\n '-v, --variables '?: string\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n\n /**\n * The API version to use in GraphiQL. Defaults to the latest stable version.\n * @environment SHOPIFY_FLAG_VERSION\n */\n '--version '?: string\n}" } }, "appimportcustomdatadefinitions": { @@ -2200,6 +2398,15 @@ "isOptional": true, "environmentValue": "SHOPIFY_FLAG_INCLUDE_EXISTING" }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-import-custom-data-definitions.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--json-schema", + "value": "''", + "description": "Print the command's JSON schemas.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON_SCHEMA" + }, { "filePath": "docs-shopify.dev/commands/interfaces/app-import-custom-data-definitions.interface.ts", "syntaxKind": "PropertySignature", @@ -2255,7 +2462,7 @@ "environmentValue": "SHOPIFY_FLAG_STORE" } ], - "value": "export interface appimportcustomdatadefinitions {\n /**\n * Alias of the Shopify account to use for authentication.\n * @environment SHOPIFY_FLAG_AUTH_ALIAS\n */\n '--auth-alias '?: string\n\n /**\n * The Client ID of your app.\n * @environment SHOPIFY_FLAG_CLIENT_ID\n */\n '--client-id '?: string\n\n /**\n * The name of the app configuration.\n * @environment SHOPIFY_FLAG_APP_CONFIG\n */\n '-c, --config '?: string\n\n /**\n * Include existing declared definitions in the output.\n * @environment SHOPIFY_FLAG_INCLUDE_EXISTING\n */\n '--include-existing'?: ''\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * The path to your app directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Reset all your settings.\n * @environment SHOPIFY_FLAG_RESET\n */\n '--reset'?: ''\n\n /**\n * Store URL. Must be an existing development or Shopify Plus sandbox store.\n * @environment SHOPIFY_FLAG_STORE\n */\n '-s, --store '?: string\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" + "value": "export interface appimportcustomdatadefinitions {\n /**\n * Alias of the Shopify account to use for authentication.\n * @environment SHOPIFY_FLAG_AUTH_ALIAS\n */\n '--auth-alias '?: string\n\n /**\n * The Client ID of your app.\n * @environment SHOPIFY_FLAG_CLIENT_ID\n */\n '--client-id '?: string\n\n /**\n * The name of the app configuration.\n * @environment SHOPIFY_FLAG_APP_CONFIG\n */\n '-c, --config '?: string\n\n /**\n * Include existing declared definitions in the output.\n * @environment SHOPIFY_FLAG_INCLUDE_EXISTING\n */\n '--include-existing'?: ''\n\n /**\n * Print the command's JSON schemas.\n * @environment SHOPIFY_FLAG_JSON_SCHEMA\n */\n '--json-schema'?: ''\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * The path to your app directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Reset all your settings.\n * @environment SHOPIFY_FLAG_RESET\n */\n '--reset'?: ''\n\n /**\n * Store URL. Must be an existing development or Shopify Plus sandbox store.\n * @environment SHOPIFY_FLAG_STORE\n */\n '-s, --store '?: string\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" } }, "appimportextensions": { @@ -2283,6 +2490,15 @@ "isOptional": true, "environmentValue": "SHOPIFY_FLAG_CLIENT_ID" }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-import-extensions.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--json-schema", + "value": "''", + "description": "Print the command's JSON schemas.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON_SCHEMA" + }, { "filePath": "docs-shopify.dev/commands/interfaces/app-import-extensions.interface.ts", "syntaxKind": "PropertySignature", @@ -2329,7 +2545,7 @@ "environmentValue": "SHOPIFY_FLAG_APP_CONFIG" } ], - "value": "export interface appimportextensions {\n /**\n * Alias of the Shopify account to use for authentication.\n * @environment SHOPIFY_FLAG_AUTH_ALIAS\n */\n '--auth-alias '?: string\n\n /**\n * The Client ID of your app.\n * @environment SHOPIFY_FLAG_CLIENT_ID\n */\n '--client-id '?: string\n\n /**\n * The name of the app configuration.\n * @environment SHOPIFY_FLAG_APP_CONFIG\n */\n '-c, --config '?: string\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * The path to your app directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Reset all your settings.\n * @environment SHOPIFY_FLAG_RESET\n */\n '--reset'?: ''\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" + "value": "export interface appimportextensions {\n /**\n * Alias of the Shopify account to use for authentication.\n * @environment SHOPIFY_FLAG_AUTH_ALIAS\n */\n '--auth-alias '?: string\n\n /**\n * The Client ID of your app.\n * @environment SHOPIFY_FLAG_CLIENT_ID\n */\n '--client-id '?: string\n\n /**\n * The name of the app configuration.\n * @environment SHOPIFY_FLAG_APP_CONFIG\n */\n '-c, --config '?: string\n\n /**\n * Print the command's JSON schemas.\n * @environment SHOPIFY_FLAG_JSON_SCHEMA\n */\n '--json-schema'?: ''\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * The path to your app directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Reset all your settings.\n * @environment SHOPIFY_FLAG_RESET\n */\n '--reset'?: ''\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" } }, "appinfo": { @@ -2357,6 +2573,15 @@ "isOptional": true, "environmentValue": "SHOPIFY_FLAG_CLIENT_ID" }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-info.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--json-schema", + "value": "''", + "description": "Print the command's JSON schemas.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON_SCHEMA" + }, { "filePath": "docs-shopify.dev/commands/interfaces/app-info.interface.ts", "syntaxKind": "PropertySignature", @@ -2421,7 +2646,7 @@ "environmentValue": "SHOPIFY_FLAG_JSON" } ], - "value": "export interface appinfo {\n /**\n * Alias of the Shopify account to use for authentication.\n * @environment SHOPIFY_FLAG_AUTH_ALIAS\n */\n '--auth-alias '?: string\n\n /**\n * The Client ID of your app.\n * @environment SHOPIFY_FLAG_CLIENT_ID\n */\n '--client-id '?: string\n\n /**\n * The name of the app configuration.\n * @environment SHOPIFY_FLAG_APP_CONFIG\n */\n '-c, --config '?: string\n\n /**\n * Output the result as JSON. Automatically disables color output.\n * @environment SHOPIFY_FLAG_JSON\n */\n '-j, --json'?: ''\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * The path to your app directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Reset all your settings.\n * @environment SHOPIFY_FLAG_RESET\n */\n '--reset'?: ''\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n\n /**\n * Outputs environment variables necessary for running and deploying web/.\n * @environment SHOPIFY_FLAG_OUTPUT_WEB_ENV\n */\n '--web-env'?: ''\n}" + "value": "export interface appinfo {\n /**\n * Alias of the Shopify account to use for authentication.\n * @environment SHOPIFY_FLAG_AUTH_ALIAS\n */\n '--auth-alias '?: string\n\n /**\n * The Client ID of your app.\n * @environment SHOPIFY_FLAG_CLIENT_ID\n */\n '--client-id '?: string\n\n /**\n * The name of the app configuration.\n * @environment SHOPIFY_FLAG_APP_CONFIG\n */\n '-c, --config '?: string\n\n /**\n * Output the result as JSON. Automatically disables color output.\n * @environment SHOPIFY_FLAG_JSON\n */\n '-j, --json'?: ''\n\n /**\n * Print the command's JSON schemas.\n * @environment SHOPIFY_FLAG_JSON_SCHEMA\n */\n '--json-schema'?: ''\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * The path to your app directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Reset all your settings.\n * @environment SHOPIFY_FLAG_RESET\n */\n '--reset'?: ''\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n\n /**\n * Outputs environment variables necessary for running and deploying web/.\n * @environment SHOPIFY_FLAG_OUTPUT_WEB_ENV\n */\n '--web-env'?: ''\n}" } }, "appinit": { @@ -2458,6 +2683,15 @@ "isOptional": true, "environmentValue": "SHOPIFY_FLAG_TEMPLATE_FLAVOR" }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-init.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--json-schema", + "value": "''", + "description": "Print the command's JSON schemas.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON_SCHEMA" + }, { "filePath": "docs-shopify.dev/commands/interfaces/app-init.interface.ts", "syntaxKind": "PropertySignature", @@ -2522,7 +2756,7 @@ "environmentValue": "SHOPIFY_FLAG_PATH" } ], - "value": "export interface appinit {\n /**\n * Alias of the Shopify account to use for authentication.\n * @environment SHOPIFY_FLAG_AUTH_ALIAS\n */\n '--auth-alias '?: string\n\n /**\n * 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.\n * @environment SHOPIFY_FLAG_CLIENT_ID\n */\n '--client-id '?: string\n\n /**\n * Which flavor of the given template to use. Required in non-interactive environments when the selected template offers multiple flavors.\n * @environment SHOPIFY_FLAG_TEMPLATE_FLAVOR\n */\n '--flavor '?: string\n\n /**\n * 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.\n * @environment SHOPIFY_FLAG_NAME\n */\n '-n, --name '?: string\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * 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.\n * @environment SHOPIFY_FLAG_ORGANIZATION_ID\n */\n '--organization-id '?: string\n\n /**\n * \n * @environment SHOPIFY_FLAG_PACKAGE_MANAGER\n */\n '-d, --package-manager '?: string\n\n /**\n * \n * @environment SHOPIFY_FLAG_PATH\n */\n '-p, --path '?: string\n\n /**\n * 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.\n * @environment SHOPIFY_FLAG_TEMPLATE\n */\n '--template '?: string\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" + "value": "export interface appinit {\n /**\n * Alias of the Shopify account to use for authentication.\n * @environment SHOPIFY_FLAG_AUTH_ALIAS\n */\n '--auth-alias '?: string\n\n /**\n * 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.\n * @environment SHOPIFY_FLAG_CLIENT_ID\n */\n '--client-id '?: string\n\n /**\n * Which flavor of the given template to use. Required in non-interactive environments when the selected template offers multiple flavors.\n * @environment SHOPIFY_FLAG_TEMPLATE_FLAVOR\n */\n '--flavor '?: string\n\n /**\n * Print the command's JSON schemas.\n * @environment SHOPIFY_FLAG_JSON_SCHEMA\n */\n '--json-schema'?: ''\n\n /**\n * 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.\n * @environment SHOPIFY_FLAG_NAME\n */\n '-n, --name '?: string\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * 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.\n * @environment SHOPIFY_FLAG_ORGANIZATION_ID\n */\n '--organization-id '?: string\n\n /**\n * \n * @environment SHOPIFY_FLAG_PACKAGE_MANAGER\n */\n '-d, --package-manager '?: string\n\n /**\n * \n * @environment SHOPIFY_FLAG_PATH\n */\n '-p, --path '?: string\n\n /**\n * 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.\n * @environment SHOPIFY_FLAG_TEMPLATE\n */\n '--template '?: string\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" } }, "applogssources": { @@ -2550,6 +2784,15 @@ "isOptional": true, "environmentValue": "SHOPIFY_FLAG_CLIENT_ID" }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-logs-sources.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--json-schema", + "value": "''", + "description": "Print the command's JSON schemas.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON_SCHEMA" + }, { "filePath": "docs-shopify.dev/commands/interfaces/app-logs-sources.interface.ts", "syntaxKind": "PropertySignature", @@ -2596,7 +2839,7 @@ "environmentValue": "SHOPIFY_FLAG_APP_CONFIG" } ], - "value": "export interface applogssources {\n /**\n * Alias of the Shopify account to use for authentication.\n * @environment SHOPIFY_FLAG_AUTH_ALIAS\n */\n '--auth-alias '?: string\n\n /**\n * The Client ID of your app.\n * @environment SHOPIFY_FLAG_CLIENT_ID\n */\n '--client-id '?: string\n\n /**\n * The name of the app configuration.\n * @environment SHOPIFY_FLAG_APP_CONFIG\n */\n '-c, --config '?: string\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * The path to your app directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Reset all your settings.\n * @environment SHOPIFY_FLAG_RESET\n */\n '--reset'?: ''\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" + "value": "export interface applogssources {\n /**\n * Alias of the Shopify account to use for authentication.\n * @environment SHOPIFY_FLAG_AUTH_ALIAS\n */\n '--auth-alias '?: string\n\n /**\n * The Client ID of your app.\n * @environment SHOPIFY_FLAG_CLIENT_ID\n */\n '--client-id '?: string\n\n /**\n * The name of the app configuration.\n * @environment SHOPIFY_FLAG_APP_CONFIG\n */\n '-c, --config '?: string\n\n /**\n * Print the command's JSON schemas.\n * @environment SHOPIFY_FLAG_JSON_SCHEMA\n */\n '--json-schema'?: ''\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * The path to your app directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Reset all your settings.\n * @environment SHOPIFY_FLAG_RESET\n */\n '--reset'?: ''\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" } }, "applogs": { @@ -2624,6 +2867,15 @@ "isOptional": true, "environmentValue": "SHOPIFY_FLAG_CLIENT_ID" }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-logs.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--json-schema", + "value": "''", + "description": "Print the command's JSON schemas.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON_SCHEMA" + }, { "filePath": "docs-shopify.dev/commands/interfaces/app-logs.interface.ts", "syntaxKind": "PropertySignature", @@ -2706,7 +2958,7 @@ "environmentValue": "SHOPIFY_FLAG_STORE" } ], - "value": "export interface applogs {\n /**\n * Alias of the Shopify account to use for authentication.\n * @environment SHOPIFY_FLAG_AUTH_ALIAS\n */\n '--auth-alias '?: string\n\n /**\n * The Client ID of your app.\n * @environment SHOPIFY_FLAG_CLIENT_ID\n */\n '--client-id '?: string\n\n /**\n * The name of the app configuration.\n * @environment SHOPIFY_FLAG_APP_CONFIG\n */\n '-c, --config '?: string\n\n /**\n * Output the result as JSON. Automatically disables color output.\n * @environment SHOPIFY_FLAG_JSON\n */\n '-j, --json'?: ''\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * The path to your app directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Reset all your settings.\n * @environment SHOPIFY_FLAG_RESET\n */\n '--reset'?: ''\n\n /**\n * Filters output to the specified log source.\n * @environment SHOPIFY_FLAG_SOURCE\n */\n '--source '?: string\n\n /**\n * Filters output to the specified status (success or failure).\n * @environment SHOPIFY_FLAG_STATUS\n */\n '--status '?: string\n\n /**\n * Store URL. Must be an existing development or Shopify Plus sandbox store.\n * @environment SHOPIFY_FLAG_STORE\n */\n '-s, --store '?: string\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" + "value": "export interface applogs {\n /**\n * Alias of the Shopify account to use for authentication.\n * @environment SHOPIFY_FLAG_AUTH_ALIAS\n */\n '--auth-alias '?: string\n\n /**\n * The Client ID of your app.\n * @environment SHOPIFY_FLAG_CLIENT_ID\n */\n '--client-id '?: string\n\n /**\n * The name of the app configuration.\n * @environment SHOPIFY_FLAG_APP_CONFIG\n */\n '-c, --config '?: string\n\n /**\n * Output the result as JSON. Automatically disables color output.\n * @environment SHOPIFY_FLAG_JSON\n */\n '-j, --json'?: ''\n\n /**\n * Print the command's JSON schemas.\n * @environment SHOPIFY_FLAG_JSON_SCHEMA\n */\n '--json-schema'?: ''\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * The path to your app directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Reset all your settings.\n * @environment SHOPIFY_FLAG_RESET\n */\n '--reset'?: ''\n\n /**\n * Filters output to the specified log source.\n * @environment SHOPIFY_FLAG_SOURCE\n */\n '--source '?: string\n\n /**\n * Filters output to the specified status (success or failure).\n * @environment SHOPIFY_FLAG_STATUS\n */\n '--status '?: string\n\n /**\n * Store URL. Must be an existing development or Shopify Plus sandbox store.\n * @environment SHOPIFY_FLAG_STORE\n */\n '-s, --store '?: string\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" } }, "apprelease": { @@ -2752,6 +3004,15 @@ "isOptional": true, "environmentValue": "SHOPIFY_FLAG_CLIENT_ID" }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-release.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--json-schema", + "value": "''", + "description": "Print the command's JSON schemas.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON_SCHEMA" + }, { "filePath": "docs-shopify.dev/commands/interfaces/app-release.interface.ts", "syntaxKind": "PropertySignature", @@ -2806,7 +3067,7 @@ "environmentValue": "SHOPIFY_FLAG_APP_CONFIG" } ], - "value": "export interface apprelease {\n /**\n * Allows removing extensions and configuration without requiring user confirmation. For CI/CD environments, the recommended flag is --allow-updates. Required in non-interactive environments unless --allow-updates is provided.\n * @environment SHOPIFY_FLAG_ALLOW_DELETES\n */\n '--allow-deletes'?: ''\n\n /**\n * Allows adding and updating extensions and configuration without requiring user confirmation. Recommended option for CI/CD environments. Required in non-interactive environments unless --allow-deletes is provided.\n * @environment SHOPIFY_FLAG_ALLOW_UPDATES\n */\n '--allow-updates'?: ''\n\n /**\n * Alias of the Shopify account to use for authentication.\n * @environment SHOPIFY_FLAG_AUTH_ALIAS\n */\n '--auth-alias '?: string\n\n /**\n * The Client ID of your app.\n * @environment SHOPIFY_FLAG_CLIENT_ID\n */\n '--client-id '?: string\n\n /**\n * The name of the app configuration.\n * @environment SHOPIFY_FLAG_APP_CONFIG\n */\n '-c, --config '?: string\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * The path to your app directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Reset all your settings.\n * @environment SHOPIFY_FLAG_RESET\n */\n '--reset'?: ''\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n\n /**\n * The name of the app version to release.\n * @environment SHOPIFY_FLAG_VERSION\n */\n '--version ': string\n}" + "value": "export interface apprelease {\n /**\n * Allows removing extensions and configuration without requiring user confirmation. For CI/CD environments, the recommended flag is --allow-updates. Required in non-interactive environments unless --allow-updates is provided.\n * @environment SHOPIFY_FLAG_ALLOW_DELETES\n */\n '--allow-deletes'?: ''\n\n /**\n * Allows adding and updating extensions and configuration without requiring user confirmation. Recommended option for CI/CD environments. Required in non-interactive environments unless --allow-deletes is provided.\n * @environment SHOPIFY_FLAG_ALLOW_UPDATES\n */\n '--allow-updates'?: ''\n\n /**\n * Alias of the Shopify account to use for authentication.\n * @environment SHOPIFY_FLAG_AUTH_ALIAS\n */\n '--auth-alias '?: string\n\n /**\n * The Client ID of your app.\n * @environment SHOPIFY_FLAG_CLIENT_ID\n */\n '--client-id '?: string\n\n /**\n * The name of the app configuration.\n * @environment SHOPIFY_FLAG_APP_CONFIG\n */\n '-c, --config '?: string\n\n /**\n * Print the command's JSON schemas.\n * @environment SHOPIFY_FLAG_JSON_SCHEMA\n */\n '--json-schema'?: ''\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * The path to your app directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Reset all your settings.\n * @environment SHOPIFY_FLAG_RESET\n */\n '--reset'?: ''\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n\n /**\n * The name of the app version to release.\n * @environment SHOPIFY_FLAG_VERSION\n */\n '--version ': string\n}" } }, "appversionslist": { @@ -2834,6 +3095,15 @@ "isOptional": true, "environmentValue": "SHOPIFY_FLAG_CLIENT_ID" }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-versions-list.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--json-schema", + "value": "''", + "description": "Print the command's JSON schemas.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON_SCHEMA" + }, { "filePath": "docs-shopify.dev/commands/interfaces/app-versions-list.interface.ts", "syntaxKind": "PropertySignature", @@ -2889,7 +3159,7 @@ "environmentValue": "SHOPIFY_FLAG_JSON" } ], - "value": "export interface appversionslist {\n /**\n * Alias of the Shopify account to use for authentication.\n * @environment SHOPIFY_FLAG_AUTH_ALIAS\n */\n '--auth-alias '?: string\n\n /**\n * The Client ID of your app.\n * @environment SHOPIFY_FLAG_CLIENT_ID\n */\n '--client-id '?: string\n\n /**\n * The name of the app configuration.\n * @environment SHOPIFY_FLAG_APP_CONFIG\n */\n '-c, --config '?: string\n\n /**\n * Output the result as JSON. Automatically disables color output.\n * @environment SHOPIFY_FLAG_JSON\n */\n '-j, --json'?: ''\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * The path to your app directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Reset all your settings.\n * @environment SHOPIFY_FLAG_RESET\n */\n '--reset'?: ''\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" + "value": "export interface appversionslist {\n /**\n * Alias of the Shopify account to use for authentication.\n * @environment SHOPIFY_FLAG_AUTH_ALIAS\n */\n '--auth-alias '?: string\n\n /**\n * The Client ID of your app.\n * @environment SHOPIFY_FLAG_CLIENT_ID\n */\n '--client-id '?: string\n\n /**\n * The name of the app configuration.\n * @environment SHOPIFY_FLAG_APP_CONFIG\n */\n '-c, --config '?: string\n\n /**\n * Output the result as JSON. Automatically disables color output.\n * @environment SHOPIFY_FLAG_JSON\n */\n '-j, --json'?: ''\n\n /**\n * Print the command's JSON schemas.\n * @environment SHOPIFY_FLAG_JSON_SCHEMA\n */\n '--json-schema'?: ''\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * The path to your app directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Reset all your settings.\n * @environment SHOPIFY_FLAG_RESET\n */\n '--reset'?: ''\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" } }, "appwebhooktrigger": { @@ -2962,6 +3232,15 @@ "isOptional": true, "environmentValue": "SHOPIFY_FLAG_HELP" }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-webhook-trigger.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--json-schema", + "value": "''", + "description": "Print the command's JSON schemas.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON_SCHEMA" + }, { "filePath": "docs-shopify.dev/commands/interfaces/app-webhook-trigger.interface.ts", "syntaxKind": "PropertySignature", @@ -2999,7 +3278,7 @@ "environmentValue": "SHOPIFY_FLAG_APP_CONFIG" } ], - "value": "export interface appwebhooktrigger {\n /**\n * The URL where the webhook payload should be sent.\n You will need a different address type for each delivery-method:\n · For remote HTTP testing, use a URL that starts with https://\n · For local HTTP testing, use http://localhost:{port}/{url-path}\n · For Google Pub/Sub, use pubsub://{project-id}:{topic-id}\n · For Amazon EventBridge, use an Amazon Resource Name (ARN) starting with arn:aws:events:. Required if non interactive.\n * @environment SHOPIFY_FLAG_ADDRESS\n */\n '--address '?: string\n\n /**\n * The API Version of the webhook topic. Required if non interactive.\n * @environment SHOPIFY_FLAG_API_VERSION\n */\n '--api-version '?: string\n\n /**\n * Alias of the Shopify account to use for authentication.\n * @environment SHOPIFY_FLAG_AUTH_ALIAS\n */\n '--auth-alias '?: string\n\n /**\n * The Client ID of your app.\n * @environment SHOPIFY_FLAG_CLIENT_ID\n */\n '--client-id '?: string\n\n /**\n * Your app's client secret. This secret allows us to return the X-Shopify-Hmac-SHA256 header that lets you validate the origin of the response that you receive.\n * @environment SHOPIFY_FLAG_CLIENT_SECRET\n */\n '--client-secret '?: string\n\n /**\n * The name of the app configuration.\n * @environment SHOPIFY_FLAG_APP_CONFIG\n */\n '-c, --config '?: string\n\n /**\n * Method chosen to deliver the topic payload. If not passed, it's inferred from the address.\n * @environment SHOPIFY_FLAG_DELIVERY_METHOD\n */\n '--delivery-method '?: string\n\n /**\n * This help. When you run the trigger command the CLI will prompt you for any information that isn't passed using flags.\n * @environment SHOPIFY_FLAG_HELP\n */\n '--help'?: ''\n\n /**\n * The path to your app directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Reset all your settings.\n * @environment SHOPIFY_FLAG_RESET\n */\n '--reset'?: ''\n\n /**\n * The requested webhook topic. Required if non interactive.\n * @environment SHOPIFY_FLAG_TOPIC\n */\n '--topic '?: string\n}" + "value": "export interface appwebhooktrigger {\n /**\n * The URL where the webhook payload should be sent.\n You will need a different address type for each delivery-method:\n · For remote HTTP testing, use a URL that starts with https://\n · For local HTTP testing, use http://localhost:{port}/{url-path}\n · For Google Pub/Sub, use pubsub://{project-id}:{topic-id}\n · For Amazon EventBridge, use an Amazon Resource Name (ARN) starting with arn:aws:events:. Required if non interactive.\n * @environment SHOPIFY_FLAG_ADDRESS\n */\n '--address '?: string\n\n /**\n * The API Version of the webhook topic. Required if non interactive.\n * @environment SHOPIFY_FLAG_API_VERSION\n */\n '--api-version '?: string\n\n /**\n * Alias of the Shopify account to use for authentication.\n * @environment SHOPIFY_FLAG_AUTH_ALIAS\n */\n '--auth-alias '?: string\n\n /**\n * The Client ID of your app.\n * @environment SHOPIFY_FLAG_CLIENT_ID\n */\n '--client-id '?: string\n\n /**\n * Your app's client secret. This secret allows us to return the X-Shopify-Hmac-SHA256 header that lets you validate the origin of the response that you receive.\n * @environment SHOPIFY_FLAG_CLIENT_SECRET\n */\n '--client-secret '?: string\n\n /**\n * The name of the app configuration.\n * @environment SHOPIFY_FLAG_APP_CONFIG\n */\n '-c, --config '?: string\n\n /**\n * Method chosen to deliver the topic payload. If not passed, it's inferred from the address.\n * @environment SHOPIFY_FLAG_DELIVERY_METHOD\n */\n '--delivery-method '?: string\n\n /**\n * This help. When you run the trigger command the CLI will prompt you for any information that isn't passed using flags.\n * @environment SHOPIFY_FLAG_HELP\n */\n '--help'?: ''\n\n /**\n * Print the command's JSON schemas.\n * @environment SHOPIFY_FLAG_JSON_SCHEMA\n */\n '--json-schema'?: ''\n\n /**\n * The path to your app directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Reset all your settings.\n * @environment SHOPIFY_FLAG_RESET\n */\n '--reset'?: ''\n\n /**\n * The requested webhook topic. Required if non interactive.\n * @environment SHOPIFY_FLAG_TOPIC\n */\n '--topic '?: string\n}" } }, "authlogin": { @@ -3017,9 +3296,18 @@ "description": "Alias of an existing session you want to use. Required if non interactive.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_AUTH_ALIAS" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/auth-login.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--json-schema", + "value": "''", + "description": "Print the command's JSON schemas.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON_SCHEMA" } ], - "value": "export interface authlogin {\n /**\n * Alias of an existing session you want to use. Required if non interactive.\n * @environment SHOPIFY_FLAG_AUTH_ALIAS\n */\n '--alias '?: string\n}" + "value": "export interface authlogin {\n /**\n * Alias of an existing session you want to use. Required if non interactive.\n * @environment SHOPIFY_FLAG_AUTH_ALIAS\n */\n '--alias '?: string\n\n /**\n * Print the command's JSON schemas.\n * @environment SHOPIFY_FLAG_JSON_SCHEMA\n */\n '--json-schema'?: ''\n}" } }, "authlogout": { @@ -3028,8 +3316,18 @@ "name": "authlogout", "description": "The following flags are available for the `auth logout` command:", "isPublicDocs": true, - "members": [], - "value": "export interface authlogout {\n\n}" + "members": [ + { + "filePath": "docs-shopify.dev/commands/interfaces/auth-logout.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--json-schema", + "value": "''", + "description": "Print the command's JSON schemas.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON_SCHEMA" + } + ], + "value": "export interface authlogout {\n /**\n * Print the command's JSON schemas.\n * @environment SHOPIFY_FLAG_JSON_SCHEMA\n */\n '--json-schema'?: ''\n}" } }, "commands": { @@ -3113,8 +3411,18 @@ "name": "configautocorrectoff", "description": "The following flags are available for the `config autocorrect off` command:", "isPublicDocs": true, - "members": [], - "value": "export interface configautocorrectoff {\n\n}" + "members": [ + { + "filePath": "docs-shopify.dev/commands/interfaces/config-autocorrect-off.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--json-schema", + "value": "''", + "description": "Print the command's JSON schemas.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON_SCHEMA" + } + ], + "value": "export interface configautocorrectoff {\n /**\n * Print the command's JSON schemas.\n * @environment SHOPIFY_FLAG_JSON_SCHEMA\n */\n '--json-schema'?: ''\n}" } }, "configautocorrecton": { @@ -3123,8 +3431,18 @@ "name": "configautocorrecton", "description": "The following flags are available for the `config autocorrect on` command:", "isPublicDocs": true, - "members": [], - "value": "export interface configautocorrecton {\n\n}" + "members": [ + { + "filePath": "docs-shopify.dev/commands/interfaces/config-autocorrect-on.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--json-schema", + "value": "''", + "description": "Print the command's JSON schemas.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON_SCHEMA" + } + ], + "value": "export interface configautocorrecton {\n /**\n * Print the command's JSON schemas.\n * @environment SHOPIFY_FLAG_JSON_SCHEMA\n */\n '--json-schema'?: ''\n}" } }, "configautocorrectstatus": { @@ -3133,8 +3451,18 @@ "name": "configautocorrectstatus", "description": "The following flags are available for the `config autocorrect status` command:", "isPublicDocs": true, - "members": [], - "value": "export interface configautocorrectstatus {\n\n}" + "members": [ + { + "filePath": "docs-shopify.dev/commands/interfaces/config-autocorrect-status.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--json-schema", + "value": "''", + "description": "Print the command's JSON schemas.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON_SCHEMA" + } + ], + "value": "export interface configautocorrectstatus {\n /**\n * Print the command's JSON schemas.\n * @environment SHOPIFY_FLAG_JSON_SCHEMA\n */\n '--json-schema'?: ''\n}" } }, "configautoupgradeoff": { @@ -3143,8 +3471,18 @@ "name": "configautoupgradeoff", "description": "The following flags are available for the `config autoupgrade off` command:", "isPublicDocs": true, - "members": [], - "value": "export interface configautoupgradeoff {\n\n}" + "members": [ + { + "filePath": "docs-shopify.dev/commands/interfaces/config-autoupgrade-off.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--json-schema", + "value": "''", + "description": "Print the command's JSON schemas.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON_SCHEMA" + } + ], + "value": "export interface configautoupgradeoff {\n /**\n * Print the command's JSON schemas.\n * @environment SHOPIFY_FLAG_JSON_SCHEMA\n */\n '--json-schema'?: ''\n}" } }, "configautoupgradeon": { @@ -3153,8 +3491,18 @@ "name": "configautoupgradeon", "description": "The following flags are available for the `config autoupgrade on` command:", "isPublicDocs": true, - "members": [], - "value": "export interface configautoupgradeon {\n\n}" + "members": [ + { + "filePath": "docs-shopify.dev/commands/interfaces/config-autoupgrade-on.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--json-schema", + "value": "''", + "description": "Print the command's JSON schemas.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON_SCHEMA" + } + ], + "value": "export interface configautoupgradeon {\n /**\n * Print the command's JSON schemas.\n * @environment SHOPIFY_FLAG_JSON_SCHEMA\n */\n '--json-schema'?: ''\n}" } }, "configautoupgradestatus": { @@ -3163,8 +3511,18 @@ "name": "configautoupgradestatus", "description": "The following flags are available for the `config autoupgrade status` command:", "isPublicDocs": true, - "members": [], - "value": "export interface configautoupgradestatus {\n\n}" + "members": [ + { + "filePath": "docs-shopify.dev/commands/interfaces/config-autoupgrade-status.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--json-schema", + "value": "''", + "description": "Print the command's JSON schemas.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON_SCHEMA" + } + ], + "value": "export interface configautoupgradestatus {\n /**\n * Print the command's JSON schemas.\n * @environment SHOPIFY_FLAG_JSON_SCHEMA\n */\n '--json-schema'?: ''\n}" } }, "docfetch": { @@ -3174,6 +3532,15 @@ "description": "The following flags are available for the `doc fetch` command:", "isPublicDocs": true, "members": [ + { + "filePath": "docs-shopify.dev/commands/interfaces/doc-fetch.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--json-schema", + "value": "''", + "description": "Print the command's JSON schemas.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON_SCHEMA" + }, { "filePath": "docs-shopify.dev/commands/interfaces/doc-fetch.interface.ts", "syntaxKind": "PropertySignature", @@ -3210,7 +3577,7 @@ "environmentValue": "SHOPIFY_FLAG_VERBOSE" } ], - "value": "export interface docfetch {\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * Write the document to this file path instead of printing it to stdout.\n * @environment SHOPIFY_FLAG_OUTPUT\n */\n '--output '?: string\n\n /**\n * The shopify.dev URL to fetch.\n * @environment SHOPIFY_FLAG_URL\n */\n '--url ': string\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" + "value": "export interface docfetch {\n /**\n * Print the command's JSON schemas.\n * @environment SHOPIFY_FLAG_JSON_SCHEMA\n */\n '--json-schema'?: ''\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * Write the document to this file path instead of printing it to stdout.\n * @environment SHOPIFY_FLAG_OUTPUT\n */\n '--output '?: string\n\n /**\n * The shopify.dev URL to fetch.\n * @environment SHOPIFY_FLAG_URL\n */\n '--url ': string\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" } }, "docsearch": { @@ -3238,6 +3605,15 @@ "isOptional": true, "environmentValue": "SHOPIFY_FLAG_API_VERSION" }, + { + "filePath": "docs-shopify.dev/commands/interfaces/doc-search.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--json-schema", + "value": "''", + "description": "Print the command's JSON schemas.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON_SCHEMA" + }, { "filePath": "docs-shopify.dev/commands/interfaces/doc-search.interface.ts", "syntaxKind": "PropertySignature", @@ -3265,7 +3641,7 @@ "environmentValue": "SHOPIFY_FLAG_VERBOSE" } ], - "value": "export interface docsearch {\n /**\n * Limit results to a specific API (for example: admin, storefront, hydrogen, functions). Unrecognized values are ignored.\n * @environment SHOPIFY_FLAG_API_NAME\n */\n '--api-name '?: string\n\n /**\n * Limit results to a specific API version (for example: 2025-10, latest, current).\n * @environment SHOPIFY_FLAG_API_VERSION\n */\n '--api-version '?: string\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * The search query.\n * @environment SHOPIFY_FLAG_QUERY\n */\n '--query ': string\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" + "value": "export interface docsearch {\n /**\n * Limit results to a specific API (for example: admin, storefront, hydrogen, functions). Unrecognized values are ignored.\n * @environment SHOPIFY_FLAG_API_NAME\n */\n '--api-name '?: string\n\n /**\n * Limit results to a specific API version (for example: 2025-10, latest, current).\n * @environment SHOPIFY_FLAG_API_VERSION\n */\n '--api-version '?: string\n\n /**\n * Print the command's JSON schemas.\n * @environment SHOPIFY_FLAG_JSON_SCHEMA\n */\n '--json-schema'?: ''\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * The search query.\n * @environment SHOPIFY_FLAG_QUERY\n */\n '--query ': string\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" } }, "help": { @@ -3278,14 +3654,23 @@ { "filePath": "docs-shopify.dev/commands/interfaces/help.interface.ts", "syntaxKind": "PropertySignature", - "name": "-n, --nested-commands", + "name": "--json-schema", "value": "''", - "description": "Include all nested commands in the output.", + "description": "Print the command's JSON schemas.", "isOptional": true, - "environmentValue": "SHOPIFY_FLAG_CLI_NESTED_COMMANDS" + "environmentValue": "SHOPIFY_FLAG_JSON_SCHEMA" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/help.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-n, --nested-commands", + "value": "''", + "description": "Include all nested commands in the output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_CLI_NESTED_COMMANDS" } ], - "value": "export interface help {\n /**\n * Include all nested commands in the output.\n * @environment SHOPIFY_FLAG_CLI_NESTED_COMMANDS\n */\n '-n, --nested-commands'?: ''\n}" + "value": "export interface help {\n /**\n * Print the command's JSON schemas.\n * @environment SHOPIFY_FLAG_JSON_SCHEMA\n */\n '--json-schema'?: ''\n\n /**\n * Include all nested commands in the output.\n * @environment SHOPIFY_FLAG_CLI_NESTED_COMMANDS\n */\n '-n, --nested-commands'?: ''\n}" } }, "hydrogenbuild": { @@ -3346,6 +3731,15 @@ "isOptional": true, "environmentValue": "SHOPIFY_HYDROGEN_FLAG_FORCE_CLIENT_SOURCEMAP" }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-build.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--json-schema", + "value": "''", + "description": "Print the command's JSON schemas.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON_SCHEMA" + }, { "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-build.interface.ts", "syntaxKind": "PropertySignature", @@ -3383,7 +3777,7 @@ "environmentValue": "SHOPIFY_HYDROGEN_FLAG_WATCH" } ], - "value": "export interface hydrogenbuild {\n /**\n * Show a bundle size summary after building. Defaults to true, use `--no-bundle-stats` to disable.\n *\n */\n '--bundle-stats'?: ''\n\n /**\n * Automatically generates GraphQL types for your project’s Storefront API queries.\n *\n */\n '--codegen'?: ''\n\n /**\n * Specifies a path to a codegen configuration file. Defaults to `/codegen.ts` if this file exists.\n *\n */\n '--codegen-config-path '?: string\n\n /**\n * Disables any warnings about missing standard routes.\n * @environment SHOPIFY_HYDROGEN_FLAG_DISABLE_ROUTE_WARNING\n */\n '--disable-route-warning'?: ''\n\n /**\n * Entry file for the worker. Defaults to `./server`.\n * @environment SHOPIFY_HYDROGEN_FLAG_ENTRY\n */\n '--entry '?: string\n\n /**\n * Client sourcemapping is avoided by default because it makes backend code visible in the browser. Use this flag to force enabling it.\n * @environment SHOPIFY_HYDROGEN_FLAG_FORCE_CLIENT_SOURCEMAP\n */\n '--force-client-sourcemap'?: ''\n\n /**\n * Checks that there is exactly one valid lockfile in the project. Defaults to `true`. Deactivate with `--no-lockfile-check`.\n * @environment SHOPIFY_HYDROGEN_FLAG_LOCKFILE_CHECK\n */\n '--lockfile-check'?: ''\n\n /**\n * The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.\n * @environment SHOPIFY_HYDROGEN_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Controls whether server sourcemaps are generated. Default to `true`. Deactivate `--no-sourcemaps`.\n * @environment SHOPIFY_HYDROGEN_FLAG_SOURCEMAP\n */\n '--sourcemap'?: ''\n\n /**\n * Watches for changes and rebuilds the project writing output to disk.\n * @environment SHOPIFY_HYDROGEN_FLAG_WATCH\n */\n '--watch'?: ''\n}" + "value": "export interface hydrogenbuild {\n /**\n * Show a bundle size summary after building. Defaults to true, use `--no-bundle-stats` to disable.\n *\n */\n '--bundle-stats'?: ''\n\n /**\n * Automatically generates GraphQL types for your project’s Storefront API queries.\n *\n */\n '--codegen'?: ''\n\n /**\n * Specifies a path to a codegen configuration file. Defaults to `/codegen.ts` if this file exists.\n *\n */\n '--codegen-config-path '?: string\n\n /**\n * Disables any warnings about missing standard routes.\n * @environment SHOPIFY_HYDROGEN_FLAG_DISABLE_ROUTE_WARNING\n */\n '--disable-route-warning'?: ''\n\n /**\n * Entry file for the worker. Defaults to `./server`.\n * @environment SHOPIFY_HYDROGEN_FLAG_ENTRY\n */\n '--entry '?: string\n\n /**\n * Client sourcemapping is avoided by default because it makes backend code visible in the browser. Use this flag to force enabling it.\n * @environment SHOPIFY_HYDROGEN_FLAG_FORCE_CLIENT_SOURCEMAP\n */\n '--force-client-sourcemap'?: ''\n\n /**\n * Print the command's JSON schemas.\n * @environment SHOPIFY_FLAG_JSON_SCHEMA\n */\n '--json-schema'?: ''\n\n /**\n * Checks that there is exactly one valid lockfile in the project. Defaults to `true`. Deactivate with `--no-lockfile-check`.\n * @environment SHOPIFY_HYDROGEN_FLAG_LOCKFILE_CHECK\n */\n '--lockfile-check'?: ''\n\n /**\n * The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.\n * @environment SHOPIFY_HYDROGEN_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Controls whether server sourcemaps are generated. Default to `true`. Deactivate `--no-sourcemaps`.\n * @environment SHOPIFY_HYDROGEN_FLAG_SOURCEMAP\n */\n '--sourcemap'?: ''\n\n /**\n * Watches for changes and rebuilds the project writing output to disk.\n * @environment SHOPIFY_HYDROGEN_FLAG_WATCH\n */\n '--watch'?: ''\n}" } }, "hydrogencheck": { @@ -3393,6 +3787,15 @@ "description": "The following flags are available for the `hydrogen check` command:", "isPublicDocs": true, "members": [ + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-check.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--json-schema", + "value": "''", + "description": "Print the command's JSON schemas.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON_SCHEMA" + }, { "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-check.interface.ts", "syntaxKind": "PropertySignature", @@ -3403,7 +3806,7 @@ "environmentValue": "SHOPIFY_HYDROGEN_FLAG_PATH" } ], - "value": "export interface hydrogencheck {\n /**\n * The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.\n * @environment SHOPIFY_HYDROGEN_FLAG_PATH\n */\n '--path '?: string\n}" + "value": "export interface hydrogencheck {\n /**\n * Print the command's JSON schemas.\n * @environment SHOPIFY_FLAG_JSON_SCHEMA\n */\n '--json-schema'?: ''\n\n /**\n * The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.\n * @environment SHOPIFY_HYDROGEN_FLAG_PATH\n */\n '--path '?: string\n}" } }, "hydrogencodegen": { @@ -3421,6 +3824,15 @@ "description": "Specify a path to a codegen configuration file. Defaults to `/codegen.ts` if it exists.", "isOptional": true }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-codegen.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--json-schema", + "value": "''", + "description": "Print the command's JSON schemas.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON_SCHEMA" + }, { "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-codegen.interface.ts", "syntaxKind": "PropertySignature", @@ -3439,7 +3851,7 @@ "isOptional": true } ], - "value": "export interface hydrogencodegen {\n /**\n * Specify a path to a codegen configuration file. Defaults to `/codegen.ts` if it exists.\n *\n */\n '--codegen-config-path '?: string\n\n /**\n * The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.\n * @environment SHOPIFY_HYDROGEN_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Watch the project for changes to update types on file save.\n *\n */\n '--watch'?: ''\n}" + "value": "export interface hydrogencodegen {\n /**\n * Specify a path to a codegen configuration file. Defaults to `/codegen.ts` if it exists.\n *\n */\n '--codegen-config-path '?: string\n\n /**\n * Print the command's JSON schemas.\n * @environment SHOPIFY_FLAG_JSON_SCHEMA\n */\n '--json-schema'?: ''\n\n /**\n * The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.\n * @environment SHOPIFY_HYDROGEN_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Watch the project for changes to update types on file save.\n *\n */\n '--watch'?: ''\n}" } }, "hydrogencustomeraccountpush": { @@ -3456,6 +3868,15 @@ "value": "string", "description": "The development domain of your application." }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-customer-account-push.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--json-schema", + "value": "''", + "description": "Print the command's JSON schemas.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON_SCHEMA" + }, { "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-customer-account-push.interface.ts", "syntaxKind": "PropertySignature", @@ -3490,7 +3911,7 @@ "isOptional": true } ], - "value": "export interface hydrogencustomeraccountpush {\n /**\n * The development domain of your application.\n *\n */\n '--dev-origin ': string\n\n /**\n * The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.\n * @environment SHOPIFY_HYDROGEN_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * The relative url of allowed url that will be redirected to post-logout for Customer Account API OAuth flow. Default to nothing.\n *\n */\n '--relative-logout-uri '?: string\n\n /**\n * The relative url of allowed callback url for Customer Account API OAuth flow. Default is '/account/authorize'\n *\n */\n '--relative-redirect-uri '?: string\n\n /**\n * The id of the storefront the configuration should be pushed to. Must start with 'gid://shopify/HydrogenStorefront/'\n *\n */\n '--storefront-id '?: string\n}" + "value": "export interface hydrogencustomeraccountpush {\n /**\n * The development domain of your application.\n *\n */\n '--dev-origin ': string\n\n /**\n * Print the command's JSON schemas.\n * @environment SHOPIFY_FLAG_JSON_SCHEMA\n */\n '--json-schema'?: ''\n\n /**\n * The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.\n * @environment SHOPIFY_HYDROGEN_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * The relative url of allowed url that will be redirected to post-logout for Customer Account API OAuth flow. Default to nothing.\n *\n */\n '--relative-logout-uri '?: string\n\n /**\n * The relative url of allowed callback url for Customer Account API OAuth flow. Default is '/account/authorize'\n *\n */\n '--relative-redirect-uri '?: string\n\n /**\n * The id of the storefront the configuration should be pushed to. Must start with 'gid://shopify/HydrogenStorefront/'\n *\n */\n '--storefront-id '?: string\n}" } }, "hydrogendebugcpu": { @@ -3509,6 +3930,15 @@ "isOptional": true, "environmentValue": "SHOPIFY_HYDROGEN_FLAG_ENTRY" }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-debug-cpu.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--json-schema", + "value": "''", + "description": "Print the command's JSON schemas.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON_SCHEMA" + }, { "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-debug-cpu.interface.ts", "syntaxKind": "PropertySignature", @@ -3527,7 +3957,7 @@ "environmentValue": "SHOPIFY_HYDROGEN_FLAG_PATH" } ], - "value": "export interface hydrogendebugcpu {\n /**\n * Entry file for the worker. Defaults to `./server`.\n * @environment SHOPIFY_HYDROGEN_FLAG_ENTRY\n */\n '--entry '?: string\n\n /**\n * Specify a path to generate the profile file. Defaults to \"startup.cpuprofile\".\n *\n */\n '--output '?: string\n\n /**\n * The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.\n * @environment SHOPIFY_HYDROGEN_FLAG_PATH\n */\n '--path '?: string\n}" + "value": "export interface hydrogendebugcpu {\n /**\n * Entry file for the worker. Defaults to `./server`.\n * @environment SHOPIFY_HYDROGEN_FLAG_ENTRY\n */\n '--entry '?: string\n\n /**\n * Print the command's JSON schemas.\n * @environment SHOPIFY_FLAG_JSON_SCHEMA\n */\n '--json-schema'?: ''\n\n /**\n * Specify a path to generate the profile file. Defaults to \"startup.cpuprofile\".\n *\n */\n '--output '?: string\n\n /**\n * The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.\n * @environment SHOPIFY_HYDROGEN_FLAG_PATH\n */\n '--path '?: string\n}" } }, "hydrogendeploy": { @@ -3623,6 +4053,15 @@ "description": "Create a JSON file containing the deployment details in CI environments. Defaults to true, use `--no-json-output` to disable.", "isOptional": true }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-deploy.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--json-schema", + "value": "''", + "description": "Print the command's JSON schemas.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON_SCHEMA" + }, { "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-deploy.interface.ts", "syntaxKind": "PropertySignature", @@ -3712,7 +4151,7 @@ "environmentValue": "SHOPIFY_HYDROGEN_DEPLOYMENT_TOKEN" } ], - "value": "export interface hydrogendeploy {\n /**\n * 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`.\n * @environment SHOPIFY_HYDROGEN_FLAG_ASSETS_DIR\n */\n '--assets-dir '?: string\n\n /**\n * Generate an authentication bypass token, which can be used to perform end-to-end tests against the deployment.\n * @environment AUTH_BYPASS_TOKEN\n */\n '--auth-bypass-token'?: ''\n\n /**\n * Specify the duration (in hours) up to 12 hours for the authentication bypass token. Defaults to `2`\n * @environment AUTH_BYPASS_TOKEN_DURATION\n */\n '--auth-bypass-token-duration '?: string\n\n /**\n * 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`.\n *\n */\n '--build-command '?: string\n\n /**\n * Entry file for the worker. Defaults to `./server`.\n * @environment SHOPIFY_HYDROGEN_FLAG_ENTRY\n */\n '--entry '?: string\n\n /**\n * Specifies the environment to perform the operation using its handle. Fetch the handle using the `env list` command.\n *\n */\n '--env '?: string\n\n /**\n * Specifies the environment to perform the operation using its Git branch name.\n * @environment SHOPIFY_HYDROGEN_ENVIRONMENT_BRANCH\n */\n '--env-branch '?: string\n\n /**\n * Path to an environment file to override existing environment variables for the deployment.\n *\n */\n '--env-file '?: string\n\n /**\n * Forces a deployment to proceed if there are uncommitted changes in its Git repository, and skips confirmation prompts for non-preview environments.\n * @environment SHOPIFY_HYDROGEN_FLAG_FORCE\n */\n '-f, --force'?: ''\n\n /**\n * Client sourcemapping is avoided by default because it makes backend code visible in the browser. Use this flag to force enabling it.\n * @environment SHOPIFY_HYDROGEN_FLAG_FORCE_CLIENT_SOURCEMAP\n */\n '--force-client-sourcemap'?: ''\n\n /**\n * Create a JSON file containing the deployment details in CI environments. Defaults to true, use `--no-json-output` to disable.\n *\n */\n '--json-output'?: ''\n\n /**\n * Checks that there is exactly one valid lockfile in the project. Defaults to `true`. Deactivate with `--no-lockfile-check`.\n * @environment SHOPIFY_HYDROGEN_FLAG_LOCKFILE_CHECK\n */\n '--lockfile-check'?: ''\n\n /**\n * Description of the changes in the deployment. Defaults to the commit message of the latest commit if there are no uncommitted changes.\n * @environment SHOPIFY_HYDROGEN_FLAG_METADATA_DESCRIPTION\n */\n '--metadata-description '?: string\n\n /**\n * User that initiated the deployment. Will be saved and displayed in the Shopify admin\n * @environment SHOPIFY_HYDROGEN_FLAG_METADATA_USER\n */\n '--metadata-user '?: string\n\n /**\n * Skip the routability verification step after deployment.\n *\n */\n '--no-verify'?: ''\n\n /**\n * The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.\n * @environment SHOPIFY_HYDROGEN_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Deploys to the Preview environment.\n *\n */\n '--preview'?: ''\n\n /**\n * Shop URL. It can be the shop prefix (janes-apparel) or the full myshopify.com URL (janes-apparel.myshopify.com, https://janes-apparel.myshopify.com).\n * @environment SHOPIFY_SHOP\n */\n '-s, --shop '?: string\n\n /**\n * Oxygen deployment token. Defaults to the linked storefront's token if available.\n * @environment SHOPIFY_HYDROGEN_DEPLOYMENT_TOKEN\n */\n '-t, --token '?: string\n\n /**\n * 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`.\n * @environment SHOPIFY_HYDROGEN_FLAG_WORKER_DIR\n */\n '--worker-dir '?: string\n}" + "value": "export interface hydrogendeploy {\n /**\n * 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`.\n * @environment SHOPIFY_HYDROGEN_FLAG_ASSETS_DIR\n */\n '--assets-dir '?: string\n\n /**\n * Generate an authentication bypass token, which can be used to perform end-to-end tests against the deployment.\n * @environment AUTH_BYPASS_TOKEN\n */\n '--auth-bypass-token'?: ''\n\n /**\n * Specify the duration (in hours) up to 12 hours for the authentication bypass token. Defaults to `2`\n * @environment AUTH_BYPASS_TOKEN_DURATION\n */\n '--auth-bypass-token-duration '?: string\n\n /**\n * 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`.\n *\n */\n '--build-command '?: string\n\n /**\n * Entry file for the worker. Defaults to `./server`.\n * @environment SHOPIFY_HYDROGEN_FLAG_ENTRY\n */\n '--entry '?: string\n\n /**\n * Specifies the environment to perform the operation using its handle. Fetch the handle using the `env list` command.\n *\n */\n '--env '?: string\n\n /**\n * Specifies the environment to perform the operation using its Git branch name.\n * @environment SHOPIFY_HYDROGEN_ENVIRONMENT_BRANCH\n */\n '--env-branch '?: string\n\n /**\n * Path to an environment file to override existing environment variables for the deployment.\n *\n */\n '--env-file '?: string\n\n /**\n * Forces a deployment to proceed if there are uncommitted changes in its Git repository, and skips confirmation prompts for non-preview environments.\n * @environment SHOPIFY_HYDROGEN_FLAG_FORCE\n */\n '-f, --force'?: ''\n\n /**\n * Client sourcemapping is avoided by default because it makes backend code visible in the browser. Use this flag to force enabling it.\n * @environment SHOPIFY_HYDROGEN_FLAG_FORCE_CLIENT_SOURCEMAP\n */\n '--force-client-sourcemap'?: ''\n\n /**\n * Create a JSON file containing the deployment details in CI environments. Defaults to true, use `--no-json-output` to disable.\n *\n */\n '--json-output'?: ''\n\n /**\n * Print the command's JSON schemas.\n * @environment SHOPIFY_FLAG_JSON_SCHEMA\n */\n '--json-schema'?: ''\n\n /**\n * Checks that there is exactly one valid lockfile in the project. Defaults to `true`. Deactivate with `--no-lockfile-check`.\n * @environment SHOPIFY_HYDROGEN_FLAG_LOCKFILE_CHECK\n */\n '--lockfile-check'?: ''\n\n /**\n * Description of the changes in the deployment. Defaults to the commit message of the latest commit if there are no uncommitted changes.\n * @environment SHOPIFY_HYDROGEN_FLAG_METADATA_DESCRIPTION\n */\n '--metadata-description '?: string\n\n /**\n * User that initiated the deployment. Will be saved and displayed in the Shopify admin\n * @environment SHOPIFY_HYDROGEN_FLAG_METADATA_USER\n */\n '--metadata-user '?: string\n\n /**\n * Skip the routability verification step after deployment.\n *\n */\n '--no-verify'?: ''\n\n /**\n * The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.\n * @environment SHOPIFY_HYDROGEN_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Deploys to the Preview environment.\n *\n */\n '--preview'?: ''\n\n /**\n * Shop URL. It can be the shop prefix (janes-apparel) or the full myshopify.com URL (janes-apparel.myshopify.com, https://janes-apparel.myshopify.com).\n * @environment SHOPIFY_SHOP\n */\n '-s, --shop '?: string\n\n /**\n * Oxygen deployment token. Defaults to the linked storefront's token if available.\n * @environment SHOPIFY_HYDROGEN_DEPLOYMENT_TOKEN\n */\n '-t, --token '?: string\n\n /**\n * 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`.\n * @environment SHOPIFY_HYDROGEN_FLAG_WORKER_DIR\n */\n '--worker-dir '?: string\n}" } }, "hydrogendev": { @@ -3833,6 +4272,15 @@ "isOptional": true, "environmentValue": "SHOPIFY_HYDROGEN_FLAG_INSPECTOR_PORT" }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-dev.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--json-schema", + "value": "''", + "description": "Print the command's JSON schemas.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON_SCHEMA" + }, { "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-dev.interface.ts", "syntaxKind": "PropertySignature", @@ -3861,7 +4309,7 @@ "environmentValue": "SHOPIFY_HYDROGEN_FLAG_VERBOSE" } ], - "value": "export interface hydrogendev {\n /**\n * Automatically generates GraphQL types for your project’s Storefront API queries.\n *\n */\n '--codegen'?: ''\n\n /**\n * Specifies a path to a codegen configuration file. Defaults to `/codegen.ts` if this file exists.\n *\n */\n '--codegen-config-path '?: string\n\n /**\n * Use tunneling for local development and push the tunneling domain to admin. Required to use Customer Account API's OAuth flow\n * @environment SHOPIFY_HYDROGEN_FLAG_CUSTOMER_ACCOUNT_PUSH\n */\n '--customer-account-push'?: ''\n\n /**\n * Enables inspector connections to the server with a debugger such as Visual Studio Code or Chrome DevTools.\n * @environment SHOPIFY_HYDROGEN_FLAG_DEBUG\n */\n '--debug'?: ''\n\n /**\n * Disable adding dependencies to Vite's `ssr.optimizeDeps.include` automatically\n * @environment SHOPIFY_HYDROGEN_FLAG_DISABLE_DEPS_OPTIMIZER\n */\n '--disable-deps-optimizer'?: ''\n\n /**\n * Skip the version check when running `hydrogen dev`\n *\n */\n '--disable-version-check'?: ''\n\n /**\n * Disable rendering fallback routes when a route file doesn't exist.\n * @environment SHOPIFY_HYDROGEN_FLAG_DISABLE_VIRTUAL_ROUTES\n */\n '--disable-virtual-routes'?: ''\n\n /**\n * Entry file for the worker. Defaults to `./server`.\n * @environment SHOPIFY_HYDROGEN_FLAG_ENTRY\n */\n '--entry '?: string\n\n /**\n * Specifies the environment to perform the operation using its handle. Fetch the handle using the `env list` command.\n *\n */\n '--env '?: string\n\n /**\n * Specifies the environment to perform the operation using its Git branch name.\n * @environment SHOPIFY_HYDROGEN_ENVIRONMENT_BRANCH\n */\n '--env-branch '?: string\n\n /**\n * Path to an environment file to override existing environment variables. Defaults to the '.env' located in your project path `--path`.\n *\n */\n '--env-file '?: string\n\n /**\n * Expose the server to the local network\n *\n */\n '--host'?: ''\n\n /**\n * The port where the inspector is available. Defaults to 9229.\n * @environment SHOPIFY_HYDROGEN_FLAG_INSPECTOR_PORT\n */\n '--inspector-port '?: string\n\n /**\n * The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.\n * @environment SHOPIFY_HYDROGEN_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * The port to run the server on. Defaults to 3000.\n * @environment SHOPIFY_HYDROGEN_FLAG_PORT\n */\n '--port '?: string\n\n /**\n * Outputs more information about the command's execution.\n * @environment SHOPIFY_HYDROGEN_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" + "value": "export interface hydrogendev {\n /**\n * Automatically generates GraphQL types for your project’s Storefront API queries.\n *\n */\n '--codegen'?: ''\n\n /**\n * Specifies a path to a codegen configuration file. Defaults to `/codegen.ts` if this file exists.\n *\n */\n '--codegen-config-path '?: string\n\n /**\n * Use tunneling for local development and push the tunneling domain to admin. Required to use Customer Account API's OAuth flow\n * @environment SHOPIFY_HYDROGEN_FLAG_CUSTOMER_ACCOUNT_PUSH\n */\n '--customer-account-push'?: ''\n\n /**\n * Enables inspector connections to the server with a debugger such as Visual Studio Code or Chrome DevTools.\n * @environment SHOPIFY_HYDROGEN_FLAG_DEBUG\n */\n '--debug'?: ''\n\n /**\n * Disable adding dependencies to Vite's `ssr.optimizeDeps.include` automatically\n * @environment SHOPIFY_HYDROGEN_FLAG_DISABLE_DEPS_OPTIMIZER\n */\n '--disable-deps-optimizer'?: ''\n\n /**\n * Skip the version check when running `hydrogen dev`\n *\n */\n '--disable-version-check'?: ''\n\n /**\n * Disable rendering fallback routes when a route file doesn't exist.\n * @environment SHOPIFY_HYDROGEN_FLAG_DISABLE_VIRTUAL_ROUTES\n */\n '--disable-virtual-routes'?: ''\n\n /**\n * Entry file for the worker. Defaults to `./server`.\n * @environment SHOPIFY_HYDROGEN_FLAG_ENTRY\n */\n '--entry '?: string\n\n /**\n * Specifies the environment to perform the operation using its handle. Fetch the handle using the `env list` command.\n *\n */\n '--env '?: string\n\n /**\n * Specifies the environment to perform the operation using its Git branch name.\n * @environment SHOPIFY_HYDROGEN_ENVIRONMENT_BRANCH\n */\n '--env-branch '?: string\n\n /**\n * Path to an environment file to override existing environment variables. Defaults to the '.env' located in your project path `--path`.\n *\n */\n '--env-file '?: string\n\n /**\n * Expose the server to the local network\n *\n */\n '--host'?: ''\n\n /**\n * The port where the inspector is available. Defaults to 9229.\n * @environment SHOPIFY_HYDROGEN_FLAG_INSPECTOR_PORT\n */\n '--inspector-port '?: string\n\n /**\n * Print the command's JSON schemas.\n * @environment SHOPIFY_FLAG_JSON_SCHEMA\n */\n '--json-schema'?: ''\n\n /**\n * The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.\n * @environment SHOPIFY_HYDROGEN_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * The port to run the server on. Defaults to 3000.\n * @environment SHOPIFY_HYDROGEN_FLAG_PORT\n */\n '--port '?: string\n\n /**\n * Outputs more information about the command's execution.\n * @environment SHOPIFY_HYDROGEN_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" } }, "hydrogenenvlist": { @@ -3871,6 +4319,15 @@ "description": "The following flags are available for the `hydrogen env list` command:", "isPublicDocs": true, "members": [ + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-env-list.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--json-schema", + "value": "''", + "description": "Print the command's JSON schemas.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON_SCHEMA" + }, { "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-env-list.interface.ts", "syntaxKind": "PropertySignature", @@ -3881,7 +4338,7 @@ "environmentValue": "SHOPIFY_HYDROGEN_FLAG_PATH" } ], - "value": "export interface hydrogenenvlist {\n /**\n * The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.\n * @environment SHOPIFY_HYDROGEN_FLAG_PATH\n */\n '--path '?: string\n}" + "value": "export interface hydrogenenvlist {\n /**\n * Print the command's JSON schemas.\n * @environment SHOPIFY_FLAG_JSON_SCHEMA\n */\n '--json-schema'?: ''\n\n /**\n * The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.\n * @environment SHOPIFY_HYDROGEN_FLAG_PATH\n */\n '--path '?: string\n}" } }, "hydrogenenvpull": { @@ -3916,6 +4373,15 @@ "description": "Path to an environment file to override existing environment variables. Defaults to the '.env' located in your project path `--path`.", "isOptional": true }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-env-pull.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--json-schema", + "value": "''", + "description": "Print the command's JSON schemas.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON_SCHEMA" + }, { "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-env-pull.interface.ts", "syntaxKind": "PropertySignature", @@ -3935,7 +4401,7 @@ "environmentValue": "SHOPIFY_HYDROGEN_FLAG_FORCE" } ], - "value": "export interface hydrogenenvpull {\n /**\n * Specifies the environment to perform the operation using its handle. Fetch the handle using the `env list` command.\n *\n */\n '--env '?: string\n\n /**\n * Specifies the environment to perform the operation using its Git branch name.\n * @environment SHOPIFY_HYDROGEN_ENVIRONMENT_BRANCH\n */\n '--env-branch '?: string\n\n /**\n * Path to an environment file to override existing environment variables. Defaults to the '.env' located in your project path `--path`.\n *\n */\n '--env-file '?: string\n\n /**\n * Overwrites the destination directory and files if they already exist.\n * @environment SHOPIFY_HYDROGEN_FLAG_FORCE\n */\n '-f, --force'?: ''\n\n /**\n * The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.\n * @environment SHOPIFY_HYDROGEN_FLAG_PATH\n */\n '--path '?: string\n}" + "value": "export interface hydrogenenvpull {\n /**\n * Specifies the environment to perform the operation using its handle. Fetch the handle using the `env list` command.\n *\n */\n '--env '?: string\n\n /**\n * Specifies the environment to perform the operation using its Git branch name.\n * @environment SHOPIFY_HYDROGEN_ENVIRONMENT_BRANCH\n */\n '--env-branch '?: string\n\n /**\n * Path to an environment file to override existing environment variables. Defaults to the '.env' located in your project path `--path`.\n *\n */\n '--env-file '?: string\n\n /**\n * Overwrites the destination directory and files if they already exist.\n * @environment SHOPIFY_HYDROGEN_FLAG_FORCE\n */\n '-f, --force'?: ''\n\n /**\n * Print the command's JSON schemas.\n * @environment SHOPIFY_FLAG_JSON_SCHEMA\n */\n '--json-schema'?: ''\n\n /**\n * The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.\n * @environment SHOPIFY_HYDROGEN_FLAG_PATH\n */\n '--path '?: string\n}" } }, "hydrogenenvpush": { @@ -3970,6 +4436,15 @@ "description": "Path to an environment file to override existing environment variables. Defaults to the '.env' located in your project path `--path`.", "isOptional": true }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-env-push.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--json-schema", + "value": "''", + "description": "Print the command's JSON schemas.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON_SCHEMA" + }, { "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-env-push.interface.ts", "syntaxKind": "PropertySignature", @@ -3989,7 +4464,7 @@ "environmentValue": "SHOPIFY_HYDROGEN_FLAG_FORCE" } ], - "value": "export interface hydrogenenvpush {\n /**\n * Preview environment variable changes without pushing them.\n * @environment SHOPIFY_HYDROGEN_FLAG_DRY_RUN\n */\n '--dry-run'?: ''\n\n /**\n * Specifies the environment to perform the operation using its handle. Fetch the handle using the `env list` command.\n *\n */\n '--env '?: string\n\n /**\n * Path to an environment file to override existing environment variables. Defaults to the '.env' located in your project path `--path`.\n *\n */\n '--env-file '?: string\n\n /**\n * Push environment variable changes without confirmation.\n * @environment SHOPIFY_HYDROGEN_FLAG_FORCE\n */\n '-f, --force'?: ''\n\n /**\n * The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.\n * @environment SHOPIFY_HYDROGEN_FLAG_PATH\n */\n '--path '?: string\n}" + "value": "export interface hydrogenenvpush {\n /**\n * Preview environment variable changes without pushing them.\n * @environment SHOPIFY_HYDROGEN_FLAG_DRY_RUN\n */\n '--dry-run'?: ''\n\n /**\n * Specifies the environment to perform the operation using its handle. Fetch the handle using the `env list` command.\n *\n */\n '--env '?: string\n\n /**\n * Path to an environment file to override existing environment variables. Defaults to the '.env' located in your project path `--path`.\n *\n */\n '--env-file '?: string\n\n /**\n * Push environment variable changes without confirmation.\n * @environment SHOPIFY_HYDROGEN_FLAG_FORCE\n */\n '-f, --force'?: ''\n\n /**\n * Print the command's JSON schemas.\n * @environment SHOPIFY_FLAG_JSON_SCHEMA\n */\n '--json-schema'?: ''\n\n /**\n * The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.\n * @environment SHOPIFY_HYDROGEN_FLAG_PATH\n */\n '--path '?: string\n}" } }, "hydrogengenerateroute": { @@ -4008,6 +4483,15 @@ "isOptional": true, "environmentValue": "SHOPIFY_HYDROGEN_FLAG_ADAPTER" }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-generate-route.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--json-schema", + "value": "''", + "description": "Print the command's JSON schemas.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON_SCHEMA" + }, { "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-generate-route.interface.ts", "syntaxKind": "PropertySignature", @@ -4045,7 +4529,7 @@ "environmentValue": "SHOPIFY_HYDROGEN_FLAG_FORCE" } ], - "value": "export interface hydrogengenerateroute {\n /**\n * React Router adapter used in the route. The default is `react-router`.\n * @environment SHOPIFY_HYDROGEN_FLAG_ADAPTER\n */\n '--adapter '?: string\n\n /**\n * Overwrites the destination directory and files if they already exist.\n * @environment SHOPIFY_HYDROGEN_FLAG_FORCE\n */\n '-f, --force'?: ''\n\n /**\n * The param name in Remix routes for the i18n locale, if any. Example: `locale` becomes ($locale).\n * @environment SHOPIFY_HYDROGEN_FLAG_ADAPTER\n */\n '--locale-param '?: string\n\n /**\n * The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.\n * @environment SHOPIFY_HYDROGEN_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Generate TypeScript files\n * @environment SHOPIFY_HYDROGEN_FLAG_TYPESCRIPT\n */\n '--typescript'?: ''\n}" + "value": "export interface hydrogengenerateroute {\n /**\n * React Router adapter used in the route. The default is `react-router`.\n * @environment SHOPIFY_HYDROGEN_FLAG_ADAPTER\n */\n '--adapter '?: string\n\n /**\n * Overwrites the destination directory and files if they already exist.\n * @environment SHOPIFY_HYDROGEN_FLAG_FORCE\n */\n '-f, --force'?: ''\n\n /**\n * Print the command's JSON schemas.\n * @environment SHOPIFY_FLAG_JSON_SCHEMA\n */\n '--json-schema'?: ''\n\n /**\n * The param name in Remix routes for the i18n locale, if any. Example: `locale` becomes ($locale).\n * @environment SHOPIFY_HYDROGEN_FLAG_ADAPTER\n */\n '--locale-param '?: string\n\n /**\n * The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.\n * @environment SHOPIFY_HYDROGEN_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Generate TypeScript files\n * @environment SHOPIFY_HYDROGEN_FLAG_TYPESCRIPT\n */\n '--typescript'?: ''\n}" } }, "hydrogengenerateroutes": { @@ -4064,6 +4548,15 @@ "isOptional": true, "environmentValue": "SHOPIFY_HYDROGEN_FLAG_ADAPTER" }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-generate-routes.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--json-schema", + "value": "''", + "description": "Print the command's JSON schemas.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON_SCHEMA" + }, { "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-generate-routes.interface.ts", "syntaxKind": "PropertySignature", @@ -4101,7 +4594,7 @@ "environmentValue": "SHOPIFY_HYDROGEN_FLAG_FORCE" } ], - "value": "export interface hydrogengenerateroutes {\n /**\n * React Router adapter used in the route. The default is `react-router`.\n * @environment SHOPIFY_HYDROGEN_FLAG_ADAPTER\n */\n '--adapter '?: string\n\n /**\n * Overwrites the destination directory and files if they already exist.\n * @environment SHOPIFY_HYDROGEN_FLAG_FORCE\n */\n '-f, --force'?: ''\n\n /**\n * The param name in Remix routes for the i18n locale, if any. Example: `locale` becomes ($locale).\n * @environment SHOPIFY_HYDROGEN_FLAG_ADAPTER\n */\n '--locale-param '?: string\n\n /**\n * The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.\n * @environment SHOPIFY_HYDROGEN_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Generate TypeScript files\n * @environment SHOPIFY_HYDROGEN_FLAG_TYPESCRIPT\n */\n '--typescript'?: ''\n}" + "value": "export interface hydrogengenerateroutes {\n /**\n * React Router adapter used in the route. The default is `react-router`.\n * @environment SHOPIFY_HYDROGEN_FLAG_ADAPTER\n */\n '--adapter '?: string\n\n /**\n * Overwrites the destination directory and files if they already exist.\n * @environment SHOPIFY_HYDROGEN_FLAG_FORCE\n */\n '-f, --force'?: ''\n\n /**\n * Print the command's JSON schemas.\n * @environment SHOPIFY_FLAG_JSON_SCHEMA\n */\n '--json-schema'?: ''\n\n /**\n * The param name in Remix routes for the i18n locale, if any. Example: `locale` becomes ($locale).\n * @environment SHOPIFY_HYDROGEN_FLAG_ADAPTER\n */\n '--locale-param '?: string\n\n /**\n * The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.\n * @environment SHOPIFY_HYDROGEN_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Generate TypeScript files\n * @environment SHOPIFY_HYDROGEN_FLAG_TYPESCRIPT\n */\n '--typescript'?: ''\n}" } }, "hydrogeninit": { @@ -4129,6 +4622,15 @@ "isOptional": true, "environmentValue": "SHOPIFY_HYDROGEN_FLAG_INSTALL_DEPS" }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-init.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--json-schema", + "value": "''", + "description": "Print the command's JSON schemas.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON_SCHEMA" + }, { "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-init.interface.ts", "syntaxKind": "PropertySignature", @@ -4211,7 +4713,7 @@ "environmentValue": "SHOPIFY_HYDROGEN_FLAG_FORCE" } ], - "value": "export interface hydrogeninit {\n /**\n * Overwrites the destination directory and files if they already exist.\n * @environment SHOPIFY_HYDROGEN_FLAG_FORCE\n */\n '-f, --force'?: ''\n\n /**\n * Init Git and create initial commits.\n * @environment SHOPIFY_HYDROGEN_FLAG_GIT\n */\n '--git'?: ''\n\n /**\n * Auto installs dependencies using the active package manager.\n * @environment SHOPIFY_HYDROGEN_FLAG_INSTALL_DEPS\n */\n '--install-deps'?: ''\n\n /**\n * Sets the template language to use. One of `js` or `ts`.\n * @environment SHOPIFY_HYDROGEN_FLAG_LANGUAGE\n */\n '--language '?: string\n\n /**\n * Sets the URL structure to support multiple markets. Must be one of: `subfolders`, `domains`, `subdomains`, `none`. Example: `--markets subfolders`.\n * @environment SHOPIFY_HYDROGEN_FLAG_I18N\n */\n '--markets '?: string\n\n /**\n * Use mock.shop as the data source for the storefront.\n * @environment SHOPIFY_HYDROGEN_FLAG_MOCK_DATA\n */\n '--mock-shop'?: ''\n\n /**\n * The path to the directory of the new Hydrogen storefront.\n * @environment SHOPIFY_HYDROGEN_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Scaffolds a new Hydrogen project with a set of sensible defaults. Equivalent to `shopify hydrogen init --path hydrogen-quickstart --mock-shop --language js --shortcut --markets none`\n * @environment SHOPIFY_HYDROGEN_FLAG_QUICKSTART\n */\n '--quickstart'?: ''\n\n /**\n * Creates a global h2 shortcut for Shopify CLI using shell aliases. Deactivate with `--no-shortcut`.\n * @environment SHOPIFY_HYDROGEN_FLAG_SHORTCUT\n */\n '--shortcut'?: ''\n\n /**\n * Sets the styling strategy to use. One of `tailwind`, `vanilla-extract`, `css-modules`, `postcss`, `none`.\n * @environment SHOPIFY_HYDROGEN_FLAG_STYLING\n */\n '--styling '?: string\n\n /**\n * Scaffolds project based on an existing template or example from the Hydrogen repository.\n * @environment SHOPIFY_HYDROGEN_FLAG_TEMPLATE\n */\n '--template '?: string\n}" + "value": "export interface hydrogeninit {\n /**\n * Overwrites the destination directory and files if they already exist.\n * @environment SHOPIFY_HYDROGEN_FLAG_FORCE\n */\n '-f, --force'?: ''\n\n /**\n * Init Git and create initial commits.\n * @environment SHOPIFY_HYDROGEN_FLAG_GIT\n */\n '--git'?: ''\n\n /**\n * Auto installs dependencies using the active package manager.\n * @environment SHOPIFY_HYDROGEN_FLAG_INSTALL_DEPS\n */\n '--install-deps'?: ''\n\n /**\n * Print the command's JSON schemas.\n * @environment SHOPIFY_FLAG_JSON_SCHEMA\n */\n '--json-schema'?: ''\n\n /**\n * Sets the template language to use. One of `js` or `ts`.\n * @environment SHOPIFY_HYDROGEN_FLAG_LANGUAGE\n */\n '--language '?: string\n\n /**\n * Sets the URL structure to support multiple markets. Must be one of: `subfolders`, `domains`, `subdomains`, `none`. Example: `--markets subfolders`.\n * @environment SHOPIFY_HYDROGEN_FLAG_I18N\n */\n '--markets '?: string\n\n /**\n * Use mock.shop as the data source for the storefront.\n * @environment SHOPIFY_HYDROGEN_FLAG_MOCK_DATA\n */\n '--mock-shop'?: ''\n\n /**\n * The path to the directory of the new Hydrogen storefront.\n * @environment SHOPIFY_HYDROGEN_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Scaffolds a new Hydrogen project with a set of sensible defaults. Equivalent to `shopify hydrogen init --path hydrogen-quickstart --mock-shop --language js --shortcut --markets none`\n * @environment SHOPIFY_HYDROGEN_FLAG_QUICKSTART\n */\n '--quickstart'?: ''\n\n /**\n * Creates a global h2 shortcut for Shopify CLI using shell aliases. Deactivate with `--no-shortcut`.\n * @environment SHOPIFY_HYDROGEN_FLAG_SHORTCUT\n */\n '--shortcut'?: ''\n\n /**\n * Sets the styling strategy to use. One of `tailwind`, `vanilla-extract`, `css-modules`, `postcss`, `none`.\n * @environment SHOPIFY_HYDROGEN_FLAG_STYLING\n */\n '--styling '?: string\n\n /**\n * Scaffolds project based on an existing template or example from the Hydrogen repository.\n * @environment SHOPIFY_HYDROGEN_FLAG_TEMPLATE\n */\n '--template '?: string\n}" } }, "hydrogenlink": { @@ -4230,6 +4732,15 @@ "isOptional": true, "environmentValue": "SHOPIFY_HYDROGEN_FLAG_CREATE_STOREFRONT" }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-link.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--json-schema", + "value": "''", + "description": "Print the command's JSON schemas.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON_SCHEMA" + }, { "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-link.interface.ts", "syntaxKind": "PropertySignature", @@ -4276,7 +4787,7 @@ "environmentValue": "SHOPIFY_SHOP" } ], - "value": "export interface hydrogenlink {\n /**\n * Create a new Hydrogen storefront.\n * @environment SHOPIFY_HYDROGEN_FLAG_CREATE_STOREFRONT\n */\n '--create-storefront'?: ''\n\n /**\n * Overwrites the destination directory and files if they already exist.\n * @environment SHOPIFY_HYDROGEN_FLAG_FORCE\n */\n '-f, --force'?: ''\n\n /**\n * The name to use when creating a new Hydrogen storefront.\n * @environment SHOPIFY_HYDROGEN_FLAG_NAME\n */\n '--name '?: string\n\n /**\n * The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.\n * @environment SHOPIFY_HYDROGEN_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Shop URL. It can be the shop prefix (janes-apparel) or the full myshopify.com URL (janes-apparel.myshopify.com, https://janes-apparel.myshopify.com).\n * @environment SHOPIFY_SHOP\n */\n '-s, --shop '?: string\n\n /**\n * The name of a Hydrogen Storefront (e.g. \"Jane's Apparel\")\n * @environment SHOPIFY_HYDROGEN_STOREFRONT\n */\n '--storefront '?: string\n}" + "value": "export interface hydrogenlink {\n /**\n * Create a new Hydrogen storefront.\n * @environment SHOPIFY_HYDROGEN_FLAG_CREATE_STOREFRONT\n */\n '--create-storefront'?: ''\n\n /**\n * Overwrites the destination directory and files if they already exist.\n * @environment SHOPIFY_HYDROGEN_FLAG_FORCE\n */\n '-f, --force'?: ''\n\n /**\n * Print the command's JSON schemas.\n * @environment SHOPIFY_FLAG_JSON_SCHEMA\n */\n '--json-schema'?: ''\n\n /**\n * The name to use when creating a new Hydrogen storefront.\n * @environment SHOPIFY_HYDROGEN_FLAG_NAME\n */\n '--name '?: string\n\n /**\n * The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.\n * @environment SHOPIFY_HYDROGEN_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Shop URL. It can be the shop prefix (janes-apparel) or the full myshopify.com URL (janes-apparel.myshopify.com, https://janes-apparel.myshopify.com).\n * @environment SHOPIFY_SHOP\n */\n '-s, --shop '?: string\n\n /**\n * The name of a Hydrogen Storefront (e.g. \"Jane's Apparel\")\n * @environment SHOPIFY_HYDROGEN_STOREFRONT\n */\n '--storefront '?: string\n}" } }, "hydrogenlist": { @@ -4286,6 +4797,15 @@ "description": "The following flags are available for the `hydrogen list` command:", "isPublicDocs": true, "members": [ + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-list.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--json-schema", + "value": "''", + "description": "Print the command's JSON schemas.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON_SCHEMA" + }, { "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-list.interface.ts", "syntaxKind": "PropertySignature", @@ -4296,7 +4816,7 @@ "environmentValue": "SHOPIFY_HYDROGEN_FLAG_PATH" } ], - "value": "export interface hydrogenlist {\n /**\n * The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.\n * @environment SHOPIFY_HYDROGEN_FLAG_PATH\n */\n '--path '?: string\n}" + "value": "export interface hydrogenlist {\n /**\n * Print the command's JSON schemas.\n * @environment SHOPIFY_FLAG_JSON_SCHEMA\n */\n '--json-schema'?: ''\n\n /**\n * The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.\n * @environment SHOPIFY_HYDROGEN_FLAG_PATH\n */\n '--path '?: string\n}" } }, "hydrogenlogin": { @@ -4306,6 +4826,15 @@ "description": "The following flags are available for the `hydrogen login` command:", "isPublicDocs": true, "members": [ + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-login.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--json-schema", + "value": "''", + "description": "Print the command's JSON schemas.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON_SCHEMA" + }, { "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-login.interface.ts", "syntaxKind": "PropertySignature", @@ -4325,7 +4854,7 @@ "environmentValue": "SHOPIFY_SHOP" } ], - "value": "export interface hydrogenlogin {\n /**\n * The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.\n * @environment SHOPIFY_HYDROGEN_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Shop URL. It can be the shop prefix (janes-apparel) or the full myshopify.com URL (janes-apparel.myshopify.com, https://janes-apparel.myshopify.com).\n * @environment SHOPIFY_SHOP\n */\n '-s, --shop '?: string\n}" + "value": "export interface hydrogenlogin {\n /**\n * Print the command's JSON schemas.\n * @environment SHOPIFY_FLAG_JSON_SCHEMA\n */\n '--json-schema'?: ''\n\n /**\n * The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.\n * @environment SHOPIFY_HYDROGEN_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Shop URL. It can be the shop prefix (janes-apparel) or the full myshopify.com URL (janes-apparel.myshopify.com, https://janes-apparel.myshopify.com).\n * @environment SHOPIFY_SHOP\n */\n '-s, --shop '?: string\n}" } }, "hydrogenlogout": { @@ -4335,6 +4864,15 @@ "description": "The following flags are available for the `hydrogen logout` command:", "isPublicDocs": true, "members": [ + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-logout.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--json-schema", + "value": "''", + "description": "Print the command's JSON schemas.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON_SCHEMA" + }, { "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-logout.interface.ts", "syntaxKind": "PropertySignature", @@ -4345,7 +4883,7 @@ "environmentValue": "SHOPIFY_HYDROGEN_FLAG_PATH" } ], - "value": "export interface hydrogenlogout {\n /**\n * The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.\n * @environment SHOPIFY_HYDROGEN_FLAG_PATH\n */\n '--path '?: string\n}" + "value": "export interface hydrogenlogout {\n /**\n * Print the command's JSON schemas.\n * @environment SHOPIFY_FLAG_JSON_SCHEMA\n */\n '--json-schema'?: ''\n\n /**\n * The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.\n * @environment SHOPIFY_HYDROGEN_FLAG_PATH\n */\n '--path '?: string\n}" } }, "hydrogenpreview": { @@ -4431,6 +4969,15 @@ "isOptional": true, "environmentValue": "SHOPIFY_HYDROGEN_FLAG_INSPECTOR_PORT" }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-preview.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--json-schema", + "value": "''", + "description": "Print the command's JSON schemas.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON_SCHEMA" + }, { "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-preview.interface.ts", "syntaxKind": "PropertySignature", @@ -4467,7 +5014,7 @@ "isOptional": true } ], - "value": "export interface hydrogenpreview {\n /**\n * Builds the app before starting the preview server.\n *\n */\n '--build'?: ''\n\n /**\n * Automatically generates GraphQL types for your project’s Storefront API queries.\n *\n */\n '--codegen'?: ''\n\n /**\n * Specifies a path to a codegen configuration file. Defaults to `/codegen.ts` if this file exists.\n *\n */\n '--codegen-config-path '?: string\n\n /**\n * Enables inspector connections to the server with a debugger such as Visual Studio Code or Chrome DevTools.\n * @environment SHOPIFY_HYDROGEN_FLAG_DEBUG\n */\n '--debug'?: ''\n\n /**\n * Entry file for the worker. Defaults to `./server`.\n * @environment SHOPIFY_HYDROGEN_FLAG_ENTRY\n */\n '--entry '?: string\n\n /**\n * Specifies the environment to perform the operation using its handle. Fetch the handle using the `env list` command.\n *\n */\n '--env '?: string\n\n /**\n * Specifies the environment to perform the operation using its Git branch name.\n * @environment SHOPIFY_HYDROGEN_ENVIRONMENT_BRANCH\n */\n '--env-branch '?: string\n\n /**\n * Path to an environment file to override existing environment variables. Defaults to the '.env' located in your project path `--path`.\n *\n */\n '--env-file '?: string\n\n /**\n * The port where the inspector is available. Defaults to 9229.\n * @environment SHOPIFY_HYDROGEN_FLAG_INSPECTOR_PORT\n */\n '--inspector-port '?: string\n\n /**\n * The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.\n * @environment SHOPIFY_HYDROGEN_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * The port to run the server on. Defaults to 3000.\n * @environment SHOPIFY_HYDROGEN_FLAG_PORT\n */\n '--port '?: string\n\n /**\n * Outputs more information about the command's execution.\n * @environment SHOPIFY_HYDROGEN_FLAG_VERBOSE\n */\n '--verbose'?: ''\n\n /**\n * Watches for changes and rebuilds the project.\n *\n */\n '--watch'?: ''\n}" + "value": "export interface hydrogenpreview {\n /**\n * Builds the app before starting the preview server.\n *\n */\n '--build'?: ''\n\n /**\n * Automatically generates GraphQL types for your project’s Storefront API queries.\n *\n */\n '--codegen'?: ''\n\n /**\n * Specifies a path to a codegen configuration file. Defaults to `/codegen.ts` if this file exists.\n *\n */\n '--codegen-config-path '?: string\n\n /**\n * Enables inspector connections to the server with a debugger such as Visual Studio Code or Chrome DevTools.\n * @environment SHOPIFY_HYDROGEN_FLAG_DEBUG\n */\n '--debug'?: ''\n\n /**\n * Entry file for the worker. Defaults to `./server`.\n * @environment SHOPIFY_HYDROGEN_FLAG_ENTRY\n */\n '--entry '?: string\n\n /**\n * Specifies the environment to perform the operation using its handle. Fetch the handle using the `env list` command.\n *\n */\n '--env '?: string\n\n /**\n * Specifies the environment to perform the operation using its Git branch name.\n * @environment SHOPIFY_HYDROGEN_ENVIRONMENT_BRANCH\n */\n '--env-branch '?: string\n\n /**\n * Path to an environment file to override existing environment variables. Defaults to the '.env' located in your project path `--path`.\n *\n */\n '--env-file '?: string\n\n /**\n * The port where the inspector is available. Defaults to 9229.\n * @environment SHOPIFY_HYDROGEN_FLAG_INSPECTOR_PORT\n */\n '--inspector-port '?: string\n\n /**\n * Print the command's JSON schemas.\n * @environment SHOPIFY_FLAG_JSON_SCHEMA\n */\n '--json-schema'?: ''\n\n /**\n * The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.\n * @environment SHOPIFY_HYDROGEN_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * The port to run the server on. Defaults to 3000.\n * @environment SHOPIFY_HYDROGEN_FLAG_PORT\n */\n '--port '?: string\n\n /**\n * Outputs more information about the command's execution.\n * @environment SHOPIFY_HYDROGEN_FLAG_VERBOSE\n */\n '--verbose'?: ''\n\n /**\n * Watches for changes and rebuilds the project.\n *\n */\n '--watch'?: ''\n}" } }, "hydrogensetupcss": { @@ -4486,6 +5033,15 @@ "isOptional": true, "environmentValue": "SHOPIFY_HYDROGEN_FLAG_INSTALL_DEPS" }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-setup-css.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--json-schema", + "value": "''", + "description": "Print the command's JSON schemas.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON_SCHEMA" + }, { "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-setup-css.interface.ts", "syntaxKind": "PropertySignature", @@ -4505,7 +5061,7 @@ "environmentValue": "SHOPIFY_HYDROGEN_FLAG_FORCE" } ], - "value": "export interface hydrogensetupcss {\n /**\n * Overwrites the destination directory and files if they already exist.\n * @environment SHOPIFY_HYDROGEN_FLAG_FORCE\n */\n '-f, --force'?: ''\n\n /**\n * Auto installs dependencies using the active package manager.\n * @environment SHOPIFY_HYDROGEN_FLAG_INSTALL_DEPS\n */\n '--install-deps'?: ''\n\n /**\n * The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.\n * @environment SHOPIFY_HYDROGEN_FLAG_PATH\n */\n '--path '?: string\n}" + "value": "export interface hydrogensetupcss {\n /**\n * Overwrites the destination directory and files if they already exist.\n * @environment SHOPIFY_HYDROGEN_FLAG_FORCE\n */\n '-f, --force'?: ''\n\n /**\n * Auto installs dependencies using the active package manager.\n * @environment SHOPIFY_HYDROGEN_FLAG_INSTALL_DEPS\n */\n '--install-deps'?: ''\n\n /**\n * Print the command's JSON schemas.\n * @environment SHOPIFY_FLAG_JSON_SCHEMA\n */\n '--json-schema'?: ''\n\n /**\n * The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.\n * @environment SHOPIFY_HYDROGEN_FLAG_PATH\n */\n '--path '?: string\n}" } }, "hydrogensetupmarkets": { @@ -4515,6 +5071,15 @@ "description": "The following flags are available for the `hydrogen setup markets` command:", "isPublicDocs": true, "members": [ + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-setup-markets.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--json-schema", + "value": "''", + "description": "Print the command's JSON schemas.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON_SCHEMA" + }, { "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-setup-markets.interface.ts", "syntaxKind": "PropertySignature", @@ -4525,7 +5090,7 @@ "environmentValue": "SHOPIFY_HYDROGEN_FLAG_PATH" } ], - "value": "export interface hydrogensetupmarkets {\n /**\n * The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.\n * @environment SHOPIFY_HYDROGEN_FLAG_PATH\n */\n '--path '?: string\n}" + "value": "export interface hydrogensetupmarkets {\n /**\n * Print the command's JSON schemas.\n * @environment SHOPIFY_FLAG_JSON_SCHEMA\n */\n '--json-schema'?: ''\n\n /**\n * The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.\n * @environment SHOPIFY_HYDROGEN_FLAG_PATH\n */\n '--path '?: string\n}" } }, "hydrogensetupvite": { @@ -4535,6 +5100,15 @@ "description": "The following flags are available for the `hydrogen setup vite` command:", "isPublicDocs": true, "members": [ + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-setup-vite.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--json-schema", + "value": "''", + "description": "Print the command's JSON schemas.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON_SCHEMA" + }, { "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-setup-vite.interface.ts", "syntaxKind": "PropertySignature", @@ -4545,7 +5119,7 @@ "environmentValue": "SHOPIFY_HYDROGEN_FLAG_PATH" } ], - "value": "export interface hydrogensetupvite {\n /**\n * The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.\n * @environment SHOPIFY_HYDROGEN_FLAG_PATH\n */\n '--path '?: string\n}" + "value": "export interface hydrogensetupvite {\n /**\n * Print the command's JSON schemas.\n * @environment SHOPIFY_FLAG_JSON_SCHEMA\n */\n '--json-schema'?: ''\n\n /**\n * The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.\n * @environment SHOPIFY_HYDROGEN_FLAG_PATH\n */\n '--path '?: string\n}" } }, "hydrogensetup": { @@ -4564,6 +5138,15 @@ "isOptional": true, "environmentValue": "SHOPIFY_HYDROGEN_FLAG_INSTALL_DEPS" }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-setup.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--json-schema", + "value": "''", + "description": "Print the command's JSON schemas.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON_SCHEMA" + }, { "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-setup.interface.ts", "syntaxKind": "PropertySignature", @@ -4601,7 +5184,7 @@ "environmentValue": "SHOPIFY_HYDROGEN_FLAG_FORCE" } ], - "value": "export interface hydrogensetup {\n /**\n * Overwrites the destination directory and files if they already exist.\n * @environment SHOPIFY_HYDROGEN_FLAG_FORCE\n */\n '-f, --force'?: ''\n\n /**\n * Auto installs dependencies using the active package manager.\n * @environment SHOPIFY_HYDROGEN_FLAG_INSTALL_DEPS\n */\n '--install-deps'?: ''\n\n /**\n * Sets the URL structure to support multiple markets. Must be one of: `subfolders`, `domains`, `subdomains`, `none`. Example: `--markets subfolders`.\n * @environment SHOPIFY_HYDROGEN_FLAG_I18N\n */\n '--markets '?: string\n\n /**\n * The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.\n * @environment SHOPIFY_HYDROGEN_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Creates a global h2 shortcut for Shopify CLI using shell aliases. Deactivate with `--no-shortcut`.\n * @environment SHOPIFY_HYDROGEN_FLAG_SHORTCUT\n */\n '--shortcut'?: ''\n}" + "value": "export interface hydrogensetup {\n /**\n * Overwrites the destination directory and files if they already exist.\n * @environment SHOPIFY_HYDROGEN_FLAG_FORCE\n */\n '-f, --force'?: ''\n\n /**\n * Auto installs dependencies using the active package manager.\n * @environment SHOPIFY_HYDROGEN_FLAG_INSTALL_DEPS\n */\n '--install-deps'?: ''\n\n /**\n * Print the command's JSON schemas.\n * @environment SHOPIFY_FLAG_JSON_SCHEMA\n */\n '--json-schema'?: ''\n\n /**\n * Sets the URL structure to support multiple markets. Must be one of: `subfolders`, `domains`, `subdomains`, `none`. Example: `--markets subfolders`.\n * @environment SHOPIFY_HYDROGEN_FLAG_I18N\n */\n '--markets '?: string\n\n /**\n * The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.\n * @environment SHOPIFY_HYDROGEN_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Creates a global h2 shortcut for Shopify CLI using shell aliases. Deactivate with `--no-shortcut`.\n * @environment SHOPIFY_HYDROGEN_FLAG_SHORTCUT\n */\n '--shortcut'?: ''\n}" } }, "hydrogenshortcut": { @@ -4610,8 +5193,18 @@ "name": "hydrogenshortcut", "description": "The following flags are available for the `hydrogen shortcut` command:", "isPublicDocs": true, - "members": [], - "value": "export interface hydrogenshortcut {\n\n}" + "members": [ + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-shortcut.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--json-schema", + "value": "''", + "description": "Print the command's JSON schemas.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON_SCHEMA" + } + ], + "value": "export interface hydrogenshortcut {\n /**\n * Print the command's JSON schemas.\n * @environment SHOPIFY_FLAG_JSON_SCHEMA\n */\n '--json-schema'?: ''\n}" } }, "hydrogenunlink": { @@ -4621,6 +5214,15 @@ "description": "The following flags are available for the `hydrogen unlink` command:", "isPublicDocs": true, "members": [ + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-unlink.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--json-schema", + "value": "''", + "description": "Print the command's JSON schemas.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON_SCHEMA" + }, { "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-unlink.interface.ts", "syntaxKind": "PropertySignature", @@ -4631,7 +5233,7 @@ "environmentValue": "SHOPIFY_HYDROGEN_FLAG_PATH" } ], - "value": "export interface hydrogenunlink {\n /**\n * The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.\n * @environment SHOPIFY_HYDROGEN_FLAG_PATH\n */\n '--path '?: string\n}" + "value": "export interface hydrogenunlink {\n /**\n * Print the command's JSON schemas.\n * @environment SHOPIFY_FLAG_JSON_SCHEMA\n */\n '--json-schema'?: ''\n\n /**\n * The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.\n * @environment SHOPIFY_HYDROGEN_FLAG_PATH\n */\n '--path '?: string\n}" } }, "hydrogenupgrade": { @@ -4641,6 +5243,15 @@ "description": "The following flags are available for the `hydrogen upgrade` command:", "isPublicDocs": true, "members": [ + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-upgrade.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--json-schema", + "value": "''", + "description": "Print the command's JSON schemas.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON_SCHEMA" + }, { "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-upgrade.interface.ts", "syntaxKind": "PropertySignature", @@ -4668,7 +5279,7 @@ "isOptional": true } ], - "value": "export interface hydrogenupgrade {\n /**\n * Ignore warnings and force the upgrade to the target version\n * @environment SHOPIFY_HYDROGEN_FLAG_FORCE\n */\n '-f, --force'?: ''\n\n /**\n * The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.\n * @environment SHOPIFY_HYDROGEN_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * A target hydrogen version to update to\n *\n */\n '-v, --version '?: string\n}" + "value": "export interface hydrogenupgrade {\n /**\n * Ignore warnings and force the upgrade to the target version\n * @environment SHOPIFY_HYDROGEN_FLAG_FORCE\n */\n '-f, --force'?: ''\n\n /**\n * Print the command's JSON schemas.\n * @environment SHOPIFY_FLAG_JSON_SCHEMA\n */\n '--json-schema'?: ''\n\n /**\n * The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.\n * @environment SHOPIFY_HYDROGEN_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * A target hydrogen version to update to\n *\n */\n '-v, --version '?: string\n}" } }, "organizationlist": { @@ -4687,6 +5298,15 @@ "isOptional": true, "environmentValue": "SHOPIFY_FLAG_AUTH_ALIAS" }, + { + "filePath": "docs-shopify.dev/commands/interfaces/organization-list.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--json-schema", + "value": "''", + "description": "Print the command's JSON schemas.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON_SCHEMA" + }, { "filePath": "docs-shopify.dev/commands/interfaces/organization-list.interface.ts", "syntaxKind": "PropertySignature", @@ -4715,7 +5335,7 @@ "environmentValue": "SHOPIFY_FLAG_JSON" } ], - "value": "export interface organizationlist {\n /**\n * Alias of the Shopify account to use for authentication.\n * @environment SHOPIFY_FLAG_AUTH_ALIAS\n */\n '--auth-alias '?: string\n\n /**\n * Output the result as JSON. Automatically disables color output.\n * @environment SHOPIFY_FLAG_JSON\n */\n '-j, --json'?: ''\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" + "value": "export interface organizationlist {\n /**\n * Alias of the Shopify account to use for authentication.\n * @environment SHOPIFY_FLAG_AUTH_ALIAS\n */\n '--auth-alias '?: string\n\n /**\n * Output the result as JSON. Automatically disables color output.\n * @environment SHOPIFY_FLAG_JSON\n */\n '-j, --json'?: ''\n\n /**\n * Print the command's JSON schemas.\n * @environment SHOPIFY_FLAG_JSON_SCHEMA\n */\n '--json-schema'?: ''\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" } }, "search": { @@ -4725,6 +5345,15 @@ "description": "The following flags are available for the `search` command:", "isPublicDocs": true, "members": [ + { + "filePath": "docs-shopify.dev/commands/interfaces/search.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--json-schema", + "value": "''", + "description": "Print the command's JSON schemas.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON_SCHEMA" + }, { "filePath": "docs-shopify.dev/commands/interfaces/search.interface.ts", "syntaxKind": "PropertySignature", @@ -4744,7 +5373,7 @@ "environmentValue": "SHOPIFY_FLAG_VERBOSE" } ], - "value": "export interface search {\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" + "value": "export interface search {\n /**\n * Print the command's JSON schemas.\n * @environment SHOPIFY_FLAG_JSON_SCHEMA\n */\n '--json-schema'?: ''\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" } }, "storeauthlist": { @@ -4754,6 +5383,15 @@ "description": "The following flags are available for the `store auth list` command:", "isPublicDocs": true, "members": [ + { + "filePath": "docs-shopify.dev/commands/interfaces/store-auth-list.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--json-schema", + "value": "''", + "description": "Print the command's JSON schemas.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON_SCHEMA" + }, { "filePath": "docs-shopify.dev/commands/interfaces/store-auth-list.interface.ts", "syntaxKind": "PropertySignature", @@ -4782,7 +5420,7 @@ "environmentValue": "SHOPIFY_FLAG_JSON" } ], - "value": "export interface storeauthlist {\n /**\n * Output the result as JSON. Automatically disables color output.\n * @environment SHOPIFY_FLAG_JSON\n */\n '-j, --json'?: ''\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" + "value": "export interface storeauthlist {\n /**\n * Output the result as JSON. Automatically disables color output.\n * @environment SHOPIFY_FLAG_JSON\n */\n '-j, --json'?: ''\n\n /**\n * Print the command's JSON schemas.\n * @environment SHOPIFY_FLAG_JSON_SCHEMA\n */\n '--json-schema'?: ''\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" } }, "storeauth": { @@ -4792,6 +5430,15 @@ "description": "The following flags are available for the `store auth` command:", "isPublicDocs": true, "members": [ + { + "filePath": "docs-shopify.dev/commands/interfaces/store-auth.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--json-schema", + "value": "''", + "description": "Print the command's JSON schemas.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON_SCHEMA" + }, { "filePath": "docs-shopify.dev/commands/interfaces/store-auth.interface.ts", "syntaxKind": "PropertySignature", @@ -4836,7 +5483,7 @@ "environmentValue": "SHOPIFY_FLAG_STORE" } ], - "value": "export interface storeauth {\n /**\n * Output the result as JSON. Automatically disables color output.\n * @environment SHOPIFY_FLAG_JSON\n */\n '-j, --json'?: ''\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * Comma-separated Admin API scopes to request for the app.\n * @environment SHOPIFY_FLAG_SCOPES\n */\n '--scopes ': string\n\n /**\n * The myshopify.com domain of the store.\n * @environment SHOPIFY_FLAG_STORE\n */\n '-s, --store ': string\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" + "value": "export interface storeauth {\n /**\n * Output the result as JSON. Automatically disables color output.\n * @environment SHOPIFY_FLAG_JSON\n */\n '-j, --json'?: ''\n\n /**\n * Print the command's JSON schemas.\n * @environment SHOPIFY_FLAG_JSON_SCHEMA\n */\n '--json-schema'?: ''\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * Comma-separated Admin API scopes to request for the app.\n * @environment SHOPIFY_FLAG_SCOPES\n */\n '--scopes ': string\n\n /**\n * The myshopify.com domain of the store.\n * @environment SHOPIFY_FLAG_STORE\n */\n '-s, --store ': string\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" } }, "storebulkcancel": { @@ -4854,6 +5501,15 @@ "description": "The bulk operation ID to cancel (numeric ID or full GID).", "environmentValue": "SHOPIFY_FLAG_ID" }, + { + "filePath": "docs-shopify.dev/commands/interfaces/store-bulk-cancel.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--json-schema", + "value": "''", + "description": "Print the command's JSON schemas.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON_SCHEMA" + }, { "filePath": "docs-shopify.dev/commands/interfaces/store-bulk-cancel.interface.ts", "syntaxKind": "PropertySignature", @@ -4881,7 +5537,7 @@ "environmentValue": "SHOPIFY_FLAG_STORE" } ], - "value": "export interface storebulkcancel {\n /**\n * The bulk operation ID to cancel (numeric ID or full GID).\n * @environment SHOPIFY_FLAG_ID\n */\n '--id ': string\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * The myshopify.com domain of the store.\n * @environment SHOPIFY_FLAG_STORE\n */\n '-s, --store ': string\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" + "value": "export interface storebulkcancel {\n /**\n * The bulk operation ID to cancel (numeric ID or full GID).\n * @environment SHOPIFY_FLAG_ID\n */\n '--id ': string\n\n /**\n * Print the command's JSON schemas.\n * @environment SHOPIFY_FLAG_JSON_SCHEMA\n */\n '--json-schema'?: ''\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * The myshopify.com domain of the store.\n * @environment SHOPIFY_FLAG_STORE\n */\n '-s, --store ': string\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" } }, "storebulkexecute": { @@ -4900,6 +5556,15 @@ "isOptional": true, "environmentValue": "SHOPIFY_FLAG_ALLOW_MUTATIONS" }, + { + "filePath": "docs-shopify.dev/commands/interfaces/store-bulk-execute.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--json-schema", + "value": "''", + "description": "Print the command's JSON schemas.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON_SCHEMA" + }, { "filePath": "docs-shopify.dev/commands/interfaces/store-bulk-execute.interface.ts", "syntaxKind": "PropertySignature", @@ -4990,7 +5655,7 @@ "environmentValue": "SHOPIFY_FLAG_VARIABLES" } ], - "value": "export interface storebulkexecute {\n /**\n * Allow GraphQL mutations to run against the target store.\n * @environment SHOPIFY_FLAG_ALLOW_MUTATIONS\n */\n '--allow-mutations'?: ''\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * The file path where results should be written if --watch is specified. If not specified, results will be written to STDOUT.\n * @environment SHOPIFY_FLAG_OUTPUT_FILE\n */\n '--output-file '?: string\n\n /**\n * The GraphQL query or mutation to run as a bulk operation.\n * @environment SHOPIFY_FLAG_QUERY\n */\n '-q, --query '?: string\n\n /**\n * Path to a file containing the GraphQL query or mutation. Can't be used with --query.\n * @environment SHOPIFY_FLAG_QUERY_FILE\n */\n '--query-file '?: string\n\n /**\n * The myshopify.com domain of the store.\n * @environment SHOPIFY_FLAG_STORE\n */\n '-s, --store ': string\n\n /**\n * Path to a file containing GraphQL variables in JSONL format (one JSON object per line). Can't be used with --variables.\n * @environment SHOPIFY_FLAG_VARIABLE_FILE\n */\n '--variable-file '?: string\n\n /**\n * The values for any GraphQL variables in your mutation, in JSON format. Can be specified multiple times.\n * @environment SHOPIFY_FLAG_VARIABLES\n */\n '-v, --variables '?: string\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n\n /**\n * The API version to use for the bulk operation. If not specified, uses the latest stable version.\n * @environment SHOPIFY_FLAG_VERSION\n */\n '--version '?: string\n\n /**\n * Wait for bulk operation results before exiting. Defaults to false.\n * @environment SHOPIFY_FLAG_WATCH\n */\n '--watch'?: ''\n}" + "value": "export interface storebulkexecute {\n /**\n * Allow GraphQL mutations to run against the target store.\n * @environment SHOPIFY_FLAG_ALLOW_MUTATIONS\n */\n '--allow-mutations'?: ''\n\n /**\n * Print the command's JSON schemas.\n * @environment SHOPIFY_FLAG_JSON_SCHEMA\n */\n '--json-schema'?: ''\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * The file path where results should be written if --watch is specified. If not specified, results will be written to STDOUT.\n * @environment SHOPIFY_FLAG_OUTPUT_FILE\n */\n '--output-file '?: string\n\n /**\n * The GraphQL query or mutation to run as a bulk operation.\n * @environment SHOPIFY_FLAG_QUERY\n */\n '-q, --query '?: string\n\n /**\n * Path to a file containing the GraphQL query or mutation. Can't be used with --query.\n * @environment SHOPIFY_FLAG_QUERY_FILE\n */\n '--query-file '?: string\n\n /**\n * The myshopify.com domain of the store.\n * @environment SHOPIFY_FLAG_STORE\n */\n '-s, --store ': string\n\n /**\n * Path to a file containing GraphQL variables in JSONL format (one JSON object per line). Can't be used with --variables.\n * @environment SHOPIFY_FLAG_VARIABLE_FILE\n */\n '--variable-file '?: string\n\n /**\n * The values for any GraphQL variables in your mutation, in JSON format. Can be specified multiple times.\n * @environment SHOPIFY_FLAG_VARIABLES\n */\n '-v, --variables '?: string\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n\n /**\n * The API version to use for the bulk operation. If not specified, uses the latest stable version.\n * @environment SHOPIFY_FLAG_VERSION\n */\n '--version '?: string\n\n /**\n * Wait for bulk operation results before exiting. Defaults to false.\n * @environment SHOPIFY_FLAG_WATCH\n */\n '--watch'?: ''\n}" } }, "storebulkstatus": { @@ -5009,6 +5674,15 @@ "isOptional": true, "environmentValue": "SHOPIFY_FLAG_ID" }, + { + "filePath": "docs-shopify.dev/commands/interfaces/store-bulk-status.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--json-schema", + "value": "''", + "description": "Print the command's JSON schemas.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON_SCHEMA" + }, { "filePath": "docs-shopify.dev/commands/interfaces/store-bulk-status.interface.ts", "syntaxKind": "PropertySignature", @@ -5036,7 +5710,7 @@ "environmentValue": "SHOPIFY_FLAG_STORE" } ], - "value": "export interface storebulkstatus {\n /**\n * The bulk operation ID (numeric ID or full GID). If not provided, lists all bulk operations on this store in the last 7 days.\n * @environment SHOPIFY_FLAG_ID\n */\n '--id '?: string\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * The myshopify.com domain of the store.\n * @environment SHOPIFY_FLAG_STORE\n */\n '-s, --store ': string\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" + "value": "export interface storebulkstatus {\n /**\n * The bulk operation ID (numeric ID or full GID). If not provided, lists all bulk operations on this store in the last 7 days.\n * @environment SHOPIFY_FLAG_ID\n */\n '--id '?: string\n\n /**\n * Print the command's JSON schemas.\n * @environment SHOPIFY_FLAG_JSON_SCHEMA\n */\n '--json-schema'?: ''\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * The myshopify.com domain of the store.\n * @environment SHOPIFY_FLAG_STORE\n */\n '-s, --store ': string\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" } }, "storecreatepreview": { @@ -5055,6 +5729,15 @@ "isOptional": true, "environmentValue": "SHOPIFY_FLAG_STORE_COUNTRY" }, + { + "filePath": "docs-shopify.dev/commands/interfaces/store-create-preview.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--json-schema", + "value": "''", + "description": "Print the command's JSON schemas.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON_SCHEMA" + }, { "filePath": "docs-shopify.dev/commands/interfaces/store-create-preview.interface.ts", "syntaxKind": "PropertySignature", @@ -5092,7 +5775,7 @@ "environmentValue": "SHOPIFY_FLAG_JSON" } ], - "value": "export interface storecreatepreview {\n /**\n * Two-letter country code for the store, such as US, CA, or GB. Follows the ISO 3166-1 alpha-2 standard.\n * @environment SHOPIFY_FLAG_STORE_COUNTRY\n */\n '--country '?: string\n\n /**\n * Output the result as JSON. Automatically disables color output.\n * @environment SHOPIFY_FLAG_JSON\n */\n '-j, --json'?: ''\n\n /**\n * The name of the store.\n * @environment SHOPIFY_FLAG_PREVIEW_STORE_NAME\n */\n '--name '?: string\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" + "value": "export interface storecreatepreview {\n /**\n * Two-letter country code for the store, such as US, CA, or GB. Follows the ISO 3166-1 alpha-2 standard.\n * @environment SHOPIFY_FLAG_STORE_COUNTRY\n */\n '--country '?: string\n\n /**\n * Output the result as JSON. Automatically disables color output.\n * @environment SHOPIFY_FLAG_JSON\n */\n '-j, --json'?: ''\n\n /**\n * Print the command's JSON schemas.\n * @environment SHOPIFY_FLAG_JSON_SCHEMA\n */\n '--json-schema'?: ''\n\n /**\n * The name of the store.\n * @environment SHOPIFY_FLAG_PREVIEW_STORE_NAME\n */\n '--name '?: string\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" } }, "storeexecute": { @@ -5111,6 +5794,15 @@ "isOptional": true, "environmentValue": "SHOPIFY_FLAG_ALLOW_MUTATIONS" }, + { + "filePath": "docs-shopify.dev/commands/interfaces/store-execute.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--json-schema", + "value": "''", + "description": "Print the command's JSON schemas.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON_SCHEMA" + }, { "filePath": "docs-shopify.dev/commands/interfaces/store-execute.interface.ts", "syntaxKind": "PropertySignature", @@ -5201,7 +5893,7 @@ "environmentValue": "SHOPIFY_FLAG_VARIABLES" } ], - "value": "export interface storeexecute {\n /**\n * Allow GraphQL mutations to run against the target store.\n * @environment SHOPIFY_FLAG_ALLOW_MUTATIONS\n */\n '--allow-mutations'?: ''\n\n /**\n * Output the result as JSON. Automatically disables color output.\n * @environment SHOPIFY_FLAG_JSON\n */\n '-j, --json'?: ''\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * The file name where results should be written, instead of STDOUT.\n * @environment SHOPIFY_FLAG_OUTPUT_FILE\n */\n '--output-file '?: string\n\n /**\n * The GraphQL query or mutation, as a string.\n * @environment SHOPIFY_FLAG_QUERY\n */\n '-q, --query '?: string\n\n /**\n * Path to a file containing the GraphQL query or mutation. Can't be used with --query.\n * @environment SHOPIFY_FLAG_QUERY_FILE\n */\n '--query-file '?: string\n\n /**\n * The myshopify.com domain of the store.\n * @environment SHOPIFY_FLAG_STORE\n */\n '-s, --store ': string\n\n /**\n * Path to a file containing GraphQL variables in JSON format. Can't be used with --variables.\n * @environment SHOPIFY_FLAG_VARIABLE_FILE\n */\n '--variable-file '?: string\n\n /**\n * The values for any GraphQL variables in your query or mutation, in JSON format.\n * @environment SHOPIFY_FLAG_VARIABLES\n */\n '-v, --variables '?: string\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n\n /**\n * The API version to use for the query or mutation. Defaults to the latest stable version.\n * @environment SHOPIFY_FLAG_VERSION\n */\n '--version '?: string\n}" + "value": "export interface storeexecute {\n /**\n * Allow GraphQL mutations to run against the target store.\n * @environment SHOPIFY_FLAG_ALLOW_MUTATIONS\n */\n '--allow-mutations'?: ''\n\n /**\n * Output the result as JSON. Automatically disables color output.\n * @environment SHOPIFY_FLAG_JSON\n */\n '-j, --json'?: ''\n\n /**\n * Print the command's JSON schemas.\n * @environment SHOPIFY_FLAG_JSON_SCHEMA\n */\n '--json-schema'?: ''\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * The file name where results should be written, instead of STDOUT.\n * @environment SHOPIFY_FLAG_OUTPUT_FILE\n */\n '--output-file '?: string\n\n /**\n * The GraphQL query or mutation, as a string.\n * @environment SHOPIFY_FLAG_QUERY\n */\n '-q, --query '?: string\n\n /**\n * Path to a file containing the GraphQL query or mutation. Can't be used with --query.\n * @environment SHOPIFY_FLAG_QUERY_FILE\n */\n '--query-file '?: string\n\n /**\n * The myshopify.com domain of the store.\n * @environment SHOPIFY_FLAG_STORE\n */\n '-s, --store ': string\n\n /**\n * Path to a file containing GraphQL variables in JSON format. Can't be used with --variables.\n * @environment SHOPIFY_FLAG_VARIABLE_FILE\n */\n '--variable-file '?: string\n\n /**\n * The values for any GraphQL variables in your query or mutation, in JSON format.\n * @environment SHOPIFY_FLAG_VARIABLES\n */\n '-v, --variables '?: string\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n\n /**\n * The API version to use for the query or mutation. Defaults to the latest stable version.\n * @environment SHOPIFY_FLAG_VERSION\n */\n '--version '?: string\n}" } }, "storegraphiql": { @@ -5220,6 +5912,15 @@ "isOptional": true, "environmentValue": "SHOPIFY_FLAG_ALLOW_MUTATIONS" }, + { + "filePath": "docs-shopify.dev/commands/interfaces/store-graphiql.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--json-schema", + "value": "''", + "description": "Print the command's JSON schemas.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON_SCHEMA" + }, { "filePath": "docs-shopify.dev/commands/interfaces/store-graphiql.interface.ts", "syntaxKind": "PropertySignature", @@ -5274,7 +5975,7 @@ "environmentValue": "SHOPIFY_FLAG_VARIABLES" } ], - "value": "export interface storegraphiql {\n /**\n * Allow GraphQL mutations to run against the target store.\n * @environment SHOPIFY_FLAG_ALLOW_MUTATIONS\n */\n '--allow-mutations'?: ''\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * Local port for the GraphiQL server. Must be between 1 and 65535.\n * @environment SHOPIFY_FLAG_PORT\n */\n '--port '?: string\n\n /**\n * The myshopify.com domain of the store.\n * @environment SHOPIFY_FLAG_STORE\n */\n '-s, --store ': string\n\n /**\n * The values for any GraphQL variables in your query or mutation, in JSON format.\n * @environment SHOPIFY_FLAG_VARIABLES\n */\n '-v, --variables '?: string\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n\n /**\n * The API version to use in GraphiQL. Defaults to the latest stable version.\n * @environment SHOPIFY_FLAG_VERSION\n */\n '--version '?: string\n}" + "value": "export interface storegraphiql {\n /**\n * Allow GraphQL mutations to run against the target store.\n * @environment SHOPIFY_FLAG_ALLOW_MUTATIONS\n */\n '--allow-mutations'?: ''\n\n /**\n * Print the command's JSON schemas.\n * @environment SHOPIFY_FLAG_JSON_SCHEMA\n */\n '--json-schema'?: ''\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * Local port for the GraphiQL server. Must be between 1 and 65535.\n * @environment SHOPIFY_FLAG_PORT\n */\n '--port '?: string\n\n /**\n * The myshopify.com domain of the store.\n * @environment SHOPIFY_FLAG_STORE\n */\n '-s, --store ': string\n\n /**\n * The values for any GraphQL variables in your query or mutation, in JSON format.\n * @environment SHOPIFY_FLAG_VARIABLES\n */\n '-v, --variables '?: string\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n\n /**\n * The API version to use in GraphiQL. Defaults to the latest stable version.\n * @environment SHOPIFY_FLAG_VERSION\n */\n '--version '?: string\n}" } }, "storeinfo": { @@ -5284,6 +5985,15 @@ "description": "The following flags are available for the `store info` command:", "isPublicDocs": true, "members": [ + { + "filePath": "docs-shopify.dev/commands/interfaces/store-info.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--json-schema", + "value": "''", + "description": "Print the command's JSON schemas.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON_SCHEMA" + }, { "filePath": "docs-shopify.dev/commands/interfaces/store-info.interface.ts", "syntaxKind": "PropertySignature", @@ -5320,7 +6030,7 @@ "environmentValue": "SHOPIFY_FLAG_STORE" } ], - "value": "export interface storeinfo {\n /**\n * Output the result as JSON. Automatically disables color output.\n * @environment SHOPIFY_FLAG_JSON\n */\n '-j, --json'?: ''\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * The myshopify.com domain of the store.\n * @environment SHOPIFY_FLAG_STORE\n */\n '-s, --store ': string\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" + "value": "export interface storeinfo {\n /**\n * Output the result as JSON. Automatically disables color output.\n * @environment SHOPIFY_FLAG_JSON\n */\n '-j, --json'?: ''\n\n /**\n * Print the command's JSON schemas.\n * @environment SHOPIFY_FLAG_JSON_SCHEMA\n */\n '--json-schema'?: ''\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * The myshopify.com domain of the store.\n * @environment SHOPIFY_FLAG_STORE\n */\n '-s, --store ': string\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" } }, "storelist": { @@ -5330,6 +6040,15 @@ "description": "The following flags are available for the `store list` command:", "isPublicDocs": true, "members": [ + { + "filePath": "docs-shopify.dev/commands/interfaces/store-list.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--json-schema", + "value": "''", + "description": "Print the command's JSON schemas.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON_SCHEMA" + }, { "filePath": "docs-shopify.dev/commands/interfaces/store-list.interface.ts", "syntaxKind": "PropertySignature", @@ -5367,7 +6086,7 @@ "environmentValue": "SHOPIFY_FLAG_JSON" } ], - "value": "export interface storelist {\n /**\n * Output the result as JSON. Automatically disables color output.\n * @environment SHOPIFY_FLAG_JSON\n */\n '-j, --json'?: ''\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * The numeric organization ID. Auto-selects if you belong to a single organization. Required if non interactive when more than one organization is available.\n * @environment SHOPIFY_FLAG_ORGANIZATION_ID\n */\n '--organization-id '?: string\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" + "value": "export interface storelist {\n /**\n * Output the result as JSON. Automatically disables color output.\n * @environment SHOPIFY_FLAG_JSON\n */\n '-j, --json'?: ''\n\n /**\n * Print the command's JSON schemas.\n * @environment SHOPIFY_FLAG_JSON_SCHEMA\n */\n '--json-schema'?: ''\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * The numeric organization ID. Auto-selects if you belong to a single organization. Required if non interactive when more than one organization is available.\n * @environment SHOPIFY_FLAG_ORGANIZATION_ID\n */\n '--organization-id '?: string\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" } }, "storeopen": { @@ -5377,6 +6096,15 @@ "description": "The following flags are available for the `store open` command:", "isPublicDocs": true, "members": [ + { + "filePath": "docs-shopify.dev/commands/interfaces/store-open.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--json-schema", + "value": "''", + "description": "Print the command's JSON schemas.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON_SCHEMA" + }, { "filePath": "docs-shopify.dev/commands/interfaces/store-open.interface.ts", "syntaxKind": "PropertySignature", @@ -5404,7 +6132,7 @@ "environmentValue": "SHOPIFY_FLAG_STORE" } ], - "value": "export interface storeopen {\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * The myshopify.com domain of the store.\n * @environment SHOPIFY_FLAG_STORE\n */\n '-s, --store ': string\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" + "value": "export interface storeopen {\n /**\n * Print the command's JSON schemas.\n * @environment SHOPIFY_FLAG_JSON_SCHEMA\n */\n '--json-schema'?: ''\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * The myshopify.com domain of the store.\n * @environment SHOPIFY_FLAG_STORE\n */\n '-s, --store ': string\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" } }, "themecheck": { @@ -5441,6 +6169,15 @@ "isOptional": true, "environmentValue": "SHOPIFY_FLAG_INIT" }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-check.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--json-schema", + "value": "''", + "description": "Print the command's JSON schemas.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON_SCHEMA" + }, { "filePath": "docs-shopify.dev/commands/interfaces/theme-check.interface.ts", "syntaxKind": "PropertySignature", @@ -5532,7 +6269,7 @@ "environmentValue": "SHOPIFY_FLAG_VERSION" } ], - "value": "export interface themecheck {\n /**\n * Alias of the Shopify account to use for authentication.\n * @environment SHOPIFY_FLAG_AUTH_ALIAS\n */\n '--auth-alias '?: string\n\n /**\n * Automatically fix offenses\n * @environment SHOPIFY_FLAG_AUTO_CORRECT\n */\n '-a, --auto-correct'?: ''\n\n /**\n * Use the config provided, overriding .theme-check.yml if present\n Supports all theme-check: config values, e.g., theme-check:theme-app-extension,\n theme-check:recommended, theme-check:all\n For backwards compatibility, :theme_app_extension is also supported \n * @environment SHOPIFY_FLAG_CONFIG\n */\n '-C, --config '?: string\n\n /**\n * The environment to apply to the current command.\n * @environment SHOPIFY_FLAG_ENVIRONMENT\n */\n '-e, --environment '?: string\n\n /**\n * Minimum severity for exit with error code\n * @environment SHOPIFY_FLAG_FAIL_LEVEL\n */\n '--fail-level '?: string\n\n /**\n * Generate a .theme-check.yml file\n * @environment SHOPIFY_FLAG_INIT\n */\n '--init'?: ''\n\n /**\n * List enabled checks\n * @environment SHOPIFY_FLAG_LIST\n */\n '--list'?: ''\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * The output format to use\n * @environment SHOPIFY_FLAG_OUTPUT\n */\n '-o, --output '?: string\n\n /**\n * The path where you want to run the command. Defaults to the current working directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Output active config to STDOUT\n * @environment SHOPIFY_FLAG_PRINT\n */\n '--print'?: ''\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n\n /**\n * Print Theme Check version\n * @environment SHOPIFY_FLAG_VERSION\n */\n '-v, --version'?: ''\n}" + "value": "export interface themecheck {\n /**\n * Alias of the Shopify account to use for authentication.\n * @environment SHOPIFY_FLAG_AUTH_ALIAS\n */\n '--auth-alias '?: string\n\n /**\n * Automatically fix offenses\n * @environment SHOPIFY_FLAG_AUTO_CORRECT\n */\n '-a, --auto-correct'?: ''\n\n /**\n * Use the config provided, overriding .theme-check.yml if present\n Supports all theme-check: config values, e.g., theme-check:theme-app-extension,\n theme-check:recommended, theme-check:all\n For backwards compatibility, :theme_app_extension is also supported \n * @environment SHOPIFY_FLAG_CONFIG\n */\n '-C, --config '?: string\n\n /**\n * The environment to apply to the current command.\n * @environment SHOPIFY_FLAG_ENVIRONMENT\n */\n '-e, --environment '?: string\n\n /**\n * Minimum severity for exit with error code\n * @environment SHOPIFY_FLAG_FAIL_LEVEL\n */\n '--fail-level '?: string\n\n /**\n * Generate a .theme-check.yml file\n * @environment SHOPIFY_FLAG_INIT\n */\n '--init'?: ''\n\n /**\n * Print the command's JSON schemas.\n * @environment SHOPIFY_FLAG_JSON_SCHEMA\n */\n '--json-schema'?: ''\n\n /**\n * List enabled checks\n * @environment SHOPIFY_FLAG_LIST\n */\n '--list'?: ''\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * The output format to use\n * @environment SHOPIFY_FLAG_OUTPUT\n */\n '-o, --output '?: string\n\n /**\n * The path where you want to run the command. Defaults to the current working directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Output active config to STDOUT\n * @environment SHOPIFY_FLAG_PRINT\n */\n '--print'?: ''\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n\n /**\n * Print Theme Check version\n * @environment SHOPIFY_FLAG_VERSION\n */\n '-v, --version'?: ''\n}" } }, "themeconsole": { @@ -5551,6 +6288,15 @@ "isOptional": true, "environmentValue": "SHOPIFY_FLAG_AUTH_ALIAS" }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-console.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--json-schema", + "value": "''", + "description": "Print the command's JSON schemas.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON_SCHEMA" + }, { "filePath": "docs-shopify.dev/commands/interfaces/theme-console.interface.ts", "syntaxKind": "PropertySignature", @@ -5624,7 +6370,7 @@ "environmentValue": "SHOPIFY_FLAG_STORE" } ], - "value": "export interface themeconsole {\n /**\n * Alias of the Shopify account to use for authentication.\n * @environment SHOPIFY_FLAG_AUTH_ALIAS\n */\n '--auth-alias '?: string\n\n /**\n * The environment to apply to the current command.\n * @environment SHOPIFY_FLAG_ENVIRONMENT\n */\n '-e, --environment '?: string\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * Password generated from the Theme Access app or an Admin API token.\n * @environment SHOPIFY_CLI_THEME_TOKEN\n */\n '--password '?: string\n\n /**\n * The path where you want to run the command. Defaults to the current working directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).\n * @environment SHOPIFY_FLAG_STORE\n */\n '-s, --store '?: string\n\n /**\n * The password for storefronts with password protection.\n * @environment SHOPIFY_FLAG_STORE_PASSWORD\n */\n '--store-password '?: string\n\n /**\n * The url to be used as context\n * @environment SHOPIFY_FLAG_URL\n */\n '--url '?: string\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" + "value": "export interface themeconsole {\n /**\n * Alias of the Shopify account to use for authentication.\n * @environment SHOPIFY_FLAG_AUTH_ALIAS\n */\n '--auth-alias '?: string\n\n /**\n * The environment to apply to the current command.\n * @environment SHOPIFY_FLAG_ENVIRONMENT\n */\n '-e, --environment '?: string\n\n /**\n * Print the command's JSON schemas.\n * @environment SHOPIFY_FLAG_JSON_SCHEMA\n */\n '--json-schema'?: ''\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * Password generated from the Theme Access app or an Admin API token.\n * @environment SHOPIFY_CLI_THEME_TOKEN\n */\n '--password '?: string\n\n /**\n * The path where you want to run the command. Defaults to the current working directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).\n * @environment SHOPIFY_FLAG_STORE\n */\n '-s, --store '?: string\n\n /**\n * The password for storefronts with password protection.\n * @environment SHOPIFY_FLAG_STORE_PASSWORD\n */\n '--store-password '?: string\n\n /**\n * The url to be used as context\n * @environment SHOPIFY_FLAG_URL\n */\n '--url '?: string\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" } }, "themedelete": { @@ -5643,6 +6389,15 @@ "isOptional": true, "environmentValue": "SHOPIFY_FLAG_AUTH_ALIAS" }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-delete.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--json-schema", + "value": "''", + "description": "Print the command's JSON schemas.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON_SCHEMA" + }, { "filePath": "docs-shopify.dev/commands/interfaces/theme-delete.interface.ts", "syntaxKind": "PropertySignature", @@ -5734,7 +6489,7 @@ "environmentValue": "SHOPIFY_FLAG_THEME_ID" } ], - "value": "export interface themedelete {\n /**\n * Alias of the Shopify account to use for authentication.\n * @environment SHOPIFY_FLAG_AUTH_ALIAS\n */\n '--auth-alias '?: string\n\n /**\n * Delete your development theme. Use --show-all, --development, or --theme in non-interactive environments.\n * @environment SHOPIFY_FLAG_DEVELOPMENT\n */\n '-d, --development'?: ''\n\n /**\n * The environment to apply to the current command.\n * @environment SHOPIFY_FLAG_ENVIRONMENT\n */\n '-e, --environment '?: string\n\n /**\n * Skip confirmation. Required if non interactive.\n * @environment SHOPIFY_FLAG_FORCE\n */\n '-f, --force'?: ''\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * Password generated from the Theme Access app or an Admin API token.\n * @environment SHOPIFY_CLI_THEME_TOKEN\n */\n '--password '?: string\n\n /**\n * The path where you want to run the command. Defaults to the current working directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Include other development themes in the theme list. Use --show-all, --development, or --theme in non-interactive environments.\n * @environment SHOPIFY_FLAG_SHOW_ALL\n */\n '-a, --show-all'?: ''\n\n /**\n * Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).\n * @environment SHOPIFY_FLAG_STORE\n */\n '-s, --store '?: string\n\n /**\n * Theme ID or name of the remote theme. Use --show-all, --development, or --theme in non-interactive environments.\n * @environment SHOPIFY_FLAG_THEME_ID\n */\n '-t, --theme '?: string\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" + "value": "export interface themedelete {\n /**\n * Alias of the Shopify account to use for authentication.\n * @environment SHOPIFY_FLAG_AUTH_ALIAS\n */\n '--auth-alias '?: string\n\n /**\n * Delete your development theme. Use --show-all, --development, or --theme in non-interactive environments.\n * @environment SHOPIFY_FLAG_DEVELOPMENT\n */\n '-d, --development'?: ''\n\n /**\n * The environment to apply to the current command.\n * @environment SHOPIFY_FLAG_ENVIRONMENT\n */\n '-e, --environment '?: string\n\n /**\n * Skip confirmation. Required if non interactive.\n * @environment SHOPIFY_FLAG_FORCE\n */\n '-f, --force'?: ''\n\n /**\n * Print the command's JSON schemas.\n * @environment SHOPIFY_FLAG_JSON_SCHEMA\n */\n '--json-schema'?: ''\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * Password generated from the Theme Access app or an Admin API token.\n * @environment SHOPIFY_CLI_THEME_TOKEN\n */\n '--password '?: string\n\n /**\n * The path where you want to run the command. Defaults to the current working directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Include other development themes in the theme list. Use --show-all, --development, or --theme in non-interactive environments.\n * @environment SHOPIFY_FLAG_SHOW_ALL\n */\n '-a, --show-all'?: ''\n\n /**\n * Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).\n * @environment SHOPIFY_FLAG_STORE\n */\n '-s, --store '?: string\n\n /**\n * Theme ID or name of the remote theme. Use --show-all, --development, or --theme in non-interactive environments.\n * @environment SHOPIFY_FLAG_THEME_ID\n */\n '-t, --theme '?: string\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" } }, "themedev": { @@ -5771,6 +6526,15 @@ "isOptional": true, "environmentValue": "SHOPIFY_FLAG_HOST" }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-dev.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--json-schema", + "value": "''", + "description": "Print the command's JSON schemas.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON_SCHEMA" + }, { "filePath": "docs-shopify.dev/commands/interfaces/theme-dev.interface.ts", "syntaxKind": "PropertySignature", @@ -5952,7 +6716,7 @@ "environmentValue": "SHOPIFY_FLAG_IGNORE" } ], - "value": "export interface themedev {\n /**\n * Allow development on a live theme.\n * @environment SHOPIFY_FLAG_ALLOW_LIVE\n */\n '-a, --allow-live'?: ''\n\n /**\n * Alias of the Shopify account to use for authentication.\n * @environment SHOPIFY_FLAG_AUTH_ALIAS\n */\n '--auth-alias '?: string\n\n /**\n * The environment to apply to the current command.\n * @environment SHOPIFY_FLAG_ENVIRONMENT\n */\n '-e, --environment '?: string\n\n /**\n * Controls the visibility of the error overlay when an theme asset upload fails:\n- silent Prevents the error overlay from appearing.\n- default Displays the error overlay.\n \n * @environment SHOPIFY_FLAG_ERROR_OVERLAY\n */\n '--error-overlay '?: string\n\n /**\n * Set which network interface the web server listens on. The default value is 127.0.0.1.\n * @environment SHOPIFY_FLAG_HOST\n */\n '--host '?: string\n\n /**\n * Skip hot reloading any files that match the specified pattern.\n * @environment SHOPIFY_FLAG_IGNORE\n */\n '-x, --ignore '?: string\n\n /**\n * The listing preset to use for multi-preset themes. Applies preset files from listings/[preset-name] directory.\n * @environment SHOPIFY_FLAG_LISTING\n */\n '--listing '?: string\n\n /**\n * The live reload mode switches the server behavior when a file is modified:\n- hot-reload Hot reloads local changes to CSS and sections (default)\n- full-page Always refreshes the entire page\n- off Deactivate live reload\n * @environment SHOPIFY_FLAG_LIVE_RELOAD\n */\n '--live-reload '?: string\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * Prevents files from being deleted in the remote theme when a file has been deleted locally. This applies to files that are deleted while the command is running, and files that have been deleted locally before the command is run.\n * @environment SHOPIFY_FLAG_NODELETE\n */\n '-n, --nodelete'?: ''\n\n /**\n * The file path or URL. The file path is to a file that you want updated on idle. The URL path is where you want a webhook posted to report on file changes.\n * @environment SHOPIFY_FLAG_NOTIFY\n */\n '--notify '?: string\n\n /**\n * Hot reload only files that match the specified pattern.\n * @environment SHOPIFY_FLAG_ONLY\n */\n '-o, --only '?: string\n\n /**\n * Automatically launch the theme preview in your default web browser.\n * @environment SHOPIFY_FLAG_OPEN\n */\n '--open'?: ''\n\n /**\n * Password generated from the Theme Access app or an Admin API token.\n * @environment SHOPIFY_CLI_THEME_TOKEN\n */\n '--password '?: string\n\n /**\n * The path where you want to run the command. Defaults to the current working directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Local port to serve theme preview from. Must be between 1 and 65535.\n * @environment SHOPIFY_FLAG_PORT\n */\n '--port '?: string\n\n /**\n * 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.\n * @environment SHOPIFY_FLAG_RECONCILIATION_STRATEGY\n */\n '--reconciliation-strategy '?: string\n\n /**\n * Inject the standard events inspector into storefront HTML.\n * @environment SHOPIFY_FLAG_STANDARD_EVENTS_INSPECTOR\n */\n '--standard-events-inspector'?: ''\n\n /**\n * Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).\n * @environment SHOPIFY_FLAG_STORE\n */\n '-s, --store '?: string\n\n /**\n * The password for storefronts with password protection.\n * @environment SHOPIFY_FLAG_STORE_PASSWORD\n */\n '--store-password '?: string\n\n /**\n * Theme ID or name of the remote theme.\n * @environment SHOPIFY_FLAG_THEME_ID\n */\n '-t, --theme '?: string\n\n /**\n * Synchronize Theme Editor updates in the local theme files.\n * @environment SHOPIFY_FLAG_THEME_EDITOR_SYNC\n */\n '--theme-editor-sync'?: ''\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" + "value": "export interface themedev {\n /**\n * Allow development on a live theme.\n * @environment SHOPIFY_FLAG_ALLOW_LIVE\n */\n '-a, --allow-live'?: ''\n\n /**\n * Alias of the Shopify account to use for authentication.\n * @environment SHOPIFY_FLAG_AUTH_ALIAS\n */\n '--auth-alias '?: string\n\n /**\n * The environment to apply to the current command.\n * @environment SHOPIFY_FLAG_ENVIRONMENT\n */\n '-e, --environment '?: string\n\n /**\n * Controls the visibility of the error overlay when an theme asset upload fails:\n- silent Prevents the error overlay from appearing.\n- default Displays the error overlay.\n \n * @environment SHOPIFY_FLAG_ERROR_OVERLAY\n */\n '--error-overlay '?: string\n\n /**\n * Set which network interface the web server listens on. The default value is 127.0.0.1.\n * @environment SHOPIFY_FLAG_HOST\n */\n '--host '?: string\n\n /**\n * Skip hot reloading any files that match the specified pattern.\n * @environment SHOPIFY_FLAG_IGNORE\n */\n '-x, --ignore '?: string\n\n /**\n * Print the command's JSON schemas.\n * @environment SHOPIFY_FLAG_JSON_SCHEMA\n */\n '--json-schema'?: ''\n\n /**\n * The listing preset to use for multi-preset themes. Applies preset files from listings/[preset-name] directory.\n * @environment SHOPIFY_FLAG_LISTING\n */\n '--listing '?: string\n\n /**\n * The live reload mode switches the server behavior when a file is modified:\n- hot-reload Hot reloads local changes to CSS and sections (default)\n- full-page Always refreshes the entire page\n- off Deactivate live reload\n * @environment SHOPIFY_FLAG_LIVE_RELOAD\n */\n '--live-reload '?: string\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * Prevents files from being deleted in the remote theme when a file has been deleted locally. This applies to files that are deleted while the command is running, and files that have been deleted locally before the command is run.\n * @environment SHOPIFY_FLAG_NODELETE\n */\n '-n, --nodelete'?: ''\n\n /**\n * The file path or URL. The file path is to a file that you want updated on idle. The URL path is where you want a webhook posted to report on file changes.\n * @environment SHOPIFY_FLAG_NOTIFY\n */\n '--notify '?: string\n\n /**\n * Hot reload only files that match the specified pattern.\n * @environment SHOPIFY_FLAG_ONLY\n */\n '-o, --only '?: string\n\n /**\n * Automatically launch the theme preview in your default web browser.\n * @environment SHOPIFY_FLAG_OPEN\n */\n '--open'?: ''\n\n /**\n * Password generated from the Theme Access app or an Admin API token.\n * @environment SHOPIFY_CLI_THEME_TOKEN\n */\n '--password '?: string\n\n /**\n * The path where you want to run the command. Defaults to the current working directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Local port to serve theme preview from. Must be between 1 and 65535.\n * @environment SHOPIFY_FLAG_PORT\n */\n '--port '?: string\n\n /**\n * 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.\n * @environment SHOPIFY_FLAG_RECONCILIATION_STRATEGY\n */\n '--reconciliation-strategy '?: string\n\n /**\n * Inject the standard events inspector into storefront HTML.\n * @environment SHOPIFY_FLAG_STANDARD_EVENTS_INSPECTOR\n */\n '--standard-events-inspector'?: ''\n\n /**\n * Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).\n * @environment SHOPIFY_FLAG_STORE\n */\n '-s, --store '?: string\n\n /**\n * The password for storefronts with password protection.\n * @environment SHOPIFY_FLAG_STORE_PASSWORD\n */\n '--store-password '?: string\n\n /**\n * Theme ID or name of the remote theme.\n * @environment SHOPIFY_FLAG_THEME_ID\n */\n '-t, --theme '?: string\n\n /**\n * Synchronize Theme Editor updates in the local theme files.\n * @environment SHOPIFY_FLAG_THEME_EDITOR_SYNC\n */\n '--theme-editor-sync'?: ''\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" } }, "themeduplicate": { @@ -5971,6 +6735,15 @@ "isOptional": true, "environmentValue": "SHOPIFY_FLAG_AUTH_ALIAS" }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-duplicate.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--json-schema", + "value": "''", + "description": "Print the command's JSON schemas.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON_SCHEMA" + }, { "filePath": "docs-shopify.dev/commands/interfaces/theme-duplicate.interface.ts", "syntaxKind": "PropertySignature", @@ -6053,7 +6826,7 @@ "environmentValue": "SHOPIFY_FLAG_THEME_ID" } ], - "value": "export interface themeduplicate {\n /**\n * Alias of the Shopify account to use for authentication.\n * @environment SHOPIFY_FLAG_AUTH_ALIAS\n */\n '--auth-alias '?: string\n\n /**\n * The environment to apply to the current command.\n * @environment SHOPIFY_FLAG_ENVIRONMENT\n */\n '-e, --environment '?: string\n\n /**\n * Force the duplicate operation to run without prompts or confirmations. Required if non interactive outside CI.\n * @environment SHOPIFY_FLAG_FORCE\n */\n '-f, --force'?: ''\n\n /**\n * Output the result as JSON. Automatically disables color output.\n * @environment SHOPIFY_FLAG_JSON\n */\n '-j, --json'?: ''\n\n /**\n * Name of the newly duplicated theme.\n * @environment SHOPIFY_FLAG_NAME\n */\n '-n, --name '?: string\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * Password generated from the Theme Access app or an Admin API token.\n * @environment SHOPIFY_CLI_THEME_TOKEN\n */\n '--password '?: string\n\n /**\n * Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).\n * @environment SHOPIFY_FLAG_STORE\n */\n '-s, --store '?: string\n\n /**\n * Theme ID or name of the remote theme. Required if non interactive.\n * @environment SHOPIFY_FLAG_THEME_ID\n */\n '-t, --theme '?: string\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" + "value": "export interface themeduplicate {\n /**\n * Alias of the Shopify account to use for authentication.\n * @environment SHOPIFY_FLAG_AUTH_ALIAS\n */\n '--auth-alias '?: string\n\n /**\n * The environment to apply to the current command.\n * @environment SHOPIFY_FLAG_ENVIRONMENT\n */\n '-e, --environment '?: string\n\n /**\n * Force the duplicate operation to run without prompts or confirmations. Required if non interactive outside CI.\n * @environment SHOPIFY_FLAG_FORCE\n */\n '-f, --force'?: ''\n\n /**\n * Output the result as JSON. Automatically disables color output.\n * @environment SHOPIFY_FLAG_JSON\n */\n '-j, --json'?: ''\n\n /**\n * Print the command's JSON schemas.\n * @environment SHOPIFY_FLAG_JSON_SCHEMA\n */\n '--json-schema'?: ''\n\n /**\n * Name of the newly duplicated theme.\n * @environment SHOPIFY_FLAG_NAME\n */\n '-n, --name '?: string\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * Password generated from the Theme Access app or an Admin API token.\n * @environment SHOPIFY_CLI_THEME_TOKEN\n */\n '--password '?: string\n\n /**\n * Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).\n * @environment SHOPIFY_FLAG_STORE\n */\n '-s, --store '?: string\n\n /**\n * Theme ID or name of the remote theme. Required if non interactive.\n * @environment SHOPIFY_FLAG_THEME_ID\n */\n '-t, --theme '?: string\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" } }, "themeinfo": { @@ -6072,6 +6845,15 @@ "isOptional": true, "environmentValue": "SHOPIFY_FLAG_AUTH_ALIAS" }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-info.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--json-schema", + "value": "''", + "description": "Print the command's JSON schemas.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON_SCHEMA" + }, { "filePath": "docs-shopify.dev/commands/interfaces/theme-info.interface.ts", "syntaxKind": "PropertySignature", @@ -6154,7 +6936,7 @@ "environmentValue": "SHOPIFY_FLAG_THEME_ID" } ], - "value": "export interface themeinfo {\n /**\n * Alias of the Shopify account to use for authentication.\n * @environment SHOPIFY_FLAG_AUTH_ALIAS\n */\n '--auth-alias '?: string\n\n /**\n * Retrieve info from your development theme.\n * @environment SHOPIFY_FLAG_DEVELOPMENT\n */\n '-d, --development'?: ''\n\n /**\n * The environment to apply to the current command.\n * @environment SHOPIFY_FLAG_ENVIRONMENT\n */\n '-e, --environment '?: string\n\n /**\n * Output the result as JSON. Automatically disables color output.\n * @environment SHOPIFY_FLAG_JSON\n */\n '-j, --json'?: ''\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * Password generated from the Theme Access app or an Admin API token.\n * @environment SHOPIFY_CLI_THEME_TOKEN\n */\n '--password '?: string\n\n /**\n * The path where you want to run the command. Defaults to the current working directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).\n * @environment SHOPIFY_FLAG_STORE\n */\n '-s, --store '?: string\n\n /**\n * Theme ID or name of the remote theme.\n * @environment SHOPIFY_FLAG_THEME_ID\n */\n '-t, --theme '?: string\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" + "value": "export interface themeinfo {\n /**\n * Alias of the Shopify account to use for authentication.\n * @environment SHOPIFY_FLAG_AUTH_ALIAS\n */\n '--auth-alias '?: string\n\n /**\n * Retrieve info from your development theme.\n * @environment SHOPIFY_FLAG_DEVELOPMENT\n */\n '-d, --development'?: ''\n\n /**\n * The environment to apply to the current command.\n * @environment SHOPIFY_FLAG_ENVIRONMENT\n */\n '-e, --environment '?: string\n\n /**\n * Output the result as JSON. Automatically disables color output.\n * @environment SHOPIFY_FLAG_JSON\n */\n '-j, --json'?: ''\n\n /**\n * Print the command's JSON schemas.\n * @environment SHOPIFY_FLAG_JSON_SCHEMA\n */\n '--json-schema'?: ''\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * Password generated from the Theme Access app or an Admin API token.\n * @environment SHOPIFY_CLI_THEME_TOKEN\n */\n '--password '?: string\n\n /**\n * The path where you want to run the command. Defaults to the current working directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).\n * @environment SHOPIFY_FLAG_STORE\n */\n '-s, --store '?: string\n\n /**\n * Theme ID or name of the remote theme.\n * @environment SHOPIFY_FLAG_THEME_ID\n */\n '-t, --theme '?: string\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" } }, "themeinit": { @@ -6173,6 +6955,15 @@ "isOptional": true, "environmentValue": "SHOPIFY_FLAG_AUTH_ALIAS" }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-init.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--json-schema", + "value": "''", + "description": "Print the command's JSON schemas.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON_SCHEMA" + }, { "filePath": "docs-shopify.dev/commands/interfaces/theme-init.interface.ts", "syntaxKind": "PropertySignature", @@ -6219,7 +7010,7 @@ "environmentValue": "SHOPIFY_FLAG_CLONE_URL" } ], - "value": "export interface themeinit {\n /**\n * Alias of the Shopify account to use for authentication.\n * @environment SHOPIFY_FLAG_AUTH_ALIAS\n */\n '--auth-alias '?: string\n\n /**\n * The Git URL to clone from. Defaults to Shopify's Skeleton theme.\n * @environment SHOPIFY_FLAG_CLONE_URL\n */\n '-u, --clone-url '?: string\n\n /**\n * Downloads the latest release of the `clone-url`\n * @environment SHOPIFY_FLAG_LATEST\n */\n '-l, --latest'?: ''\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * The path where you want to run the command. Defaults to the current working directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" + "value": "export interface themeinit {\n /**\n * Alias of the Shopify account to use for authentication.\n * @environment SHOPIFY_FLAG_AUTH_ALIAS\n */\n '--auth-alias '?: string\n\n /**\n * The Git URL to clone from. Defaults to Shopify's Skeleton theme.\n * @environment SHOPIFY_FLAG_CLONE_URL\n */\n '-u, --clone-url '?: string\n\n /**\n * Print the command's JSON schemas.\n * @environment SHOPIFY_FLAG_JSON_SCHEMA\n */\n '--json-schema'?: ''\n\n /**\n * Downloads the latest release of the `clone-url`\n * @environment SHOPIFY_FLAG_LATEST\n */\n '-l, --latest'?: ''\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * The path where you want to run the command. Defaults to the current working directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" } }, "themelanguageserver": { @@ -6238,6 +7029,15 @@ "isOptional": true, "environmentValue": "SHOPIFY_FLAG_AUTH_ALIAS" }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-language-server.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--json-schema", + "value": "''", + "description": "Print the command's JSON schemas.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON_SCHEMA" + }, { "filePath": "docs-shopify.dev/commands/interfaces/theme-language-server.interface.ts", "syntaxKind": "PropertySignature", @@ -6257,7 +7057,7 @@ "environmentValue": "SHOPIFY_FLAG_VERBOSE" } ], - "value": "export interface themelanguageserver {\n /**\n * Alias of the Shopify account to use for authentication.\n * @environment SHOPIFY_FLAG_AUTH_ALIAS\n */\n '--auth-alias '?: string\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" + "value": "export interface themelanguageserver {\n /**\n * Alias of the Shopify account to use for authentication.\n * @environment SHOPIFY_FLAG_AUTH_ALIAS\n */\n '--auth-alias '?: string\n\n /**\n * Print the command's JSON schemas.\n * @environment SHOPIFY_FLAG_JSON_SCHEMA\n */\n '--json-schema'?: ''\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" } }, "themelist": { @@ -6285,6 +7085,15 @@ "isOptional": true, "environmentValue": "SHOPIFY_FLAG_ID" }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-list.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--json-schema", + "value": "''", + "description": "Print the command's JSON schemas.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON_SCHEMA" + }, { "filePath": "docs-shopify.dev/commands/interfaces/theme-list.interface.ts", "syntaxKind": "PropertySignature", @@ -6367,7 +7176,7 @@ "environmentValue": "SHOPIFY_FLAG_STORE" } ], - "value": "export interface themelist {\n /**\n * Alias of the Shopify account to use for authentication.\n * @environment SHOPIFY_FLAG_AUTH_ALIAS\n */\n '--auth-alias '?: string\n\n /**\n * The environment to apply to the current command.\n * @environment SHOPIFY_FLAG_ENVIRONMENT\n */\n '-e, --environment '?: string\n\n /**\n * Only list theme with the given ID.\n * @environment SHOPIFY_FLAG_ID\n */\n '--id '?: string\n\n /**\n * Output the result as JSON. Automatically disables color output.\n * @environment SHOPIFY_FLAG_JSON\n */\n '-j, --json'?: ''\n\n /**\n * Only list themes that contain the given name.\n * @environment SHOPIFY_FLAG_NAME\n */\n '--name '?: string\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * Password generated from the Theme Access app or an Admin API token.\n * @environment SHOPIFY_CLI_THEME_TOKEN\n */\n '--password '?: string\n\n /**\n * The path where you want to run the command. Defaults to the current working directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Only list themes with the given role.\n * @environment SHOPIFY_FLAG_ROLE\n */\n '--role '?: string\n\n /**\n * Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).\n * @environment SHOPIFY_FLAG_STORE\n */\n '-s, --store '?: string\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" + "value": "export interface themelist {\n /**\n * Alias of the Shopify account to use for authentication.\n * @environment SHOPIFY_FLAG_AUTH_ALIAS\n */\n '--auth-alias '?: string\n\n /**\n * The environment to apply to the current command.\n * @environment SHOPIFY_FLAG_ENVIRONMENT\n */\n '-e, --environment '?: string\n\n /**\n * Only list theme with the given ID.\n * @environment SHOPIFY_FLAG_ID\n */\n '--id '?: string\n\n /**\n * Output the result as JSON. Automatically disables color output.\n * @environment SHOPIFY_FLAG_JSON\n */\n '-j, --json'?: ''\n\n /**\n * Print the command's JSON schemas.\n * @environment SHOPIFY_FLAG_JSON_SCHEMA\n */\n '--json-schema'?: ''\n\n /**\n * Only list themes that contain the given name.\n * @environment SHOPIFY_FLAG_NAME\n */\n '--name '?: string\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * Password generated from the Theme Access app or an Admin API token.\n * @environment SHOPIFY_CLI_THEME_TOKEN\n */\n '--password '?: string\n\n /**\n * The path where you want to run the command. Defaults to the current working directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Only list themes with the given role.\n * @environment SHOPIFY_FLAG_ROLE\n */\n '--role '?: string\n\n /**\n * Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).\n * @environment SHOPIFY_FLAG_STORE\n */\n '-s, --store '?: string\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" } }, "thememetafieldspull": { @@ -6386,6 +7195,15 @@ "isOptional": true, "environmentValue": "SHOPIFY_FLAG_AUTH_ALIAS" }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-metafields-pull.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--json-schema", + "value": "''", + "description": "Print the command's JSON schemas.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON_SCHEMA" + }, { "filePath": "docs-shopify.dev/commands/interfaces/theme-metafields-pull.interface.ts", "syntaxKind": "PropertySignature", @@ -6441,7 +7259,7 @@ "environmentValue": "SHOPIFY_FLAG_STORE" } ], - "value": "export interface thememetafieldspull {\n /**\n * Alias of the Shopify account to use for authentication.\n * @environment SHOPIFY_FLAG_AUTH_ALIAS\n */\n '--auth-alias '?: string\n\n /**\n * The environment to apply to the current command.\n * @environment SHOPIFY_FLAG_ENVIRONMENT\n */\n '-e, --environment '?: string\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * Password generated from the Theme Access app or an Admin API token.\n * @environment SHOPIFY_CLI_THEME_TOKEN\n */\n '--password '?: string\n\n /**\n * The path where you want to run the command. Defaults to the current working directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).\n * @environment SHOPIFY_FLAG_STORE\n */\n '-s, --store '?: string\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" + "value": "export interface thememetafieldspull {\n /**\n * Alias of the Shopify account to use for authentication.\n * @environment SHOPIFY_FLAG_AUTH_ALIAS\n */\n '--auth-alias '?: string\n\n /**\n * The environment to apply to the current command.\n * @environment SHOPIFY_FLAG_ENVIRONMENT\n */\n '-e, --environment '?: string\n\n /**\n * Print the command's JSON schemas.\n * @environment SHOPIFY_FLAG_JSON_SCHEMA\n */\n '--json-schema'?: ''\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * Password generated from the Theme Access app or an Admin API token.\n * @environment SHOPIFY_CLI_THEME_TOKEN\n */\n '--password '?: string\n\n /**\n * The path where you want to run the command. Defaults to the current working directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).\n * @environment SHOPIFY_FLAG_STORE\n */\n '-s, --store '?: string\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" } }, "themeopen": { @@ -6460,6 +7278,15 @@ "isOptional": true, "environmentValue": "SHOPIFY_FLAG_AUTH_ALIAS" }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-open.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--json-schema", + "value": "''", + "description": "Print the command's JSON schemas.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON_SCHEMA" + }, { "filePath": "docs-shopify.dev/commands/interfaces/theme-open.interface.ts", "syntaxKind": "PropertySignature", @@ -6551,7 +7378,7 @@ "environmentValue": "SHOPIFY_FLAG_THEME_ID" } ], - "value": "export interface themeopen {\n /**\n * Alias of the Shopify account to use for authentication.\n * @environment SHOPIFY_FLAG_AUTH_ALIAS\n */\n '--auth-alias '?: string\n\n /**\n * Open your development theme. Use --development, --live, or --theme in non-interactive environments.\n * @environment SHOPIFY_FLAG_DEVELOPMENT\n */\n '-d, --development'?: ''\n\n /**\n * Open the theme editor for the specified theme in the browser.\n * @environment SHOPIFY_FLAG_EDITOR\n */\n '-E, --editor'?: ''\n\n /**\n * The environment to apply to the current command.\n * @environment SHOPIFY_FLAG_ENVIRONMENT\n */\n '-e, --environment '?: string\n\n /**\n * Open your live (published) theme. Use --development, --live, or --theme in non-interactive environments.\n * @environment SHOPIFY_FLAG_LIVE\n */\n '-l, --live'?: ''\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * Password generated from the Theme Access app or an Admin API token.\n * @environment SHOPIFY_CLI_THEME_TOKEN\n */\n '--password '?: string\n\n /**\n * The path where you want to run the command. Defaults to the current working directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).\n * @environment SHOPIFY_FLAG_STORE\n */\n '-s, --store '?: string\n\n /**\n * Theme ID or name of the remote theme. Use --development, --live, or --theme in non-interactive environments.\n * @environment SHOPIFY_FLAG_THEME_ID\n */\n '-t, --theme '?: string\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" + "value": "export interface themeopen {\n /**\n * Alias of the Shopify account to use for authentication.\n * @environment SHOPIFY_FLAG_AUTH_ALIAS\n */\n '--auth-alias '?: string\n\n /**\n * Open your development theme. Use --development, --live, or --theme in non-interactive environments.\n * @environment SHOPIFY_FLAG_DEVELOPMENT\n */\n '-d, --development'?: ''\n\n /**\n * Open the theme editor for the specified theme in the browser.\n * @environment SHOPIFY_FLAG_EDITOR\n */\n '-E, --editor'?: ''\n\n /**\n * The environment to apply to the current command.\n * @environment SHOPIFY_FLAG_ENVIRONMENT\n */\n '-e, --environment '?: string\n\n /**\n * Print the command's JSON schemas.\n * @environment SHOPIFY_FLAG_JSON_SCHEMA\n */\n '--json-schema'?: ''\n\n /**\n * Open your live (published) theme. Use --development, --live, or --theme in non-interactive environments.\n * @environment SHOPIFY_FLAG_LIVE\n */\n '-l, --live'?: ''\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * Password generated from the Theme Access app or an Admin API token.\n * @environment SHOPIFY_CLI_THEME_TOKEN\n */\n '--password '?: string\n\n /**\n * The path where you want to run the command. Defaults to the current working directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).\n * @environment SHOPIFY_FLAG_STORE\n */\n '-s, --store '?: string\n\n /**\n * Theme ID or name of the remote theme. Use --development, --live, or --theme in non-interactive environments.\n * @environment SHOPIFY_FLAG_THEME_ID\n */\n '-t, --theme '?: string\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" } }, "themepackage": { @@ -6570,6 +7397,15 @@ "isOptional": true, "environmentValue": "SHOPIFY_FLAG_AUTH_ALIAS" }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-package.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--json-schema", + "value": "''", + "description": "Print the command's JSON schemas.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON_SCHEMA" + }, { "filePath": "docs-shopify.dev/commands/interfaces/theme-package.interface.ts", "syntaxKind": "PropertySignature", @@ -6598,7 +7434,7 @@ "environmentValue": "SHOPIFY_FLAG_VERBOSE" } ], - "value": "export interface themepackage {\n /**\n * Alias of the Shopify account to use for authentication.\n * @environment SHOPIFY_FLAG_AUTH_ALIAS\n */\n '--auth-alias '?: string\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * The path where you want to run the command. Defaults to the current working directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" + "value": "export interface themepackage {\n /**\n * Alias of the Shopify account to use for authentication.\n * @environment SHOPIFY_FLAG_AUTH_ALIAS\n */\n '--auth-alias '?: string\n\n /**\n * Print the command's JSON schemas.\n * @environment SHOPIFY_FLAG_JSON_SCHEMA\n */\n '--json-schema'?: ''\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * The path where you want to run the command. Defaults to the current working directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" } }, "themepreview": { @@ -6626,6 +7462,15 @@ "isOptional": true, "environmentValue": "SHOPIFY_FLAG_JSON" }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-preview.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--json-schema", + "value": "''", + "description": "Print the command's JSON schemas.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON_SCHEMA" + }, { "filePath": "docs-shopify.dev/commands/interfaces/theme-preview.interface.ts", "syntaxKind": "PropertySignature", @@ -6715,7 +7560,7 @@ "environmentValue": "SHOPIFY_FLAG_THEME_ID" } ], - "value": "export interface themepreview {\n /**\n * Alias of the Shopify account to use for authentication.\n * @environment SHOPIFY_FLAG_AUTH_ALIAS\n */\n '--auth-alias '?: string\n\n /**\n * The environment to apply to the current command.\n * @environment SHOPIFY_FLAG_ENVIRONMENT\n */\n '-e, --environment '?: string\n\n /**\n * Output the preview URL and identifier as JSON.\n * @environment SHOPIFY_FLAG_JSON\n */\n '--json'?: ''\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * Automatically launch the theme preview in your default web browser.\n * @environment SHOPIFY_FLAG_OPEN\n */\n '--open'?: ''\n\n /**\n * Path to a JSON overrides file.\n * @environment SHOPIFY_FLAG_OVERRIDES\n */\n '--overrides ': string\n\n /**\n * Password generated from the Theme Access app or an Admin API token.\n * @environment SHOPIFY_CLI_THEME_TOKEN\n */\n '--password '?: string\n\n /**\n * The path where you want to run the command. Defaults to the current working directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * An existing preview identifier to update instead of creating a new preview.\n * @environment SHOPIFY_FLAG_PREVIEW_ID\n */\n '--preview-id '?: string\n\n /**\n * Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).\n * @environment SHOPIFY_FLAG_STORE\n */\n '-s, --store '?: string\n\n /**\n * Theme ID or name of the remote theme.\n * @environment SHOPIFY_FLAG_THEME_ID\n */\n '-t, --theme ': string\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" + "value": "export interface themepreview {\n /**\n * Alias of the Shopify account to use for authentication.\n * @environment SHOPIFY_FLAG_AUTH_ALIAS\n */\n '--auth-alias '?: string\n\n /**\n * The environment to apply to the current command.\n * @environment SHOPIFY_FLAG_ENVIRONMENT\n */\n '-e, --environment '?: string\n\n /**\n * Output the preview URL and identifier as JSON.\n * @environment SHOPIFY_FLAG_JSON\n */\n '--json'?: ''\n\n /**\n * Print the command's JSON schemas.\n * @environment SHOPIFY_FLAG_JSON_SCHEMA\n */\n '--json-schema'?: ''\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * Automatically launch the theme preview in your default web browser.\n * @environment SHOPIFY_FLAG_OPEN\n */\n '--open'?: ''\n\n /**\n * Path to a JSON overrides file.\n * @environment SHOPIFY_FLAG_OVERRIDES\n */\n '--overrides ': string\n\n /**\n * Password generated from the Theme Access app or an Admin API token.\n * @environment SHOPIFY_CLI_THEME_TOKEN\n */\n '--password '?: string\n\n /**\n * The path where you want to run the command. Defaults to the current working directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * An existing preview identifier to update instead of creating a new preview.\n * @environment SHOPIFY_FLAG_PREVIEW_ID\n */\n '--preview-id '?: string\n\n /**\n * Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).\n * @environment SHOPIFY_FLAG_STORE\n */\n '-s, --store '?: string\n\n /**\n * Theme ID or name of the remote theme.\n * @environment SHOPIFY_FLAG_THEME_ID\n */\n '-t, --theme ': string\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" } }, "themeprofile": { @@ -6734,6 +7579,15 @@ "isOptional": true, "environmentValue": "SHOPIFY_FLAG_AUTH_ALIAS" }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-profile.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--json-schema", + "value": "''", + "description": "Print the command's JSON schemas.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON_SCHEMA" + }, { "filePath": "docs-shopify.dev/commands/interfaces/theme-profile.interface.ts", "syntaxKind": "PropertySignature", @@ -6825,7 +7679,7 @@ "environmentValue": "SHOPIFY_FLAG_THEME_ID" } ], - "value": "export interface themeprofile {\n /**\n * Alias of the Shopify account to use for authentication.\n * @environment SHOPIFY_FLAG_AUTH_ALIAS\n */\n '--auth-alias '?: string\n\n /**\n * The environment to apply to the current command.\n * @environment SHOPIFY_FLAG_ENVIRONMENT\n */\n '-e, --environment '?: string\n\n /**\n * Output the result as JSON. Automatically disables color output.\n * @environment SHOPIFY_FLAG_JSON\n */\n '-j, --json'?: ''\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * Password generated from the Theme Access app or an Admin API token.\n * @environment SHOPIFY_CLI_THEME_TOKEN\n */\n '--password '?: string\n\n /**\n * The path where you want to run the command. Defaults to the current working directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).\n * @environment SHOPIFY_FLAG_STORE\n */\n '-s, --store '?: string\n\n /**\n * The password for storefronts with password protection.\n * @environment SHOPIFY_FLAG_STORE_PASSWORD\n */\n '--store-password '?: string\n\n /**\n * Theme ID or name of the remote theme.\n * @environment SHOPIFY_FLAG_THEME_ID\n */\n '-t, --theme '?: string\n\n /**\n * The url to be used as context\n * @environment SHOPIFY_FLAG_URL\n */\n '--url '?: string\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" + "value": "export interface themeprofile {\n /**\n * Alias of the Shopify account to use for authentication.\n * @environment SHOPIFY_FLAG_AUTH_ALIAS\n */\n '--auth-alias '?: string\n\n /**\n * The environment to apply to the current command.\n * @environment SHOPIFY_FLAG_ENVIRONMENT\n */\n '-e, --environment '?: string\n\n /**\n * Output the result as JSON. Automatically disables color output.\n * @environment SHOPIFY_FLAG_JSON\n */\n '-j, --json'?: ''\n\n /**\n * Print the command's JSON schemas.\n * @environment SHOPIFY_FLAG_JSON_SCHEMA\n */\n '--json-schema'?: ''\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * Password generated from the Theme Access app or an Admin API token.\n * @environment SHOPIFY_CLI_THEME_TOKEN\n */\n '--password '?: string\n\n /**\n * The path where you want to run the command. Defaults to the current working directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).\n * @environment SHOPIFY_FLAG_STORE\n */\n '-s, --store '?: string\n\n /**\n * The password for storefronts with password protection.\n * @environment SHOPIFY_FLAG_STORE_PASSWORD\n */\n '--store-password '?: string\n\n /**\n * Theme ID or name of the remote theme.\n * @environment SHOPIFY_FLAG_THEME_ID\n */\n '-t, --theme '?: string\n\n /**\n * The url to be used as context\n * @environment SHOPIFY_FLAG_URL\n */\n '--url '?: string\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" } }, "themepublish": { @@ -6844,6 +7698,15 @@ "isOptional": true, "environmentValue": "SHOPIFY_FLAG_AUTH_ALIAS" }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-publish.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--json-schema", + "value": "''", + "description": "Print the command's JSON schemas.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON_SCHEMA" + }, { "filePath": "docs-shopify.dev/commands/interfaces/theme-publish.interface.ts", "syntaxKind": "PropertySignature", @@ -6917,7 +7780,7 @@ "environmentValue": "SHOPIFY_FLAG_THEME_ID" } ], - "value": "export interface themepublish {\n /**\n * Alias of the Shopify account to use for authentication.\n * @environment SHOPIFY_FLAG_AUTH_ALIAS\n */\n '--auth-alias '?: string\n\n /**\n * The environment to apply to the current command.\n * @environment SHOPIFY_FLAG_ENVIRONMENT\n */\n '-e, --environment '?: string\n\n /**\n * Skip confirmation. Required if non interactive.\n * @environment SHOPIFY_FLAG_FORCE\n */\n '-f, --force'?: ''\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * Password generated from the Theme Access app or an Admin API token.\n * @environment SHOPIFY_CLI_THEME_TOKEN\n */\n '--password '?: string\n\n /**\n * The path where you want to run the command. Defaults to the current working directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).\n * @environment SHOPIFY_FLAG_STORE\n */\n '-s, --store '?: string\n\n /**\n * Theme ID or name of the remote theme. Required if non interactive.\n * @environment SHOPIFY_FLAG_THEME_ID\n */\n '-t, --theme '?: string\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" + "value": "export interface themepublish {\n /**\n * Alias of the Shopify account to use for authentication.\n * @environment SHOPIFY_FLAG_AUTH_ALIAS\n */\n '--auth-alias '?: string\n\n /**\n * The environment to apply to the current command.\n * @environment SHOPIFY_FLAG_ENVIRONMENT\n */\n '-e, --environment '?: string\n\n /**\n * Skip confirmation. Required if non interactive.\n * @environment SHOPIFY_FLAG_FORCE\n */\n '-f, --force'?: ''\n\n /**\n * Print the command's JSON schemas.\n * @environment SHOPIFY_FLAG_JSON_SCHEMA\n */\n '--json-schema'?: ''\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * Password generated from the Theme Access app or an Admin API token.\n * @environment SHOPIFY_CLI_THEME_TOKEN\n */\n '--password '?: string\n\n /**\n * The path where you want to run the command. Defaults to the current working directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).\n * @environment SHOPIFY_FLAG_STORE\n */\n '-s, --store '?: string\n\n /**\n * Theme ID or name of the remote theme. Required if non interactive.\n * @environment SHOPIFY_FLAG_THEME_ID\n */\n '-t, --theme '?: string\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" } }, "themepull": { @@ -6936,6 +7799,15 @@ "isOptional": true, "environmentValue": "SHOPIFY_FLAG_AUTH_ALIAS" }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-pull.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--json-schema", + "value": "''", + "description": "Print the command's JSON schemas.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON_SCHEMA" + }, { "filePath": "docs-shopify.dev/commands/interfaces/theme-pull.interface.ts", "syntaxKind": "PropertySignature", @@ -7045,7 +7917,7 @@ "environmentValue": "SHOPIFY_FLAG_IGNORE" } ], - "value": "export interface themepull {\n /**\n * Alias of the Shopify account to use for authentication.\n * @environment SHOPIFY_FLAG_AUTH_ALIAS\n */\n '--auth-alias '?: string\n\n /**\n * Pull theme files from your remote development theme. Use --development, --live, or --theme in non-interactive environments.\n * @environment SHOPIFY_FLAG_DEVELOPMENT\n */\n '-d, --development'?: ''\n\n /**\n * The environment to apply to the current command.\n * @environment SHOPIFY_FLAG_ENVIRONMENT\n */\n '-e, --environment '?: string\n\n /**\n * Skip downloading the specified files (Multiple flags allowed). Wrap the value in double quotes if you're using wildcards.\n * @environment SHOPIFY_FLAG_IGNORE\n */\n '-x, --ignore '?: string\n\n /**\n * Pull theme files from your remote live theme. Use --development, --live, or --theme in non-interactive environments.\n * @environment SHOPIFY_FLAG_LIVE\n */\n '-l, --live'?: ''\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * Prevent deleting local files that don't exist remotely.\n * @environment SHOPIFY_FLAG_NODELETE\n */\n '-n, --nodelete'?: ''\n\n /**\n * Download only the specified files (Multiple flags allowed). Wrap the value in double quotes if you're using wildcards.\n * @environment SHOPIFY_FLAG_ONLY\n */\n '-o, --only '?: string\n\n /**\n * Password generated from the Theme Access app or an Admin API token.\n * @environment SHOPIFY_CLI_THEME_TOKEN\n */\n '--password '?: string\n\n /**\n * The path where you want to run the command. Defaults to the current working directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).\n * @environment SHOPIFY_FLAG_STORE\n */\n '-s, --store '?: string\n\n /**\n * Theme ID or name of the remote theme. Use --development, --live, or --theme in non-interactive environments.\n * @environment SHOPIFY_FLAG_THEME_ID\n */\n '-t, --theme '?: string\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" + "value": "export interface themepull {\n /**\n * Alias of the Shopify account to use for authentication.\n * @environment SHOPIFY_FLAG_AUTH_ALIAS\n */\n '--auth-alias '?: string\n\n /**\n * Pull theme files from your remote development theme. Use --development, --live, or --theme in non-interactive environments.\n * @environment SHOPIFY_FLAG_DEVELOPMENT\n */\n '-d, --development'?: ''\n\n /**\n * The environment to apply to the current command.\n * @environment SHOPIFY_FLAG_ENVIRONMENT\n */\n '-e, --environment '?: string\n\n /**\n * Skip downloading the specified files (Multiple flags allowed). Wrap the value in double quotes if you're using wildcards.\n * @environment SHOPIFY_FLAG_IGNORE\n */\n '-x, --ignore '?: string\n\n /**\n * Print the command's JSON schemas.\n * @environment SHOPIFY_FLAG_JSON_SCHEMA\n */\n '--json-schema'?: ''\n\n /**\n * Pull theme files from your remote live theme. Use --development, --live, or --theme in non-interactive environments.\n * @environment SHOPIFY_FLAG_LIVE\n */\n '-l, --live'?: ''\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * Prevent deleting local files that don't exist remotely.\n * @environment SHOPIFY_FLAG_NODELETE\n */\n '-n, --nodelete'?: ''\n\n /**\n * Download only the specified files (Multiple flags allowed). Wrap the value in double quotes if you're using wildcards.\n * @environment SHOPIFY_FLAG_ONLY\n */\n '-o, --only '?: string\n\n /**\n * Password generated from the Theme Access app or an Admin API token.\n * @environment SHOPIFY_CLI_THEME_TOKEN\n */\n '--password '?: string\n\n /**\n * The path where you want to run the command. Defaults to the current working directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).\n * @environment SHOPIFY_FLAG_STORE\n */\n '-s, --store '?: string\n\n /**\n * Theme ID or name of the remote theme. Use --development, --live, or --theme in non-interactive environments.\n * @environment SHOPIFY_FLAG_THEME_ID\n */\n '-t, --theme '?: string\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" } }, "themepush": { @@ -7064,6 +7936,15 @@ "isOptional": true, "environmentValue": "SHOPIFY_FLAG_AUTH_ALIAS" }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-push.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--json-schema", + "value": "''", + "description": "Print the command's JSON schemas.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON_SCHEMA" + }, { "filePath": "docs-shopify.dev/commands/interfaces/theme-push.interface.ts", "syntaxKind": "PropertySignature", @@ -7236,7 +8117,7 @@ "environmentValue": "SHOPIFY_FLAG_IGNORE" } ], - "value": "export interface themepush {\n /**\n * Allow push to a live theme. Required in non-interactive environments when targeting the live theme.\n * @environment SHOPIFY_FLAG_ALLOW_LIVE\n */\n '-a, --allow-live'?: ''\n\n /**\n * Alias of the Shopify account to use for authentication.\n * @environment SHOPIFY_FLAG_AUTH_ALIAS\n */\n '--auth-alias '?: string\n\n /**\n * Push theme files from your remote development theme. Use --development, --live, --theme, or --unpublished in non-interactive environments.\n * @environment SHOPIFY_FLAG_DEVELOPMENT\n */\n '-d, --development'?: ''\n\n /**\n * 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.\n * @environment SHOPIFY_FLAG_DEVELOPMENT_CONTEXT\n */\n '-c, --development-context '?: string\n\n /**\n * The environment to apply to the current command.\n * @environment SHOPIFY_FLAG_ENVIRONMENT\n */\n '-e, --environment '?: string\n\n /**\n * Skip uploading the specified files (Multiple flags allowed). Wrap the value in double quotes if you're using wildcards.\n * @environment SHOPIFY_FLAG_IGNORE\n */\n '-x, --ignore '?: string\n\n /**\n * Output the result as JSON. Automatically disables color output.\n * @environment SHOPIFY_FLAG_JSON\n */\n '-j, --json'?: ''\n\n /**\n * The listing preset to use for multi-preset themes. Applies preset files from listings/[preset-name] directory.\n * @environment SHOPIFY_FLAG_LISTING\n */\n '--listing '?: string\n\n /**\n * Push theme files from your remote live theme. Use --development, --live, --theme, or --unpublished in non-interactive environments.\n * @environment SHOPIFY_FLAG_LIVE\n */\n '-l, --live'?: ''\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * Prevent deleting remote files that don't exist locally.\n * @environment SHOPIFY_FLAG_NODELETE\n */\n '-n, --nodelete'?: ''\n\n /**\n * Upload only the specified files (Multiple flags allowed). Wrap the value in double quotes if you're using wildcards.\n * @environment SHOPIFY_FLAG_ONLY\n */\n '-o, --only '?: string\n\n /**\n * Password generated from the Theme Access app or an Admin API token.\n * @environment SHOPIFY_CLI_THEME_TOKEN\n */\n '--password '?: string\n\n /**\n * The path where you want to run the command. Defaults to the current working directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Publish as the live theme after uploading.\n * @environment SHOPIFY_FLAG_PUBLISH\n */\n '-p, --publish'?: ''\n\n /**\n * Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).\n * @environment SHOPIFY_FLAG_STORE\n */\n '-s, --store '?: string\n\n /**\n * Require theme check to pass without errors before pushing. Warnings are allowed.\n * @environment SHOPIFY_FLAG_STRICT_PUSH\n */\n '--strict'?: ''\n\n /**\n * Theme ID or name of the remote theme. Use --development, --live, --theme, or --unpublished in non-interactive environments. When using --unpublished without --development, use --theme to provide the new theme name.\n * @environment SHOPIFY_FLAG_THEME_ID\n */\n '-t, --theme '?: string\n\n /**\n * 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.\n * @environment SHOPIFY_FLAG_UNPUBLISHED\n */\n '-u, --unpublished'?: ''\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" + "value": "export interface themepush {\n /**\n * Allow push to a live theme. Required in non-interactive environments when targeting the live theme.\n * @environment SHOPIFY_FLAG_ALLOW_LIVE\n */\n '-a, --allow-live'?: ''\n\n /**\n * Alias of the Shopify account to use for authentication.\n * @environment SHOPIFY_FLAG_AUTH_ALIAS\n */\n '--auth-alias '?: string\n\n /**\n * Push theme files from your remote development theme. Use --development, --live, --theme, or --unpublished in non-interactive environments.\n * @environment SHOPIFY_FLAG_DEVELOPMENT\n */\n '-d, --development'?: ''\n\n /**\n * 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.\n * @environment SHOPIFY_FLAG_DEVELOPMENT_CONTEXT\n */\n '-c, --development-context '?: string\n\n /**\n * The environment to apply to the current command.\n * @environment SHOPIFY_FLAG_ENVIRONMENT\n */\n '-e, --environment '?: string\n\n /**\n * Skip uploading the specified files (Multiple flags allowed). Wrap the value in double quotes if you're using wildcards.\n * @environment SHOPIFY_FLAG_IGNORE\n */\n '-x, --ignore '?: string\n\n /**\n * Output the result as JSON. Automatically disables color output.\n * @environment SHOPIFY_FLAG_JSON\n */\n '-j, --json'?: ''\n\n /**\n * Print the command's JSON schemas.\n * @environment SHOPIFY_FLAG_JSON_SCHEMA\n */\n '--json-schema'?: ''\n\n /**\n * The listing preset to use for multi-preset themes. Applies preset files from listings/[preset-name] directory.\n * @environment SHOPIFY_FLAG_LISTING\n */\n '--listing '?: string\n\n /**\n * Push theme files from your remote live theme. Use --development, --live, --theme, or --unpublished in non-interactive environments.\n * @environment SHOPIFY_FLAG_LIVE\n */\n '-l, --live'?: ''\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * Prevent deleting remote files that don't exist locally.\n * @environment SHOPIFY_FLAG_NODELETE\n */\n '-n, --nodelete'?: ''\n\n /**\n * Upload only the specified files (Multiple flags allowed). Wrap the value in double quotes if you're using wildcards.\n * @environment SHOPIFY_FLAG_ONLY\n */\n '-o, --only '?: string\n\n /**\n * Password generated from the Theme Access app or an Admin API token.\n * @environment SHOPIFY_CLI_THEME_TOKEN\n */\n '--password '?: string\n\n /**\n * The path where you want to run the command. Defaults to the current working directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Publish as the live theme after uploading.\n * @environment SHOPIFY_FLAG_PUBLISH\n */\n '-p, --publish'?: ''\n\n /**\n * Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).\n * @environment SHOPIFY_FLAG_STORE\n */\n '-s, --store '?: string\n\n /**\n * Require theme check to pass without errors before pushing. Warnings are allowed.\n * @environment SHOPIFY_FLAG_STRICT_PUSH\n */\n '--strict'?: ''\n\n /**\n * Theme ID or name of the remote theme. Use --development, --live, --theme, or --unpublished in non-interactive environments. When using --unpublished without --development, use --theme to provide the new theme name.\n * @environment SHOPIFY_FLAG_THEME_ID\n */\n '-t, --theme '?: string\n\n /**\n * 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.\n * @environment SHOPIFY_FLAG_UNPUBLISHED\n */\n '-u, --unpublished'?: ''\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" } }, "themerename": { @@ -7255,6 +8136,15 @@ "isOptional": true, "environmentValue": "SHOPIFY_FLAG_AUTH_ALIAS" }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-rename.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--json-schema", + "value": "''", + "description": "Print the command's JSON schemas.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON_SCHEMA" + }, { "filePath": "docs-shopify.dev/commands/interfaces/theme-rename.interface.ts", "syntaxKind": "PropertySignature", @@ -7346,7 +8236,7 @@ "environmentValue": "SHOPIFY_FLAG_THEME_ID" } ], - "value": "export interface themerename {\n /**\n * Alias of the Shopify account to use for authentication.\n * @environment SHOPIFY_FLAG_AUTH_ALIAS\n */\n '--auth-alias '?: string\n\n /**\n * Rename your development theme. Use --development, --live, or --theme in non-interactive environments.\n * @environment SHOPIFY_FLAG_DEVELOPMENT\n */\n '-d, --development'?: ''\n\n /**\n * The environment to apply to the current command.\n * @environment SHOPIFY_FLAG_ENVIRONMENT\n */\n '-e, --environment '?: string\n\n /**\n * Rename your remote live theme. Use --development, --live, or --theme in non-interactive environments.\n * @environment SHOPIFY_FLAG_LIVE\n */\n '-l, --live'?: ''\n\n /**\n * The new name for the theme. Required if non interactive.\n * @environment SHOPIFY_FLAG_NEW_NAME\n */\n '-n, --name '?: string\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * Password generated from the Theme Access app or an Admin API token.\n * @environment SHOPIFY_CLI_THEME_TOKEN\n */\n '--password '?: string\n\n /**\n * The path where you want to run the command. Defaults to the current working directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).\n * @environment SHOPIFY_FLAG_STORE\n */\n '-s, --store '?: string\n\n /**\n * Theme ID or name of the remote theme. Use --development, --live, or --theme in non-interactive environments.\n * @environment SHOPIFY_FLAG_THEME_ID\n */\n '-t, --theme '?: string\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" + "value": "export interface themerename {\n /**\n * Alias of the Shopify account to use for authentication.\n * @environment SHOPIFY_FLAG_AUTH_ALIAS\n */\n '--auth-alias '?: string\n\n /**\n * Rename your development theme. Use --development, --live, or --theme in non-interactive environments.\n * @environment SHOPIFY_FLAG_DEVELOPMENT\n */\n '-d, --development'?: ''\n\n /**\n * The environment to apply to the current command.\n * @environment SHOPIFY_FLAG_ENVIRONMENT\n */\n '-e, --environment '?: string\n\n /**\n * Print the command's JSON schemas.\n * @environment SHOPIFY_FLAG_JSON_SCHEMA\n */\n '--json-schema'?: ''\n\n /**\n * Rename your remote live theme. Use --development, --live, or --theme in non-interactive environments.\n * @environment SHOPIFY_FLAG_LIVE\n */\n '-l, --live'?: ''\n\n /**\n * The new name for the theme. Required if non interactive.\n * @environment SHOPIFY_FLAG_NEW_NAME\n */\n '-n, --name '?: string\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * Password generated from the Theme Access app or an Admin API token.\n * @environment SHOPIFY_CLI_THEME_TOKEN\n */\n '--password '?: string\n\n /**\n * The path where you want to run the command. Defaults to the current working directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).\n * @environment SHOPIFY_FLAG_STORE\n */\n '-s, --store '?: string\n\n /**\n * Theme ID or name of the remote theme. Use --development, --live, or --theme in non-interactive environments.\n * @environment SHOPIFY_FLAG_THEME_ID\n */\n '-t, --theme '?: string\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" } }, "themeshare": { @@ -7365,6 +8255,15 @@ "isOptional": true, "environmentValue": "SHOPIFY_FLAG_AUTH_ALIAS" }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-share.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--json-schema", + "value": "''", + "description": "Print the command's JSON schemas.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON_SCHEMA" + }, { "filePath": "docs-shopify.dev/commands/interfaces/theme-share.interface.ts", "syntaxKind": "PropertySignature", @@ -7429,7 +8328,7 @@ "environmentValue": "SHOPIFY_FLAG_STORE" } ], - "value": "export interface themeshare {\n /**\n * Alias of the Shopify account to use for authentication.\n * @environment SHOPIFY_FLAG_AUTH_ALIAS\n */\n '--auth-alias '?: string\n\n /**\n * The environment to apply to the current command.\n * @environment SHOPIFY_FLAG_ENVIRONMENT\n */\n '-e, --environment '?: string\n\n /**\n * The listing preset to use for multi-preset themes. Applies preset files from listings/[preset-name] directory.\n * @environment SHOPIFY_FLAG_LISTING\n */\n '--listing '?: string\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * Password generated from the Theme Access app or an Admin API token.\n * @environment SHOPIFY_CLI_THEME_TOKEN\n */\n '--password '?: string\n\n /**\n * The path where you want to run the command. Defaults to the current working directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).\n * @environment SHOPIFY_FLAG_STORE\n */\n '-s, --store '?: string\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" + "value": "export interface themeshare {\n /**\n * Alias of the Shopify account to use for authentication.\n * @environment SHOPIFY_FLAG_AUTH_ALIAS\n */\n '--auth-alias '?: string\n\n /**\n * The environment to apply to the current command.\n * @environment SHOPIFY_FLAG_ENVIRONMENT\n */\n '-e, --environment '?: string\n\n /**\n * Print the command's JSON schemas.\n * @environment SHOPIFY_FLAG_JSON_SCHEMA\n */\n '--json-schema'?: ''\n\n /**\n * The listing preset to use for multi-preset themes. Applies preset files from listings/[preset-name] directory.\n * @environment SHOPIFY_FLAG_LISTING\n */\n '--listing '?: string\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * Password generated from the Theme Access app or an Admin API token.\n * @environment SHOPIFY_CLI_THEME_TOKEN\n */\n '--password '?: string\n\n /**\n * The path where you want to run the command. Defaults to the current working directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).\n * @environment SHOPIFY_FLAG_STORE\n */\n '-s, --store '?: string\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" } }, "upgrade": { @@ -7438,8 +8337,18 @@ "name": "upgrade", "description": "The following flags are available for the `upgrade` command:", "isPublicDocs": true, - "members": [], - "value": "export interface upgrade {\n\n}" + "members": [ + { + "filePath": "docs-shopify.dev/commands/interfaces/upgrade.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--json-schema", + "value": "''", + "description": "Print the command's JSON schemas.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON_SCHEMA" + } + ], + "value": "export interface upgrade {\n /**\n * Print the command's JSON schemas.\n * @environment SHOPIFY_FLAG_JSON_SCHEMA\n */\n '--json-schema'?: ''\n}" } }, "version": { @@ -7448,8 +8357,18 @@ "name": "version", "description": "The following flags are available for the `version` command:", "isPublicDocs": true, - "members": [], - "value": "export interface version {\n\n}" + "members": [ + { + "filePath": "docs-shopify.dev/commands/interfaces/version.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--json-schema", + "value": "''", + "description": "Print the command's JSON schemas.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON_SCHEMA" + } + ], + "value": "export interface version {\n /**\n * Print the command's JSON schemas.\n * @environment SHOPIFY_FLAG_JSON_SCHEMA\n */\n '--json-schema'?: ''\n}" } } } \ No newline at end of file diff --git a/packages/app/src/cli/commands/organization/list.ts b/packages/app/src/cli/commands/organization/list.ts index 9f56f5605dd..1e5f71003bf 100644 --- a/packages/app/src/cli/commands/organization/list.ts +++ b/packages/app/src/cli/commands/organization/list.ts @@ -3,7 +3,7 @@ import {authAliasFlag, globalFlags, jsonFlag} from '@shopify/cli-kit/node/cli' import BaseCommand from '@shopify/cli-kit/node/base-command' export default class OrganizationList extends BaseCommand { - static baseFlags = authAliasFlag + static baseFlags = {...BaseCommand.baseFlags, ...authAliasFlag} static summary = 'List Shopify organizations you have access to.' diff --git a/packages/app/src/cli/utilities/app-command.ts b/packages/app/src/cli/utilities/app-command.ts index 39f050c74e6..b4a06478b61 100644 --- a/packages/app/src/cli/utilities/app-command.ts +++ b/packages/app/src/cli/utilities/app-command.ts @@ -8,7 +8,7 @@ interface AppCommandOutput { } export default abstract class AppCommand extends BaseCommand { - static baseFlags = authAliasFlag + static baseFlags = {...BaseCommand.baseFlags, ...authAliasFlag} environmentsFilename(): string { return configurationFileNames.appEnvironments diff --git a/packages/cli-kit/src/public/node/base-command.test.ts b/packages/cli-kit/src/public/node/base-command.test.ts index 1d2a232c7be..aba67345549 100644 --- a/packages/cli-kit/src/public/node/base-command.test.ts +++ b/packages/cli-kit/src/public/node/base-command.test.ts @@ -9,7 +9,7 @@ import {unstyled} from './output.js' import {defineJsonOutputSchema} from './json-output-schema.js' import {zod} from './schema.js' import {afterEach, beforeEach, describe, expect, test, vi} from 'vitest' -import {Flags} from '@oclif/core' +import {Flags, type Config} from '@oclif/core' let originalStdinIsTTY: boolean | undefined let originalStdoutIsTTY: boolean | undefined @@ -228,7 +228,9 @@ describe('command descriptions', () => { expect(CommandWithJsonOutput.description).toBe(`Returns a value. "Learn more" (https://shopify.dev). -With \`--json\`, the command returns \`CommandResult\`: +Output from \`--json\` conforms to the \`CommandResult\` schema. + +Use \`--json-schema\` to print the schema directly: \`\`\`ts interface CommandResult { @@ -242,6 +244,110 @@ interface CommandResult { }) }) +describe('JSON output schema flag', () => { + class CommandWithJsonOutput extends Command { + static get jsonOutputSchema() { + return defineJsonOutputSchema({ + name: 'CommandResult', + schema: zod.object({value: zod.string()}), + }) + } + + public async run(): Promise {} + } + + test('prints only the schema and exits', () => { + const outputMock = mockAndCaptureOutput() + const command = new CommandWithJsonOutput(['--json-schema'], {} as Config) + const exit = vi.spyOn(process, 'exit').mockImplementation(() => { + throw new Error('process.exit') + }) + + try { + expect(() => + ( + command as unknown as { + exitWithJsonSchemaWhenRequested(): void + } + ).exitWithJsonSchemaWhenRequested(), + ).toThrow('process.exit') + expect(outputMock.output()).toBe(`interface CommandResult { + value: string +} + +interface JsonErrorDocument { + error: JsonError +} + +type JsonError = JsonAbortError | JsonBugError | JsonExternalError + +interface JsonErrorCustomSection { + title?: string + body: string | string[][] +} + +interface JsonAbortError { + type: "abort" + message: string + tryMessage?: string + nextSteps?: string[] + customSections?: JsonErrorCustomSection[] +} + +interface JsonBugError { + type: "bug" + message: string + tryMessage?: string + nextSteps?: string[] + customSections?: JsonErrorCustomSection[] + stack?: string +} + +interface JsonExternalError { + type: "external" + message: string + tryMessage?: string + nextSteps?: string[] + customSections?: JsonErrorCustomSection[] + command: string + args: string[] +} + +type CommandEvent = CommandDiagnosticEvent | CommandProgressEvent + +interface CommandDiagnosticEvent { + type: "diagnostic" + timestamp: string + level: "debug" | "info" | "warning" + message: string + code?: string +} + +interface CommandProgressEvent { + type: "progress" + timestamp: string + message: string + current?: number + total?: number +}`) + } finally { + exit.mockRestore() + } + }) + + test('throws an error when the command has no schema', () => { + const command = new MockCommand(['--json-schema'], {} as Config) + + expect(() => + ( + command as unknown as { + exitWithJsonSchemaWhenRequested(): void + } + ).exitWithJsonSchemaWhenRequested(), + ).toThrow('This command does not define a JSON output schema.') + }) +}) + describe('applying environments', async () => { const runTestInTmpDir = (testName: string, testFunc: (tmpDir: string) => Promise) => { test(testName, async () => { diff --git a/packages/cli-kit/src/public/node/base-command.ts b/packages/cli-kit/src/public/node/base-command.ts index 78d1811ed16..5ee059bff88 100644 --- a/packages/cli-kit/src/public/node/base-command.ts +++ b/packages/cli-kit/src/public/node/base-command.ts @@ -1,6 +1,8 @@ import {isDevelopment} from './context/local.js' import {addPublicMetadata} from './metadata.js' import {AbortError} from './error.js' +import {jsonErrorOutputSchema} from './error/schema.js' +import {commandEventOutputSchema} from './command-events.js' import {outputContent, outputResult, outputToken} from './output.js' import {setCurrentSessionAlias} from './session.js' import {terminalSupportsPrompting} from './system.js' @@ -9,7 +11,7 @@ import {isTruthy} from './context/utilities.js' import {setCurrentCommandId} from './global-context.js' import {JsonMap} from '../../private/common/json.js' import {underscore} from '../common/string.js' -import {Command, Config, Errors} from '@oclif/core' +import {Command, Config, Errors, Flags} from '@oclif/core' import {OutputFlags, Input, ParserOutput, FlagInput, OutputArgs} from '@oclif/core/parser' import type {JsonOutputSchema} from './json-output-schema.js' @@ -32,7 +34,13 @@ interface EnvironmentFlags { } abstract class BaseCommand extends Command { - static baseFlags: FlagInput<{}> = {} + static baseFlags: FlagInput<{}> = { + 'json-schema': Flags.boolean({ + description: "Print the command's JSON schemas.", + env: 'SHOPIFY_FLAG_JSON_SCHEMA', + }), + } + static descriptionWithMarkdown?: string public static get jsonOutputSchema(): JsonOutputSchema | undefined { @@ -71,6 +79,7 @@ abstract class BaseCommand extends Command { } protected async init(): Promise { + this.exitWithJsonSchemaWhenRequested() this.exitWithTimestampWhenEnvVariablePresent() setCurrentCommandId(this.id ?? '') if (!isDevelopment()) { @@ -119,6 +128,21 @@ abstract class BaseCommand extends Command { } } + protected exitWithJsonSchemaWhenRequested(): void { + if (!this.argv.includes('--json-schema') && !isTruthy(process.env.SHOPIFY_FLAG_JSON_SCHEMA)) return + + const command = this.constructor as typeof BaseCommand + const outputSchema = command.jsonOutputSchema + if (!outputSchema) { + throw new AbortError('This command does not define a JSON output schema.') + } + + outputResult( + [outputSchema.typescript, jsonErrorOutputSchema.typescript, commandEventOutputSchema.typescript].join('\n\n'), + ) + process.exit(0) + } + protected async parse< TFlags extends FlagOutput & {path?: string; verbose?: boolean; 'auth-alias'?: string}, TGlobalFlags extends FlagOutput, @@ -403,7 +427,9 @@ function commandSupportsFlag(flags: FlagInput | undefined, flagName: string): bo function appendJsonOutputSchema(description: string, outputSchema: JsonOutputSchema | undefined): string { if (!outputSchema) return description - const jsonOutputDescription = `With \`--json\`, the command returns \`${outputSchema.name}\`: + const jsonOutputDescription = `Output from \`--json\` conforms to the \`${outputSchema.name}\` schema. + +Use \`--json-schema\` to print the schema directly: \`\`\`ts ${outputSchema.typescript} diff --git a/packages/cli-kit/src/public/node/command-events.test.ts b/packages/cli-kit/src/public/node/command-events.test.ts index 2f656a645cf..f53af12d05e 100644 --- a/packages/cli-kit/src/public/node/command-events.test.ts +++ b/packages/cli-kit/src/public/node/command-events.test.ts @@ -1,4 +1,4 @@ -import {renderCommandEvent, renderCommandEventAsJson} from './command-events.js' +import {commandEventOutputSchema, renderCommandEvent, renderCommandEventAsJson} from './command-events.js' import {mockAndCaptureOutput} from './testing/output.js' import {beforeEach, describe, expect, test} from 'vitest' @@ -8,6 +8,28 @@ beforeEach(() => { outputMock.clear() }) +describe('commandEventOutputSchema', () => { + test('renders the event schemas as TypeScript', () => { + expect(commandEventOutputSchema.typescript).toBe(`type CommandEvent = CommandDiagnosticEvent | CommandProgressEvent + +interface CommandDiagnosticEvent { + type: "diagnostic" + timestamp: string + level: "debug" | "info" | "warning" + message: string + code?: string +} + +interface CommandProgressEvent { + type: "progress" + timestamp: string + message: string + current?: number + total?: number +}`) + }) +}) + describe('renderCommandEvent', () => { test('renders debug diagnostics to stderr through the debug output path', () => { renderCommandEvent({ diff --git a/packages/cli-kit/src/public/node/command-events.ts b/packages/cli-kit/src/public/node/command-events.ts index 3ecf7fd21ac..18b04b54480 100644 --- a/packages/cli-kit/src/public/node/command-events.ts +++ b/packages/cli-kit/src/public/node/command-events.ts @@ -1,5 +1,20 @@ import {outputDebug, outputInfo, outputWarn} from './output.js' -import type {CommandEvent} from '../common/command-events.js' +import {defineJsonOutputSchema} from './json-output-schema.js' +import { + commandDiagnosticEventSchema, + commandEventSchema, + commandProgressEventSchema, + type CommandEvent, +} from '../common/command-events.js' + +export const commandEventOutputSchema = defineJsonOutputSchema({ + name: 'CommandEvent', + schema: commandEventSchema, + definitions: { + CommandDiagnosticEvent: commandDiagnosticEventSchema, + CommandProgressEvent: commandProgressEventSchema, + }, +}) /** * Renders a command side event to stderr using the existing CLI output behavior. diff --git a/packages/cli-kit/src/public/node/json-output-schema.ts b/packages/cli-kit/src/public/node/json-output-schema.ts index 69797561f61..50b1a1329ca 100644 --- a/packages/cli-kit/src/public/node/json-output-schema.ts +++ b/packages/cli-kit/src/public/node/json-output-schema.ts @@ -2,6 +2,7 @@ import { ZodAny, ZodArray, ZodBoolean, + ZodDiscriminatedUnion, ZodEnum, ZodLiteral, ZodNull, @@ -139,7 +140,7 @@ function renderType( if (schema instanceof ZodEnum) return schema.options.map((value: string) => JSON.stringify(value)).join(' | ') if (schema instanceof ZodArray) return `${renderArrayElementType(schema.element, namedSchemas)}[]` if (schema instanceof ZodRecord) return `Record` - if (schema instanceof ZodUnion) { + if (schema instanceof ZodUnion || schema instanceof ZodDiscriminatedUnion) { return schema.options.map((option: ZodTypeAny) => renderType(option, namedSchemas)).join(' | ') } @@ -152,7 +153,9 @@ function renderType( function renderArrayElementType(schema: ZodTypeAny, namedSchemas: ReadonlyMap): string { const type = renderType(schema, namedSchemas) - return schema instanceof ZodUnion || schema instanceof ZodNullable ? `(${type})` : type + return schema instanceof ZodUnion || schema instanceof ZodDiscriminatedUnion || schema instanceof ZodNullable + ? `(${type})` + : type } function renderLiteral(value: unknown): string { diff --git a/packages/cli/README.md b/packages/cli/README.md index fdaf59c458b..1d2b03449ad 100644 --- a/packages/cli/README.md +++ b/packages/cli/README.md @@ -118,8 +118,8 @@ Build the app, including extensions. ``` USAGE - $ shopify app build [--auth-alias ] [--client-id | -c ] [--no-color] [--path ] - [--reset | ] [--skip-dependencies-installation] [--verbose] + $ shopify app build [--auth-alias ] [--client-id | -c ] [--json-schema] [--no-color] + [--path ] [--reset | ] [--skip-dependencies-installation] [--verbose] FLAGS -c, --config= @@ -134,6 +134,10 @@ FLAGS The Client ID of your app. [env: SHOPIFY_FLAG_CLIENT_ID] + --json-schema + Print the command's JSON schemas. + [env: SHOPIFY_FLAG_JSON_SCHEMA] + --no-color Disable color output. [env: SHOPIFY_FLAG_NO_COLOR] @@ -172,8 +176,8 @@ Cancel a bulk operation. ``` USAGE - $ shopify app bulk cancel --id [--auth-alias ] [--client-id | -c ] [--no-color] - [--path ] [--reset | ] [-s ] [--verbose] + $ shopify app bulk cancel --id [--auth-alias ] [--client-id | -c ] [--json-schema] + [--no-color] [--path ] [--reset | ] [-s ] [--verbose] FLAGS -c, --config= @@ -196,6 +200,10 @@ FLAGS (required) The bulk operation ID to cancel (numeric ID or full GID). [env: SHOPIFY_FLAG_ID] + --json-schema + Print the command's JSON schemas. + [env: SHOPIFY_FLAG_JSON_SCHEMA] + --no-color Disable color output. [env: SHOPIFY_FLAG_NO_COLOR] @@ -224,9 +232,9 @@ Execute bulk operations. ``` USAGE - $ shopify app bulk execute [--auth-alias ] [--client-id | -c ] [--no-color] [--output-file - --watch] [--path ] [-q ] [--query-file ] [--reset | ] [-s ] [--variable-file - | -v ...] [--verbose] [--version ] + $ shopify app bulk execute [--auth-alias ] [--client-id | -c ] [--json-schema] [--no-color] + [--output-file --watch] [--path ] [-q ] [--query-file ] [--reset | ] [-s ] + [--variable-file | -v ...] [--verbose] [--version ] FLAGS -c, --config= @@ -253,6 +261,10 @@ FLAGS The Client ID of your app. [env: SHOPIFY_FLAG_CLIENT_ID] + --json-schema + Print the command's JSON schemas. + [env: SHOPIFY_FLAG_JSON_SCHEMA] + --no-color Disable color output. [env: SHOPIFY_FLAG_NO_COLOR] @@ -311,8 +323,8 @@ Check the status of bulk operations. ``` USAGE - $ shopify app bulk status [--auth-alias ] [--client-id | -c ] [--id ] [--no-color] - [--path ] [--reset | ] [-s ] [--verbose] + $ shopify app bulk status [--auth-alias ] [--client-id | -c ] [--id ] [--json-schema] + [--no-color] [--path ] [--reset | ] [-s ] [--verbose] FLAGS -c, --config= @@ -336,6 +348,10 @@ FLAGS this store in the last 7 days. [env: SHOPIFY_FLAG_ID] + --json-schema + Print the command's JSON schemas. + [env: SHOPIFY_FLAG_JSON_SCHEMA] + --no-color Disable color output. [env: SHOPIFY_FLAG_NO_COLOR] @@ -372,7 +388,7 @@ Fetch your app configuration from the Developer Dashboard. ``` USAGE $ shopify app config link [--auth-alias ] [--client-id | -c ] [--force [--file-name | - ]] [--no-color] [--path ] [--reset | ] [--verbose] + ]] [--json-schema] [--no-color] [--path ] [--reset | ] [--verbose] FLAGS -c, --config= @@ -395,6 +411,10 @@ FLAGS Overwrite an existing configuration file without prompting. [env: SHOPIFY_FLAG_FORCE] + --json-schema + Print the command's JSON schemas. + [env: SHOPIFY_FLAG_JSON_SCHEMA] + --no-color Disable color output. [env: SHOPIFY_FLAG_NO_COLOR] @@ -427,8 +447,8 @@ Refresh an already-linked app configuration without prompts. ``` USAGE - $ shopify app config pull [--auth-alias ] [--client-id | -c ] [--no-color] [--path ] - [--reset | ] [--verbose] + $ shopify app config pull [--auth-alias ] [--client-id | -c ] [--json-schema] [--no-color] + [--path ] [--reset | ] [--verbose] FLAGS -c, --config= @@ -443,6 +463,10 @@ FLAGS The Client ID of your app. [env: SHOPIFY_FLAG_CLIENT_ID] + --json-schema + Print the command's JSON schemas. + [env: SHOPIFY_FLAG_JSON_SCHEMA] + --no-color Disable color output. [env: SHOPIFY_FLAG_NO_COLOR] @@ -488,6 +512,10 @@ FLAGS The Client ID of your app. [env: SHOPIFY_FLAG_CLIENT_ID] + --json-schema + Print the command's JSON schemas. + [env: SHOPIFY_FLAG_JSON_SCHEMA] + --no-color Disable color output. [env: SHOPIFY_FLAG_NO_COLOR] @@ -517,8 +545,8 @@ Validate your app configuration and extensions. ``` USAGE - $ shopify app config validate [--auth-alias ] [--client-id | -c ] [-j] [--no-color] [--path - ] [--reset | ] [--verbose] + $ shopify app config validate [--auth-alias ] [--client-id | -c ] [-j] [--json-schema] + [--no-color] [--path ] [--reset | ] [--verbose] FLAGS -c, --config= @@ -537,6 +565,10 @@ FLAGS The Client ID of your app. [env: SHOPIFY_FLAG_CLIENT_ID] + --json-schema + Print the command's JSON schemas. + [env: SHOPIFY_FLAG_JSON_SCHEMA] + --no-color Disable color output. [env: SHOPIFY_FLAG_NO_COLOR] @@ -566,8 +598,8 @@ Deploy your Shopify app. ``` USAGE - $ shopify app deploy [--auth-alias ] [--client-id | -c ] [--message ] - [--no-build] [--no-color] [--no-release | --allow-updates | --allow-deletes] [--path ] [--reset | ] + $ shopify app deploy [--auth-alias ] [--client-id | -c ] [--json-schema] [--message + ] [--no-build] [--no-color] [--no-release | --allow-updates | --allow-deletes] [--path ] [--reset | ] [--source-control-url ] [--verbose] [--version ] FLAGS @@ -594,6 +626,10 @@ FLAGS The Client ID of your app. [env: SHOPIFY_FLAG_CLIENT_ID] + --json-schema + Print the command's JSON schemas. + [env: SHOPIFY_FLAG_JSON_SCHEMA] + --message= Optional message that will be associated with this version. This is for internal use only and won't be available externally. @@ -654,8 +690,8 @@ Run the app. ``` USAGE $ shopify app dev [--auth-alias ] [--checkout-cart-url ] [--client-id | -c ] - [--install-mkcert --use-localhost] [--localhost-port ] [--no-color] [--no-update] [--notify ] [--path - ] [--reset | ] [--skip-dependencies-installation] [-s ] [--store-password ] + [--install-mkcert --use-localhost] [--json-schema] [--localhost-port ] [--no-color] [--no-update] [--notify + ] [--path ] [--reset | ] [--skip-dependencies-installation] [-s ] [--store-password ] [--subscription-product-url ] [-t ] [--theme-app-extension-port ] [--tunnel-url | ] [--verbose] @@ -688,6 +724,10 @@ FLAGS Install and use mkcert to generate localhost certificates when --use-localhost is enabled without prompting. [env: SHOPIFY_FLAG_INSTALL_MKCERT] + --json-schema + Print the command's JSON schemas. + [env: SHOPIFY_FLAG_JSON_SCHEMA] + --localhost-port= Port to use for localhost. Must be between 1 and 65535. [env: SHOPIFY_FLAG_LOCALHOST_PORT] @@ -755,8 +795,8 @@ Cleans up the dev preview from the selected store. ``` USAGE - $ shopify app dev clean [--auth-alias ] [--client-id | -c ] [--no-color] [--path ] - [--reset | ] [-s ] [--verbose] + $ shopify app dev clean [--auth-alias ] [--client-id | -c ] [--json-schema] [--no-color] + [--path ] [--reset | ] [-s ] [--verbose] FLAGS -c, --config= @@ -775,6 +815,10 @@ FLAGS The Client ID of your app. [env: SHOPIFY_FLAG_CLIENT_ID] + --json-schema + Print the command's JSON schemas. + [env: SHOPIFY_FLAG_JSON_SCHEMA] + --no-color Disable color output. [env: SHOPIFY_FLAG_NO_COLOR] @@ -806,7 +850,7 @@ Pull app and extensions environment variables. ``` USAGE $ shopify app env pull [--auth-alias ] [--client-id | -c ] [--env-file ] - [--no-color] [--path ] [--reset | ] [--verbose] + [--json-schema] [--no-color] [--path ] [--reset | ] [--verbose] FLAGS -c, --config= @@ -825,6 +869,10 @@ FLAGS Specify an environment file to update if the update flag is set [env: SHOPIFY_FLAG_ENV_FILE] + --json-schema + Print the command's JSON schemas. + [env: SHOPIFY_FLAG_JSON_SCHEMA] + --no-color Disable color output. [env: SHOPIFY_FLAG_NO_COLOR] @@ -856,8 +904,8 @@ Display app and extensions environment variables. ``` USAGE - $ shopify app env show [--auth-alias ] [--client-id | -c ] [--no-color] [--path ] - [--reset | ] [--verbose] + $ shopify app env show [--auth-alias ] [--client-id | -c ] [--json-schema] [--no-color] + [--path ] [--reset | ] [--verbose] FLAGS -c, --config= @@ -872,6 +920,10 @@ FLAGS The Client ID of your app. [env: SHOPIFY_FLAG_CLIENT_ID] + --json-schema + Print the command's JSON schemas. + [env: SHOPIFY_FLAG_JSON_SCHEMA] + --no-color Disable color output. [env: SHOPIFY_FLAG_NO_COLOR] @@ -900,9 +952,9 @@ Execute GraphQL queries and mutations. ``` USAGE - $ shopify app execute [--auth-alias ] [--client-id | -c ] [--no-color] [--output-file - ] [--path ] [-q ] [--query-file ] [--reset | ] [-s ] [--variable-file | - -v ] [--verbose] [--version ] + $ shopify app execute [--auth-alias ] [--client-id | -c ] [--json-schema] [--no-color] + [--output-file ] [--path ] [-q ] [--query-file ] [--reset | ] [-s ] + [--variable-file | -v ] [--verbose] [--version ] FLAGS -c, --config= @@ -930,6 +982,10 @@ FLAGS The Client ID of your app. [env: SHOPIFY_FLAG_CLIENT_ID] + --json-schema + Print the command's JSON schemas. + [env: SHOPIFY_FLAG_JSON_SCHEMA] + --no-color Disable color output. [env: SHOPIFY_FLAG_NO_COLOR] @@ -977,8 +1033,8 @@ Compile a function to wasm. ``` USAGE - $ shopify app function build [--auth-alias ] [--client-id | -c ] [--no-color] [--path ] - [--reset | ] [--verbose] + $ shopify app function build [--auth-alias ] [--client-id | -c ] [--json-schema] [--no-color] + [--path ] [--reset | ] [--verbose] FLAGS -c, --config= @@ -993,6 +1049,10 @@ FLAGS The Client ID of your app. [env: SHOPIFY_FLAG_CLIENT_ID] + --json-schema + Print the command's JSON schemas. + [env: SHOPIFY_FLAG_JSON_SCHEMA] + --no-color Disable color output. [env: SHOPIFY_FLAG_NO_COLOR] @@ -1021,8 +1081,8 @@ Print basic information about your function. ``` USAGE - $ shopify app function info [--auth-alias ] [--client-id | -c ] [-j] [--no-color] [--path - ] [--reset | ] [--verbose] + $ shopify app function info [--auth-alias ] [--client-id | -c ] [-j] [--json-schema] + [--no-color] [--path ] [--reset | ] [--verbose] FLAGS -c, --config= @@ -1041,6 +1101,10 @@ FLAGS The Client ID of your app. [env: SHOPIFY_FLAG_CLIENT_ID] + --json-schema + Print the command's JSON schemas. + [env: SHOPIFY_FLAG_JSON_SCHEMA] + --no-color Disable color output. [env: SHOPIFY_FLAG_NO_COLOR] @@ -1077,8 +1141,8 @@ Replays a function run from an app log. ``` USAGE - $ shopify app function replay [--auth-alias ] [--client-id | -c ] [-j] [-l ] [--no-color] - [--path ] [--reset | ] [--verbose] [-w] + $ shopify app function replay [--auth-alias ] [--client-id | -c ] [-j] [--json-schema] [-l + ] [--no-color] [--path ] [--reset | ] [--verbose] [-w] FLAGS -c, --config= @@ -1106,6 +1170,10 @@ FLAGS The Client ID of your app. [env: SHOPIFY_FLAG_CLIENT_ID] + --json-schema + Print the command's JSON schemas. + [env: SHOPIFY_FLAG_JSON_SCHEMA] + --no-color Disable color output. [env: SHOPIFY_FLAG_NO_COLOR] @@ -1137,7 +1205,7 @@ Run a function locally for testing. ``` USAGE $ shopify app function run [--auth-alias ] [--client-id | -c ] [-e ] [-i ] [-j] - [--no-color] [--path ] [--profile] [--reset | ] [--verbose] + [--json-schema] [--no-color] [--path ] [--profile] [--reset | ] [--verbose] FLAGS -c, --config= @@ -1164,6 +1232,10 @@ FLAGS The Client ID of your app. [env: SHOPIFY_FLAG_CLIENT_ID] + --json-schema + Print the command's JSON schemas. + [env: SHOPIFY_FLAG_JSON_SCHEMA] + --no-color Disable color output. [env: SHOPIFY_FLAG_NO_COLOR] @@ -1198,8 +1270,8 @@ Fetch the latest GraphQL schema for a function. ``` USAGE - $ shopify app function schema [--auth-alias ] [--client-id | -c ] [--no-color] [--path ] - [--reset | ] [--stdout] [--verbose] + $ shopify app function schema [--auth-alias ] [--client-id | -c ] [--json-schema] [--no-color] + [--path ] [--reset | ] [--stdout] [--verbose] FLAGS -c, --config= @@ -1214,6 +1286,10 @@ FLAGS The Client ID of your app. [env: SHOPIFY_FLAG_CLIENT_ID] + --json-schema + Print the command's JSON schemas. + [env: SHOPIFY_FLAG_JSON_SCHEMA] + --no-color Disable color output. [env: SHOPIFY_FLAG_NO_COLOR] @@ -1250,8 +1326,8 @@ Generate GraphQL types for a function. ``` USAGE - $ shopify app function typegen [--auth-alias ] [--client-id | -c ] [--no-color] [--path ] - [--reset | ] [--verbose] + $ shopify app function typegen [--auth-alias ] [--client-id | -c ] [--json-schema] [--no-color] + [--path ] [--reset | ] [--verbose] FLAGS -c, --config= @@ -1266,6 +1342,10 @@ FLAGS The Client ID of your app. [env: SHOPIFY_FLAG_CLIENT_ID] + --json-schema + Print the command's JSON schemas. + [env: SHOPIFY_FLAG_JSON_SCHEMA] + --no-color Disable color output. [env: SHOPIFY_FLAG_NO_COLOR] @@ -1296,8 +1376,8 @@ Generate a new app Extension. ``` USAGE $ shopify app generate extension [--auth-alias ] [--client-id | -c ] [--flavor - vanilla-js|react|typescript|typescript-react|wasm|rust] [-n ] [--no-color] [--path ] [--reset | ] [-t - ] [--verbose] + vanilla-js|react|typescript|typescript-react|wasm|rust] [--json-schema] [-n ] [--no-color] [--path ] + [--reset | ] [-t ] [--verbose] FLAGS -c, --config= @@ -1326,6 +1406,10 @@ FLAGS [env: SHOPIFY_FLAG_FLAVOR] + --json-schema + Print the command's JSON schemas. + [env: SHOPIFY_FLAG_JSON_SCHEMA] + --no-color Disable color output. [env: SHOPIFY_FLAG_NO_COLOR] @@ -1360,8 +1444,8 @@ Open a local GraphiQL UI for your app and store. ``` USAGE - $ shopify app graphiql [--auth-alias ] [--client-id | -c ] [--no-color] [--path ] - [--port ] [--reset | ] [-s ] [-v ] [--verbose] [--version ] + $ shopify app graphiql [--auth-alias ] [--client-id | -c ] [--json-schema] [--no-color] + [--path ] [--port ] [--reset | ] [-s ] [-v ] [--verbose] [--version ] FLAGS -c, --config= @@ -1385,6 +1469,10 @@ FLAGS The Client ID of your app. [env: SHOPIFY_FLAG_CLIENT_ID] + --json-schema + Print the command's JSON schemas. + [env: SHOPIFY_FLAG_JSON_SCHEMA] + --no-color Disable color output. [env: SHOPIFY_FLAG_NO_COLOR] @@ -1429,7 +1517,7 @@ Import metafield and metaobject definitions. ``` USAGE $ shopify app import-custom-data-definitions [--auth-alias ] [--client-id | -c ] [--include-existing] - [--no-color] [--path ] [--reset | ] [-s ] [--verbose] + [--json-schema] [--no-color] [--path ] [--reset | ] [-s ] [--verbose] FLAGS -c, --config= @@ -1452,6 +1540,10 @@ FLAGS Include existing declared definitions in the output. [env: SHOPIFY_FLAG_INCLUDE_EXISTING] + --json-schema + Print the command's JSON schemas. + [env: SHOPIFY_FLAG_JSON_SCHEMA] + --no-color Disable color output. [env: SHOPIFY_FLAG_NO_COLOR] @@ -1481,8 +1573,8 @@ Import dashboard-managed extensions into your app. ``` USAGE - $ shopify app import-extensions [--auth-alias ] [--client-id | -c ] [--no-color] [--path ] - [--reset | ] [--verbose] + $ shopify app import-extensions [--auth-alias ] [--client-id | -c ] [--json-schema] [--no-color] + [--path ] [--reset | ] [--verbose] FLAGS -c, --config= @@ -1497,6 +1589,10 @@ FLAGS The Client ID of your app. [env: SHOPIFY_FLAG_CLIENT_ID] + --json-schema + Print the command's JSON schemas. + [env: SHOPIFY_FLAG_JSON_SCHEMA] + --no-color Disable color output. [env: SHOPIFY_FLAG_NO_COLOR] @@ -1523,8 +1619,8 @@ Print basic information about your app and extensions. ``` USAGE - $ shopify app info [--auth-alias ] [--client-id | -c ] [-j] [--no-color] [--path - ] [--reset | ] [--verbose] [--web-env] + $ shopify app info [--auth-alias ] [--client-id | -c ] [-j] [--json-schema] + [--no-color] [--path ] [--reset | ] [--verbose] [--web-env] FLAGS -c, --config= @@ -1543,6 +1639,10 @@ FLAGS The Client ID of your app. [env: SHOPIFY_FLAG_CLIENT_ID] + --json-schema + Print the command's JSON schemas. + [env: SHOPIFY_FLAG_JSON_SCHEMA] + --no-color Disable color output. [env: SHOPIFY_FLAG_NO_COLOR] @@ -1582,8 +1682,9 @@ Create a new app project ``` USAGE - $ shopify app init [--auth-alias ] [--flavor ] [-n ] [--no-color] [--organization-id - | [--client-id | ]] [-d npm|yarn|pnpm|bun] [-p ] [--template ] [--verbose] + $ shopify app init [--auth-alias ] [--flavor ] [--json-schema] [-n ] [--no-color] + [--organization-id | [--client-id | ]] [-d npm|yarn|pnpm|bun] [-p ] [--template ] + [--verbose] FLAGS -d, --package-manager=