From 604a2ceaa094e6d7ef24da92eca6764ad9bcb23d Mon Sep 17 00:00:00 2001 From: freddie Date: Fri, 23 Oct 2026 12:44:05 +0100 Subject: [PATCH] Bump cli-hydrogen to 13.1.0 --- .changeset/update-hydrogen-cli-13.1.0.md | 5 + .../generated/generated_docs_data_v2.json | 945 +++++- packages/cli/README.md | 2747 +++++++++++++++-- packages/cli/oclif.manifest.json | 847 ++++- packages/cli/package.json | 2 +- pnpm-lock.yaml | 162 +- 6 files changed, 4178 insertions(+), 530 deletions(-) create mode 100644 .changeset/update-hydrogen-cli-13.1.0.md diff --git a/.changeset/update-hydrogen-cli-13.1.0.md b/.changeset/update-hydrogen-cli-13.1.0.md new file mode 100644 index 00000000000..9c2ff89f620 --- /dev/null +++ b/.changeset/update-hydrogen-cli-13.1.0.md @@ -0,0 +1,5 @@ +--- +'@shopify/cli': minor +--- + +Update cli-hydrogen 13.1.0, adding typed JSON output to Hydrogen commands diff --git a/docs-shopify.dev/generated/generated_docs_data_v2.json b/docs-shopify.dev/generated/generated_docs_data_v2.json index 186e3a2f023..968c240a37f 100644 --- a/docs-shopify.dev/generated/generated_docs_data_v2.json +++ b/docs-shopify.dev/generated/generated_docs_data_v2.json @@ -5533,6 +5533,24 @@ "isOptional": true, "environmentValue": "SHOPIFY_HYDROGEN_FLAG_LOCKFILE_CHECK" }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-build.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--no-color", + "value": "''", + "description": "Disable color output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_NO_COLOR" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-build.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--no-input", + "value": "''", + "description": "Disable interactive prompts and browser authentication.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_NO_INPUT" + }, { "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-build.interface.ts", "syntaxKind": "PropertySignature", @@ -5551,6 +5569,15 @@ "isOptional": true, "environmentValue": "SHOPIFY_HYDROGEN_FLAG_SOURCEMAP" }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-build.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--verbose", + "value": "''", + "description": "Increase the verbosity of the output. May include sensitive data.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_VERBOSE" + }, { "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-build.interface.ts", "syntaxKind": "PropertySignature", @@ -5559,9 +5586,18 @@ "description": "Watches for changes and rebuilds the project writing output to disk.", "isOptional": true, "environmentValue": "SHOPIFY_HYDROGEN_FLAG_WATCH" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-build.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-j, --json", + "value": "''", + "description": "Output the result as JSON. Automatically disables color output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON" } ], - "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}" + "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 * 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 * 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 * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * Disable interactive prompts and browser authentication.\n * @environment SHOPIFY_FLAG_NO_INPUT\n */\n '--no-input'?: ''\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 * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\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": { @@ -5580,6 +5616,24 @@ "isOptional": true, "environmentValue": "SHOPIFY_FLAG_JSON_SCHEMA" }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-check.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--no-color", + "value": "''", + "description": "Disable color output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_NO_COLOR" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-check.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--no-input", + "value": "''", + "description": "Disable interactive prompts and browser authentication.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_NO_INPUT" + }, { "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-check.interface.ts", "syntaxKind": "PropertySignature", @@ -5588,9 +5642,27 @@ "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.", "isOptional": true, "environmentValue": "SHOPIFY_HYDROGEN_FLAG_PATH" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-check.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--verbose", + "value": "''", + "description": "Increase the verbosity of the output. May include sensitive data.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_VERBOSE" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-check.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-j, --json", + "value": "''", + "description": "Output the result as JSON. Automatically disables color output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON" } ], - "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}" + "value": "export interface hydrogencheck {\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 * Disable interactive prompts and browser authentication.\n * @environment SHOPIFY_FLAG_NO_INPUT\n */\n '--no-input'?: ''\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 * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" } }, "hydrogencodegen": { @@ -5617,6 +5689,24 @@ "isOptional": true, "environmentValue": "SHOPIFY_FLAG_JSON_SCHEMA" }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-codegen.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--no-color", + "value": "''", + "description": "Disable color output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_NO_COLOR" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-codegen.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--no-input", + "value": "''", + "description": "Disable interactive prompts and browser authentication.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_NO_INPUT" + }, { "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-codegen.interface.ts", "syntaxKind": "PropertySignature", @@ -5626,6 +5716,15 @@ "isOptional": true, "environmentValue": "SHOPIFY_HYDROGEN_FLAG_PATH" }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-codegen.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--verbose", + "value": "''", + "description": "Increase the verbosity of the output. May include sensitive data.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_VERBOSE" + }, { "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-codegen.interface.ts", "syntaxKind": "PropertySignature", @@ -5633,9 +5732,18 @@ "value": "''", "description": "Watch the project for changes to update types on file save.", "isOptional": true + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-codegen.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-j, --json", + "value": "''", + "description": "Output the result as JSON. Automatically disables color output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON" } ], - "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}" + "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 * 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 * Disable interactive prompts and browser authentication.\n * @environment SHOPIFY_FLAG_NO_INPUT\n */\n '--no-input'?: ''\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 * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n\n /**\n * Watch the project for changes to update types on file save.\n *\n */\n '--watch'?: ''\n}" } }, "hydrogencustomeraccountpush": { @@ -5669,6 +5777,24 @@ "isOptional": true, "environmentValue": "SHOPIFY_FLAG_JSON_SCHEMA" }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-customer-account-push.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--no-color", + "value": "''", + "description": "Disable color output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_NO_COLOR" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-customer-account-push.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--no-input", + "value": "''", + "description": "Disable interactive prompts and browser authentication.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_NO_INPUT" + }, { "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-customer-account-push.interface.ts", "syntaxKind": "PropertySignature", @@ -5701,9 +5827,27 @@ "value": "string", "description": "The id of the storefront the configuration should be pushed to. Must start with 'gid://shopify/HydrogenStorefront/'", "isOptional": true + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-customer-account-push.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--verbose", + "value": "''", + "description": "Increase the verbosity of the output. May include sensitive data.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_VERBOSE" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-customer-account-push.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-j, --json", + "value": "''", + "description": "Output the result as JSON. Automatically disables color output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON" } ], - "value": "export interface hydrogencustomeraccountpush {\n /**\n * The development domain of your application.\n *\n */\n '--dev-origin ': string\n\n /**\n * The origin to register as the allowed JavaScript origin for the Customer Account API OAuth flow. Defaults to --dev-origin. Must not include a port (Shopify rejects origins with ports); use this to register a portless origin while keeping a portful --dev-origin.\n *\n */\n '--javascript-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}" + "value": "export interface hydrogencustomeraccountpush {\n /**\n * The development domain of your application.\n *\n */\n '--dev-origin ': string\n\n /**\n * The origin to register as the allowed JavaScript origin for the Customer Account API OAuth flow. Defaults to --dev-origin. Must not include a port (Shopify rejects origins with ports); use this to register a portless origin while keeping a portful --dev-origin.\n *\n */\n '--javascript-origin '?: 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 * Disable interactive prompts and browser authentication.\n * @environment SHOPIFY_FLAG_NO_INPUT\n */\n '--no-input'?: ''\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\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" } }, "hydrogendebugcpu": { @@ -5731,6 +5875,24 @@ "isOptional": true, "environmentValue": "SHOPIFY_FLAG_JSON_SCHEMA" }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-debug-cpu.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--no-color", + "value": "''", + "description": "Disable color output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_NO_COLOR" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-debug-cpu.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--no-input", + "value": "''", + "description": "Disable interactive prompts and browser authentication.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_NO_INPUT" + }, { "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-debug-cpu.interface.ts", "syntaxKind": "PropertySignature", @@ -5747,9 +5909,18 @@ "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.", "isOptional": true, "environmentValue": "SHOPIFY_HYDROGEN_FLAG_PATH" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-debug-cpu.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--verbose", + "value": "''", + "description": "Increase the verbosity of the output. May include sensitive data.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_VERBOSE" } ], - "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}" + "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 * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * Disable interactive prompts and browser authentication.\n * @environment SHOPIFY_FLAG_NO_INPUT\n */\n '--no-input'?: ''\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\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" } }, "hydrogendeploy": { @@ -5881,6 +6052,24 @@ "isOptional": true, "environmentValue": "SHOPIFY_HYDROGEN_FLAG_METADATA_USER" }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-deploy.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--no-color", + "value": "''", + "description": "Disable color output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_NO_COLOR" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-deploy.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--no-input", + "value": "''", + "description": "Disable interactive prompts and browser authentication.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_NO_INPUT" + }, { "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-deploy.interface.ts", "syntaxKind": "PropertySignature", @@ -5906,6 +6095,15 @@ "description": "Deploys to the Preview environment.", "isOptional": true }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-deploy.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--verbose", + "value": "''", + "description": "Increase the verbosity of the output. May include sensitive data.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_VERBOSE" + }, { "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-deploy.interface.ts", "syntaxKind": "PropertySignature", @@ -5924,6 +6122,15 @@ "isOptional": true, "environmentValue": "SHOPIFY_HYDROGEN_FLAG_FORCE" }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-deploy.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-j, --json", + "value": "''", + "description": "Output the result as JSON. Automatically disables color output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON" + }, { "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-deploy.interface.ts", "syntaxKind": "PropertySignature", @@ -5943,7 +6150,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 * 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}" + "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 * Output the result as JSON. Automatically disables color output.\n * @environment SHOPIFY_FLAG_JSON\n */\n '-j, --json'?: ''\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 * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * Disable interactive prompts and browser authentication.\n * @environment SHOPIFY_FLAG_NO_INPUT\n */\n '--no-input'?: ''\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 * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\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": { @@ -6073,6 +6280,24 @@ "isOptional": true, "environmentValue": "SHOPIFY_FLAG_JSON_SCHEMA" }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-dev.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--no-color", + "value": "''", + "description": "Disable color output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_NO_COLOR" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-dev.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--no-input", + "value": "''", + "description": "Disable interactive prompts and browser authentication.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_NO_INPUT" + }, { "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-dev.interface.ts", "syntaxKind": "PropertySignature", @@ -6101,7 +6326,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 * 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}" + "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 * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * Disable interactive prompts and browser authentication.\n * @environment SHOPIFY_FLAG_NO_INPUT\n */\n '--no-input'?: ''\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": { @@ -6120,6 +6345,24 @@ "isOptional": true, "environmentValue": "SHOPIFY_FLAG_JSON_SCHEMA" }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-env-list.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--no-color", + "value": "''", + "description": "Disable color output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_NO_COLOR" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-env-list.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--no-input", + "value": "''", + "description": "Disable interactive prompts and browser authentication.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_NO_INPUT" + }, { "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-env-list.interface.ts", "syntaxKind": "PropertySignature", @@ -6128,20 +6371,38 @@ "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.", "isOptional": true, "environmentValue": "SHOPIFY_HYDROGEN_FLAG_PATH" - } - ], - "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": { - "docs-shopify.dev/commands/interfaces/hydrogen-env-pull.interface.ts": { - "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-env-pull.interface.ts", - "name": "hydrogenenvpull", - "description": "The following flags are available for the `hydrogen env pull` command:", - "isPublicDocs": true, - "members": [ + }, { - "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-env-pull.interface.ts", + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-env-list.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--verbose", + "value": "''", + "description": "Increase the verbosity of the output. May include sensitive data.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_VERBOSE" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-env-list.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-j, --json", + "value": "''", + "description": "Output the result as JSON. Automatically disables color output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON" + } + ], + "value": "export interface hydrogenenvlist {\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 * Disable interactive prompts and browser authentication.\n * @environment SHOPIFY_FLAG_NO_INPUT\n */\n '--no-input'?: ''\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 * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" + } + }, + "hydrogenenvpull": { + "docs-shopify.dev/commands/interfaces/hydrogen-env-pull.interface.ts": { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-env-pull.interface.ts", + "name": "hydrogenenvpull", + "description": "The following flags are available for the `hydrogen env pull` command:", + "isPublicDocs": true, + "members": [ + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-env-pull.interface.ts", "syntaxKind": "PropertySignature", "name": "--env ", "value": "string", @@ -6174,6 +6435,24 @@ "isOptional": true, "environmentValue": "SHOPIFY_FLAG_JSON_SCHEMA" }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-env-pull.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--no-color", + "value": "''", + "description": "Disable color output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_NO_COLOR" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-env-pull.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--no-input", + "value": "''", + "description": "Disable interactive prompts and browser authentication.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_NO_INPUT" + }, { "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-env-pull.interface.ts", "syntaxKind": "PropertySignature", @@ -6183,6 +6462,15 @@ "isOptional": true, "environmentValue": "SHOPIFY_HYDROGEN_FLAG_PATH" }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-env-pull.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--verbose", + "value": "''", + "description": "Increase the verbosity of the output. May include sensitive data.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_VERBOSE" + }, { "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-env-pull.interface.ts", "syntaxKind": "PropertySignature", @@ -6191,9 +6479,18 @@ "description": "Overwrites the destination directory and files if they already exist.", "isOptional": true, "environmentValue": "SHOPIFY_HYDROGEN_FLAG_FORCE" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-env-pull.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-j, --json", + "value": "''", + "description": "Output the result as JSON. Automatically disables color output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON" } ], - "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}" + "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 * 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 * Disable interactive prompts and browser authentication.\n * @environment SHOPIFY_FLAG_NO_INPUT\n */\n '--no-input'?: ''\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 * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" } }, "hydrogenenvpush": { @@ -6237,6 +6534,24 @@ "isOptional": true, "environmentValue": "SHOPIFY_FLAG_JSON_SCHEMA" }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-env-push.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--no-color", + "value": "''", + "description": "Disable color output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_NO_COLOR" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-env-push.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--no-input", + "value": "''", + "description": "Disable interactive prompts and browser authentication.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_NO_INPUT" + }, { "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-env-push.interface.ts", "syntaxKind": "PropertySignature", @@ -6246,6 +6561,15 @@ "isOptional": true, "environmentValue": "SHOPIFY_HYDROGEN_FLAG_PATH" }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-env-push.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--verbose", + "value": "''", + "description": "Increase the verbosity of the output. May include sensitive data.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_VERBOSE" + }, { "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-env-push.interface.ts", "syntaxKind": "PropertySignature", @@ -6254,9 +6578,18 @@ "description": "Push environment variable changes without confirmation.", "isOptional": true, "environmentValue": "SHOPIFY_HYDROGEN_FLAG_FORCE" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-env-push.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-j, --json", + "value": "''", + "description": "Output the result as JSON. Automatically disables color output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON" } ], - "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}" + "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 * 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 * Disable interactive prompts and browser authentication.\n * @environment SHOPIFY_FLAG_NO_INPUT\n */\n '--no-input'?: ''\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 * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" } }, "hydrogengenerateroute": { @@ -6293,6 +6626,24 @@ "isOptional": true, "environmentValue": "SHOPIFY_HYDROGEN_FLAG_ADAPTER" }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-generate-route.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--no-color", + "value": "''", + "description": "Disable color output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_NO_COLOR" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-generate-route.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--no-input", + "value": "''", + "description": "Disable interactive prompts and browser authentication.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_NO_INPUT" + }, { "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-generate-route.interface.ts", "syntaxKind": "PropertySignature", @@ -6311,6 +6662,15 @@ "isOptional": true, "environmentValue": "SHOPIFY_HYDROGEN_FLAG_TYPESCRIPT" }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-generate-route.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--verbose", + "value": "''", + "description": "Increase the verbosity of the output. May include sensitive data.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_VERBOSE" + }, { "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-generate-route.interface.ts", "syntaxKind": "PropertySignature", @@ -6319,9 +6679,18 @@ "description": "Overwrites the destination directory and files if they already exist.", "isOptional": true, "environmentValue": "SHOPIFY_HYDROGEN_FLAG_FORCE" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-generate-route.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-j, --json", + "value": "''", + "description": "Output the result as JSON. Automatically disables color output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON" } ], - "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}" + "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 * 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 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 * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * Disable interactive prompts and browser authentication.\n * @environment SHOPIFY_FLAG_NO_INPUT\n */\n '--no-input'?: ''\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\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" } }, "hydrogengenerateroutes": { @@ -6358,6 +6727,24 @@ "isOptional": true, "environmentValue": "SHOPIFY_HYDROGEN_FLAG_ADAPTER" }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-generate-routes.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--no-color", + "value": "''", + "description": "Disable color output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_NO_COLOR" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-generate-routes.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--no-input", + "value": "''", + "description": "Disable interactive prompts and browser authentication.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_NO_INPUT" + }, { "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-generate-routes.interface.ts", "syntaxKind": "PropertySignature", @@ -6376,6 +6763,15 @@ "isOptional": true, "environmentValue": "SHOPIFY_HYDROGEN_FLAG_TYPESCRIPT" }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-generate-routes.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--verbose", + "value": "''", + "description": "Increase the verbosity of the output. May include sensitive data.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_VERBOSE" + }, { "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-generate-routes.interface.ts", "syntaxKind": "PropertySignature", @@ -6384,9 +6780,18 @@ "description": "Overwrites the destination directory and files if they already exist.", "isOptional": true, "environmentValue": "SHOPIFY_HYDROGEN_FLAG_FORCE" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-generate-routes.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-j, --json", + "value": "''", + "description": "Output the result as JSON. Automatically disables color output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON" } ], - "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}" + "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 * 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 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 * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * Disable interactive prompts and browser authentication.\n * @environment SHOPIFY_FLAG_NO_INPUT\n */\n '--no-input'?: ''\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\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" } }, "hydrogeninit": { @@ -6450,6 +6855,24 @@ "isOptional": true, "environmentValue": "SHOPIFY_HYDROGEN_FLAG_MOCK_DATA" }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-init.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--no-color", + "value": "''", + "description": "Disable color output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_NO_COLOR" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-init.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--no-input", + "value": "''", + "description": "Disable interactive prompts and browser authentication.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_NO_INPUT" + }, { "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-init.interface.ts", "syntaxKind": "PropertySignature", @@ -6495,6 +6918,15 @@ "isOptional": true, "environmentValue": "SHOPIFY_HYDROGEN_FLAG_TEMPLATE" }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-init.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--verbose", + "value": "''", + "description": "Increase the verbosity of the output. May include sensitive data.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_VERBOSE" + }, { "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-init.interface.ts", "syntaxKind": "PropertySignature", @@ -6503,9 +6935,18 @@ "description": "Overwrites the destination directory and files if they already exist.", "isOptional": true, "environmentValue": "SHOPIFY_HYDROGEN_FLAG_FORCE" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-init.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-j, --json", + "value": "''", + "description": "Output the result as JSON. Automatically disables color output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON" } ], - "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 a template: `skeleton` (the default), `demo-store` or a URL to a git 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 * 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 * 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 * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * Disable interactive prompts and browser authentication.\n * @environment SHOPIFY_FLAG_NO_INPUT\n */\n '--no-input'?: ''\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 a template: `skeleton` (the default), `demo-store` or a URL to a git repository.\n * @environment SHOPIFY_HYDROGEN_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}" } }, "hydrogenlink": { @@ -6542,6 +6983,24 @@ "isOptional": true, "environmentValue": "SHOPIFY_HYDROGEN_FLAG_NAME" }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-link.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--no-color", + "value": "''", + "description": "Disable color output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_NO_COLOR" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-link.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--no-input", + "value": "''", + "description": "Disable interactive prompts and browser authentication.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_NO_INPUT" + }, { "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-link.interface.ts", "syntaxKind": "PropertySignature", @@ -6560,6 +7019,15 @@ "isOptional": true, "environmentValue": "SHOPIFY_HYDROGEN_STOREFRONT" }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-link.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--verbose", + "value": "''", + "description": "Increase the verbosity of the output. May include sensitive data.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_VERBOSE" + }, { "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-link.interface.ts", "syntaxKind": "PropertySignature", @@ -6569,6 +7037,15 @@ "isOptional": true, "environmentValue": "SHOPIFY_HYDROGEN_FLAG_FORCE" }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-link.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-j, --json", + "value": "''", + "description": "Output the result as JSON. Automatically disables color output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON" + }, { "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-link.interface.ts", "syntaxKind": "PropertySignature", @@ -6579,7 +7056,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 * 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}" + "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 * 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 to use when creating a new Hydrogen storefront.\n * @environment SHOPIFY_HYDROGEN_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 * Disable interactive prompts and browser authentication.\n * @environment SHOPIFY_FLAG_NO_INPUT\n */\n '--no-input'?: ''\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\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" } }, "hydrogenlist": { @@ -6601,16 +7078,52 @@ { "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-list.interface.ts", "syntaxKind": "PropertySignature", - "name": "--path ", - "value": "string", - "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.", + "name": "--no-color", + "value": "''", + "description": "Disable color output.", "isOptional": true, - "environmentValue": "SHOPIFY_HYDROGEN_FLAG_PATH" - } - ], - "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}" - } - }, + "environmentValue": "SHOPIFY_FLAG_NO_COLOR" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-list.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--no-input", + "value": "''", + "description": "Disable interactive prompts and browser authentication.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_NO_INPUT" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-list.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--path ", + "value": "string", + "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.", + "isOptional": true, + "environmentValue": "SHOPIFY_HYDROGEN_FLAG_PATH" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-list.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--verbose", + "value": "''", + "description": "Increase the verbosity of the output. May include sensitive data.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_VERBOSE" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-list.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-j, --json", + "value": "''", + "description": "Output the result as JSON. Automatically disables color output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON" + } + ], + "value": "export interface hydrogenlist {\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 * Disable interactive prompts and browser authentication.\n * @environment SHOPIFY_FLAG_NO_INPUT\n */\n '--no-input'?: ''\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 * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" + } + }, "hydrogenlogin": { "docs-shopify.dev/commands/interfaces/hydrogen-login.interface.ts": { "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-login.interface.ts", @@ -6627,6 +7140,24 @@ "isOptional": true, "environmentValue": "SHOPIFY_FLAG_JSON_SCHEMA" }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-login.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--no-color", + "value": "''", + "description": "Disable color output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_NO_COLOR" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-login.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--no-input", + "value": "''", + "description": "Disable interactive prompts and browser authentication.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_NO_INPUT" + }, { "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-login.interface.ts", "syntaxKind": "PropertySignature", @@ -6636,6 +7167,24 @@ "isOptional": true, "environmentValue": "SHOPIFY_HYDROGEN_FLAG_PATH" }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-login.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--verbose", + "value": "''", + "description": "Increase the verbosity of the output. May include sensitive data.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_VERBOSE" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-login.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-j, --json", + "value": "''", + "description": "Output the result as JSON. Automatically disables color output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON" + }, { "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-login.interface.ts", "syntaxKind": "PropertySignature", @@ -6646,7 +7195,7 @@ "environmentValue": "SHOPIFY_SHOP" } ], - "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}" + "value": "export interface hydrogenlogin {\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 * Disable interactive prompts and browser authentication.\n * @environment SHOPIFY_FLAG_NO_INPUT\n */\n '--no-input'?: ''\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 * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" } }, "hydrogenlogout": { @@ -6665,6 +7214,24 @@ "isOptional": true, "environmentValue": "SHOPIFY_FLAG_JSON_SCHEMA" }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-logout.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--no-color", + "value": "''", + "description": "Disable color output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_NO_COLOR" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-logout.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--no-input", + "value": "''", + "description": "Disable interactive prompts and browser authentication.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_NO_INPUT" + }, { "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-logout.interface.ts", "syntaxKind": "PropertySignature", @@ -6673,9 +7240,27 @@ "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.", "isOptional": true, "environmentValue": "SHOPIFY_HYDROGEN_FLAG_PATH" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-logout.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--verbose", + "value": "''", + "description": "Increase the verbosity of the output. May include sensitive data.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_VERBOSE" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-logout.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-j, --json", + "value": "''", + "description": "Output the result as JSON. Automatically disables color output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON" } ], - "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}" + "value": "export interface hydrogenlogout {\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 * Disable interactive prompts and browser authentication.\n * @environment SHOPIFY_FLAG_NO_INPUT\n */\n '--no-input'?: ''\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 * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" } }, "hydrogenpreview": { @@ -6770,6 +7355,24 @@ "isOptional": true, "environmentValue": "SHOPIFY_FLAG_JSON_SCHEMA" }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-preview.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--no-color", + "value": "''", + "description": "Disable color output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_NO_COLOR" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-preview.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--no-input", + "value": "''", + "description": "Disable interactive prompts and browser authentication.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_NO_INPUT" + }, { "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-preview.interface.ts", "syntaxKind": "PropertySignature", @@ -6806,7 +7409,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 * 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}" + "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 * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * Disable interactive prompts and browser authentication.\n * @environment SHOPIFY_FLAG_NO_INPUT\n */\n '--no-input'?: ''\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": { @@ -6834,6 +7437,24 @@ "isOptional": true, "environmentValue": "SHOPIFY_FLAG_JSON_SCHEMA" }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-setup-css.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--no-color", + "value": "''", + "description": "Disable color output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_NO_COLOR" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-setup-css.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--no-input", + "value": "''", + "description": "Disable interactive prompts and browser authentication.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_NO_INPUT" + }, { "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-setup-css.interface.ts", "syntaxKind": "PropertySignature", @@ -6843,6 +7464,15 @@ "isOptional": true, "environmentValue": "SHOPIFY_HYDROGEN_FLAG_PATH" }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-setup-css.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--verbose", + "value": "''", + "description": "Increase the verbosity of the output. May include sensitive data.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_VERBOSE" + }, { "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-setup-css.interface.ts", "syntaxKind": "PropertySignature", @@ -6851,9 +7481,18 @@ "description": "Overwrites the destination directory and files if they already exist.", "isOptional": true, "environmentValue": "SHOPIFY_HYDROGEN_FLAG_FORCE" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-setup-css.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-j, --json", + "value": "''", + "description": "Output the result as JSON. Automatically disables color output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON" } ], - "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}" + "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 * 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 * Disable interactive prompts and browser authentication.\n * @environment SHOPIFY_FLAG_NO_INPUT\n */\n '--no-input'?: ''\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 * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" } }, "hydrogensetupmarkets": { @@ -6872,6 +7511,24 @@ "isOptional": true, "environmentValue": "SHOPIFY_FLAG_JSON_SCHEMA" }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-setup-markets.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--no-color", + "value": "''", + "description": "Disable color output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_NO_COLOR" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-setup-markets.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--no-input", + "value": "''", + "description": "Disable interactive prompts and browser authentication.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_NO_INPUT" + }, { "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-setup-markets.interface.ts", "syntaxKind": "PropertySignature", @@ -6880,9 +7537,27 @@ "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.", "isOptional": true, "environmentValue": "SHOPIFY_HYDROGEN_FLAG_PATH" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-setup-markets.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--verbose", + "value": "''", + "description": "Increase the verbosity of the output. May include sensitive data.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_VERBOSE" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-setup-markets.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-j, --json", + "value": "''", + "description": "Output the result as JSON. Automatically disables color output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON" } ], - "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}" + "value": "export interface hydrogensetupmarkets {\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 * Disable interactive prompts and browser authentication.\n * @environment SHOPIFY_FLAG_NO_INPUT\n */\n '--no-input'?: ''\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 * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" } }, "hydrogensetupvite": { @@ -6901,6 +7576,24 @@ "isOptional": true, "environmentValue": "SHOPIFY_FLAG_JSON_SCHEMA" }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-setup-vite.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--no-color", + "value": "''", + "description": "Disable color output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_NO_COLOR" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-setup-vite.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--no-input", + "value": "''", + "description": "Disable interactive prompts and browser authentication.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_NO_INPUT" + }, { "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-setup-vite.interface.ts", "syntaxKind": "PropertySignature", @@ -6909,9 +7602,27 @@ "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.", "isOptional": true, "environmentValue": "SHOPIFY_HYDROGEN_FLAG_PATH" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-setup-vite.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--verbose", + "value": "''", + "description": "Increase the verbosity of the output. May include sensitive data.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_VERBOSE" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-setup-vite.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-j, --json", + "value": "''", + "description": "Output the result as JSON. Automatically disables color output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON" } ], - "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}" + "value": "export interface hydrogensetupvite {\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 * Disable interactive prompts and browser authentication.\n * @environment SHOPIFY_FLAG_NO_INPUT\n */\n '--no-input'?: ''\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 * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" } }, "hydrogensetup": { @@ -6948,6 +7659,24 @@ "isOptional": true, "environmentValue": "SHOPIFY_HYDROGEN_FLAG_I18N" }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-setup.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--no-color", + "value": "''", + "description": "Disable color output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_NO_COLOR" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-setup.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--no-input", + "value": "''", + "description": "Disable interactive prompts and browser authentication.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_NO_INPUT" + }, { "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-setup.interface.ts", "syntaxKind": "PropertySignature", @@ -6966,6 +7695,15 @@ "isOptional": true, "environmentValue": "SHOPIFY_HYDROGEN_FLAG_SHORTCUT" }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-setup.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--verbose", + "value": "''", + "description": "Increase the verbosity of the output. May include sensitive data.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_VERBOSE" + }, { "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-setup.interface.ts", "syntaxKind": "PropertySignature", @@ -6974,9 +7712,18 @@ "description": "Overwrites the destination directory and files if they already exist.", "isOptional": true, "environmentValue": "SHOPIFY_HYDROGEN_FLAG_FORCE" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-setup.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-j, --json", + "value": "''", + "description": "Output the result as JSON. Automatically disables color output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON" } ], - "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}" + "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 * 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 * 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 * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * Disable interactive prompts and browser authentication.\n * @environment SHOPIFY_FLAG_NO_INPUT\n */\n '--no-input'?: ''\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\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" } }, "hydrogenshortcut": { @@ -6994,9 +7741,45 @@ "description": "Print the command's JSON schemas.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_JSON_SCHEMA" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-shortcut.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--no-color", + "value": "''", + "description": "Disable color output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_NO_COLOR" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-shortcut.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--no-input", + "value": "''", + "description": "Disable interactive prompts and browser authentication.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_NO_INPUT" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-shortcut.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--verbose", + "value": "''", + "description": "Increase the verbosity of the output. May include sensitive data.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_VERBOSE" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-shortcut.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-j, --json", + "value": "''", + "description": "Output the result as JSON. Automatically disables color output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON" } ], - "value": "export interface hydrogenshortcut {\n /**\n * Print the command's JSON schemas.\n * @environment SHOPIFY_FLAG_JSON_SCHEMA\n */\n '--json-schema'?: ''\n}" + "value": "export interface hydrogenshortcut {\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 * Disable interactive prompts and browser authentication.\n * @environment SHOPIFY_FLAG_NO_INPUT\n */\n '--no-input'?: ''\n\n /**\n * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" } }, "hydrogenunlink": { @@ -7015,6 +7798,24 @@ "isOptional": true, "environmentValue": "SHOPIFY_FLAG_JSON_SCHEMA" }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-unlink.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--no-color", + "value": "''", + "description": "Disable color output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_NO_COLOR" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-unlink.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--no-input", + "value": "''", + "description": "Disable interactive prompts and browser authentication.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_NO_INPUT" + }, { "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-unlink.interface.ts", "syntaxKind": "PropertySignature", @@ -7023,9 +7824,27 @@ "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.", "isOptional": true, "environmentValue": "SHOPIFY_HYDROGEN_FLAG_PATH" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-unlink.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--verbose", + "value": "''", + "description": "Increase the verbosity of the output. May include sensitive data.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_VERBOSE" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-unlink.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-j, --json", + "value": "''", + "description": "Output the result as JSON. Automatically disables color output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON" } ], - "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}" + "value": "export interface hydrogenunlink {\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 * Disable interactive prompts and browser authentication.\n * @environment SHOPIFY_FLAG_NO_INPUT\n */\n '--no-input'?: ''\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 * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" } }, "hydrogenupgrade": { @@ -7044,6 +7863,24 @@ "isOptional": true, "environmentValue": "SHOPIFY_FLAG_JSON_SCHEMA" }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-upgrade.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--no-color", + "value": "''", + "description": "Disable color output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_NO_COLOR" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-upgrade.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--no-input", + "value": "''", + "description": "Disable interactive prompts and browser authentication.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_NO_INPUT" + }, { "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-upgrade.interface.ts", "syntaxKind": "PropertySignature", @@ -7053,6 +7890,15 @@ "isOptional": true, "environmentValue": "SHOPIFY_HYDROGEN_FLAG_PATH" }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-upgrade.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--verbose", + "value": "''", + "description": "Increase the verbosity of the output. May include sensitive data.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_VERBOSE" + }, { "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-upgrade.interface.ts", "syntaxKind": "PropertySignature", @@ -7062,6 +7908,15 @@ "isOptional": true, "environmentValue": "SHOPIFY_HYDROGEN_FLAG_FORCE" }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-upgrade.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-j, --json", + "value": "''", + "description": "Output the result as JSON. Automatically disables color output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON" + }, { "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-upgrade.interface.ts", "syntaxKind": "PropertySignature", @@ -7071,7 +7926,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 * 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}" + "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 * 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 * Disable interactive prompts and browser authentication.\n * @environment SHOPIFY_FLAG_NO_INPUT\n */\n '--no-input'?: ''\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 * Increase the verbosity of the output. May include sensitive data.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n\n /**\n * A target hydrogen version to update to\n *\n */\n '-v, --version '?: string\n}" } }, "organizationlist": { diff --git a/packages/cli/README.md b/packages/cli/README.md index 1ccf8900c7a..202b1bf6cf7 100644 --- a/packages/cli/README.md +++ b/packages/cli/README.md @@ -10623,15 +10623,19 @@ DESCRIPTION ## `shopify hydrogen build` -Builds a Hydrogen storefront for production. +Builds a Hydrogen storefront for production. The client and app worker files are compiled to a `/dist` folder in your Hydrogen project directory. ``` USAGE $ shopify hydrogen build [--bundle-stats] [--codegen-config-path --codegen] [--disable-route-warning] - [--entry ] [--force-client-sourcemap] [--json-schema] [--lockfile-check] [--path ] [--sourcemap] - [--watch] + [--entry ] [--force-client-sourcemap] [-j] [--json-schema] [--lockfile-check] [--no-color] [--no-input] + [--path ] [--sourcemap] [--verbose] [--watch] FLAGS + -j, --json + Output the result as JSON. Automatically disables color output. + [env: SHOPIFY_FLAG_JSON] + --[no-]bundle-stats Show a bundle size summary after building. Defaults to true, use `--no-bundle-stats` to disable. @@ -10663,6 +10667,14 @@ FLAGS `--no-lockfile-check`. [env: SHOPIFY_HYDROGEN_FLAG_LOCKFILE_CHECK] + --no-color + Disable color output. + [env: SHOPIFY_FLAG_NO_COLOR] + + --no-input + Disable interactive prompts and browser authentication. + [env: SHOPIFY_FLAG_NO_INPUT] + --path= The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run. [env: SHOPIFY_HYDROGEN_FLAG_PATH] @@ -10671,47 +10683,146 @@ FLAGS Controls whether server sourcemaps are generated. Default to `true`. Deactivate `--no-sourcemaps`. [env: SHOPIFY_HYDROGEN_FLAG_SOURCEMAP] + --verbose + Increase the verbosity of the output. May include sensitive data. + [env: SHOPIFY_FLAG_VERBOSE] + --watch Watches for changes and rebuilds the project writing output to disk. [env: SHOPIFY_HYDROGEN_FLAG_WATCH] DESCRIPTION - Builds a Hydrogen storefront for production. + Builds a Hydrogen storefront for production. The client and app worker files are compiled to a `/dist` folder in your + Hydrogen project directory. + + Use `--json-schema` to print the result, error, and event schemas. + + Output from `--json` conforms to the `HydrogenBuildResult` schema. + + ```json + { + "type": "object", + "properties": { + "directory": { + "$ref": "#/definitions/AbsolutePath" + }, + "clientDirectory": { + "$ref": "#/definitions/AbsolutePath" + }, + "serverDirectory": { + "$ref": "#/definitions/AbsolutePath" + }, + "serverPath": { + "$ref": "#/definitions/AbsolutePath" + } + }, + "required": [ + "directory", + "clientDirectory", + "serverDirectory", + "serverPath" + ], + "additionalProperties": false, + "title": "HydrogenBuildResult", + "definitions": { + "AbsolutePath": { + "type": "string" + } + }, + "$schema": "http://json-schema.org/draft-07/schema#" + } + ``` ``` ## `shopify hydrogen check RESOURCE` -Returns diagnostic information about a Hydrogen storefront. +Checks whether your Hydrogen app includes a set of standard Shopify routes. ``` USAGE - $ shopify hydrogen check RESOURCE [--json-schema] [--path ] + $ shopify hydrogen check RESOURCE [-j] [--json-schema] [--no-color] [--no-input] [--path ] [--verbose] ARGUMENTS RESOURCE (routes) The resource to check. Currently only 'routes' is supported. FLAGS + -j, --json + Output the result as JSON. Automatically disables color output. + [env: SHOPIFY_FLAG_JSON] + --json-schema Print the command's JSON schemas. [env: SHOPIFY_FLAG_JSON_SCHEMA] + --no-color + Disable color output. + [env: SHOPIFY_FLAG_NO_COLOR] + + --no-input + Disable interactive prompts and browser authentication. + [env: SHOPIFY_FLAG_NO_INPUT] + --path= The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run. [env: SHOPIFY_HYDROGEN_FLAG_PATH] + --verbose + Increase the verbosity of the output. May include sensitive data. + [env: SHOPIFY_FLAG_VERBOSE] + DESCRIPTION - Returns diagnostic information about a Hydrogen storefront. + Checks whether your Hydrogen app includes a set of standard Shopify routes. + + Use `--json-schema` to print the result, error, and event schemas. + + Output from `--json` conforms to the `HydrogenCheckResult` schema. + + ```json + { + "type": "object", + "properties": { + "valid": { + "type": "boolean" + }, + "missingRoutes": { + "type": "array", + "items": { + "type": "string" + } + }, + "reservedRoutes": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "valid", + "missingRoutes", + "reservedRoutes" + ], + "additionalProperties": false, + "title": "HydrogenCheckResult", + "$schema": "http://json-schema.org/draft-07/schema#" + } + ``` ``` ## `shopify hydrogen codegen` -Generate types for the Storefront API queries found in your project. +Automatically generates GraphQL types for your project’s Storefront API queries. ``` USAGE - $ shopify hydrogen codegen [--codegen-config-path ] [--json-schema] [--path ] [--watch] + $ shopify hydrogen codegen [--codegen-config-path ] [-j] [--json-schema] [--no-color] [--no-input] [--path + ] [--verbose] [--watch] FLAGS + -j, --json + Output the result as JSON. Automatically disables color output. + [env: SHOPIFY_FLAG_JSON] + --codegen-config-path= Specify a path to a codegen configuration file. Defaults to `/codegen.ts` if it exists. @@ -10719,15 +10830,68 @@ FLAGS Print the command's JSON schemas. [env: SHOPIFY_FLAG_JSON_SCHEMA] + --no-color + Disable color output. + [env: SHOPIFY_FLAG_NO_COLOR] + + --no-input + Disable interactive prompts and browser authentication. + [env: SHOPIFY_FLAG_NO_INPUT] + --path= The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run. [env: SHOPIFY_HYDROGEN_FLAG_PATH] + --verbose + Increase the verbosity of the output. May include sensitive data. + [env: SHOPIFY_FLAG_VERBOSE] + --watch Watch the project for changes to update types on file save. DESCRIPTION - Generate types for the Storefront API queries found in your project. + Automatically generates GraphQL types for your project’s Storefront API queries. + + Use `--json-schema` to print the result, error, and event schemas. + + Output from `--json` conforms to the `HydrogenCodegenResult` schema. + + ```json + { + "type": "object", + "properties": { + "files": { + "type": "array", + "items": { + "type": "object", + "properties": { + "path": { + "type": "string" + }, + "sources": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Source patterns from the GraphQL codegen configuration." + } + }, + "required": [ + "path", + "sources" + ], + "additionalProperties": false + } + } + }, + "required": [ + "files" + ], + "additionalProperties": false, + "title": "HydrogenCodegenResult", + "$schema": "http://json-schema.org/draft-07/schema#" + } + ``` ``` ## `shopify hydrogen customer-account-push` @@ -10736,10 +10900,15 @@ Push project configuration to admin ``` USAGE - $ shopify hydrogen customer-account-push --dev-origin [--javascript-origin ] [--json-schema] [--path ] - [--relative-logout-uri ] [--relative-redirect-uri ] [--storefront-id ] + $ shopify hydrogen customer-account-push --dev-origin [--javascript-origin ] [-j] [--json-schema] [--no-color] + [--no-input] [--path ] [--relative-logout-uri ] [--relative-redirect-uri ] [--storefront-id + ] [--verbose] FLAGS + -j, --json + Output the result as JSON. Automatically disables color output. + [env: SHOPIFY_FLAG_JSON] + --dev-origin= (required) The development domain of your application. @@ -10752,6 +10921,14 @@ FLAGS Print the command's JSON schemas. [env: SHOPIFY_FLAG_JSON_SCHEMA] + --no-color + Disable color output. + [env: SHOPIFY_FLAG_NO_COLOR] + + --no-input + Disable interactive prompts and browser authentication. + [env: SHOPIFY_FLAG_NO_INPUT] + --path= The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run. [env: SHOPIFY_HYDROGEN_FLAG_PATH] @@ -10766,8 +10943,50 @@ FLAGS --storefront-id= The id of the storefront the configuration should be pushed to. Must start with 'gid://shopify/HydrogenStorefront/' + --verbose + Increase the verbosity of the output. May include sensitive data. + [env: SHOPIFY_FLAG_VERBOSE] + DESCRIPTION Push project configuration to admin + + Use `--json-schema` to print the result, error, and event schemas. + + Output from `--json` conforms to the `HydrogenCustomerAccountPushResult` schema. + + ```json + { + "type": "object", + "properties": { + "storefrontGid": { + "type": "string", + "pattern": "^gid:\\/\\/shopify\\/HydrogenStorefront\\/\\d+$", + "description": "A Shopify HydrogenStorefront GID." + }, + "redirectUri": { + "type": "string", + "format": "uri" + }, + "javascriptOrigin": { + "type": "string", + "format": "uri" + }, + "logoutUri": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "storefrontGid", + "redirectUri", + "javascriptOrigin", + "logoutUri" + ], + "additionalProperties": false, + "title": "HydrogenCustomerAccountPushResult", + "$schema": "http://json-schema.org/draft-07/schema#" + } + ``` ``` ## `shopify hydrogen debug cpu` @@ -10776,7 +10995,8 @@ Builds and profiles the server startup time the app. ``` USAGE - $ shopify hydrogen debug cpu [--entry ] [--json-schema] [--output ] [--path ] + $ shopify hydrogen debug cpu [--entry ] [--json-schema] [--no-color] [--no-input] [--output ] [--path + ] [--verbose] FLAGS --entry= @@ -10787,6 +11007,14 @@ FLAGS Print the command's JSON schemas. [env: SHOPIFY_FLAG_JSON_SCHEMA] + --no-color + Disable color output. + [env: SHOPIFY_FLAG_NO_COLOR] + + --no-input + Disable interactive prompts and browser authentication. + [env: SHOPIFY_FLAG_NO_INPUT] + --output= [default: startup.cpuprofile] Specify a path to generate the profile file. Defaults to "startup.cpuprofile". @@ -10794,21 +11022,25 @@ FLAGS The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run. [env: SHOPIFY_HYDROGEN_FLAG_PATH] + --verbose + Increase the verbosity of the output. May include sensitive data. + [env: SHOPIFY_FLAG_VERBOSE] + DESCRIPTION Builds and profiles the server startup time the app. ``` ## `shopify hydrogen deploy` -Builds and deploys a Hydrogen storefront to Oxygen. +Builds and deploys your Hydrogen storefront to Oxygen. Requires an Oxygen deployment token to be set with the `--token` flag or an environment variable (`SHOPIFY_HYDROGEN_DEPLOYMENT_TOKEN`). If the storefront is "linked" (https://shopify.dev/docs/api/shopify-cli/hydrogen/hydrogen-link) then the Oxygen deployment token for the linked storefront will be used automatically. ``` USAGE $ shopify hydrogen deploy [--assets-dir ] [--auth-bypass-token-duration --auth-bypass-token] [--build-command ] [--entry ] [--env | --env-branch ] [--env-file ] [-f] - [--force-client-sourcemap] [--json-output] [--json-schema] [--lockfile-check] [--metadata-description ] - [--metadata-user ] [--no-verify] [--path ] [--preview] [-s ] [-t ] [--worker-dir - ] + [--force-client-sourcemap] [-j] [--json-output] [--json-schema] [--lockfile-check] [--metadata-description ] + [--metadata-user ] [--no-color] [--no-input] [--no-verify] [--path ] [--preview] [-s ] [-t + ] [--verbose] [--worker-dir ] FLAGS -f, --force @@ -10816,6 +11048,10 @@ FLAGS prompts for non-preview environments. [env: SHOPIFY_HYDROGEN_FLAG_FORCE] + -j, --json + Output the result as JSON. Automatically disables color output. + [env: SHOPIFY_FLAG_JSON] + -s, --shop= 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). @@ -10883,6 +11119,14 @@ FLAGS User that initiated the deployment. Will be saved and displayed in the Shopify admin [env: SHOPIFY_HYDROGEN_FLAG_METADATA_USER] + --no-color + Disable color output. + [env: SHOPIFY_FLAG_NO_COLOR] + + --no-input + Disable interactive prompts and browser authentication. + [env: SHOPIFY_FLAG_NO_INPUT] + --no-verify Skip the routability verification step after deployment. @@ -10893,61 +11137,127 @@ FLAGS --preview Deploys to the Preview environment. + --verbose + Increase the verbosity of the output. May include sensitive data. + [env: SHOPIFY_FLAG_VERBOSE] + --worker-dir= Directory containing the Oxygen worker entry point (`index.js` or `index.mjs`), relative to the project root. Defaults to the detected Vite server output directory, then falls back to `dist/server`. [env: SHOPIFY_HYDROGEN_FLAG_WORKER_DIR] DESCRIPTION - Builds and deploys a Hydrogen storefront to Oxygen. -``` - -## `shopify hydrogen dev` - -Runs Hydrogen storefront in an Oxygen worker for development. - -``` -USAGE - $ shopify hydrogen dev [--codegen-config-path --codegen] [--customer-account-push] [--debug] - [--disable-deps-optimizer] [--disable-version-check] [--disable-virtual-routes] [--entry ] [--env | - --env-branch ] [--env-file ] [--host] [--inspector-port ] [--json-schema] [--path ] - [--port ] [--verbose] - -FLAGS - --codegen - Automatically generates GraphQL types for your project’s Storefront API queries. - - --codegen-config-path= - Specifies a path to a codegen configuration file. Defaults to `/codegen.ts` if this file exists. - - --customer-account-push - Use tunneling for local development and push the tunneling domain to admin. Required to use Customer Account API's - OAuth flow - [env: SHOPIFY_HYDROGEN_FLAG_CUSTOMER_ACCOUNT_PUSH] - - --debug - Enables inspector connections to the server with a debugger such as Visual Studio Code or Chrome DevTools. - [env: SHOPIFY_HYDROGEN_FLAG_DEBUG] - - --disable-deps-optimizer - Disable adding dependencies to Vite's `ssr.optimizeDeps.include` automatically - [env: SHOPIFY_HYDROGEN_FLAG_DISABLE_DEPS_OPTIMIZER] - - --disable-version-check - Skip the version check when running `hydrogen dev` - - --disable-virtual-routes - Disable rendering fallback routes when a route file doesn't exist. - [env: SHOPIFY_HYDROGEN_FLAG_DISABLE_VIRTUAL_ROUTES] + Builds and deploys your Hydrogen storefront to Oxygen. Requires an Oxygen deployment token to be set with the + `--token` flag or an environment variable (`SHOPIFY_HYDROGEN_DEPLOYMENT_TOKEN`). If the storefront is "linked" + (https://shopify.dev/docs/api/shopify-cli/hydrogen/hydrogen-link) then the Oxygen deployment token for the linked + storefront will be used automatically. - --entry= - Entry file for the worker. Defaults to `./server`. - [env: SHOPIFY_HYDROGEN_FLAG_ENTRY] + Use `--json-schema` to print the result, error, and event schemas. - --env= - Specifies the environment to perform the operation using its handle. Fetch the handle using the `env list` command. + Output from `--json` conforms to the `HydrogenDeployResult` schema. - --env-branch= + ```json + { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "success", + "cancelled" + ] + }, + "deployment": { + "anyOf": [ + { + "$ref": "#/definitions/Deployment" + }, + { + "type": "null" + } + ] + } + }, + "required": [ + "status", + "deployment" + ], + "additionalProperties": false, + "description": "The command result. The existing h2_deploy_log.json file retains Oxygen CompletedDeployment format, independently of this result.", + "title": "HydrogenDeployResult", + "definitions": { + "Deployment": { + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "authBypassToken": { + "type": [ + "string", + "null" + ] + } + }, + "required": [ + "url", + "authBypassToken" + ], + "additionalProperties": false + } + }, + "$schema": "http://json-schema.org/draft-07/schema#" + } + ``` +``` + +## `shopify hydrogen dev` + +Runs Hydrogen storefront in an Oxygen worker for development. + +``` +USAGE + $ shopify hydrogen dev [--codegen-config-path --codegen] [--customer-account-push] [--debug] + [--disable-deps-optimizer] [--disable-version-check] [--disable-virtual-routes] [--entry ] [--env | + --env-branch ] [--env-file ] [--host] [--inspector-port ] [--json-schema] [--no-color] + [--no-input] [--path ] [--port ] [--verbose] + +FLAGS + --codegen + Automatically generates GraphQL types for your project’s Storefront API queries. + + --codegen-config-path= + Specifies a path to a codegen configuration file. Defaults to `/codegen.ts` if this file exists. + + --customer-account-push + Use tunneling for local development and push the tunneling domain to admin. Required to use Customer Account API's + OAuth flow + [env: SHOPIFY_HYDROGEN_FLAG_CUSTOMER_ACCOUNT_PUSH] + + --debug + Enables inspector connections to the server with a debugger such as Visual Studio Code or Chrome DevTools. + [env: SHOPIFY_HYDROGEN_FLAG_DEBUG] + + --disable-deps-optimizer + Disable adding dependencies to Vite's `ssr.optimizeDeps.include` automatically + [env: SHOPIFY_HYDROGEN_FLAG_DISABLE_DEPS_OPTIMIZER] + + --disable-version-check + Skip the version check when running `hydrogen dev` + + --disable-virtual-routes + Disable rendering fallback routes when a route file doesn't exist. + [env: SHOPIFY_HYDROGEN_FLAG_DISABLE_VIRTUAL_ROUTES] + + --entry= + Entry file for the worker. Defaults to `./server`. + [env: SHOPIFY_HYDROGEN_FLAG_ENTRY] + + --env= + Specifies the environment to perform the operation using its handle. Fetch the handle using the `env list` command. + + --env-branch= Specifies the environment to perform the operation using its Git branch name. [env: SHOPIFY_HYDROGEN_ENVIRONMENT_BRANCH] @@ -10966,6 +11276,14 @@ FLAGS Print the command's JSON schemas. [env: SHOPIFY_FLAG_JSON_SCHEMA] + --no-color + Disable color output. + [env: SHOPIFY_FLAG_NO_COLOR] + + --no-input + Disable interactive prompts and browser authentication. + [env: SHOPIFY_FLAG_NO_INPUT] + --path= The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run. [env: SHOPIFY_HYDROGEN_FLAG_PATH] @@ -10984,39 +11302,186 @@ DESCRIPTION ## `shopify hydrogen env list` -List the environments on your linked Hydrogen storefront. +Lists all environments available on the linked Hydrogen storefront. ``` USAGE - $ shopify hydrogen env list [--json-schema] [--path ] + $ shopify hydrogen env list [-j] [--json-schema] [--no-color] [--no-input] [--path ] [--verbose] FLAGS + -j, --json + Output the result as JSON. Automatically disables color output. + [env: SHOPIFY_FLAG_JSON] + --json-schema Print the command's JSON schemas. [env: SHOPIFY_FLAG_JSON_SCHEMA] + --no-color + Disable color output. + [env: SHOPIFY_FLAG_NO_COLOR] + + --no-input + Disable interactive prompts and browser authentication. + [env: SHOPIFY_FLAG_NO_INPUT] + --path= The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run. [env: SHOPIFY_HYDROGEN_FLAG_PATH] + --verbose + Increase the verbosity of the output. May include sensitive data. + [env: SHOPIFY_FLAG_VERBOSE] + DESCRIPTION - List the environments on your linked Hydrogen storefront. + Lists all environments available on the linked Hydrogen storefront. + + Use `--json-schema` to print the result, error, and event schemas. + + Output from `--json` conforms to the `HydrogenEnvListResult` schema. + + ```json + { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "success", + "cancelled" + ] + }, + "storefront": { + "anyOf": [ + { + "$ref": "#/definitions/Storefront" + }, + { + "type": "null" + } + ] + }, + "environments": { + "type": "array", + "items": { + "$ref": "#/definitions/Environment" + } + } + }, + "required": [ + "status", + "storefront", + "environments" + ], + "additionalProperties": false, + "description": "The complete environment list for the linked storefront.", + "title": "HydrogenEnvListResult", + "definitions": { + "Environment": { + "type": "object", + "properties": { + "gid": { + "type": "string", + "pattern": "^gid:\\/\\/shopify\\/HydrogenStorefrontEnvironment\\/\\d+$", + "description": "A Shopify HydrogenStorefrontEnvironment GID." + }, + "name": { + "type": "string" + }, + "handle": { + "type": "string" + }, + "branch": { + "type": [ + "string", + "null" + ] + }, + "createdAt": { + "type": "string", + "format": "date-time" + }, + "type": { + "type": "string", + "description": "Upstream environment type; known values are PREVIEW, PRODUCTION, CUSTOM." + }, + "url": { + "anyOf": [ + { + "type": "string", + "format": "uri" + }, + { + "type": "null" + } + ] + } + }, + "required": [ + "gid", + "name", + "handle", + "branch", + "createdAt", + "type", + "url" + ], + "additionalProperties": false + }, + "Storefront": { + "type": "object", + "properties": { + "gid": { + "type": "string", + "pattern": "^gid:\\/\\/shopify\\/HydrogenStorefront\\/\\d+$", + "description": "A Shopify HydrogenStorefront GID." + }, + "name": { + "type": "string" + }, + "productionUrl": { + "anyOf": [ + { + "type": "string", + "format": "uri" + }, + { + "type": "null" + } + ] + } + }, + "required": [ + "gid", + "name", + "productionUrl" + ], + "additionalProperties": false + } + }, + "$schema": "http://json-schema.org/draft-07/schema#" + } + ``` ``` ## `shopify hydrogen env pull` -Populate your .env with variables from your Hydrogen storefront. +Pulls environment variables from the linked Hydrogen storefront and writes them to an `.env` file. ``` USAGE - $ shopify hydrogen env pull [--env | --env-branch ] [--env-file ] [-f] [--json-schema] [--path - ] + $ shopify hydrogen env pull [--env | --env-branch ] [--env-file ] [-f] [-j] [--json-schema] + [--no-color] [--no-input] [--path ] [--verbose] FLAGS -f, --force Overwrites the destination directory and files if they already exist. [env: SHOPIFY_HYDROGEN_FLAG_FORCE] + -j, --json + Output the result as JSON. Automatically disables color output. + [env: SHOPIFY_FLAG_JSON] + --env= Specifies the environment to perform the operation using its handle. Fetch the handle using the `env list` command. @@ -11032,32 +11497,199 @@ FLAGS Print the command's JSON schemas. [env: SHOPIFY_FLAG_JSON_SCHEMA] + --no-color + Disable color output. + [env: SHOPIFY_FLAG_NO_COLOR] + + --no-input + Disable interactive prompts and browser authentication. + [env: SHOPIFY_FLAG_NO_INPUT] + --path= The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run. [env: SHOPIFY_HYDROGEN_FLAG_PATH] -DESCRIPTION - Populate your .env with variables from your Hydrogen storefront. -``` - -## `shopify hydrogen env push` - -Push environment variables from the local .env file to your linked Hydrogen storefront. + --verbose + Increase the verbosity of the output. May include sensitive data. + [env: SHOPIFY_FLAG_VERBOSE] -``` -USAGE - $ shopify hydrogen env push [--dry-run | -f] [--env | ] [--env-file ] [--json-schema] [--path ] +DESCRIPTION + Pulls environment variables from the linked Hydrogen storefront and writes them to an `.env` file. -FLAGS - -f, --force - Push environment variable changes without confirmation. - [env: SHOPIFY_HYDROGEN_FLAG_FORCE] + Use `--json-schema` to print the result, error, and event schemas. - --dry-run - Preview environment variable changes without pushing them. - [env: SHOPIFY_HYDROGEN_FLAG_DRY_RUN] + Output from `--json` conforms to the `HydrogenEnvPullResult` schema. - --env= + ```json + { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "success", + "cancelled" + ] + }, + "changed": { + "type": "boolean" + }, + "path": { + "type": "string" + }, + "storefrontGid": { + "anyOf": [ + { + "type": "string", + "pattern": "^gid:\\/\\/shopify\\/HydrogenStorefront\\/\\d+$", + "description": "A Shopify HydrogenStorefront GID." + }, + { + "type": "null" + } + ], + "description": "A Shopify HydrogenStorefront GID." + }, + "storefrontName": { + "type": [ + "string", + "null" + ] + }, + "environment": { + "anyOf": [ + { + "$ref": "#/definitions/Environment" + }, + { + "type": "null" + } + ] + }, + "variables": { + "type": "array", + "items": { + "$ref": "#/definitions/Variable" + } + } + }, + "required": [ + "status", + "changed", + "path", + "storefrontGid", + "storefrontName", + "environment", + "variables" + ], + "additionalProperties": false, + "description": "The dotenv file keeps its native format. The result reports variable metadata without values.", + "title": "HydrogenEnvPullResult", + "definitions": { + "Environment": { + "type": "object", + "properties": { + "gid": { + "type": "string", + "pattern": "^gid:\\/\\/shopify\\/HydrogenStorefrontEnvironment\\/\\d+$", + "description": "A Shopify HydrogenStorefrontEnvironment GID." + }, + "name": { + "type": "string" + }, + "handle": { + "type": "string" + }, + "branch": { + "type": [ + "string", + "null" + ] + }, + "createdAt": { + "type": "string", + "format": "date-time" + }, + "type": { + "type": "string", + "description": "Upstream environment type; known values are PREVIEW, PRODUCTION, CUSTOM." + }, + "url": { + "anyOf": [ + { + "type": "string", + "format": "uri" + }, + { + "type": "null" + } + ] + } + }, + "required": [ + "gid", + "name", + "handle", + "branch", + "createdAt", + "type", + "url" + ], + "additionalProperties": false + }, + "Variable": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "id": { + "type": "string", + "pattern": "^\\d+$", + "description": "The decimal HydrogenStorefrontEnvironmentVariable ID, not a GID." + }, + "isSecret": { + "type": "boolean" + }, + "readOnly": { + "type": "boolean" + } + }, + "required": [ + "name" + ], + "additionalProperties": false, + "description": "Metadata only: variable spelling is preserved and values are never included. Unknown metadata is omitted." + } + }, + "$schema": "http://json-schema.org/draft-07/schema#" + } + ``` +``` + +## `shopify hydrogen env push` + +Push environment variables from the local .env file to your linked Hydrogen storefront. + +``` +USAGE + $ shopify hydrogen env push [--dry-run | -f] [--env | ] [--env-file ] [-j] [--json-schema] + [--no-color] [--no-input] [--path ] [--verbose] + +FLAGS + -f, --force + Push environment variable changes without confirmation. + [env: SHOPIFY_HYDROGEN_FLAG_FORCE] + + -j, --json + Output the result as JSON. Automatically disables color output. + [env: SHOPIFY_FLAG_JSON] + + --dry-run + Preview environment variable changes without pushing them. + [env: SHOPIFY_HYDROGEN_FLAG_DRY_RUN] + + --env= Specifies the environment to perform the operation using its handle. Fetch the handle using the `env list` command. --env-file= @@ -11068,267 +11700,1150 @@ FLAGS Print the command's JSON schemas. [env: SHOPIFY_FLAG_JSON_SCHEMA] + --no-color + Disable color output. + [env: SHOPIFY_FLAG_NO_COLOR] + + --no-input + Disable interactive prompts and browser authentication. + [env: SHOPIFY_FLAG_NO_INPUT] + --path= The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run. [env: SHOPIFY_HYDROGEN_FLAG_PATH] + --verbose + Increase the verbosity of the output. May include sensitive data. + [env: SHOPIFY_FLAG_VERBOSE] + DESCRIPTION Push environment variables from the local .env file to your linked Hydrogen storefront. + + Use `--json-schema` to print the result, error, and event schemas. + + Output from `--json` conforms to the `HydrogenEnvPushResult` schema. + + ```json + { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "success", + "cancelled" + ] + }, + "changed": { + "type": "boolean" + }, + "wouldChange": { + "type": "boolean", + "description": "Whether the compared local and remote variables differ, excluding protected variables." + }, + "dryRun": { + "type": "boolean" + }, + "path": { + "type": "string" + }, + "environment": { + "anyOf": [ + { + "$ref": "#/definitions/Environment" + }, + { + "type": "null" + } + ] + }, + "variables": { + "type": "array", + "items": { + "$ref": "#/definitions/Variable" + } + }, + "skipped": { + "type": "array", + "items": { + "$ref": "#/definitions/Variable" + } + } + }, + "required": [ + "status", + "changed", + "wouldChange", + "dryRun", + "path", + "environment", + "variables", + "skipped" + ], + "additionalProperties": false, + "title": "HydrogenEnvPushResult", + "definitions": { + "Environment": { + "type": "object", + "properties": { + "gid": { + "type": "string", + "pattern": "^gid:\\/\\/shopify\\/HydrogenStorefrontEnvironment\\/\\d+$", + "description": "A Shopify HydrogenStorefrontEnvironment GID." + }, + "name": { + "type": "string" + }, + "handle": { + "type": "string" + }, + "branch": { + "type": [ + "string", + "null" + ] + }, + "createdAt": { + "type": "string", + "format": "date-time" + }, + "type": { + "type": "string", + "description": "Upstream environment type; known values are PREVIEW, PRODUCTION, CUSTOM." + }, + "url": { + "anyOf": [ + { + "type": "string", + "format": "uri" + }, + { + "type": "null" + } + ] + } + }, + "required": [ + "gid", + "name", + "handle", + "branch", + "createdAt", + "type", + "url" + ], + "additionalProperties": false + }, + "Variable": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "id": { + "type": "string", + "pattern": "^\\d+$", + "description": "The decimal HydrogenStorefrontEnvironmentVariable ID, not a GID." + }, + "isSecret": { + "type": "boolean" + }, + "readOnly": { + "type": "boolean" + } + }, + "required": [ + "name" + ], + "additionalProperties": false, + "description": "Metadata only: variable spelling is preserved and values are never included. Unknown metadata is omitted." + } + }, + "$schema": "http://json-schema.org/draft-07/schema#" + } + ``` +``` + +## `shopify hydrogen generate route ROUTENAME` + +Generates a set of default routes from the starter template. + +``` +USAGE + $ shopify hydrogen generate route ROUTENAME [--adapter ] [-f] [-j] [--json-schema] [--locale-param ] + [--no-color] [--no-input] [--path ] [--typescript] [--verbose] + +ARGUMENTS + ROUTENAME (home|page|cart|products|collections|policies|blogs|account|search|robots|sitemap|all) The route to + generate. One of home,page,cart,products,collections,policies,blogs,account,search,robots,sitemap,all. + +FLAGS + -f, --force + Overwrites the destination directory and files if they already exist. + [env: SHOPIFY_HYDROGEN_FLAG_FORCE] + + -j, --json + Output the result as JSON. Automatically disables color output. + [env: SHOPIFY_FLAG_JSON] + + --adapter= + React Router adapter used in the route. The default is `react-router`. + [env: SHOPIFY_HYDROGEN_FLAG_ADAPTER] + + --json-schema + Print the command's JSON schemas. + [env: SHOPIFY_FLAG_JSON_SCHEMA] + + --locale-param= + The param name in Remix routes for the i18n locale, if any. Example: `locale` becomes ($locale). + [env: SHOPIFY_HYDROGEN_FLAG_ADAPTER] + + --no-color + Disable color output. + [env: SHOPIFY_FLAG_NO_COLOR] + + --no-input + Disable interactive prompts and browser authentication. + [env: SHOPIFY_FLAG_NO_INPUT] + + --path= + The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run. + [env: SHOPIFY_HYDROGEN_FLAG_PATH] + + --typescript + Generate TypeScript files + [env: SHOPIFY_HYDROGEN_FLAG_TYPESCRIPT] + + --verbose + Increase the verbosity of the output. May include sensitive data. + [env: SHOPIFY_FLAG_VERBOSE] + +DESCRIPTION + Generates a set of default routes from the starter template. + + Use `--json-schema` to print the result, error, and event schemas. + + Output from `--json` conforms to the `HydrogenGenerateRoutesResult` schema. + + ```json + { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "success", + "skipped" + ] + }, + "changed": { + "type": "boolean" + }, + "routes": { + "type": "array", + "items": { + "$ref": "#/definitions/Route" + } + }, + "routeGroups": { + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "isTypescript": { + "type": "boolean" + } + }, + "required": [ + "status", + "changed", + "routes", + "routeGroups", + "isTypescript" + ], + "additionalProperties": false, + "title": "HydrogenGenerateRoutesResult", + "definitions": { + "Route": { + "type": "object", + "properties": { + "sourceRoute": { + "type": "string" + }, + "destinationRoute": { + "type": "string" + }, + "operation": { + "type": "string", + "enum": [ + "created", + "skipped", + "replaced" + ] + }, + "skipReason": { + "type": "string", + "enum": [ + "declined", + "exists" + ] + } + }, + "required": [ + "sourceRoute", + "destinationRoute", + "operation" + ], + "additionalProperties": false + } + }, + "$schema": "http://json-schema.org/draft-07/schema#" + } + ``` +``` + +## `shopify hydrogen generate routes` + +Generates all supported standard shopify routes. + +``` +USAGE + $ shopify hydrogen generate routes [--adapter ] [-f] [-j] [--json-schema] [--locale-param ] [--no-color] + [--no-input] [--path ] [--typescript] [--verbose] + +FLAGS + -f, --force + Overwrites the destination directory and files if they already exist. + [env: SHOPIFY_HYDROGEN_FLAG_FORCE] + + -j, --json + Output the result as JSON. Automatically disables color output. + [env: SHOPIFY_FLAG_JSON] + + --adapter= + React Router adapter used in the route. The default is `react-router`. + [env: SHOPIFY_HYDROGEN_FLAG_ADAPTER] + + --json-schema + Print the command's JSON schemas. + [env: SHOPIFY_FLAG_JSON_SCHEMA] + + --locale-param= + The param name in Remix routes for the i18n locale, if any. Example: `locale` becomes ($locale). + [env: SHOPIFY_HYDROGEN_FLAG_ADAPTER] + + --no-color + Disable color output. + [env: SHOPIFY_FLAG_NO_COLOR] + + --no-input + Disable interactive prompts and browser authentication. + [env: SHOPIFY_FLAG_NO_INPUT] + + --path= + The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run. + [env: SHOPIFY_HYDROGEN_FLAG_PATH] + + --typescript + Generate TypeScript files + [env: SHOPIFY_HYDROGEN_FLAG_TYPESCRIPT] + + --verbose + Increase the verbosity of the output. May include sensitive data. + [env: SHOPIFY_FLAG_VERBOSE] + +DESCRIPTION + Generates all supported standard shopify routes. + + Use `--json-schema` to print the result, error, and event schemas. + + Output from `--json` conforms to the `HydrogenGenerateRoutesResult` schema. + + ```json + { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "success", + "skipped" + ] + }, + "changed": { + "type": "boolean" + }, + "routes": { + "type": "array", + "items": { + "$ref": "#/definitions/Route" + } + }, + "routeGroups": { + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "isTypescript": { + "type": "boolean" + } + }, + "required": [ + "status", + "changed", + "routes", + "routeGroups", + "isTypescript" + ], + "additionalProperties": false, + "title": "HydrogenGenerateRoutesResult", + "definitions": { + "Route": { + "type": "object", + "properties": { + "sourceRoute": { + "type": "string" + }, + "destinationRoute": { + "type": "string" + }, + "operation": { + "type": "string", + "enum": [ + "created", + "skipped", + "replaced" + ] + }, + "skipReason": { + "type": "string", + "enum": [ + "declined", + "exists" + ] + } + }, + "required": [ + "sourceRoute", + "destinationRoute", + "operation" + ], + "additionalProperties": false + } + }, + "$schema": "http://json-schema.org/draft-07/schema#" + } + ``` +``` + +## `shopify hydrogen init` + +Creates a new Hydrogen storefront. + +``` +USAGE + $ shopify hydrogen init [-f] [--git] [--install-deps] [-j] [--json-schema] [--language ] [--markets + ] [--mock-shop] [--no-color] [--no-input] [--path ] [--quickstart] [--shortcut] [--styling ] + [--template ] [--verbose] + +FLAGS + -f, --force + Overwrites the destination directory and files if they already exist. + [env: SHOPIFY_HYDROGEN_FLAG_FORCE] + + -j, --json + Output the result as JSON. Automatically disables color output. + [env: SHOPIFY_FLAG_JSON] + + --[no-]git + Init Git and create initial commits. + [env: SHOPIFY_HYDROGEN_FLAG_GIT] + + --[no-]install-deps + Auto installs dependencies using the active package manager. + [env: SHOPIFY_HYDROGEN_FLAG_INSTALL_DEPS] + + --json-schema + Print the command's JSON schemas. + [env: SHOPIFY_FLAG_JSON_SCHEMA] + + --language= + Sets the template language to use. One of `js` or `ts`. + [env: SHOPIFY_HYDROGEN_FLAG_LANGUAGE] + + --markets= + Sets the URL structure to support multiple markets. Must be one of: `subfolders`, `domains`, `subdomains`, `none`. + Example: `--markets subfolders`. + [env: SHOPIFY_HYDROGEN_FLAG_I18N] + + --mock-shop + Use mock.shop as the data source for the storefront. + [env: SHOPIFY_HYDROGEN_FLAG_MOCK_DATA] + + --no-color + Disable color output. + [env: SHOPIFY_FLAG_NO_COLOR] + + --no-input + Disable interactive prompts and browser authentication. + [env: SHOPIFY_FLAG_NO_INPUT] + + --path= + The path to the directory of the new Hydrogen storefront. + [env: SHOPIFY_HYDROGEN_FLAG_PATH] + + --quickstart + Scaffolds a new Hydrogen project with a set of sensible defaults. Equivalent to `shopify hydrogen init --path + hydrogen-quickstart --mock-shop --language js --shortcut --markets none` + [env: SHOPIFY_HYDROGEN_FLAG_QUICKSTART] + + --[no-]shortcut + Creates a global h2 shortcut for Shopify CLI using shell aliases. Deactivate with `--no-shortcut`. + [env: SHOPIFY_HYDROGEN_FLAG_SHORTCUT] + + --styling= + Sets the styling strategy to use. One of `tailwind`, `vanilla-extract`, `css-modules`, `postcss`, `none`. + [env: SHOPIFY_HYDROGEN_FLAG_STYLING] + + --template= + Scaffolds project based on a template: `skeleton` (the default), `demo-store` or a URL to a git repository. + [env: SHOPIFY_HYDROGEN_FLAG_TEMPLATE] + + --verbose + Increase the verbosity of the output. May include sensitive data. + [env: SHOPIFY_FLAG_VERBOSE] + +DESCRIPTION + Creates a new Hydrogen storefront. + + Use `--json-schema` to print the result, error, and event schemas. + + Output from `--json` conforms to the `HydrogenInitResult` schema. + + ```json + { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "success", + "partial", + "skipped", + "cancelled" + ] + }, + "project": { + "anyOf": [ + { + "$ref": "#/definitions/Project" + }, + { + "type": "null" + } + ], + "description": "All projected fields are present; unavailable settings are null. Route values are relative route names." + }, + "failures": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "dependencies", + "markets", + "routes" + ] + } + } + }, + "required": [ + "status", + "project", + "failures" + ], + "additionalProperties": false, + "title": "HydrogenInitResult", + "definitions": { + "Project": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "directory": { + "type": "string" + }, + "storefrontName": { + "type": [ + "string", + "null" + ] + }, + "language": { + "anyOf": [ + { + "type": "string", + "enum": [ + "js", + "ts" + ] + }, + { + "type": "null" + } + ] + }, + "packageManager": { + "type": "string", + "enum": [ + "npm", + "pnpm", + "yarn", + "bun", + "unknown" + ] + }, + "dependenciesInstalled": { + "type": "boolean" + }, + "cssStrategy": { + "anyOf": [ + { + "type": "string", + "enum": [ + "none", + "tailwind", + "vanilla-extract", + "css-modules", + "postcss" + ] + }, + { + "type": "null" + } + ] + }, + "i18n": { + "anyOf": [ + { + "type": "string", + "enum": [ + "none", + "subfolders", + "domains", + "subdomains" + ] + }, + { + "type": "null" + } + ] + }, + "routes": { + "anyOf": [ + { + "type": "object", + "additionalProperties": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ] + } + }, + { + "type": "null" + } + ] + } + }, + "required": [ + "name", + "directory", + "storefrontName", + "language", + "packageManager", + "dependenciesInstalled", + "cssStrategy", + "i18n", + "routes" + ], + "additionalProperties": false, + "description": "All projected fields are present; unavailable settings are null. Route values are relative route names." + } + }, + "$schema": "http://json-schema.org/draft-07/schema#" + } + ``` ``` -## `shopify hydrogen generate route ROUTENAME` +## `shopify hydrogen link` -Generates a standard Shopify route. +Links your local development environment to a remote Hydrogen storefront. You can link an unlimited number of development environments to a single Hydrogen storefront. ``` USAGE - $ shopify hydrogen generate route ROUTENAME [--adapter ] [-f] [--json-schema] [--locale-param ] [--path - ] [--typescript] - -ARGUMENTS - ROUTENAME (home|page|cart|products|collections|policies|blogs|account|search|robots|sitemap|all) The route to - generate. One of home,page,cart,products,collections,policies,blogs,account,search,robots,sitemap,all. + $ shopify hydrogen link [--create-storefront | --storefront ] [-f] [-j] [--json-schema] [--name | + ] [--no-color] [--no-input] [--path ] [-s ] [--verbose] FLAGS -f, --force Overwrites the destination directory and files if they already exist. [env: SHOPIFY_HYDROGEN_FLAG_FORCE] - --adapter= - React Router adapter used in the route. The default is `react-router`. - [env: SHOPIFY_HYDROGEN_FLAG_ADAPTER] + -j, --json + Output the result as JSON. Automatically disables color output. + [env: SHOPIFY_FLAG_JSON] + + -s, --shop= + Shop URL. It can be the shop prefix (janes-apparel) or the full myshopify.com URL (janes-apparel.myshopify.com, + https://janes-apparel.myshopify.com). + [env: SHOPIFY_SHOP] + + --create-storefront + Create a new Hydrogen storefront. + [env: SHOPIFY_HYDROGEN_FLAG_CREATE_STOREFRONT] --json-schema Print the command's JSON schemas. [env: SHOPIFY_FLAG_JSON_SCHEMA] - --locale-param= - The param name in Remix routes for the i18n locale, if any. Example: `locale` becomes ($locale). - [env: SHOPIFY_HYDROGEN_FLAG_ADAPTER] + --name= + The name to use when creating a new Hydrogen storefront. + [env: SHOPIFY_HYDROGEN_FLAG_NAME] + + --no-color + Disable color output. + [env: SHOPIFY_FLAG_NO_COLOR] + + --no-input + Disable interactive prompts and browser authentication. + [env: SHOPIFY_FLAG_NO_INPUT] --path= The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run. [env: SHOPIFY_HYDROGEN_FLAG_PATH] - --typescript - Generate TypeScript files - [env: SHOPIFY_HYDROGEN_FLAG_TYPESCRIPT] - -DESCRIPTION - Generates a standard Shopify route. -``` - -## `shopify hydrogen generate routes` - -Generates all supported standard shopify routes. - -``` -USAGE - $ shopify hydrogen generate routes [--adapter ] [-f] [--json-schema] [--locale-param ] [--path ] - [--typescript] + --storefront= + The name of a Hydrogen Storefront (e.g. "Jane's Apparel") + [env: SHOPIFY_HYDROGEN_STOREFRONT] -FLAGS - -f, --force - Overwrites the destination directory and files if they already exist. - [env: SHOPIFY_HYDROGEN_FLAG_FORCE] + --verbose + Increase the verbosity of the output. May include sensitive data. + [env: SHOPIFY_FLAG_VERBOSE] - --adapter= - React Router adapter used in the route. The default is `react-router`. - [env: SHOPIFY_HYDROGEN_FLAG_ADAPTER] +DESCRIPTION + Links your local development environment to a remote Hydrogen storefront. You can link an unlimited number of + development environments to a single Hydrogen storefront. - --json-schema - Print the command's JSON schemas. - [env: SHOPIFY_FLAG_JSON_SCHEMA] + Linking to a Hydrogen storefront enables you to run "dev" + (https://shopify.dev/docs/api/shopify-cli/hydrogen/hydrogen-dev) and automatically inject your linked Hydrogen + storefront's environment variables directly into the server runtime. - --locale-param= - The param name in Remix routes for the i18n locale, if any. Example: `locale` becomes ($locale). - [env: SHOPIFY_HYDROGEN_FLAG_ADAPTER] + After you run the `link` command, you can access the "env list" + (https://shopify.dev/docs/api/shopify-cli/hydrogen/hydrogen-env-list), "env pull" + (https://shopify.dev/docs/api/shopify-cli/hydrogen/hydrogen-env-pull), and "unlink" + (https://shopify.dev/docs/api/shopify-cli/hydrogen/hydrogen-unlink) commands. - --path= - The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run. - [env: SHOPIFY_HYDROGEN_FLAG_PATH] + Use `--json-schema` to print the result, error, and event schemas. - --typescript - Generate TypeScript files - [env: SHOPIFY_HYDROGEN_FLAG_TYPESCRIPT] + Output from `--json` conforms to the `HydrogenLinkResult` schema. -DESCRIPTION - Generates all supported standard shopify routes. + ```json + { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "success", + "partial", + "skipped", + "cancelled" + ] + }, + "changed": { + "type": "boolean" + }, + "storeDomain": { + "anyOf": [ + { + "type": "string", + "pattern": "^[a-z0-9][a-z0-9-]*\\.myshopify\\.com$" + }, + { + "type": "null" + } + ] + }, + "storefront": { + "anyOf": [ + { + "$ref": "#/definitions/Storefront" + }, + { + "type": "null" + } + ], + "description": "All projected fields are present; unavailable productionUrl is null." + } + }, + "required": [ + "status", + "changed", + "storeDomain", + "storefront" + ], + "additionalProperties": false, + "title": "HydrogenLinkResult", + "definitions": { + "Storefront": { + "type": "object", + "properties": { + "gid": { + "type": "string", + "pattern": "^gid:\\/\\/shopify\\/HydrogenStorefront\\/\\d+$", + "description": "A Shopify HydrogenStorefront GID." + }, + "name": { + "type": "string" + }, + "productionUrl": { + "anyOf": [ + { + "type": "string", + "format": "uri" + }, + { + "type": "null" + } + ] + } + }, + "required": [ + "gid", + "name", + "productionUrl" + ], + "additionalProperties": false, + "description": "All projected fields are present; unavailable productionUrl is null." + } + }, + "$schema": "http://json-schema.org/draft-07/schema#" + } + ``` ``` -## `shopify hydrogen init` +## `shopify hydrogen list` -Creates a new Hydrogen storefront. +Lists all remote Hydrogen storefronts available to link to your local development environment. ``` USAGE - $ shopify hydrogen init [-f] [--git] [--install-deps] [--json-schema] [--language ] [--markets ] - [--mock-shop] [--path ] [--quickstart] [--shortcut] [--styling ] [--template ] + $ shopify hydrogen list [-j] [--json-schema] [--no-color] [--no-input] [--path ] [--verbose] FLAGS - -f, --force - Overwrites the destination directory and files if they already exist. - [env: SHOPIFY_HYDROGEN_FLAG_FORCE] - - --[no-]git - Init Git and create initial commits. - [env: SHOPIFY_HYDROGEN_FLAG_GIT] - - --[no-]install-deps - Auto installs dependencies using the active package manager. - [env: SHOPIFY_HYDROGEN_FLAG_INSTALL_DEPS] + -j, --json + Output the result as JSON. Automatically disables color output. + [env: SHOPIFY_FLAG_JSON] --json-schema Print the command's JSON schemas. [env: SHOPIFY_FLAG_JSON_SCHEMA] - --language= - Sets the template language to use. One of `js` or `ts`. - [env: SHOPIFY_HYDROGEN_FLAG_LANGUAGE] - - --markets= - Sets the URL structure to support multiple markets. Must be one of: `subfolders`, `domains`, `subdomains`, `none`. - Example: `--markets subfolders`. - [env: SHOPIFY_HYDROGEN_FLAG_I18N] + --no-color + Disable color output. + [env: SHOPIFY_FLAG_NO_COLOR] - --mock-shop - Use mock.shop as the data source for the storefront. - [env: SHOPIFY_HYDROGEN_FLAG_MOCK_DATA] + --no-input + Disable interactive prompts and browser authentication. + [env: SHOPIFY_FLAG_NO_INPUT] --path= - The path to the directory of the new Hydrogen storefront. + The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run. [env: SHOPIFY_HYDROGEN_FLAG_PATH] - --quickstart - Scaffolds a new Hydrogen project with a set of sensible defaults. Equivalent to `shopify hydrogen init --path - hydrogen-quickstart --mock-shop --language js --shortcut --markets none` - [env: SHOPIFY_HYDROGEN_FLAG_QUICKSTART] + --verbose + Increase the verbosity of the output. May include sensitive data. + [env: SHOPIFY_FLAG_VERBOSE] - --[no-]shortcut - Creates a global h2 shortcut for Shopify CLI using shell aliases. Deactivate with `--no-shortcut`. - [env: SHOPIFY_HYDROGEN_FLAG_SHORTCUT] +DESCRIPTION + Lists all remote Hydrogen storefronts available to link to your local development environment. - --styling= - Sets the styling strategy to use. One of `tailwind`, `vanilla-extract`, `css-modules`, `postcss`, `none`. - [env: SHOPIFY_HYDROGEN_FLAG_STYLING] + Use `--json-schema` to print the result, error, and event schemas. - --template= - Scaffolds project based on a template: `skeleton` (the default), `demo-store` or a URL to a git repository. - [env: SHOPIFY_HYDROGEN_FLAG_TEMPLATE] + Output from `--json` conforms to the `HydrogenListResult` schema. -DESCRIPTION - Creates a new Hydrogen storefront. + ```json + { + "type": "object", + "properties": { + "storeDomain": { + "anyOf": [ + { + "type": "string", + "pattern": "^[a-z0-9][a-z0-9-]*\\.myshopify\\.com$" + }, + { + "type": "null" + } + ] + }, + "storefronts": { + "type": "array", + "items": { + "$ref": "#/definitions/Storefront" + } + } + }, + "required": [ + "storeDomain", + "storefronts" + ], + "additionalProperties": false, + "description": "The complete list of Hydrogen storefronts for the store.", + "title": "HydrogenListResult", + "definitions": { + "Storefront": { + "type": "object", + "properties": { + "gid": { + "type": "string", + "pattern": "^gid:\\/\\/shopify\\/HydrogenStorefront\\/\\d+$", + "description": "A Shopify HydrogenStorefront GID." + }, + "name": { + "type": "string" + }, + "productionUrl": { + "anyOf": [ + { + "type": "string", + "format": "uri" + }, + { + "type": "null" + } + ] + }, + "currentProductionDeployment": { + "anyOf": [ + { + "$ref": "#/definitions/Deployment" + }, + { + "type": "null" + } + ] + } + }, + "required": [ + "gid", + "name", + "productionUrl", + "currentProductionDeployment" + ], + "additionalProperties": false, + "description": "All projected fields are present; unavailable productionUrl is null." + }, + "Deployment": { + "type": "object", + "properties": { + "gid": { + "type": "string", + "pattern": "^gid:\\/\\/shopify\\/HydrogenStorefrontDeployment\\/\\d+$", + "description": "A Shopify HydrogenStorefrontDeployment GID." + }, + "createdAt": { + "type": "string", + "format": "date-time" + }, + "commitMessage": { + "type": [ + "string", + "null" + ] + } + }, + "required": [ + "gid", + "createdAt", + "commitMessage" + ], + "additionalProperties": false + } + }, + "$schema": "http://json-schema.org/draft-07/schema#" + } + ``` ``` -## `shopify hydrogen link` +## `shopify hydrogen login` -Link a local project to one of your shop's Hydrogen storefronts. +Logs in to the specified shop and saves the shop domain to the project. ``` USAGE - $ shopify hydrogen link [--create-storefront | --storefront ] [-f] [--json-schema] [--name | ] - [--path ] [-s ] + $ shopify hydrogen login [-j] [--json-schema] [--no-color] [--no-input] [--path ] [-s ] [--verbose] FLAGS - -f, --force - Overwrites the destination directory and files if they already exist. - [env: SHOPIFY_HYDROGEN_FLAG_FORCE] + -j, --json + Output the result as JSON. Automatically disables color output. + [env: SHOPIFY_FLAG_JSON] -s, --shop= Shop URL. It can be the shop prefix (janes-apparel) or the full myshopify.com URL (janes-apparel.myshopify.com, https://janes-apparel.myshopify.com). [env: SHOPIFY_SHOP] - --create-storefront - Create a new Hydrogen storefront. - [env: SHOPIFY_HYDROGEN_FLAG_CREATE_STOREFRONT] - --json-schema Print the command's JSON schemas. [env: SHOPIFY_FLAG_JSON_SCHEMA] - --name= - The name to use when creating a new Hydrogen storefront. - [env: SHOPIFY_HYDROGEN_FLAG_NAME] + --no-color + Disable color output. + [env: SHOPIFY_FLAG_NO_COLOR] + + --no-input + Disable interactive prompts and browser authentication. + [env: SHOPIFY_FLAG_NO_INPUT] --path= The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run. [env: SHOPIFY_HYDROGEN_FLAG_PATH] - --storefront= - The name of a Hydrogen Storefront (e.g. "Jane's Apparel") - [env: SHOPIFY_HYDROGEN_STOREFRONT] + --verbose + Increase the verbosity of the output. May include sensitive data. + [env: SHOPIFY_FLAG_VERBOSE] DESCRIPTION - Link a local project to one of your shop's Hydrogen storefronts. -``` - -## `shopify hydrogen list` - -Returns a list of Hydrogen storefronts available on a given shop. - -``` -USAGE - $ shopify hydrogen list [--json-schema] [--path ] + Logs in to the specified shop and saves the shop domain to the project. -FLAGS - --json-schema - Print the command's JSON schemas. - [env: SHOPIFY_FLAG_JSON_SCHEMA] + Use `--json-schema` to print the result, error, and event schemas. - --path= - The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run. - [env: SHOPIFY_HYDROGEN_FLAG_PATH] + Output from `--json` conforms to the `HydrogenLoginResult` schema. -DESCRIPTION - Returns a list of Hydrogen storefronts available on a given shop. + ```json + { + "type": "object", + "properties": { + "storeDomain": { + "anyOf": [ + { + "type": "string", + "pattern": "^[a-z0-9][a-z0-9-]*\\.myshopify\\.com$" + }, + { + "type": "null" + } + ] + }, + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "anyOf": [ + { + "type": "string", + "format": "email" + }, + { + "type": "null" + } + ] + } + }, + "required": [ + "storeDomain", + "name", + "email" + ], + "additionalProperties": false, + "title": "HydrogenLoginResult", + "$schema": "http://json-schema.org/draft-07/schema#" + } + ``` ``` -## `shopify hydrogen login` +## `shopify hydrogen logout` -Login to your Shopify account. +Log out from the current shop. ``` USAGE - $ shopify hydrogen login [--json-schema] [--path ] [-s ] + $ shopify hydrogen logout [-j] [--json-schema] [--no-color] [--no-input] [--path ] [--verbose] FLAGS - -s, --shop= - Shop URL. It can be the shop prefix (janes-apparel) or the full myshopify.com URL (janes-apparel.myshopify.com, - https://janes-apparel.myshopify.com). - [env: SHOPIFY_SHOP] + -j, --json + Output the result as JSON. Automatically disables color output. + [env: SHOPIFY_FLAG_JSON] --json-schema Print the command's JSON schemas. [env: SHOPIFY_FLAG_JSON_SCHEMA] + --no-color + Disable color output. + [env: SHOPIFY_FLAG_NO_COLOR] + + --no-input + Disable interactive prompts and browser authentication. + [env: SHOPIFY_FLAG_NO_INPUT] + --path= The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run. [env: SHOPIFY_HYDROGEN_FLAG_PATH] -DESCRIPTION - Login to your Shopify account. -``` - -## `shopify hydrogen logout` - -Logout of your local session. + --verbose + Increase the verbosity of the output. May include sensitive data. + [env: SHOPIFY_FLAG_VERBOSE] -``` -USAGE - $ shopify hydrogen logout [--json-schema] [--path ] +DESCRIPTION + Log out from the current shop. -FLAGS - --json-schema - Print the command's JSON schemas. - [env: SHOPIFY_FLAG_JSON_SCHEMA] + Use `--json-schema` to print the result, error, and event schemas. - --path= - The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run. - [env: SHOPIFY_HYDROGEN_FLAG_PATH] + Output from `--json` conforms to the `HydrogenLogoutResult` schema. -DESCRIPTION - Logout of your local session. + ```json + { + "type": "object", + "properties": { + "status": { + "type": "string", + "const": "success" + }, + "loggedOut": { + "type": "boolean", + "const": true + } + }, + "required": [ + "status", + "loggedOut" + ], + "additionalProperties": false, + "title": "HydrogenLogoutResult", + "$schema": "http://json-schema.org/draft-07/schema#" + } + ``` ``` ## `shopify hydrogen preview` @@ -11338,8 +12853,8 @@ Runs a Hydrogen storefront in an Oxygen worker for production. ``` USAGE $ shopify hydrogen preview [--codegen-config-path [--codegen --build]] [--debug] [--entry ] [--env - | --env-branch ] [--env-file ] [--inspector-port ] [--json-schema] [--path ] - [--port ] [--verbose] [--watch ] + | --env-branch ] [--env-file ] [--inspector-port ] [--json-schema] [--no-color] + [--no-input] [--path ] [--port ] [--verbose] [--watch ] FLAGS --build @@ -11378,6 +12893,14 @@ FLAGS Print the command's JSON schemas. [env: SHOPIFY_FLAG_JSON_SCHEMA] + --no-color + Disable color output. + [env: SHOPIFY_FLAG_NO_COLOR] + + --no-input + Disable interactive prompts and browser authentication. + [env: SHOPIFY_FLAG_NO_INPUT] + --path= The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run. [env: SHOPIFY_HYDROGEN_FLAG_PATH] @@ -11397,19 +12920,183 @@ DESCRIPTION Runs a Hydrogen storefront in an Oxygen worker for production. ``` -## `shopify hydrogen setup` +## `shopify hydrogen setup` + +Scaffold routes and core functionality. + +``` +USAGE + $ shopify hydrogen setup [-f] [--install-deps] [-j] [--json-schema] [--markets ] [--no-color] [--no-input] + [--path ] [--shortcut] [--verbose] + +FLAGS + -f, --force + Overwrites the destination directory and files if they already exist. + [env: SHOPIFY_HYDROGEN_FLAG_FORCE] + + -j, --json + Output the result as JSON. Automatically disables color output. + [env: SHOPIFY_FLAG_JSON] + + --[no-]install-deps + Auto installs dependencies using the active package manager. + [env: SHOPIFY_HYDROGEN_FLAG_INSTALL_DEPS] + + --json-schema + Print the command's JSON schemas. + [env: SHOPIFY_FLAG_JSON_SCHEMA] + + --markets= + Sets the URL structure to support multiple markets. Must be one of: `subfolders`, `domains`, `subdomains`, `none`. + Example: `--markets subfolders`. + [env: SHOPIFY_HYDROGEN_FLAG_I18N] + + --no-color + Disable color output. + [env: SHOPIFY_FLAG_NO_COLOR] + + --no-input + Disable interactive prompts and browser authentication. + [env: SHOPIFY_FLAG_NO_INPUT] + + --path= + The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run. + [env: SHOPIFY_HYDROGEN_FLAG_PATH] + + --[no-]shortcut + Creates a global h2 shortcut for Shopify CLI using shell aliases. Deactivate with `--no-shortcut`. + [env: SHOPIFY_HYDROGEN_FLAG_SHORTCUT] + + --verbose + Increase the verbosity of the output. May include sensitive data. + [env: SHOPIFY_FLAG_VERBOSE] + +DESCRIPTION + Scaffold routes and core functionality. + + Use `--json-schema` to print the result, error, and event schemas. + + Output from `--json` conforms to the `HydrogenSetupResult` schema. + + ```json + { + "type": "object", + "properties": { + "status": { + "type": "string", + "const": "success" + }, + "changed": { + "type": "boolean" + }, + "directory": { + "type": "string" + }, + "name": { + "type": "string" + }, + "i18n": { + "anyOf": [ + { + "type": "string", + "enum": [ + "subfolders", + "domains", + "subdomains" + ] + }, + { + "type": "null" + } + ] + }, + "routes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "sourceRoute": { + "type": "string" + }, + "destinationRoute": { + "type": "string" + }, + "operation": { + "type": "string", + "enum": [ + "created", + "skipped", + "replaced" + ] + }, + "skipReason": { + "type": "string", + "enum": [ + "declined", + "exists" + ] + } + }, + "required": [ + "sourceRoute", + "destinationRoute", + "operation" + ], + "additionalProperties": false + } + }, + "routeGroups": { + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "shortcut": { + "type": "boolean" + } + }, + "required": [ + "status", + "changed", + "directory", + "name", + "i18n", + "routes", + "routeGroups", + "shortcut" + ], + "additionalProperties": false, + "title": "HydrogenSetupResult", + "$schema": "http://json-schema.org/draft-07/schema#" + } + ``` +``` + +## `shopify hydrogen setup css [STRATEGY]` -Scaffold routes and core functionality. +Adds support for certain CSS strategies to your project. ``` USAGE - $ shopify hydrogen setup [-f] [--install-deps] [--json-schema] [--markets ] [--path ] [--shortcut] + $ shopify hydrogen setup css [STRATEGY] [-f] [--install-deps] [-j] [--json-schema] [--no-color] [--no-input] [--path + ] [--verbose] + +ARGUMENTS + [STRATEGY] (tailwind|vanilla-extract|css-modules|postcss) The CSS strategy to setup. One of + tailwind,vanilla-extract,css-modules,postcss FLAGS -f, --force Overwrites the destination directory and files if they already exist. [env: SHOPIFY_HYDROGEN_FLAG_FORCE] + -j, --json + Output the result as JSON. Automatically disables color output. + [env: SHOPIFY_FLAG_JSON] + --[no-]install-deps Auto installs dependencies using the active package manager. [env: SHOPIFY_HYDROGEN_FLAG_INSTALL_DEPS] @@ -11418,153 +13105,473 @@ FLAGS Print the command's JSON schemas. [env: SHOPIFY_FLAG_JSON_SCHEMA] - --markets= - Sets the URL structure to support multiple markets. Must be one of: `subfolders`, `domains`, `subdomains`, `none`. - Example: `--markets subfolders`. - [env: SHOPIFY_HYDROGEN_FLAG_I18N] + --no-color + Disable color output. + [env: SHOPIFY_FLAG_NO_COLOR] + + --no-input + Disable interactive prompts and browser authentication. + [env: SHOPIFY_FLAG_NO_INPUT] --path= The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run. [env: SHOPIFY_HYDROGEN_FLAG_PATH] - --[no-]shortcut - Creates a global h2 shortcut for Shopify CLI using shell aliases. Deactivate with `--no-shortcut`. - [env: SHOPIFY_HYDROGEN_FLAG_SHORTCUT] + --verbose + Increase the verbosity of the output. May include sensitive data. + [env: SHOPIFY_FLAG_VERBOSE] DESCRIPTION - Scaffold routes and core functionality. + Adds support for certain CSS strategies to your project. + + Use `--json-schema` to print the result, error, and event schemas. + + Output from `--json` conforms to the `HydrogenSetupCssResult` schema. + + ```json + { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "success", + "cancelled" + ] + }, + "changed": { + "type": "boolean" + }, + "directory": { + "$ref": "#/definitions/AbsolutePath" + }, + "strategy": { + "type": "string", + "enum": [ + "tailwind", + "vanilla-extract", + "css-modules", + "postcss" + ] + }, + "filePaths": { + "type": "array", + "items": { + "$ref": "#/definitions/AbsolutePath" + } + }, + "dependenciesInstalled": { + "type": "boolean" + }, + "needsNpmReinstall": { + "type": "boolean" + } + }, + "required": [ + "status", + "changed", + "directory", + "strategy", + "filePaths", + "dependenciesInstalled", + "needsNpmReinstall" + ], + "additionalProperties": false, + "title": "HydrogenSetupCssResult", + "definitions": { + "AbsolutePath": { + "type": "string" + } + }, + "$schema": "http://json-schema.org/draft-07/schema#" + } + ``` ``` -## `shopify hydrogen setup css [STRATEGY]` +## `shopify hydrogen setup markets [STRATEGY]` -Setup CSS strategies for your project. +Adds support for multiple "markets" (https://shopify.dev/docs/custom-storefronts/hydrogen/markets) to your project by using the URL structure. ``` USAGE - $ shopify hydrogen setup css [STRATEGY] [-f] [--install-deps] [--json-schema] [--path ] + $ shopify hydrogen setup markets [STRATEGY] [-j] [--json-schema] [--no-color] [--no-input] [--path ] + [--verbose] ARGUMENTS - [STRATEGY] (tailwind|vanilla-extract|css-modules|postcss) The CSS strategy to setup. One of - tailwind,vanilla-extract,css-modules,postcss + [STRATEGY] (subfolders|domains|subdomains) The URL structure strategy to setup multiple markets. One of + subfolders,domains,subdomains FLAGS - -f, --force - Overwrites the destination directory and files if they already exist. - [env: SHOPIFY_HYDROGEN_FLAG_FORCE] - - --[no-]install-deps - Auto installs dependencies using the active package manager. - [env: SHOPIFY_HYDROGEN_FLAG_INSTALL_DEPS] + -j, --json + Output the result as JSON. Automatically disables color output. + [env: SHOPIFY_FLAG_JSON] --json-schema Print the command's JSON schemas. [env: SHOPIFY_FLAG_JSON_SCHEMA] + --no-color + Disable color output. + [env: SHOPIFY_FLAG_NO_COLOR] + + --no-input + Disable interactive prompts and browser authentication. + [env: SHOPIFY_FLAG_NO_INPUT] + --path= The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run. [env: SHOPIFY_HYDROGEN_FLAG_PATH] + --verbose + Increase the verbosity of the output. May include sensitive data. + [env: SHOPIFY_FLAG_VERBOSE] + DESCRIPTION - Setup CSS strategies for your project. + Adds support for multiple "markets" (https://shopify.dev/docs/custom-storefronts/hydrogen/markets) to your project by + using the URL structure. + + Use `--json-schema` to print the result, error, and event schemas. + + Output from `--json` conforms to the `HydrogenSetupMarketsResult` schema. + + ```json + { + "type": "object", + "properties": { + "status": { + "type": "string", + "const": "success" + }, + "changed": { + "type": "boolean", + "const": true + }, + "directory": { + "$ref": "#/definitions/AbsolutePath" + }, + "strategy": { + "type": "string", + "enum": [ + "subfolders", + "domains", + "subdomains" + ] + }, + "serverPath": { + "anyOf": [ + { + "$ref": "#/definitions/AbsolutePath" + }, + { + "type": "null" + } + ] + } + }, + "required": [ + "status", + "changed", + "directory", + "strategy", + "serverPath" + ], + "additionalProperties": false, + "title": "HydrogenSetupMarketsResult", + "definitions": { + "AbsolutePath": { + "type": "string" + } + }, + "$schema": "http://json-schema.org/draft-07/schema#" + } + ``` ``` -## `shopify hydrogen setup markets [STRATEGY]` +## `shopify hydrogen setup vite` -Setup support for multiple markets in your project. +EXPERIMENTAL: Upgrades the project to use Vite. ``` USAGE - $ shopify hydrogen setup markets [STRATEGY] [--json-schema] [--path ] - -ARGUMENTS - [STRATEGY] (subfolders|domains|subdomains) The URL structure strategy to setup multiple markets. One of - subfolders,domains,subdomains + $ shopify hydrogen setup vite [-j] [--json-schema] [--no-color] [--no-input] [--path ] [--verbose] FLAGS + -j, --json + Output the result as JSON. Automatically disables color output. + [env: SHOPIFY_FLAG_JSON] + --json-schema Print the command's JSON schemas. [env: SHOPIFY_FLAG_JSON_SCHEMA] + --no-color + Disable color output. + [env: SHOPIFY_FLAG_NO_COLOR] + + --no-input + Disable interactive prompts and browser authentication. + [env: SHOPIFY_FLAG_NO_INPUT] + --path= The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run. [env: SHOPIFY_HYDROGEN_FLAG_PATH] + --verbose + Increase the verbosity of the output. May include sensitive data. + [env: SHOPIFY_FLAG_VERBOSE] + DESCRIPTION - Setup support for multiple markets in your project. + EXPERIMENTAL: Upgrades the project to use Vite. + + Use `--json-schema` to print the result, error, and event schemas. + + Output from `--json` conforms to the `HydrogenSetupViteResult` schema. + + ```json + { + "type": "object", + "properties": { + "status": { + "type": "string", + "const": "success" + }, + "changed": { + "type": "boolean", + "const": true + }, + "directory": { + "$ref": "#/definitions/AbsolutePath" + }, + "viteConfigPath": { + "$ref": "#/definitions/AbsolutePath" + }, + "serverPath": { + "$ref": "#/definitions/AbsolutePath" + }, + "dependenciesInstalled": { + "type": "boolean", + "const": true + }, + "needsMdxSetup": { + "type": "boolean" + } + }, + "required": [ + "status", + "changed", + "directory", + "viteConfigPath", + "serverPath", + "dependenciesInstalled", + "needsMdxSetup" + ], + "additionalProperties": false, + "title": "HydrogenSetupViteResult", + "definitions": { + "AbsolutePath": { + "type": "string" + } + }, + "$schema": "http://json-schema.org/draft-07/schema#" + } + ``` ``` -## `shopify hydrogen setup vite` +## `shopify hydrogen shortcut` -EXPERIMENTAL: Upgrades the project to use Vite. +Creates a global h2 shortcut for Shopify CLI using shell aliases. ``` USAGE - $ shopify hydrogen setup vite [--json-schema] [--path ] + $ shopify hydrogen shortcut [-j] [--json-schema] [--no-color] [--no-input] [--verbose] FLAGS + -j, --json + Output the result as JSON. Automatically disables color output. + [env: SHOPIFY_FLAG_JSON] + --json-schema Print the command's JSON schemas. [env: SHOPIFY_FLAG_JSON_SCHEMA] - --path= - The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run. - [env: SHOPIFY_HYDROGEN_FLAG_PATH] + --no-color + Disable color output. + [env: SHOPIFY_FLAG_NO_COLOR] + + --no-input + Disable interactive prompts and browser authentication. + [env: SHOPIFY_FLAG_NO_INPUT] + + --verbose + Increase the verbosity of the output. May include sensitive data. + [env: SHOPIFY_FLAG_VERBOSE] DESCRIPTION - EXPERIMENTAL: Upgrades the project to use Vite. -``` + Creates a global h2 shortcut for Shopify CLI using shell aliases. -## `shopify hydrogen shortcut` + The following shells are supported: -Creates a global `h2` shortcut for the Hydrogen CLI + - Bash (using `~/.bashrc`) + - ZSH (using `~/.zshrc`) + - Fish (using `~/.config/fish/functions`) + - PowerShell (added to `$PROFILE`) -``` -USAGE - $ shopify hydrogen shortcut [--json-schema] + After the alias is created, you can call Shopify CLI from anywhere in your project using `h2 `. -FLAGS - --json-schema - Print the command's JSON schemas. - [env: SHOPIFY_FLAG_JSON_SCHEMA] + Use `--json-schema` to print the result, error, and event schemas. -DESCRIPTION - Creates a global `h2` shortcut for the Hydrogen CLI + Output from `--json` conforms to the `HydrogenShortcutResult` schema. + + ```json + { + "type": "object", + "properties": { + "status": { + "type": "string", + "const": "success" + }, + "changed": { + "type": "boolean" + }, + "alias": { + "type": "string" + }, + "shells": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "bash", + "zsh", + "fish", + "powershell", + "powershell-7", + "cmd" + ] + }, + "minItems": 1 + } + }, + "required": [ + "status", + "changed", + "alias", + "shells" + ], + "additionalProperties": false, + "title": "HydrogenShortcutResult", + "$schema": "http://json-schema.org/draft-07/schema#" + } + ``` ``` ## `shopify hydrogen unlink` -Unlink a local project from a Hydrogen storefront. +Unlinks your local development environment from a remote Hydrogen storefront. ``` USAGE - $ shopify hydrogen unlink [--json-schema] [--path ] + $ shopify hydrogen unlink [-j] [--json-schema] [--no-color] [--no-input] [--path ] [--verbose] FLAGS + -j, --json + Output the result as JSON. Automatically disables color output. + [env: SHOPIFY_FLAG_JSON] + --json-schema Print the command's JSON schemas. [env: SHOPIFY_FLAG_JSON_SCHEMA] + --no-color + Disable color output. + [env: SHOPIFY_FLAG_NO_COLOR] + + --no-input + Disable interactive prompts and browser authentication. + [env: SHOPIFY_FLAG_NO_INPUT] + --path= The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run. [env: SHOPIFY_HYDROGEN_FLAG_PATH] + --verbose + Increase the verbosity of the output. May include sensitive data. + [env: SHOPIFY_FLAG_VERBOSE] + DESCRIPTION - Unlink a local project from a Hydrogen storefront. + Unlinks your local development environment from a remote Hydrogen storefront. + + Use `--json-schema` to print the result, error, and event schemas. + + Output from `--json` conforms to the `HydrogenUnlinkResult` schema. + + ```json + { + "type": "object", + "properties": { + "status": { + "type": "string", + "const": "success" + }, + "changed": { + "type": "boolean" + }, + "storefront": { + "anyOf": [ + { + "type": "object", + "properties": { + "gid": { + "type": "string", + "pattern": "^gid:\\/\\/shopify\\/HydrogenStorefront\\/\\d+$", + "description": "A Shopify HydrogenStorefront GID." + }, + "name": { + "type": "string" + } + }, + "required": [ + "gid", + "name" + ], + "additionalProperties": false + }, + { + "type": "null" + } + ] + } + }, + "required": [ + "status", + "changed", + "storefront" + ], + "additionalProperties": false, + "title": "HydrogenUnlinkResult", + "$schema": "http://json-schema.org/draft-07/schema#" + } + ``` ``` ## `shopify hydrogen upgrade` -Upgrade Remix and Hydrogen npm dependencies. +Upgrade Hydrogen project dependencies, preview features, fixes and breaking changes. The command also generates an instruction file for each upgrade. ``` USAGE - $ shopify hydrogen upgrade [-f] [--json-schema] [--path ] [-v ] + $ shopify hydrogen upgrade [-f] [-j] [--json-schema] [--no-color] [--no-input] [--path ] [--verbose] [-v + ] FLAGS -f, --force Ignore warnings and force the upgrade to the target version [env: SHOPIFY_HYDROGEN_FLAG_FORCE] + -j, --json + Output the result as JSON. Automatically disables color output. + [env: SHOPIFY_FLAG_JSON] + -v, --version= A target hydrogen version to update to @@ -11572,12 +13579,150 @@ FLAGS Print the command's JSON schemas. [env: SHOPIFY_FLAG_JSON_SCHEMA] + --no-color + Disable color output. + [env: SHOPIFY_FLAG_NO_COLOR] + + --no-input + Disable interactive prompts and browser authentication. + [env: SHOPIFY_FLAG_NO_INPUT] + --path= The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run. [env: SHOPIFY_HYDROGEN_FLAG_PATH] + --verbose + Increase the verbosity of the output. May include sensitive data. + [env: SHOPIFY_FLAG_VERBOSE] + DESCRIPTION - Upgrade Remix and Hydrogen npm dependencies. + Upgrade Hydrogen project dependencies, preview features, fixes and breaking changes. The command also generates an + instruction file for each upgrade. + + Use `--json-schema` to print the result, error, and event schemas. + + Output from `--json` conforms to the `HydrogenUpgradeResult` schema. + + ```json + { + "anyOf": [ + { + "type": "object", + "properties": { + "status": { + "type": "string", + "const": "success" + }, + "directory": { + "$ref": "#/definitions/AbsolutePath" + }, + "previousVersion": { + "type": "string" + }, + "version": { + "type": "string" + }, + "changed": { + "type": "boolean", + "const": true + }, + "packages": { + "type": "array", + "items": { + "type": "string" + } + }, + "removedPackages": { + "type": "array", + "items": { + "type": "string" + } + }, + "instructionsPath": { + "anyOf": [ + { + "$ref": "#/definitions/AbsolutePath" + }, + { + "type": "null" + } + ] + } + }, + "required": [ + "status", + "directory", + "previousVersion", + "version", + "changed", + "packages", + "removedPackages", + "instructionsPath" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "status": { + "type": "string", + "const": "success" + }, + "directory": { + "$ref": "#/definitions/AbsolutePath" + }, + "previousVersion": { + "type": "string" + }, + "version": { + "type": "string" + }, + "changed": { + "type": "boolean", + "const": false + }, + "packages": { + "type": "array", + "items": { + "type": "string" + }, + "minItems": 0, + "maxItems": 0 + }, + "removedPackages": { + "type": "array", + "items": { + "type": "string" + }, + "minItems": 0, + "maxItems": 0 + }, + "instructionsPath": { + "type": "null" + } + }, + "required": [ + "status", + "directory", + "previousVersion", + "version", + "changed", + "packages", + "removedPackages", + "instructionsPath" + ], + "additionalProperties": false + } + ], + "title": "HydrogenUpgradeResult", + "definitions": { + "AbsolutePath": { + "type": "string" + } + }, + "$schema": "http://json-schema.org/draft-07/schema#" + } + ``` ``` ## `shopify organization list` diff --git a/packages/cli/oclif.manifest.json b/packages/cli/oclif.manifest.json index fda37b74010..4e988f32ced 100644 --- a/packages/cli/oclif.manifest.json +++ b/packages/cli/oclif.manifest.json @@ -6734,7 +6734,7 @@ "args": { }, "customPluginName": "@shopify/cli-hydrogen", - "description": "Builds a Hydrogen storefront for production.", + "description": "Builds a Hydrogen storefront for production. The client and app worker files are compiled to a `/dist` folder in your Hydrogen project directory.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `HydrogenBuildResult` schema.\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"directory\": {\n \"$ref\": \"#/definitions/AbsolutePath\"\n },\n \"clientDirectory\": {\n \"$ref\": \"#/definitions/AbsolutePath\"\n },\n \"serverDirectory\": {\n \"$ref\": \"#/definitions/AbsolutePath\"\n },\n \"serverPath\": {\n \"$ref\": \"#/definitions/AbsolutePath\"\n }\n },\n \"required\": [\n \"directory\",\n \"clientDirectory\",\n \"serverDirectory\",\n \"serverPath\"\n ],\n \"additionalProperties\": false,\n \"title\": \"HydrogenBuildResult\",\n \"definitions\": {\n \"AbsolutePath\": {\n \"type\": \"string\"\n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "descriptionWithMarkdown": "Builds a Hydrogen storefront for production. The client and app worker files are compiled to a `/dist` folder in your Hydrogen project directory.", "enableJsonFlag": false, "flags": { @@ -6784,6 +6784,15 @@ "name": "force-client-sourcemap", "type": "boolean" }, + "json": { + "allowNo": false, + "char": "j", + "description": "Output the result as JSON. Automatically disables color output.", + "env": "SHOPIFY_FLAG_JSON", + "hidden": false, + "name": "json", + "type": "boolean" + }, "json-schema": { "allowNo": false, "description": "Print the command's JSON schemas.", @@ -6798,6 +6807,21 @@ "name": "lockfile-check", "type": "boolean" }, + "no-color": { + "allowNo": false, + "description": "Disable color output.", + "env": "SHOPIFY_FLAG_NO_COLOR", + "hidden": false, + "name": "no-color", + "type": "boolean" + }, + "no-input": { + "allowNo": false, + "description": "Disable interactive prompts and browser authentication.", + "env": "SHOPIFY_FLAG_NO_INPUT", + "name": "no-input", + "type": "boolean" + }, "path": { "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.", "env": "SHOPIFY_HYDROGEN_FLAG_PATH", @@ -6813,6 +6837,14 @@ "name": "sourcemap", "type": "boolean" }, + "verbose": { + "allowNo": false, + "description": "Increase the verbosity of the output. May include sensitive data.", + "env": "SHOPIFY_FLAG_VERBOSE", + "hidden": false, + "name": "verbose", + "type": "boolean" + }, "watch": { "allowNo": false, "description": "Watches for changes and rebuilds the project writing output to disk.", @@ -6844,10 +6876,19 @@ } }, "customPluginName": "@shopify/cli-hydrogen", - "description": "Returns diagnostic information about a Hydrogen storefront.", + "description": "Checks whether your Hydrogen app includes a set of standard Shopify routes.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `HydrogenCheckResult` schema.\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"valid\": {\n \"type\": \"boolean\"\n },\n \"missingRoutes\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n },\n \"reservedRoutes\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n },\n \"required\": [\n \"valid\",\n \"missingRoutes\",\n \"reservedRoutes\"\n ],\n \"additionalProperties\": false,\n \"title\": \"HydrogenCheckResult\",\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "descriptionWithMarkdown": "Checks whether your Hydrogen app includes a set of standard Shopify routes.", "enableJsonFlag": false, "flags": { + "json": { + "allowNo": false, + "char": "j", + "description": "Output the result as JSON. Automatically disables color output.", + "env": "SHOPIFY_FLAG_JSON", + "hidden": false, + "name": "json", + "type": "boolean" + }, "json-schema": { "allowNo": false, "description": "Print the command's JSON schemas.", @@ -6855,6 +6896,21 @@ "name": "json-schema", "type": "boolean" }, + "no-color": { + "allowNo": false, + "description": "Disable color output.", + "env": "SHOPIFY_FLAG_NO_COLOR", + "hidden": false, + "name": "no-color", + "type": "boolean" + }, + "no-input": { + "allowNo": false, + "description": "Disable interactive prompts and browser authentication.", + "env": "SHOPIFY_FLAG_NO_INPUT", + "name": "no-input", + "type": "boolean" + }, "path": { "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.", "env": "SHOPIFY_HYDROGEN_FLAG_PATH", @@ -6862,6 +6918,14 @@ "multiple": false, "name": "path", "type": "option" + }, + "verbose": { + "allowNo": false, + "description": "Increase the verbosity of the output. May include sensitive data.", + "env": "SHOPIFY_FLAG_VERBOSE", + "hidden": false, + "name": "verbose", + "type": "boolean" } }, "hasDynamicHelp": false, @@ -6879,7 +6943,7 @@ "args": { }, "customPluginName": "@shopify/cli-hydrogen", - "description": "Generate types for the Storefront API queries found in your project.", + "description": "Automatically generates GraphQL types for your project’s Storefront API queries.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `HydrogenCodegenResult` schema.\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"files\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"path\": {\n \"type\": \"string\"\n },\n \"sources\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n },\n \"description\": \"Source patterns from the GraphQL codegen configuration.\"\n }\n },\n \"required\": [\n \"path\",\n \"sources\"\n ],\n \"additionalProperties\": false\n }\n }\n },\n \"required\": [\n \"files\"\n ],\n \"additionalProperties\": false,\n \"title\": \"HydrogenCodegenResult\",\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "descriptionWithMarkdown": "Automatically generates GraphQL types for your project’s Storefront API queries.", "enableJsonFlag": false, "flags": { @@ -6899,6 +6963,15 @@ "name": "force-sfapi-version", "type": "option" }, + "json": { + "allowNo": false, + "char": "j", + "description": "Output the result as JSON. Automatically disables color output.", + "env": "SHOPIFY_FLAG_JSON", + "hidden": false, + "name": "json", + "type": "boolean" + }, "json-schema": { "allowNo": false, "description": "Print the command's JSON schemas.", @@ -6906,6 +6979,21 @@ "name": "json-schema", "type": "boolean" }, + "no-color": { + "allowNo": false, + "description": "Disable color output.", + "env": "SHOPIFY_FLAG_NO_COLOR", + "hidden": false, + "name": "no-color", + "type": "boolean" + }, + "no-input": { + "allowNo": false, + "description": "Disable interactive prompts and browser authentication.", + "env": "SHOPIFY_FLAG_NO_INPUT", + "name": "no-input", + "type": "boolean" + }, "path": { "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.", "env": "SHOPIFY_HYDROGEN_FLAG_PATH", @@ -6914,6 +7002,14 @@ "name": "path", "type": "option" }, + "verbose": { + "allowNo": false, + "description": "Increase the verbosity of the output. May include sensitive data.", + "env": "SHOPIFY_FLAG_VERBOSE", + "hidden": false, + "name": "verbose", + "type": "boolean" + }, "watch": { "allowNo": false, "description": "Watch the project for changes to update types on file save.", @@ -6937,7 +7033,8 @@ "args": { }, "customPluginName": "@shopify/cli-hydrogen", - "description": "Push project configuration to admin", + "description": "Push project configuration to admin\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `HydrogenCustomerAccountPushResult` schema.\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"storefrontGid\": {\n \"type\": \"string\",\n \"pattern\": \"^gid:\\\\/\\\\/shopify\\\\/HydrogenStorefront\\\\/\\\\d+$\",\n \"description\": \"A Shopify HydrogenStorefront GID.\"\n },\n \"redirectUri\": {\n \"type\": \"string\",\n \"format\": \"uri\"\n },\n \"javascriptOrigin\": {\n \"type\": \"string\",\n \"format\": \"uri\"\n },\n \"logoutUri\": {\n \"type\": \"string\",\n \"format\": \"uri\"\n }\n },\n \"required\": [\n \"storefrontGid\",\n \"redirectUri\",\n \"javascriptOrigin\",\n \"logoutUri\"\n ],\n \"additionalProperties\": false,\n \"title\": \"HydrogenCustomerAccountPushResult\",\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", + "descriptionWithMarkdown": "Push project configuration to admin", "enableJsonFlag": false, "flags": { "dev-origin": { @@ -6955,6 +7052,15 @@ "name": "javascript-origin", "type": "option" }, + "json": { + "allowNo": false, + "char": "j", + "description": "Output the result as JSON. Automatically disables color output.", + "env": "SHOPIFY_FLAG_JSON", + "hidden": false, + "name": "json", + "type": "boolean" + }, "json-schema": { "allowNo": false, "description": "Print the command's JSON schemas.", @@ -6962,6 +7068,21 @@ "name": "json-schema", "type": "boolean" }, + "no-color": { + "allowNo": false, + "description": "Disable color output.", + "env": "SHOPIFY_FLAG_NO_COLOR", + "hidden": false, + "name": "no-color", + "type": "boolean" + }, + "no-input": { + "allowNo": false, + "description": "Disable interactive prompts and browser authentication.", + "env": "SHOPIFY_FLAG_NO_INPUT", + "name": "no-input", + "type": "boolean" + }, "path": { "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.", "env": "SHOPIFY_HYDROGEN_FLAG_PATH", @@ -6990,6 +7111,14 @@ "multiple": false, "name": "storefront-id", "type": "option" + }, + "verbose": { + "allowNo": false, + "description": "Increase the verbosity of the output. May include sensitive data.", + "env": "SHOPIFY_FLAG_VERBOSE", + "hidden": false, + "name": "verbose", + "type": "boolean" } }, "hasDynamicHelp": false, @@ -7026,6 +7155,21 @@ "name": "json-schema", "type": "boolean" }, + "no-color": { + "allowNo": false, + "description": "Disable color output.", + "env": "SHOPIFY_FLAG_NO_COLOR", + "hidden": false, + "name": "no-color", + "type": "boolean" + }, + "no-input": { + "allowNo": false, + "description": "Disable interactive prompts and browser authentication.", + "env": "SHOPIFY_FLAG_NO_INPUT", + "name": "no-input", + "type": "boolean" + }, "output": { "default": "startup.cpuprofile", "description": "Specify a path to generate the profile file. Defaults to \"startup.cpuprofile\".", @@ -7042,6 +7186,14 @@ "multiple": false, "name": "path", "type": "option" + }, + "verbose": { + "allowNo": false, + "description": "Increase the verbosity of the output. May include sensitive data.", + "env": "SHOPIFY_FLAG_VERBOSE", + "hidden": false, + "name": "verbose", + "type": "boolean" } }, "hasDynamicHelp": false, @@ -7059,7 +7211,7 @@ "args": { }, "customPluginName": "@shopify/cli-hydrogen", - "description": "Builds and deploys a Hydrogen storefront to Oxygen.", + "description": "Builds and deploys your Hydrogen storefront to Oxygen. Requires an Oxygen deployment token to be set with the `--token` flag or an environment variable (`SHOPIFY_HYDROGEN_DEPLOYMENT_TOKEN`). If the storefront is \"linked\" (https://shopify.dev/docs/api/shopify-cli/hydrogen/hydrogen-link) then the Oxygen deployment token for the linked storefront will be used automatically.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `HydrogenDeployResult` schema.\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"enum\": [\n \"success\",\n \"cancelled\"\n ]\n },\n \"deployment\": {\n \"anyOf\": [\n {\n \"$ref\": \"#/definitions/Deployment\"\n },\n {\n \"type\": \"null\"\n }\n ]\n }\n },\n \"required\": [\n \"status\",\n \"deployment\"\n ],\n \"additionalProperties\": false,\n \"description\": \"The command result. The existing h2_deploy_log.json file retains Oxygen CompletedDeployment format, independently of this result.\",\n \"title\": \"HydrogenDeployResult\",\n \"definitions\": {\n \"Deployment\": {\n \"type\": \"object\",\n \"properties\": {\n \"url\": {\n \"type\": \"string\",\n \"format\": \"uri\"\n },\n \"authBypassToken\": {\n \"type\": [\n \"string\",\n \"null\"\n ]\n }\n },\n \"required\": [\n \"url\",\n \"authBypassToken\"\n ],\n \"additionalProperties\": false\n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "descriptionWithMarkdown": "Builds and deploys your Hydrogen storefront to Oxygen. Requires an Oxygen deployment token to be set with the `--token` flag or an environment variable (`SHOPIFY_HYDROGEN_DEPLOYMENT_TOKEN`). If the storefront is [linked](https://shopify.dev/docs/api/shopify-cli/hydrogen/hydrogen-link) then the Oxygen deployment token for the linked storefront will be used automatically.", "enableJsonFlag": false, "flags": { @@ -7154,6 +7306,15 @@ "name": "force-client-sourcemap", "type": "boolean" }, + "json": { + "allowNo": false, + "char": "j", + "description": "Output the result as JSON. Automatically disables color output.", + "env": "SHOPIFY_FLAG_JSON", + "hidden": false, + "name": "json", + "type": "boolean" + }, "json-output": { "allowNo": true, "description": "Create a JSON file containing the deployment details in CI environments. Defaults to true, use `--no-json-output` to disable.", @@ -7211,6 +7372,21 @@ "required": false, "type": "option" }, + "no-color": { + "allowNo": false, + "description": "Disable color output.", + "env": "SHOPIFY_FLAG_NO_COLOR", + "hidden": false, + "name": "no-color", + "type": "boolean" + }, + "no-input": { + "allowNo": false, + "description": "Disable interactive prompts and browser authentication.", + "env": "SHOPIFY_FLAG_NO_INPUT", + "name": "no-input", + "type": "boolean" + }, "no-verify": { "allowNo": false, "description": "Skip the routability verification step after deployment.", @@ -7252,6 +7428,14 @@ "required": false, "type": "option" }, + "verbose": { + "allowNo": false, + "description": "Increase the verbosity of the output. May include sensitive data.", + "env": "SHOPIFY_FLAG_VERBOSE", + "hidden": false, + "name": "verbose", + "type": "boolean" + }, "worker-dir": { "description": "Directory containing the Oxygen worker entry point (`index.js` or `index.mjs`), relative to the project root. Defaults to the detected Vite server output directory, then falls back to `dist/server`.", "env": "SHOPIFY_HYDROGEN_FLAG_WORKER_DIR", @@ -7396,6 +7580,21 @@ "name": "json-schema", "type": "boolean" }, + "no-color": { + "allowNo": false, + "description": "Disable color output.", + "env": "SHOPIFY_FLAG_NO_COLOR", + "hidden": false, + "name": "no-color", + "type": "boolean" + }, + "no-input": { + "allowNo": false, + "description": "Disable interactive prompts and browser authentication.", + "env": "SHOPIFY_FLAG_NO_INPUT", + "name": "no-input", + "type": "boolean" + }, "path": { "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.", "env": "SHOPIFY_HYDROGEN_FLAG_PATH", @@ -7437,10 +7636,19 @@ "args": { }, "customPluginName": "@shopify/cli-hydrogen", - "description": "List the environments on your linked Hydrogen storefront.", + "description": "Lists all environments available on the linked Hydrogen storefront.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `HydrogenEnvListResult` schema.\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"enum\": [\n \"success\",\n \"cancelled\"\n ]\n },\n \"storefront\": {\n \"anyOf\": [\n {\n \"$ref\": \"#/definitions/Storefront\"\n },\n {\n \"type\": \"null\"\n }\n ]\n },\n \"environments\": {\n \"type\": \"array\",\n \"items\": {\n \"$ref\": \"#/definitions/Environment\"\n }\n }\n },\n \"required\": [\n \"status\",\n \"storefront\",\n \"environments\"\n ],\n \"additionalProperties\": false,\n \"description\": \"The complete environment list for the linked storefront.\",\n \"title\": \"HydrogenEnvListResult\",\n \"definitions\": {\n \"Environment\": {\n \"type\": \"object\",\n \"properties\": {\n \"gid\": {\n \"type\": \"string\",\n \"pattern\": \"^gid:\\\\/\\\\/shopify\\\\/HydrogenStorefrontEnvironment\\\\/\\\\d+$\",\n \"description\": \"A Shopify HydrogenStorefrontEnvironment GID.\"\n },\n \"name\": {\n \"type\": \"string\"\n },\n \"handle\": {\n \"type\": \"string\"\n },\n \"branch\": {\n \"type\": [\n \"string\",\n \"null\"\n ]\n },\n \"createdAt\": {\n \"type\": \"string\",\n \"format\": \"date-time\"\n },\n \"type\": {\n \"type\": \"string\",\n \"description\": \"Upstream environment type; known values are PREVIEW, PRODUCTION, CUSTOM.\"\n },\n \"url\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"format\": \"uri\"\n },\n {\n \"type\": \"null\"\n }\n ]\n }\n },\n \"required\": [\n \"gid\",\n \"name\",\n \"handle\",\n \"branch\",\n \"createdAt\",\n \"type\",\n \"url\"\n ],\n \"additionalProperties\": false\n },\n \"Storefront\": {\n \"type\": \"object\",\n \"properties\": {\n \"gid\": {\n \"type\": \"string\",\n \"pattern\": \"^gid:\\\\/\\\\/shopify\\\\/HydrogenStorefront\\\\/\\\\d+$\",\n \"description\": \"A Shopify HydrogenStorefront GID.\"\n },\n \"name\": {\n \"type\": \"string\"\n },\n \"productionUrl\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"format\": \"uri\"\n },\n {\n \"type\": \"null\"\n }\n ]\n }\n },\n \"required\": [\n \"gid\",\n \"name\",\n \"productionUrl\"\n ],\n \"additionalProperties\": false\n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "descriptionWithMarkdown": "Lists all environments available on the linked Hydrogen storefront.", "enableJsonFlag": false, "flags": { + "json": { + "allowNo": false, + "char": "j", + "description": "Output the result as JSON. Automatically disables color output.", + "env": "SHOPIFY_FLAG_JSON", + "hidden": false, + "name": "json", + "type": "boolean" + }, "json-schema": { "allowNo": false, "description": "Print the command's JSON schemas.", @@ -7448,6 +7656,21 @@ "name": "json-schema", "type": "boolean" }, + "no-color": { + "allowNo": false, + "description": "Disable color output.", + "env": "SHOPIFY_FLAG_NO_COLOR", + "hidden": false, + "name": "no-color", + "type": "boolean" + }, + "no-input": { + "allowNo": false, + "description": "Disable interactive prompts and browser authentication.", + "env": "SHOPIFY_FLAG_NO_INPUT", + "name": "no-input", + "type": "boolean" + }, "path": { "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.", "env": "SHOPIFY_HYDROGEN_FLAG_PATH", @@ -7455,6 +7678,14 @@ "multiple": false, "name": "path", "type": "option" + }, + "verbose": { + "allowNo": false, + "description": "Increase the verbosity of the output. May include sensitive data.", + "env": "SHOPIFY_FLAG_VERBOSE", + "hidden": false, + "name": "verbose", + "type": "boolean" } }, "hasDynamicHelp": false, @@ -7472,7 +7703,7 @@ "args": { }, "customPluginName": "@shopify/cli-hydrogen", - "description": "Populate your .env with variables from your Hydrogen storefront.", + "description": "Pulls environment variables from the linked Hydrogen storefront and writes them to an `.env` file.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `HydrogenEnvPullResult` schema.\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"enum\": [\n \"success\",\n \"cancelled\"\n ]\n },\n \"changed\": {\n \"type\": \"boolean\"\n },\n \"path\": {\n \"type\": \"string\"\n },\n \"storefrontGid\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"pattern\": \"^gid:\\\\/\\\\/shopify\\\\/HydrogenStorefront\\\\/\\\\d+$\",\n \"description\": \"A Shopify HydrogenStorefront GID.\"\n },\n {\n \"type\": \"null\"\n }\n ],\n \"description\": \"A Shopify HydrogenStorefront GID.\"\n },\n \"storefrontName\": {\n \"type\": [\n \"string\",\n \"null\"\n ]\n },\n \"environment\": {\n \"anyOf\": [\n {\n \"$ref\": \"#/definitions/Environment\"\n },\n {\n \"type\": \"null\"\n }\n ]\n },\n \"variables\": {\n \"type\": \"array\",\n \"items\": {\n \"$ref\": \"#/definitions/Variable\"\n }\n }\n },\n \"required\": [\n \"status\",\n \"changed\",\n \"path\",\n \"storefrontGid\",\n \"storefrontName\",\n \"environment\",\n \"variables\"\n ],\n \"additionalProperties\": false,\n \"description\": \"The dotenv file keeps its native format. The result reports variable metadata without values.\",\n \"title\": \"HydrogenEnvPullResult\",\n \"definitions\": {\n \"Environment\": {\n \"type\": \"object\",\n \"properties\": {\n \"gid\": {\n \"type\": \"string\",\n \"pattern\": \"^gid:\\\\/\\\\/shopify\\\\/HydrogenStorefrontEnvironment\\\\/\\\\d+$\",\n \"description\": \"A Shopify HydrogenStorefrontEnvironment GID.\"\n },\n \"name\": {\n \"type\": \"string\"\n },\n \"handle\": {\n \"type\": \"string\"\n },\n \"branch\": {\n \"type\": [\n \"string\",\n \"null\"\n ]\n },\n \"createdAt\": {\n \"type\": \"string\",\n \"format\": \"date-time\"\n },\n \"type\": {\n \"type\": \"string\",\n \"description\": \"Upstream environment type; known values are PREVIEW, PRODUCTION, CUSTOM.\"\n },\n \"url\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"format\": \"uri\"\n },\n {\n \"type\": \"null\"\n }\n ]\n }\n },\n \"required\": [\n \"gid\",\n \"name\",\n \"handle\",\n \"branch\",\n \"createdAt\",\n \"type\",\n \"url\"\n ],\n \"additionalProperties\": false\n },\n \"Variable\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"id\": {\n \"type\": \"string\",\n \"pattern\": \"^\\\\d+$\",\n \"description\": \"The decimal HydrogenStorefrontEnvironmentVariable ID, not a GID.\"\n },\n \"isSecret\": {\n \"type\": \"boolean\"\n },\n \"readOnly\": {\n \"type\": \"boolean\"\n }\n },\n \"required\": [\n \"name\"\n ],\n \"additionalProperties\": false,\n \"description\": \"Metadata only: variable spelling is preserved and values are never included. Unknown metadata is omitted.\"\n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "descriptionWithMarkdown": "Pulls environment variables from the linked Hydrogen storefront and writes them to an `.env` file.", "enableJsonFlag": false, "flags": { @@ -7515,6 +7746,15 @@ "name": "force", "type": "boolean" }, + "json": { + "allowNo": false, + "char": "j", + "description": "Output the result as JSON. Automatically disables color output.", + "env": "SHOPIFY_FLAG_JSON", + "hidden": false, + "name": "json", + "type": "boolean" + }, "json-schema": { "allowNo": false, "description": "Print the command's JSON schemas.", @@ -7522,6 +7762,21 @@ "name": "json-schema", "type": "boolean" }, + "no-color": { + "allowNo": false, + "description": "Disable color output.", + "env": "SHOPIFY_FLAG_NO_COLOR", + "hidden": false, + "name": "no-color", + "type": "boolean" + }, + "no-input": { + "allowNo": false, + "description": "Disable interactive prompts and browser authentication.", + "env": "SHOPIFY_FLAG_NO_INPUT", + "name": "no-input", + "type": "boolean" + }, "path": { "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.", "env": "SHOPIFY_HYDROGEN_FLAG_PATH", @@ -7529,8 +7784,16 @@ "multiple": false, "name": "path", "type": "option" - } - }, + }, + "verbose": { + "allowNo": false, + "description": "Increase the verbosity of the output. May include sensitive data.", + "env": "SHOPIFY_FLAG_VERBOSE", + "hidden": false, + "name": "verbose", + "type": "boolean" + } + }, "hasDynamicHelp": false, "hiddenAliases": [ ], @@ -7546,7 +7809,8 @@ "args": { }, "customPluginName": "@shopify/cli-hydrogen", - "description": "Push environment variables from the local .env file to your linked Hydrogen storefront.", + "description": "Push environment variables from the local .env file to your linked Hydrogen storefront.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `HydrogenEnvPushResult` schema.\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"enum\": [\n \"success\",\n \"cancelled\"\n ]\n },\n \"changed\": {\n \"type\": \"boolean\"\n },\n \"wouldChange\": {\n \"type\": \"boolean\",\n \"description\": \"Whether the compared local and remote variables differ, excluding protected variables.\"\n },\n \"dryRun\": {\n \"type\": \"boolean\"\n },\n \"path\": {\n \"type\": \"string\"\n },\n \"environment\": {\n \"anyOf\": [\n {\n \"$ref\": \"#/definitions/Environment\"\n },\n {\n \"type\": \"null\"\n }\n ]\n },\n \"variables\": {\n \"type\": \"array\",\n \"items\": {\n \"$ref\": \"#/definitions/Variable\"\n }\n },\n \"skipped\": {\n \"type\": \"array\",\n \"items\": {\n \"$ref\": \"#/definitions/Variable\"\n }\n }\n },\n \"required\": [\n \"status\",\n \"changed\",\n \"wouldChange\",\n \"dryRun\",\n \"path\",\n \"environment\",\n \"variables\",\n \"skipped\"\n ],\n \"additionalProperties\": false,\n \"title\": \"HydrogenEnvPushResult\",\n \"definitions\": {\n \"Environment\": {\n \"type\": \"object\",\n \"properties\": {\n \"gid\": {\n \"type\": \"string\",\n \"pattern\": \"^gid:\\\\/\\\\/shopify\\\\/HydrogenStorefrontEnvironment\\\\/\\\\d+$\",\n \"description\": \"A Shopify HydrogenStorefrontEnvironment GID.\"\n },\n \"name\": {\n \"type\": \"string\"\n },\n \"handle\": {\n \"type\": \"string\"\n },\n \"branch\": {\n \"type\": [\n \"string\",\n \"null\"\n ]\n },\n \"createdAt\": {\n \"type\": \"string\",\n \"format\": \"date-time\"\n },\n \"type\": {\n \"type\": \"string\",\n \"description\": \"Upstream environment type; known values are PREVIEW, PRODUCTION, CUSTOM.\"\n },\n \"url\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"format\": \"uri\"\n },\n {\n \"type\": \"null\"\n }\n ]\n }\n },\n \"required\": [\n \"gid\",\n \"name\",\n \"handle\",\n \"branch\",\n \"createdAt\",\n \"type\",\n \"url\"\n ],\n \"additionalProperties\": false\n },\n \"Variable\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"id\": {\n \"type\": \"string\",\n \"pattern\": \"^\\\\d+$\",\n \"description\": \"The decimal HydrogenStorefrontEnvironmentVariable ID, not a GID.\"\n },\n \"isSecret\": {\n \"type\": \"boolean\"\n },\n \"readOnly\": {\n \"type\": \"boolean\"\n }\n },\n \"required\": [\n \"name\"\n ],\n \"additionalProperties\": false,\n \"description\": \"Metadata only: variable spelling is preserved and values are never included. Unknown metadata is omitted.\"\n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", + "descriptionWithMarkdown": "Push environment variables from the local .env file to your linked Hydrogen storefront.", "enableJsonFlag": false, "flags": { "dry-run": { @@ -7586,6 +7850,15 @@ "name": "force", "type": "boolean" }, + "json": { + "allowNo": false, + "char": "j", + "description": "Output the result as JSON. Automatically disables color output.", + "env": "SHOPIFY_FLAG_JSON", + "hidden": false, + "name": "json", + "type": "boolean" + }, "json-schema": { "allowNo": false, "description": "Print the command's JSON schemas.", @@ -7593,6 +7866,21 @@ "name": "json-schema", "type": "boolean" }, + "no-color": { + "allowNo": false, + "description": "Disable color output.", + "env": "SHOPIFY_FLAG_NO_COLOR", + "hidden": false, + "name": "no-color", + "type": "boolean" + }, + "no-input": { + "allowNo": false, + "description": "Disable interactive prompts and browser authentication.", + "env": "SHOPIFY_FLAG_NO_INPUT", + "name": "no-input", + "type": "boolean" + }, "path": { "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.", "env": "SHOPIFY_HYDROGEN_FLAG_PATH", @@ -7600,6 +7888,14 @@ "multiple": false, "name": "path", "type": "option" + }, + "verbose": { + "allowNo": false, + "description": "Increase the verbosity of the output. May include sensitive data.", + "env": "SHOPIFY_FLAG_VERBOSE", + "hidden": false, + "name": "verbose", + "type": "boolean" } }, "hasDynamicHelp": false, @@ -7626,6 +7922,29 @@ "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "type": "boolean" + }, + "no-color": { + "allowNo": false, + "description": "Disable color output.", + "env": "SHOPIFY_FLAG_NO_COLOR", + "hidden": false, + "name": "no-color", + "type": "boolean" + }, + "no-input": { + "allowNo": false, + "description": "Disable interactive prompts and browser authentication.", + "env": "SHOPIFY_FLAG_NO_INPUT", + "name": "no-input", + "type": "boolean" + }, + "verbose": { + "allowNo": false, + "description": "Increase the verbosity of the output. May include sensitive data.", + "env": "SHOPIFY_FLAG_VERBOSE", + "hidden": false, + "name": "verbose", + "type": "boolean" } }, "hasDynamicHelp": false, @@ -7663,7 +7982,7 @@ } }, "customPluginName": "@shopify/cli-hydrogen", - "description": "Generates a standard Shopify route.", + "description": "Generates a set of default routes from the starter template.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `HydrogenGenerateRoutesResult` schema.\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"enum\": [\n \"success\",\n \"skipped\"\n ]\n },\n \"changed\": {\n \"type\": \"boolean\"\n },\n \"routes\": {\n \"type\": \"array\",\n \"items\": {\n \"$ref\": \"#/definitions/Route\"\n }\n },\n \"routeGroups\": {\n \"type\": \"object\",\n \"additionalProperties\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n },\n \"isTypescript\": {\n \"type\": \"boolean\"\n }\n },\n \"required\": [\n \"status\",\n \"changed\",\n \"routes\",\n \"routeGroups\",\n \"isTypescript\"\n ],\n \"additionalProperties\": false,\n \"title\": \"HydrogenGenerateRoutesResult\",\n \"definitions\": {\n \"Route\": {\n \"type\": \"object\",\n \"properties\": {\n \"sourceRoute\": {\n \"type\": \"string\"\n },\n \"destinationRoute\": {\n \"type\": \"string\"\n },\n \"operation\": {\n \"type\": \"string\",\n \"enum\": [\n \"created\",\n \"skipped\",\n \"replaced\"\n ]\n },\n \"skipReason\": {\n \"type\": \"string\",\n \"enum\": [\n \"declined\",\n \"exists\"\n ]\n }\n },\n \"required\": [\n \"sourceRoute\",\n \"destinationRoute\",\n \"operation\"\n ],\n \"additionalProperties\": false\n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "descriptionWithMarkdown": "Generates a set of default routes from the starter template.", "enableJsonFlag": false, "flags": { @@ -7683,6 +8002,15 @@ "name": "force", "type": "boolean" }, + "json": { + "allowNo": false, + "char": "j", + "description": "Output the result as JSON. Automatically disables color output.", + "env": "SHOPIFY_FLAG_JSON", + "hidden": false, + "name": "json", + "type": "boolean" + }, "json-schema": { "allowNo": false, "description": "Print the command's JSON schemas.", @@ -7698,6 +8026,21 @@ "name": "locale-param", "type": "option" }, + "no-color": { + "allowNo": false, + "description": "Disable color output.", + "env": "SHOPIFY_FLAG_NO_COLOR", + "hidden": false, + "name": "no-color", + "type": "boolean" + }, + "no-input": { + "allowNo": false, + "description": "Disable interactive prompts and browser authentication.", + "env": "SHOPIFY_FLAG_NO_INPUT", + "name": "no-input", + "type": "boolean" + }, "path": { "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.", "env": "SHOPIFY_HYDROGEN_FLAG_PATH", @@ -7712,6 +8055,14 @@ "env": "SHOPIFY_HYDROGEN_FLAG_TYPESCRIPT", "name": "typescript", "type": "boolean" + }, + "verbose": { + "allowNo": false, + "description": "Increase the verbosity of the output. May include sensitive data.", + "env": "SHOPIFY_FLAG_VERBOSE", + "hidden": false, + "name": "verbose", + "type": "boolean" } }, "hasDynamicHelp": false, @@ -7729,7 +8080,8 @@ "args": { }, "customPluginName": "@shopify/cli-hydrogen", - "description": "Generates all supported standard shopify routes.", + "description": "Generates all supported standard shopify routes.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `HydrogenGenerateRoutesResult` schema.\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"enum\": [\n \"success\",\n \"skipped\"\n ]\n },\n \"changed\": {\n \"type\": \"boolean\"\n },\n \"routes\": {\n \"type\": \"array\",\n \"items\": {\n \"$ref\": \"#/definitions/Route\"\n }\n },\n \"routeGroups\": {\n \"type\": \"object\",\n \"additionalProperties\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n },\n \"isTypescript\": {\n \"type\": \"boolean\"\n }\n },\n \"required\": [\n \"status\",\n \"changed\",\n \"routes\",\n \"routeGroups\",\n \"isTypescript\"\n ],\n \"additionalProperties\": false,\n \"title\": \"HydrogenGenerateRoutesResult\",\n \"definitions\": {\n \"Route\": {\n \"type\": \"object\",\n \"properties\": {\n \"sourceRoute\": {\n \"type\": \"string\"\n },\n \"destinationRoute\": {\n \"type\": \"string\"\n },\n \"operation\": {\n \"type\": \"string\",\n \"enum\": [\n \"created\",\n \"skipped\",\n \"replaced\"\n ]\n },\n \"skipReason\": {\n \"type\": \"string\",\n \"enum\": [\n \"declined\",\n \"exists\"\n ]\n }\n },\n \"required\": [\n \"sourceRoute\",\n \"destinationRoute\",\n \"operation\"\n ],\n \"additionalProperties\": false\n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", + "descriptionWithMarkdown": "Generates all supported standard shopify routes.", "enableJsonFlag": false, "flags": { "adapter": { @@ -7748,6 +8100,15 @@ "name": "force", "type": "boolean" }, + "json": { + "allowNo": false, + "char": "j", + "description": "Output the result as JSON. Automatically disables color output.", + "env": "SHOPIFY_FLAG_JSON", + "hidden": false, + "name": "json", + "type": "boolean" + }, "json-schema": { "allowNo": false, "description": "Print the command's JSON schemas.", @@ -7763,6 +8124,21 @@ "name": "locale-param", "type": "option" }, + "no-color": { + "allowNo": false, + "description": "Disable color output.", + "env": "SHOPIFY_FLAG_NO_COLOR", + "hidden": false, + "name": "no-color", + "type": "boolean" + }, + "no-input": { + "allowNo": false, + "description": "Disable interactive prompts and browser authentication.", + "env": "SHOPIFY_FLAG_NO_INPUT", + "name": "no-input", + "type": "boolean" + }, "path": { "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.", "env": "SHOPIFY_HYDROGEN_FLAG_PATH", @@ -7777,6 +8153,14 @@ "env": "SHOPIFY_HYDROGEN_FLAG_TYPESCRIPT", "name": "typescript", "type": "boolean" + }, + "verbose": { + "allowNo": false, + "description": "Increase the verbosity of the output. May include sensitive data.", + "env": "SHOPIFY_FLAG_VERBOSE", + "hidden": false, + "name": "verbose", + "type": "boolean" } }, "hasDynamicHelp": false, @@ -7794,7 +8178,7 @@ "args": { }, "customPluginName": "@shopify/cli-hydrogen", - "description": "Creates a new Hydrogen storefront.", + "description": "Creates a new Hydrogen storefront.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `HydrogenInitResult` schema.\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"enum\": [\n \"success\",\n \"partial\",\n \"skipped\",\n \"cancelled\"\n ]\n },\n \"project\": {\n \"anyOf\": [\n {\n \"$ref\": \"#/definitions/Project\"\n },\n {\n \"type\": \"null\"\n }\n ],\n \"description\": \"All projected fields are present; unavailable settings are null. Route values are relative route names.\"\n },\n \"failures\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\",\n \"enum\": [\n \"dependencies\",\n \"markets\",\n \"routes\"\n ]\n }\n }\n },\n \"required\": [\n \"status\",\n \"project\",\n \"failures\"\n ],\n \"additionalProperties\": false,\n \"title\": \"HydrogenInitResult\",\n \"definitions\": {\n \"Project\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"directory\": {\n \"type\": \"string\"\n },\n \"storefrontName\": {\n \"type\": [\n \"string\",\n \"null\"\n ]\n },\n \"language\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"enum\": [\n \"js\",\n \"ts\"\n ]\n },\n {\n \"type\": \"null\"\n }\n ]\n },\n \"packageManager\": {\n \"type\": \"string\",\n \"enum\": [\n \"npm\",\n \"pnpm\",\n \"yarn\",\n \"bun\",\n \"unknown\"\n ]\n },\n \"dependenciesInstalled\": {\n \"type\": \"boolean\"\n },\n \"cssStrategy\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"enum\": [\n \"none\",\n \"tailwind\",\n \"vanilla-extract\",\n \"css-modules\",\n \"postcss\"\n ]\n },\n {\n \"type\": \"null\"\n }\n ]\n },\n \"i18n\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"enum\": [\n \"none\",\n \"subfolders\",\n \"domains\",\n \"subdomains\"\n ]\n },\n {\n \"type\": \"null\"\n }\n ]\n },\n \"routes\": {\n \"anyOf\": [\n {\n \"type\": \"object\",\n \"additionalProperties\": {\n \"anyOf\": [\n {\n \"type\": \"string\"\n },\n {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n ]\n }\n },\n {\n \"type\": \"null\"\n }\n ]\n }\n },\n \"required\": [\n \"name\",\n \"directory\",\n \"storefrontName\",\n \"language\",\n \"packageManager\",\n \"dependenciesInstalled\",\n \"cssStrategy\",\n \"i18n\",\n \"routes\"\n ],\n \"additionalProperties\": false,\n \"description\": \"All projected fields are present; unavailable settings are null. Route values are relative route names.\"\n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "descriptionWithMarkdown": "Creates a new Hydrogen storefront.", "enableJsonFlag": false, "flags": { @@ -7820,6 +8204,15 @@ "name": "install-deps", "type": "boolean" }, + "json": { + "allowNo": false, + "char": "j", + "description": "Output the result as JSON. Automatically disables color output.", + "env": "SHOPIFY_FLAG_JSON", + "hidden": false, + "name": "json", + "type": "boolean" + }, "json-schema": { "allowNo": false, "description": "Print the command's JSON schemas.", @@ -7850,6 +8243,21 @@ "name": "mock-shop", "type": "boolean" }, + "no-color": { + "allowNo": false, + "description": "Disable color output.", + "env": "SHOPIFY_FLAG_NO_COLOR", + "hidden": false, + "name": "no-color", + "type": "boolean" + }, + "no-input": { + "allowNo": false, + "description": "Disable interactive prompts and browser authentication.", + "env": "SHOPIFY_FLAG_NO_INPUT", + "name": "no-input", + "type": "boolean" + }, "package-manager": { "env": "SHOPIFY_HYDROGEN_FLAG_PACKAGE_MANAGER", "hasDynamicHelp": false, @@ -7901,6 +8309,14 @@ "multiple": false, "name": "template", "type": "option" + }, + "verbose": { + "allowNo": false, + "description": "Increase the verbosity of the output. May include sensitive data.", + "env": "SHOPIFY_FLAG_VERBOSE", + "hidden": false, + "name": "verbose", + "type": "boolean" } }, "hasDynamicHelp": false, @@ -7918,7 +8334,7 @@ "args": { }, "customPluginName": "@shopify/cli-hydrogen", - "description": "Link a local project to one of your shop's Hydrogen storefronts.", + "description": "Links your local development environment to a remote Hydrogen storefront. You can link an unlimited number of development environments to a single Hydrogen storefront.\n\n Linking to a Hydrogen storefront enables you to run \"dev\" (https://shopify.dev/docs/api/shopify-cli/hydrogen/hydrogen-dev) and automatically inject your linked Hydrogen storefront's environment variables directly into the server runtime.\n\n After you run the `link` command, you can access the \"env list\" (https://shopify.dev/docs/api/shopify-cli/hydrogen/hydrogen-env-list), \"env pull\" (https://shopify.dev/docs/api/shopify-cli/hydrogen/hydrogen-env-pull), and \"unlink\" (https://shopify.dev/docs/api/shopify-cli/hydrogen/hydrogen-unlink) commands.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `HydrogenLinkResult` schema.\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"enum\": [\n \"success\",\n \"partial\",\n \"skipped\",\n \"cancelled\"\n ]\n },\n \"changed\": {\n \"type\": \"boolean\"\n },\n \"storeDomain\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"pattern\": \"^[a-z0-9][a-z0-9-]*\\\\.myshopify\\\\.com$\"\n },\n {\n \"type\": \"null\"\n }\n ]\n },\n \"storefront\": {\n \"anyOf\": [\n {\n \"$ref\": \"#/definitions/Storefront\"\n },\n {\n \"type\": \"null\"\n }\n ],\n \"description\": \"All projected fields are present; unavailable productionUrl is null.\"\n }\n },\n \"required\": [\n \"status\",\n \"changed\",\n \"storeDomain\",\n \"storefront\"\n ],\n \"additionalProperties\": false,\n \"title\": \"HydrogenLinkResult\",\n \"definitions\": {\n \"Storefront\": {\n \"type\": \"object\",\n \"properties\": {\n \"gid\": {\n \"type\": \"string\",\n \"pattern\": \"^gid:\\\\/\\\\/shopify\\\\/HydrogenStorefront\\\\/\\\\d+$\",\n \"description\": \"A Shopify HydrogenStorefront GID.\"\n },\n \"name\": {\n \"type\": \"string\"\n },\n \"productionUrl\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"format\": \"uri\"\n },\n {\n \"type\": \"null\"\n }\n ]\n }\n },\n \"required\": [\n \"gid\",\n \"name\",\n \"productionUrl\"\n ],\n \"additionalProperties\": false,\n \"description\": \"All projected fields are present; unavailable productionUrl is null.\"\n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "descriptionWithMarkdown": "Links your local development environment to a remote Hydrogen storefront. You can link an unlimited number of development environments to a single Hydrogen storefront.\n\n Linking to a Hydrogen storefront enables you to run [dev](https://shopify.dev/docs/api/shopify-cli/hydrogen/hydrogen-dev) and automatically inject your linked Hydrogen storefront's environment variables directly into the server runtime.\n\n After you run the `link` command, you can access the [env list](https://shopify.dev/docs/api/shopify-cli/hydrogen/hydrogen-env-list), [env pull](https://shopify.dev/docs/api/shopify-cli/hydrogen/hydrogen-env-pull), and [unlink](https://shopify.dev/docs/api/shopify-cli/hydrogen/hydrogen-unlink) commands.", "enableJsonFlag": false, "flags": { @@ -7940,6 +8356,15 @@ "name": "force", "type": "boolean" }, + "json": { + "allowNo": false, + "char": "j", + "description": "Output the result as JSON. Automatically disables color output.", + "env": "SHOPIFY_FLAG_JSON", + "hidden": false, + "name": "json", + "type": "boolean" + }, "json-schema": { "allowNo": false, "description": "Print the command's JSON schemas.", @@ -7958,6 +8383,21 @@ "name": "name", "type": "option" }, + "no-color": { + "allowNo": false, + "description": "Disable color output.", + "env": "SHOPIFY_FLAG_NO_COLOR", + "hidden": false, + "name": "no-color", + "type": "boolean" + }, + "no-input": { + "allowNo": false, + "description": "Disable interactive prompts and browser authentication.", + "env": "SHOPIFY_FLAG_NO_INPUT", + "name": "no-input", + "type": "boolean" + }, "path": { "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.", "env": "SHOPIFY_HYDROGEN_FLAG_PATH", @@ -7986,6 +8426,14 @@ "multiple": false, "name": "storefront", "type": "option" + }, + "verbose": { + "allowNo": false, + "description": "Increase the verbosity of the output. May include sensitive data.", + "env": "SHOPIFY_FLAG_VERBOSE", + "hidden": false, + "name": "verbose", + "type": "boolean" } }, "hasDynamicHelp": false, @@ -8003,10 +8451,19 @@ "args": { }, "customPluginName": "@shopify/cli-hydrogen", - "description": "Returns a list of Hydrogen storefronts available on a given shop.", + "description": "Lists all remote Hydrogen storefronts available to link to your local development environment.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `HydrogenListResult` schema.\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"storeDomain\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"pattern\": \"^[a-z0-9][a-z0-9-]*\\\\.myshopify\\\\.com$\"\n },\n {\n \"type\": \"null\"\n }\n ]\n },\n \"storefronts\": {\n \"type\": \"array\",\n \"items\": {\n \"$ref\": \"#/definitions/Storefront\"\n }\n }\n },\n \"required\": [\n \"storeDomain\",\n \"storefronts\"\n ],\n \"additionalProperties\": false,\n \"description\": \"The complete list of Hydrogen storefronts for the store.\",\n \"title\": \"HydrogenListResult\",\n \"definitions\": {\n \"Storefront\": {\n \"type\": \"object\",\n \"properties\": {\n \"gid\": {\n \"type\": \"string\",\n \"pattern\": \"^gid:\\\\/\\\\/shopify\\\\/HydrogenStorefront\\\\/\\\\d+$\",\n \"description\": \"A Shopify HydrogenStorefront GID.\"\n },\n \"name\": {\n \"type\": \"string\"\n },\n \"productionUrl\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"format\": \"uri\"\n },\n {\n \"type\": \"null\"\n }\n ]\n },\n \"currentProductionDeployment\": {\n \"anyOf\": [\n {\n \"$ref\": \"#/definitions/Deployment\"\n },\n {\n \"type\": \"null\"\n }\n ]\n }\n },\n \"required\": [\n \"gid\",\n \"name\",\n \"productionUrl\",\n \"currentProductionDeployment\"\n ],\n \"additionalProperties\": false,\n \"description\": \"All projected fields are present; unavailable productionUrl is null.\"\n },\n \"Deployment\": {\n \"type\": \"object\",\n \"properties\": {\n \"gid\": {\n \"type\": \"string\",\n \"pattern\": \"^gid:\\\\/\\\\/shopify\\\\/HydrogenStorefrontDeployment\\\\/\\\\d+$\",\n \"description\": \"A Shopify HydrogenStorefrontDeployment GID.\"\n },\n \"createdAt\": {\n \"type\": \"string\",\n \"format\": \"date-time\"\n },\n \"commitMessage\": {\n \"type\": [\n \"string\",\n \"null\"\n ]\n }\n },\n \"required\": [\n \"gid\",\n \"createdAt\",\n \"commitMessage\"\n ],\n \"additionalProperties\": false\n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "descriptionWithMarkdown": "Lists all remote Hydrogen storefronts available to link to your local development environment.", "enableJsonFlag": false, "flags": { + "json": { + "allowNo": false, + "char": "j", + "description": "Output the result as JSON. Automatically disables color output.", + "env": "SHOPIFY_FLAG_JSON", + "hidden": false, + "name": "json", + "type": "boolean" + }, "json-schema": { "allowNo": false, "description": "Print the command's JSON schemas.", @@ -8014,6 +8471,21 @@ "name": "json-schema", "type": "boolean" }, + "no-color": { + "allowNo": false, + "description": "Disable color output.", + "env": "SHOPIFY_FLAG_NO_COLOR", + "hidden": false, + "name": "no-color", + "type": "boolean" + }, + "no-input": { + "allowNo": false, + "description": "Disable interactive prompts and browser authentication.", + "env": "SHOPIFY_FLAG_NO_INPUT", + "name": "no-input", + "type": "boolean" + }, "path": { "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.", "env": "SHOPIFY_HYDROGEN_FLAG_PATH", @@ -8021,6 +8493,14 @@ "multiple": false, "name": "path", "type": "option" + }, + "verbose": { + "allowNo": false, + "description": "Increase the verbosity of the output. May include sensitive data.", + "env": "SHOPIFY_FLAG_VERBOSE", + "hidden": false, + "name": "verbose", + "type": "boolean" } }, "hasDynamicHelp": false, @@ -8038,10 +8518,19 @@ "args": { }, "customPluginName": "@shopify/cli-hydrogen", - "description": "Login to your Shopify account.", + "description": "Logs in to the specified shop and saves the shop domain to the project.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `HydrogenLoginResult` schema.\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"storeDomain\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"pattern\": \"^[a-z0-9][a-z0-9-]*\\\\.myshopify\\\\.com$\"\n },\n {\n \"type\": \"null\"\n }\n ]\n },\n \"name\": {\n \"type\": [\n \"string\",\n \"null\"\n ]\n },\n \"email\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"format\": \"email\"\n },\n {\n \"type\": \"null\"\n }\n ]\n }\n },\n \"required\": [\n \"storeDomain\",\n \"name\",\n \"email\"\n ],\n \"additionalProperties\": false,\n \"title\": \"HydrogenLoginResult\",\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "descriptionWithMarkdown": "Logs in to the specified shop and saves the shop domain to the project.", "enableJsonFlag": false, "flags": { + "json": { + "allowNo": false, + "char": "j", + "description": "Output the result as JSON. Automatically disables color output.", + "env": "SHOPIFY_FLAG_JSON", + "hidden": false, + "name": "json", + "type": "boolean" + }, "json-schema": { "allowNo": false, "description": "Print the command's JSON schemas.", @@ -8049,6 +8538,21 @@ "name": "json-schema", "type": "boolean" }, + "no-color": { + "allowNo": false, + "description": "Disable color output.", + "env": "SHOPIFY_FLAG_NO_COLOR", + "hidden": false, + "name": "no-color", + "type": "boolean" + }, + "no-input": { + "allowNo": false, + "description": "Disable interactive prompts and browser authentication.", + "env": "SHOPIFY_FLAG_NO_INPUT", + "name": "no-input", + "type": "boolean" + }, "path": { "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.", "env": "SHOPIFY_HYDROGEN_FLAG_PATH", @@ -8065,13 +8569,21 @@ "multiple": false, "name": "shop", "type": "option" - } - }, - "hasDynamicHelp": false, - "hiddenAliases": [ - ], - "id": "hydrogen:login", - "pluginAlias": "@shopify/cli", + }, + "verbose": { + "allowNo": false, + "description": "Increase the verbosity of the output. May include sensitive data.", + "env": "SHOPIFY_FLAG_VERBOSE", + "hidden": false, + "name": "verbose", + "type": "boolean" + } + }, + "hasDynamicHelp": false, + "hiddenAliases": [ + ], + "id": "hydrogen:login", + "pluginAlias": "@shopify/cli", "pluginName": "@shopify/cli", "pluginType": "core", "strict": true @@ -8082,10 +8594,19 @@ "args": { }, "customPluginName": "@shopify/cli-hydrogen", - "description": "Logout of your local session.", + "description": "Log out from the current shop.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `HydrogenLogoutResult` schema.\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"const\": \"success\"\n },\n \"loggedOut\": {\n \"type\": \"boolean\",\n \"const\": true\n }\n },\n \"required\": [\n \"status\",\n \"loggedOut\"\n ],\n \"additionalProperties\": false,\n \"title\": \"HydrogenLogoutResult\",\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "descriptionWithMarkdown": "Log out from the current shop.", "enableJsonFlag": false, "flags": { + "json": { + "allowNo": false, + "char": "j", + "description": "Output the result as JSON. Automatically disables color output.", + "env": "SHOPIFY_FLAG_JSON", + "hidden": false, + "name": "json", + "type": "boolean" + }, "json-schema": { "allowNo": false, "description": "Print the command's JSON schemas.", @@ -8093,6 +8614,21 @@ "name": "json-schema", "type": "boolean" }, + "no-color": { + "allowNo": false, + "description": "Disable color output.", + "env": "SHOPIFY_FLAG_NO_COLOR", + "hidden": false, + "name": "no-color", + "type": "boolean" + }, + "no-input": { + "allowNo": false, + "description": "Disable interactive prompts and browser authentication.", + "env": "SHOPIFY_FLAG_NO_INPUT", + "name": "no-input", + "type": "boolean" + }, "path": { "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.", "env": "SHOPIFY_HYDROGEN_FLAG_PATH", @@ -8100,6 +8636,14 @@ "multiple": false, "name": "path", "type": "option" + }, + "verbose": { + "allowNo": false, + "description": "Increase the verbosity of the output. May include sensitive data.", + "env": "SHOPIFY_FLAG_VERBOSE", + "hidden": false, + "name": "verbose", + "type": "boolean" } }, "hasDynamicHelp": false, @@ -8212,6 +8756,21 @@ "name": "json-schema", "type": "boolean" }, + "no-color": { + "allowNo": false, + "description": "Disable color output.", + "env": "SHOPIFY_FLAG_NO_COLOR", + "hidden": false, + "name": "no-color", + "type": "boolean" + }, + "no-input": { + "allowNo": false, + "description": "Disable interactive prompts and browser authentication.", + "env": "SHOPIFY_FLAG_NO_INPUT", + "name": "no-input", + "type": "boolean" + }, "path": { "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.", "env": "SHOPIFY_HYDROGEN_FLAG_PATH", @@ -8261,7 +8820,8 @@ "args": { }, "customPluginName": "@shopify/cli-hydrogen", - "description": "Scaffold routes and core functionality.", + "description": "Scaffold routes and core functionality.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `HydrogenSetupResult` schema.\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"const\": \"success\"\n },\n \"changed\": {\n \"type\": \"boolean\"\n },\n \"directory\": {\n \"type\": \"string\"\n },\n \"name\": {\n \"type\": \"string\"\n },\n \"i18n\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"enum\": [\n \"subfolders\",\n \"domains\",\n \"subdomains\"\n ]\n },\n {\n \"type\": \"null\"\n }\n ]\n },\n \"routes\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"sourceRoute\": {\n \"type\": \"string\"\n },\n \"destinationRoute\": {\n \"type\": \"string\"\n },\n \"operation\": {\n \"type\": \"string\",\n \"enum\": [\n \"created\",\n \"skipped\",\n \"replaced\"\n ]\n },\n \"skipReason\": {\n \"type\": \"string\",\n \"enum\": [\n \"declined\",\n \"exists\"\n ]\n }\n },\n \"required\": [\n \"sourceRoute\",\n \"destinationRoute\",\n \"operation\"\n ],\n \"additionalProperties\": false\n }\n },\n \"routeGroups\": {\n \"type\": \"object\",\n \"additionalProperties\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n },\n \"shortcut\": {\n \"type\": \"boolean\"\n }\n },\n \"required\": [\n \"status\",\n \"changed\",\n \"directory\",\n \"name\",\n \"i18n\",\n \"routes\",\n \"routeGroups\",\n \"shortcut\"\n ],\n \"additionalProperties\": false,\n \"title\": \"HydrogenSetupResult\",\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", + "descriptionWithMarkdown": "Scaffold routes and core functionality.", "enableJsonFlag": false, "flags": { "force": { @@ -8279,6 +8839,15 @@ "name": "install-deps", "type": "boolean" }, + "json": { + "allowNo": false, + "char": "j", + "description": "Output the result as JSON. Automatically disables color output.", + "env": "SHOPIFY_FLAG_JSON", + "hidden": false, + "name": "json", + "type": "boolean" + }, "json-schema": { "allowNo": false, "description": "Print the command's JSON schemas.", @@ -8294,6 +8863,21 @@ "name": "markets", "type": "option" }, + "no-color": { + "allowNo": false, + "description": "Disable color output.", + "env": "SHOPIFY_FLAG_NO_COLOR", + "hidden": false, + "name": "no-color", + "type": "boolean" + }, + "no-input": { + "allowNo": false, + "description": "Disable interactive prompts and browser authentication.", + "env": "SHOPIFY_FLAG_NO_INPUT", + "name": "no-input", + "type": "boolean" + }, "path": { "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.", "env": "SHOPIFY_HYDROGEN_FLAG_PATH", @@ -8308,6 +8892,14 @@ "env": "SHOPIFY_HYDROGEN_FLAG_SHORTCUT", "name": "shortcut", "type": "boolean" + }, + "verbose": { + "allowNo": false, + "description": "Increase the verbosity of the output. May include sensitive data.", + "env": "SHOPIFY_FLAG_VERBOSE", + "hidden": false, + "name": "verbose", + "type": "boolean" } }, "hasDynamicHelp": false, @@ -8335,7 +8927,7 @@ } }, "customPluginName": "@shopify/cli-hydrogen", - "description": "Setup CSS strategies for your project.", + "description": "Adds support for certain CSS strategies to your project.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `HydrogenSetupCssResult` schema.\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"enum\": [\n \"success\",\n \"cancelled\"\n ]\n },\n \"changed\": {\n \"type\": \"boolean\"\n },\n \"directory\": {\n \"$ref\": \"#/definitions/AbsolutePath\"\n },\n \"strategy\": {\n \"type\": \"string\",\n \"enum\": [\n \"tailwind\",\n \"vanilla-extract\",\n \"css-modules\",\n \"postcss\"\n ]\n },\n \"filePaths\": {\n \"type\": \"array\",\n \"items\": {\n \"$ref\": \"#/definitions/AbsolutePath\"\n }\n },\n \"dependenciesInstalled\": {\n \"type\": \"boolean\"\n },\n \"needsNpmReinstall\": {\n \"type\": \"boolean\"\n }\n },\n \"required\": [\n \"status\",\n \"changed\",\n \"directory\",\n \"strategy\",\n \"filePaths\",\n \"dependenciesInstalled\",\n \"needsNpmReinstall\"\n ],\n \"additionalProperties\": false,\n \"title\": \"HydrogenSetupCssResult\",\n \"definitions\": {\n \"AbsolutePath\": {\n \"type\": \"string\"\n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "descriptionWithMarkdown": "Adds support for certain CSS strategies to your project.", "enableJsonFlag": false, "flags": { @@ -8354,6 +8946,15 @@ "name": "install-deps", "type": "boolean" }, + "json": { + "allowNo": false, + "char": "j", + "description": "Output the result as JSON. Automatically disables color output.", + "env": "SHOPIFY_FLAG_JSON", + "hidden": false, + "name": "json", + "type": "boolean" + }, "json-schema": { "allowNo": false, "description": "Print the command's JSON schemas.", @@ -8361,6 +8962,21 @@ "name": "json-schema", "type": "boolean" }, + "no-color": { + "allowNo": false, + "description": "Disable color output.", + "env": "SHOPIFY_FLAG_NO_COLOR", + "hidden": false, + "name": "no-color", + "type": "boolean" + }, + "no-input": { + "allowNo": false, + "description": "Disable interactive prompts and browser authentication.", + "env": "SHOPIFY_FLAG_NO_INPUT", + "name": "no-input", + "type": "boolean" + }, "path": { "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.", "env": "SHOPIFY_HYDROGEN_FLAG_PATH", @@ -8368,6 +8984,14 @@ "multiple": false, "name": "path", "type": "option" + }, + "verbose": { + "allowNo": false, + "description": "Increase the verbosity of the output. May include sensitive data.", + "env": "SHOPIFY_FLAG_VERBOSE", + "hidden": false, + "name": "verbose", + "type": "boolean" } }, "hasDynamicHelp": false, @@ -8394,10 +9018,19 @@ } }, "customPluginName": "@shopify/cli-hydrogen", - "description": "Setup support for multiple markets in your project.", + "description": "Adds support for multiple \"markets\" (https://shopify.dev/docs/custom-storefronts/hydrogen/markets) to your project by using the URL structure.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `HydrogenSetupMarketsResult` schema.\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"const\": \"success\"\n },\n \"changed\": {\n \"type\": \"boolean\",\n \"const\": true\n },\n \"directory\": {\n \"$ref\": \"#/definitions/AbsolutePath\"\n },\n \"strategy\": {\n \"type\": \"string\",\n \"enum\": [\n \"subfolders\",\n \"domains\",\n \"subdomains\"\n ]\n },\n \"serverPath\": {\n \"anyOf\": [\n {\n \"$ref\": \"#/definitions/AbsolutePath\"\n },\n {\n \"type\": \"null\"\n }\n ]\n }\n },\n \"required\": [\n \"status\",\n \"changed\",\n \"directory\",\n \"strategy\",\n \"serverPath\"\n ],\n \"additionalProperties\": false,\n \"title\": \"HydrogenSetupMarketsResult\",\n \"definitions\": {\n \"AbsolutePath\": {\n \"type\": \"string\"\n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "descriptionWithMarkdown": "Adds support for multiple [markets](https://shopify.dev/docs/custom-storefronts/hydrogen/markets) to your project by using the URL structure.", "enableJsonFlag": false, "flags": { + "json": { + "allowNo": false, + "char": "j", + "description": "Output the result as JSON. Automatically disables color output.", + "env": "SHOPIFY_FLAG_JSON", + "hidden": false, + "name": "json", + "type": "boolean" + }, "json-schema": { "allowNo": false, "description": "Print the command's JSON schemas.", @@ -8405,6 +9038,21 @@ "name": "json-schema", "type": "boolean" }, + "no-color": { + "allowNo": false, + "description": "Disable color output.", + "env": "SHOPIFY_FLAG_NO_COLOR", + "hidden": false, + "name": "no-color", + "type": "boolean" + }, + "no-input": { + "allowNo": false, + "description": "Disable interactive prompts and browser authentication.", + "env": "SHOPIFY_FLAG_NO_INPUT", + "name": "no-input", + "type": "boolean" + }, "path": { "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.", "env": "SHOPIFY_HYDROGEN_FLAG_PATH", @@ -8412,6 +9060,14 @@ "multiple": false, "name": "path", "type": "option" + }, + "verbose": { + "allowNo": false, + "description": "Increase the verbosity of the output. May include sensitive data.", + "env": "SHOPIFY_FLAG_VERBOSE", + "hidden": false, + "name": "verbose", + "type": "boolean" } }, "hasDynamicHelp": false, @@ -8429,9 +9085,19 @@ "args": { }, "customPluginName": "@shopify/cli-hydrogen", - "description": "EXPERIMENTAL: Upgrades the project to use Vite.", + "description": "EXPERIMENTAL: Upgrades the project to use Vite.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `HydrogenSetupViteResult` schema.\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"const\": \"success\"\n },\n \"changed\": {\n \"type\": \"boolean\",\n \"const\": true\n },\n \"directory\": {\n \"$ref\": \"#/definitions/AbsolutePath\"\n },\n \"viteConfigPath\": {\n \"$ref\": \"#/definitions/AbsolutePath\"\n },\n \"serverPath\": {\n \"$ref\": \"#/definitions/AbsolutePath\"\n },\n \"dependenciesInstalled\": {\n \"type\": \"boolean\",\n \"const\": true\n },\n \"needsMdxSetup\": {\n \"type\": \"boolean\"\n }\n },\n \"required\": [\n \"status\",\n \"changed\",\n \"directory\",\n \"viteConfigPath\",\n \"serverPath\",\n \"dependenciesInstalled\",\n \"needsMdxSetup\"\n ],\n \"additionalProperties\": false,\n \"title\": \"HydrogenSetupViteResult\",\n \"definitions\": {\n \"AbsolutePath\": {\n \"type\": \"string\"\n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", + "descriptionWithMarkdown": "EXPERIMENTAL: Upgrades the project to use Vite.", "enableJsonFlag": false, "flags": { + "json": { + "allowNo": false, + "char": "j", + "description": "Output the result as JSON. Automatically disables color output.", + "env": "SHOPIFY_FLAG_JSON", + "hidden": false, + "name": "json", + "type": "boolean" + }, "json-schema": { "allowNo": false, "description": "Print the command's JSON schemas.", @@ -8439,6 +9105,21 @@ "name": "json-schema", "type": "boolean" }, + "no-color": { + "allowNo": false, + "description": "Disable color output.", + "env": "SHOPIFY_FLAG_NO_COLOR", + "hidden": false, + "name": "no-color", + "type": "boolean" + }, + "no-input": { + "allowNo": false, + "description": "Disable interactive prompts and browser authentication.", + "env": "SHOPIFY_FLAG_NO_INPUT", + "name": "no-input", + "type": "boolean" + }, "path": { "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.", "env": "SHOPIFY_HYDROGEN_FLAG_PATH", @@ -8446,6 +9127,14 @@ "multiple": false, "name": "path", "type": "option" + }, + "verbose": { + "allowNo": false, + "description": "Increase the verbosity of the output. May include sensitive data.", + "env": "SHOPIFY_FLAG_VERBOSE", + "hidden": false, + "name": "verbose", + "type": "boolean" } }, "hasDynamicHelp": false, @@ -8463,16 +9152,48 @@ "args": { }, "customPluginName": "@shopify/cli-hydrogen", - "description": "Creates a global `h2` shortcut for the Hydrogen CLI", + "description": "Creates a global h2 shortcut for Shopify CLI using shell aliases.\n\n The following shells are supported:\n\n - Bash (using `~/.bashrc`)\n - ZSH (using `~/.zshrc`)\n - Fish (using `~/.config/fish/functions`)\n - PowerShell (added to `$PROFILE`)\n\n After the alias is created, you can call Shopify CLI from anywhere in your project using `h2 `.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `HydrogenShortcutResult` schema.\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"const\": \"success\"\n },\n \"changed\": {\n \"type\": \"boolean\"\n },\n \"alias\": {\n \"type\": \"string\"\n },\n \"shells\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\",\n \"enum\": [\n \"bash\",\n \"zsh\",\n \"fish\",\n \"powershell\",\n \"powershell-7\",\n \"cmd\"\n ]\n },\n \"minItems\": 1\n }\n },\n \"required\": [\n \"status\",\n \"changed\",\n \"alias\",\n \"shells\"\n ],\n \"additionalProperties\": false,\n \"title\": \"HydrogenShortcutResult\",\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "descriptionWithMarkdown": "Creates a global h2 shortcut for Shopify CLI using shell aliases.\n\n The following shells are supported:\n\n - Bash (using `~/.bashrc`)\n - ZSH (using `~/.zshrc`)\n - Fish (using `~/.config/fish/functions`)\n - PowerShell (added to `$PROFILE`)\n\n After the alias is created, you can call Shopify CLI from anywhere in your project using `h2 `.", "enableJsonFlag": false, "flags": { + "json": { + "allowNo": false, + "char": "j", + "description": "Output the result as JSON. Automatically disables color output.", + "env": "SHOPIFY_FLAG_JSON", + "hidden": false, + "name": "json", + "type": "boolean" + }, "json-schema": { "allowNo": false, "description": "Print the command's JSON schemas.", "env": "SHOPIFY_FLAG_JSON_SCHEMA", "name": "json-schema", "type": "boolean" + }, + "no-color": { + "allowNo": false, + "description": "Disable color output.", + "env": "SHOPIFY_FLAG_NO_COLOR", + "hidden": false, + "name": "no-color", + "type": "boolean" + }, + "no-input": { + "allowNo": false, + "description": "Disable interactive prompts and browser authentication.", + "env": "SHOPIFY_FLAG_NO_INPUT", + "name": "no-input", + "type": "boolean" + }, + "verbose": { + "allowNo": false, + "description": "Increase the verbosity of the output. May include sensitive data.", + "env": "SHOPIFY_FLAG_VERBOSE", + "hidden": false, + "name": "verbose", + "type": "boolean" } }, "hasDynamicHelp": false, @@ -8490,10 +9211,19 @@ "args": { }, "customPluginName": "@shopify/cli-hydrogen", - "description": "Unlink a local project from a Hydrogen storefront.", + "description": "Unlinks your local development environment from a remote Hydrogen storefront.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `HydrogenUnlinkResult` schema.\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"const\": \"success\"\n },\n \"changed\": {\n \"type\": \"boolean\"\n },\n \"storefront\": {\n \"anyOf\": [\n {\n \"type\": \"object\",\n \"properties\": {\n \"gid\": {\n \"type\": \"string\",\n \"pattern\": \"^gid:\\\\/\\\\/shopify\\\\/HydrogenStorefront\\\\/\\\\d+$\",\n \"description\": \"A Shopify HydrogenStorefront GID.\"\n },\n \"name\": {\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"gid\",\n \"name\"\n ],\n \"additionalProperties\": false\n },\n {\n \"type\": \"null\"\n }\n ]\n }\n },\n \"required\": [\n \"status\",\n \"changed\",\n \"storefront\"\n ],\n \"additionalProperties\": false,\n \"title\": \"HydrogenUnlinkResult\",\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "descriptionWithMarkdown": "Unlinks your local development environment from a remote Hydrogen storefront.", "enableJsonFlag": false, "flags": { + "json": { + "allowNo": false, + "char": "j", + "description": "Output the result as JSON. Automatically disables color output.", + "env": "SHOPIFY_FLAG_JSON", + "hidden": false, + "name": "json", + "type": "boolean" + }, "json-schema": { "allowNo": false, "description": "Print the command's JSON schemas.", @@ -8501,6 +9231,21 @@ "name": "json-schema", "type": "boolean" }, + "no-color": { + "allowNo": false, + "description": "Disable color output.", + "env": "SHOPIFY_FLAG_NO_COLOR", + "hidden": false, + "name": "no-color", + "type": "boolean" + }, + "no-input": { + "allowNo": false, + "description": "Disable interactive prompts and browser authentication.", + "env": "SHOPIFY_FLAG_NO_INPUT", + "name": "no-input", + "type": "boolean" + }, "path": { "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.", "env": "SHOPIFY_HYDROGEN_FLAG_PATH", @@ -8508,6 +9253,14 @@ "multiple": false, "name": "path", "type": "option" + }, + "verbose": { + "allowNo": false, + "description": "Increase the verbosity of the output. May include sensitive data.", + "env": "SHOPIFY_FLAG_VERBOSE", + "hidden": false, + "name": "verbose", + "type": "boolean" } }, "hasDynamicHelp": false, @@ -8525,7 +9278,7 @@ "args": { }, "customPluginName": "@shopify/cli-hydrogen", - "description": "Upgrade Remix and Hydrogen npm dependencies.", + "description": "Upgrade Hydrogen project dependencies, preview features, fixes and breaking changes. The command also generates an instruction file for each upgrade.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `HydrogenUpgradeResult` schema.\n\n```json\n{\n \"anyOf\": [\n {\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"const\": \"success\"\n },\n \"directory\": {\n \"$ref\": \"#/definitions/AbsolutePath\"\n },\n \"previousVersion\": {\n \"type\": \"string\"\n },\n \"version\": {\n \"type\": \"string\"\n },\n \"changed\": {\n \"type\": \"boolean\",\n \"const\": true\n },\n \"packages\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n },\n \"removedPackages\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n },\n \"instructionsPath\": {\n \"anyOf\": [\n {\n \"$ref\": \"#/definitions/AbsolutePath\"\n },\n {\n \"type\": \"null\"\n }\n ]\n }\n },\n \"required\": [\n \"status\",\n \"directory\",\n \"previousVersion\",\n \"version\",\n \"changed\",\n \"packages\",\n \"removedPackages\",\n \"instructionsPath\"\n ],\n \"additionalProperties\": false\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"const\": \"success\"\n },\n \"directory\": {\n \"$ref\": \"#/definitions/AbsolutePath\"\n },\n \"previousVersion\": {\n \"type\": \"string\"\n },\n \"version\": {\n \"type\": \"string\"\n },\n \"changed\": {\n \"type\": \"boolean\",\n \"const\": false\n },\n \"packages\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n },\n \"minItems\": 0,\n \"maxItems\": 0\n },\n \"removedPackages\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n },\n \"minItems\": 0,\n \"maxItems\": 0\n },\n \"instructionsPath\": {\n \"type\": \"null\"\n }\n },\n \"required\": [\n \"status\",\n \"directory\",\n \"previousVersion\",\n \"version\",\n \"changed\",\n \"packages\",\n \"removedPackages\",\n \"instructionsPath\"\n ],\n \"additionalProperties\": false\n }\n ],\n \"title\": \"HydrogenUpgradeResult\",\n \"definitions\": {\n \"AbsolutePath\": {\n \"type\": \"string\"\n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", "descriptionWithMarkdown": "Upgrade Hydrogen project dependencies, preview features, fixes and breaking changes. The command also generates an instruction file for each upgrade.", "enableJsonFlag": false, "flags": { @@ -8537,6 +9290,15 @@ "name": "force", "type": "boolean" }, + "json": { + "allowNo": false, + "char": "j", + "description": "Output the result as JSON. Automatically disables color output.", + "env": "SHOPIFY_FLAG_JSON", + "hidden": false, + "name": "json", + "type": "boolean" + }, "json-schema": { "allowNo": false, "description": "Print the command's JSON schemas.", @@ -8544,6 +9306,21 @@ "name": "json-schema", "type": "boolean" }, + "no-color": { + "allowNo": false, + "description": "Disable color output.", + "env": "SHOPIFY_FLAG_NO_COLOR", + "hidden": false, + "name": "no-color", + "type": "boolean" + }, + "no-input": { + "allowNo": false, + "description": "Disable interactive prompts and browser authentication.", + "env": "SHOPIFY_FLAG_NO_INPUT", + "name": "no-input", + "type": "boolean" + }, "path": { "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.", "env": "SHOPIFY_HYDROGEN_FLAG_PATH", @@ -8552,6 +9329,14 @@ "name": "path", "type": "option" }, + "verbose": { + "allowNo": false, + "description": "Increase the verbosity of the output. May include sensitive data.", + "env": "SHOPIFY_FLAG_VERBOSE", + "hidden": false, + "name": "verbose", + "type": "boolean" + }, "version": { "char": "v", "description": "A target hydrogen version to update to", diff --git a/packages/cli/package.json b/packages/cli/package.json index 2fc8b0116fd..7f088a4f49a 100644 --- a/packages/cli/package.json +++ b/packages/cli/package.json @@ -67,7 +67,7 @@ "@shopify/plugin-cloudflare": "4.9.0", "@shopify/plugin-did-you-mean": "4.9.0", "@shopify/theme": "4.9.0", - "@shopify/cli-hydrogen": "13.0.6", + "@shopify/cli-hydrogen": "13.1.0", "@types/global-agent": "3.0.0", "@vitest/coverage-istanbul": "^3.2.7", "esbuild-plugin-copy": "^2.1.1" diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 8251ab9372a..0a9b9611457 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -289,8 +289,8 @@ importers: specifier: 4.9.0 version: link:../app '@shopify/cli-hydrogen': - specifier: 13.0.6 - version: 13.0.6(@graphql-codegen/cli@6.3.1(@parcel/watcher@2.5.6)(@types/node@22.20.1)(crossws@0.3.5)(graphql@16.14.2)(typescript@5.9.3))(graphql-config@5.1.6(@types/node@26.1.1)(crossws@0.3.5)(graphql@16.14.2)(typescript@5.9.3))(graphql@16.14.2)(react-dom@19.2.4(react@18.3.1))(react@18.3.1)(vite@6.4.3(@types/node@26.1.1)(jiti@2.6.1)(sass@1.100.0)(tsx@4.23.1)(yaml@2.9.0)) + specifier: 13.1.0 + version: 13.1.0(@graphql-codegen/cli@6.3.1(@parcel/watcher@2.5.6)(@types/node@22.20.1)(crossws@0.3.5)(graphql@16.14.2)(typescript@5.9.3))(graphql-config@5.1.6(@types/node@26.1.1)(crossws@0.3.5)(graphql@16.14.2)(typescript@5.9.3))(graphql@16.14.2)(react-dom@19.2.4(react@18.3.1))(react@18.3.1)(vite@6.4.3(@types/node@26.1.1)(jiti@2.6.1)(sass@1.100.0)(tsx@4.23.1)(yaml@2.9.0)) '@shopify/cli-kit': specifier: 4.9.0 version: link:../cli-kit @@ -3041,10 +3041,6 @@ packages: '@nx/workspace@22.7.7': resolution: {integrity: sha512-tDSOWUEjTyEjoUKGSFyUGrFaCpScoFa8lRR0jorM169a3dA4iqwgkppcltR/uwklLw/aNSSW6J92DAzSRuOLnA==, tarball: https://registry.npmjs.org/@nx/workspace/-/workspace-22.7.7.tgz} - '@oclif/core@3.26.5': - resolution: {integrity: sha512-uRmAujGJjLhhgpLylbiuHuPt9Ec7u6aJ72utuSPNTRw47+W5vbQSGnLGPiil1Mt5YDL+zFOyTVH6Uv3NSP2SaQ==, tarball: https://registry.npmjs.org/@oclif/core/-/core-3.26.5.tgz} - engines: {node: '>=18.0.0'} - '@oclif/core@4.11.14': resolution: {integrity: sha512-cZ5Ktd+rT0PO+o7KBH4vRFTgg+xMLf8F41WK39p8MkXEViZA/Qqe+4lzZT6102zgUxMORET1HtF9t5w8CB3tnQ==, tarball: https://registry.npmjs.org/@oclif/core/-/core-4.11.14.tgz} engines: {node: '>=18.0.0'} @@ -3676,15 +3672,15 @@ packages: '@shikijs/vscode-textmate@10.0.2': resolution: {integrity: sha512-83yeghZ2xxin3Nj8z1NMd/NCuca+gsYXswywDy5bHvwlWL8tpTQmzGeUuHd9FC3E/SBEMvzJRwWEOz5gGes9Qg==, tarball: https://registry.npmjs.org/@shikijs/vscode-textmate/-/vscode-textmate-10.0.2.tgz} - '@shopify/cli-hydrogen@13.0.6': - resolution: {integrity: sha512-2NC0BMbgIFwObxMahJLWAwGTd2K/PxE4xe4ycb032GjbtPC2IhP1bOlNZK42IouvSDsQLco5pdxt9TXamifC2g==, tarball: https://registry.npmjs.org/@shopify/cli-hydrogen/-/cli-hydrogen-13.0.6.tgz} + '@shopify/cli-hydrogen@13.1.0': + resolution: {integrity: sha512-b50fhNdsIuENIO6UX+HEqwv2kGNvu4LQqhqhOzYyWtY5mv4DHIa/pwsvAC3TYxAoReQ5f7ld2h5h4UMUg9LNYQ==, tarball: https://registry.npmjs.org/@shopify/cli-hydrogen/-/cli-hydrogen-13.1.0.tgz} engines: {node: ^22 || ^24} hasBin: true peerDependencies: '@graphql-codegen/cli': ^5.0.2 '@react-router/dev': ~7.16.0 '@shopify/hydrogen-codegen': 0.3.3 - '@shopify/mini-oxygen': 4.2.3 + '@shopify/mini-oxygen': ^3.1.0 || ^4.2.3 graphql-config: ^5.0.3 vite: 6.4.3 peerDependenciesMeta: @@ -3923,9 +3919,6 @@ packages: '@types/chai@5.2.3': resolution: {integrity: sha512-Mw558oeA9fFbv65/y4mHtXDs9bPnFMZAL/jxdPFUpOHHIXX91mcgEHbS5Lahr+pwZFR8A7GQleRWeI6cGFC2UA==, tarball: https://registry.npmjs.org/@types/chai/-/chai-5.2.3.tgz} - '@types/cli-progress@3.11.6': - resolution: {integrity: sha512-cE3+jb9WRlu+uOSAugewNpITJDt1VF8dHOopPO4IABFc3SXYL5WE/+PTz/FCdZRRfIujiWW3n3aMbv1eIGVRWA==, tarball: https://registry.npmjs.org/@types/cli-progress/-/cli-progress-3.11.6.tgz} - '@types/deep-eql@4.0.2': resolution: {integrity: sha512-c9h9dVVMigMPc4bwTvC5dxqtqJZwQPePsWjPlpSOnojbor6pGqdk541lfA7AqFQr5pB1BRdq0juY9db81BwyFw==, tarball: https://registry.npmjs.org/@types/deep-eql/-/deep-eql-4.0.2.tgz} @@ -4353,9 +4346,6 @@ packages: resolution: {integrity: sha512-4Dj6M28JB+oAH8kFkTLUo+a2jwOFkuqb3yucU0CANcRRUbxS0cP0nZYCGjcc3BNXwRIsUVmDGgzawme7zvJHvg==, tarball: https://registry.npmjs.org/ansi-styles/-/ansi-styles-6.2.3.tgz} engines: {node: '>=12'} - ansicolors@0.3.2: - resolution: {integrity: sha512-QXu7BPrP29VllRxH8GwB7x5iX5qWKAAMLqKQGWTeLWVlNHNOpVMJ91dsxQAIWXpjuW5wqvxu3Jd/nRjrJ+0pqg==, tarball: https://registry.npmjs.org/ansicolors/-/ansicolors-0.3.2.tgz} - ansis@3.17.0: resolution: {integrity: sha512-0qWUglt9JEqLFr3w1I1pbrChn1grhaiAR2ocX1PP/flRmxgtwTzPFFFnfIlD6aMOLQZgSuCRlidD70lvx8yhzg==, tarball: https://registry.npmjs.org/ansis/-/ansis-3.17.0.tgz} engines: {node: '>=14'} @@ -4453,10 +4443,6 @@ packages: ast-types-flow@0.0.8: resolution: {integrity: sha512-OH/2E5Fg20h2aPrbe+QL8JZQFko0YZaF+j4mnQ7BGhfavO7OpSLa8a0y9sBwomHdSbkhTS8TQNayBfnW5DwbvQ==, tarball: https://registry.npmjs.org/ast-types-flow/-/ast-types-flow-0.0.8.tgz} - astral-regex@2.0.0: - resolution: {integrity: sha512-Z7tMw1ytTXt5jqMcOP+OQteU1VuNK9Y02uuJtKQ1Sv69jXQKKg5cibLwGJow8yzZP+eAc18EmLGPal0bp36rvQ==, tarball: https://registry.npmjs.org/astral-regex/-/astral-regex-2.0.0.tgz} - engines: {node: '>=8'} - async-function@1.0.0: resolution: {integrity: sha512-hsU18Ae8CDTR6Kgu9DYf0EbCr/a5iGL0rytQDobUcdpYOKokk8LEjVphnXkDkgpi0wYVsqrXuP0bZxJaTqdgoA==, tarball: https://registry.npmjs.org/async-function/-/async-function-1.0.0.tgz} engines: {node: '>= 0.4'} @@ -4675,10 +4661,6 @@ packages: capital-case@1.0.4: resolution: {integrity: sha512-ds37W8CytHgwnhGGTi88pcPyR15qoNkOpYwmMMfnWqqWgESapLqvDx6huFjQ5vqWSn2Z06173XNA7LtMOeUh1A==, tarball: https://registry.npmjs.org/capital-case/-/capital-case-1.0.4.tgz} - cardinal@2.1.1: - resolution: {integrity: sha512-JSr5eOgoEymtYHBjNWyjrMqet9Am2miJhlfKNdqLp6zoeAh0KN5dRAcxlecj5mAJrmQomgiOBj35xHLrFjqBpw==, tarball: https://registry.npmjs.org/cardinal/-/cardinal-2.1.1.tgz} - hasBin: true - chai@6.2.2: resolution: {integrity: sha512-NUPRluOfOiTKBKvWPtSD4PhFvWCqOi0BGStNWs57X9js7XGTprSmFoz5F0tWhR4WPjNeR9jXqdC7/UpSJTnlRg==, tarball: https://registry.npmjs.org/chai/-/chai-6.2.2.tgz} engines: {node: '>=18'} @@ -4742,10 +4724,6 @@ packages: resolution: {integrity: sha512-aCj4O5wKyszjMmDT4tZj93kxyydN/K5zPWSCe6/0AV/AA1pqe5ZBIw0a2ZfPQV7lL5/yb5HsUreJ6UFAF1tEQw==, tarball: https://registry.npmjs.org/cli-cursor/-/cli-cursor-5.0.0.tgz} engines: {node: '>=18'} - cli-progress@3.12.0: - resolution: {integrity: sha512-tRkV3HJ1ASwm19THiiLIXLO7Im7wlTuKnvkYaTkyoAPefqjNg7W7DHKUlGRxy9vxDvbyCYQkQozvptuMkGCg8A==, tarball: https://registry.npmjs.org/cli-progress/-/cli-progress-3.12.0.tgz} - engines: {node: '>=4'} - cli-spinners@2.6.1: resolution: {integrity: sha512-x/5fWmGMnbKQAaNwN+UZlV79qBLM9JFnJuJ03gIi5whrob0xV0ofNVHy9DhwGdsMJQc2OKv0oGmLzvaqvAVv+g==, tarball: https://registry.npmjs.org/cli-spinners/-/cli-spinners-2.6.1.tgz} engines: {node: '>=6'} @@ -4801,13 +4779,6 @@ packages: color-name@1.1.4: resolution: {integrity: sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==, tarball: https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz} - color-string@1.9.1: - resolution: {integrity: sha512-shrVawQFojnZv6xM40anx4CkoDP+fZsw/ZerEMsW/pyzsRbElpsL/DBVW7q3ExxwusdNXI3lXpuhEZkzs8p5Eg==, tarball: https://registry.npmjs.org/color-string/-/color-string-1.9.1.tgz} - - color@4.2.3: - resolution: {integrity: sha512-1rXeuUUiGGrykh+CeBdu5Ie7OJwinCgQY0bc7GCRxy5xVHy+moaqkpL/jqQq0MtQOeYcrqEz4abc5f0KtU7W4A==, tarball: https://registry.npmjs.org/color/-/color-4.2.3.tgz} - engines: {node: '>=12.5.0'} - colorette@2.0.20: resolution: {integrity: sha512-IfEDxwoWIjkeXL1eXcDiow4UbKjhLdq6/EuSVR9GMN7KVH3r9gQ83e73hsz1Nd1T3ijd5xv1wcWRYO+D6kCI2w==, tarball: https://registry.npmjs.org/colorette/-/colorette-2.0.20.tgz} @@ -6109,10 +6080,6 @@ packages: resolution: {integrity: sha512-AXcZb6vzzrFAUE61HnN4mpLqd/cSIwNQjtNWR0euPm6y0iqx3G4gOXaIDdtdDwZmhwe82LA6+zinmW4UBWVePQ==, tarball: https://registry.npmjs.org/human-signals/-/human-signals-5.0.0.tgz} engines: {node: '>=16.17.0'} - hyperlinker@1.0.0: - resolution: {integrity: sha512-Ty8UblRWFEcfSuIaajM34LdPXIhbs1ajEX/BBPv24J+enSVaEVY63xQ6lTO9VRYS5LAoghIG0IDJ+p+IPzKUQQ==, tarball: https://registry.npmjs.org/hyperlinker/-/hyperlinker-1.0.0.tgz} - engines: {node: '>=4'} - iconv-lite@0.6.3: resolution: {integrity: sha512-4fCk79wshMdzMp2rH06qWrJE4iolqLhCUH+OiuIgU++RB0+94NlDL81atO7GX55uUKueo0txHNtvEyI6D7WdMw==, tarball: https://registry.npmjs.org/iconv-lite/-/iconv-lite-0.6.3.tgz} engines: {node: '>=0.10.0'} @@ -6231,9 +6198,6 @@ packages: is-arrayish@0.2.1: resolution: {integrity: sha512-zz06S8t0ozoDXMG+ube26zeCTNXcKIPJZJi8hBrF4idCLms4CG9QtK7qBl1boi5ODzFpjswb5JPmHCbMpjaYzg==, tarball: https://registry.npmjs.org/is-arrayish/-/is-arrayish-0.2.1.tgz} - is-arrayish@0.3.4: - resolution: {integrity: sha512-m6UrgzFVUYawGBh1dUsWR5M2Clqic9RVXC/9f8ceNlv2IcO9j9J/z8UoCLPqtsPBFNzEpfR3xftohbfqDx8EQA==, tarball: https://registry.npmjs.org/is-arrayish/-/is-arrayish-0.3.4.tgz} - is-async-function@2.1.1: resolution: {integrity: sha512-9dgM/cZBnNvjzaMYHVoxxfPj2QXt22Ev7SuuPrs+xav0ukGB0S6d4ydZdEiM48kLx5kDV+QBPrpVnFyefL8kkQ==, tarball: https://registry.npmjs.org/is-async-function/-/is-async-function-2.1.1.tgz} engines: {node: '>= 0.4'} @@ -6989,9 +6953,6 @@ packages: natural-compare@1.4.0: resolution: {integrity: sha512-OWND8ei3VtNC9h7V60qff3SVobHr996CTwgxubgyQYEpg290h9J0buyECNNJexkFm5sOajh5G116RYA1c8ZMSw==, tarball: https://registry.npmjs.org/natural-compare/-/natural-compare-1.4.0.tgz} - natural-orderby@2.0.3: - resolution: {integrity: sha512-p7KTHxU0CUrcOXe62Zfrb5Z13nLvPhSWR/so3kFulUQU0sgUll2Z0LwpsLN351eOOD+hRGu/F1g+6xDfPeD++Q==, tarball: https://registry.npmjs.org/natural-orderby/-/natural-orderby-2.0.3.tgz} - natural-orderby@3.0.2: resolution: {integrity: sha512-x7ZdOwBxZCEm9MM7+eQCjkrNLrW3rkBKNHVr78zbtqnMGVNlnDi6C/eUEYgxHNrcbu0ymvjzcwIL/6H1iHri9g==, tarball: https://registry.npmjs.org/natural-orderby/-/natural-orderby-3.0.2.tgz} engines: {node: '>=18'} @@ -7180,10 +7141,6 @@ packages: resolution: {integrity: sha512-NuAESUOUMrlIXOfHKzD6bpPu3tYt3xvjNdRIQ+FeT0lNb4K8WR70CaDxhuNguS2XG+GjkyMwOzsN5ZktImfhLA==, tarball: https://registry.npmjs.org/object-keys/-/object-keys-1.1.1.tgz} engines: {node: '>= 0.4'} - object-treeify@1.1.33: - resolution: {integrity: sha512-EFVjAYfzWqWsBMRHPMAXLCDIJnpMhdWAqR7xG6M6a2cs6PMFpl/+Z20w9zDW4vkxOFfddegBKq9Rehd0bxWE7A==, tarball: https://registry.npmjs.org/object-treeify/-/object-treeify-1.1.33.tgz} - engines: {node: '>= 10'} - object-treeify@4.0.1: resolution: {integrity: sha512-Y6tg5rHfsefSkfKujv2SwHulInROy/rCL5F4w0QOWxut8AnxYxf0YmNhTh95Zfyxpsudo66uqkux0ACFnyMSgQ==, tarball: https://registry.npmjs.org/object-treeify/-/object-treeify-4.0.1.tgz} engines: {node: '>= 16'} @@ -7343,9 +7300,6 @@ packages: pascal-case@3.1.2: resolution: {integrity: sha512-uWlGT3YSnK9x3BQJaOdcZwrnV6hPpd8jFH1/ucpiLRPh/2zCVJKS19E4GvYHvaCcACn3foXZ0cLB9Wrx1KGe5g==, tarball: https://registry.npmjs.org/pascal-case/-/pascal-case-3.1.2.tgz} - password-prompt@1.1.3: - resolution: {integrity: sha512-HkrjG2aJlvF0t2BMH0e2LB/EHf3Lcq3fNMzy4GYHcQblAvOl+QQji1Lx7WRBMqpVK8p+KR7bCg7oqAMXtdgqyw==, tarball: https://registry.npmjs.org/password-prompt/-/password-prompt-1.1.3.tgz} - patch-console@2.0.0: resolution: {integrity: sha512-0YNdUceMdaQwoKce1gatDScmMo5pu/tfABfnzEqeG0gtTmd7mh/WcwgUjtAeOU7N8nFFlbQBnFK2gXW5fGvmMA==, tarball: https://registry.npmjs.org/patch-console/-/patch-console-2.0.0.tgz} engines: {node: ^12.20.0 || ^14.13.1 || >=16.0.0} @@ -7661,9 +7615,6 @@ packages: resolution: {integrity: sha512-6tDA8g98We0zd0GvVeMT9arEOnTw9qM03L9cJXaCjrip1OO764RDBLBfrB4cwzNGDj5OA5ioymC9GkizgWJDUg==, tarball: https://registry.npmjs.org/redent/-/redent-3.0.0.tgz} engines: {node: '>=8'} - redeyed@2.1.1: - resolution: {integrity: sha512-FNpGGo1DycYAdnrKFxCMmKYgo/mILAqtRYbkdQD8Ep/Hk2PQ5+aEAEx+IU713RTDmuBaH0c8P5ZozurNu5ObRQ==, tarball: https://registry.npmjs.org/redeyed/-/redeyed-2.1.1.tgz} - reduce-flatten@2.0.0: resolution: {integrity: sha512-EJ4UNY/U1t2P/2k6oqotuX2Cc3T6nxJwsM0N0asT7dhrtH1ltUxDn4NalSYmPE2rCkVpcf/X6R0wDwcFpzhd4w==, tarball: https://registry.npmjs.org/reduce-flatten/-/reduce-flatten-2.0.0.tgz} engines: {node: '>=6'} @@ -7960,17 +7911,10 @@ packages: simple-git@3.36.0: resolution: {integrity: sha512-cGQjLjK8bxJw4QuYT7gxHw3/IouVESbhahSsHrX97MzCL1gu2u7oy38W6L2ZIGECEfIBG4BabsWDPjBxJENv9Q==, tarball: https://registry.npmjs.org/simple-git/-/simple-git-3.36.0.tgz} - simple-swizzle@0.2.4: - resolution: {integrity: sha512-nAu1WFPQSMNr2Zn9PGSZK9AGn4t/y97lEm+MXTtUDwfP0ksAIX4nO+6ruD9Jwut4C49SB1Ws+fbXsm/yScWOHw==, tarball: https://registry.npmjs.org/simple-swizzle/-/simple-swizzle-0.2.4.tgz} - slash@3.0.0: resolution: {integrity: sha512-g9Q1haeby36OSStwb4ntCGGGaKsaVSjQ68fBxoQcutl5fS1vuY18H3wSt3jFyFtrkx+Kz0V1G85A4MyAdDMi2Q==, tarball: https://registry.npmjs.org/slash/-/slash-3.0.0.tgz} engines: {node: '>=8'} - slice-ansi@4.0.0: - resolution: {integrity: sha512-qMCMfhY040cVHT43K9BFygqYbUPFZKHOg7K73mtTWJRb8pyP3fzf4Ixd5SzdEJQ6MRUg/WBnOLxghZtKKurENQ==, tarball: https://registry.npmjs.org/slice-ansi/-/slice-ansi-4.0.0.tgz} - engines: {node: '>=10'} - slice-ansi@5.0.0: resolution: {integrity: sha512-FC+lgizVPfie0kkhqUScwRu1O/lF6NOgJmlCgK+/LYxDCTk8sGelYaHDhFcDN+Sn3Cv+3VSa4Byeo+IMCzpMgQ==, tarball: https://registry.npmjs.org/slice-ansi/-/slice-ansi-5.0.0.tgz} engines: {node: '>=12'} @@ -11743,37 +11687,6 @@ snapshots: - '@swc/core' - debug - '@oclif/core@3.26.5': - dependencies: - '@types/cli-progress': 3.11.6 - ansi-escapes: 4.3.2 - ansi-styles: 4.3.0 - cardinal: 2.1.1 - chalk: 4.1.2 - clean-stack: 3.0.1 - cli-progress: 3.12.0 - color: 4.2.3 - debug: 4.4.3(supports-color@8.1.1) - ejs: 3.1.10 - get-package-type: 0.1.0 - globby: 11.1.0 - hyperlinker: 1.0.0 - indent-string: 4.0.0 - is-wsl: 2.2.0 - js-yaml: 3.15.0 - minimatch: 9.0.9 - natural-orderby: 2.0.3 - object-treeify: 1.1.33 - password-prompt: 1.1.3 - slice-ansi: 4.0.0 - string-width: 4.2.3 - strip-ansi: 6.0.1 - supports-color: 8.1.1 - supports-hyperlinks: 3.2.0 - widest-line: 3.1.0 - wordwrap: 1.0.0 - wrap-ansi: 7.0.0 - '@oclif/core@4.11.14': dependencies: ansi-escapes: 4.3.2 @@ -12392,13 +12305,12 @@ snapshots: '@shikijs/vscode-textmate@10.0.2': {} - '@shopify/cli-hydrogen@13.0.6(@graphql-codegen/cli@6.3.1(@parcel/watcher@2.5.6)(@types/node@22.20.1)(crossws@0.3.5)(graphql@16.14.2)(typescript@5.9.3))(graphql-config@5.1.6(@types/node@26.1.1)(crossws@0.3.5)(graphql@16.14.2)(typescript@5.9.3))(graphql@16.14.2)(react-dom@19.2.4(react@18.3.1))(react@18.3.1)(vite@6.4.3(@types/node@26.1.1)(jiti@2.6.1)(sass@1.100.0)(tsx@4.23.1)(yaml@2.9.0))': + '@shopify/cli-hydrogen@13.1.0(@graphql-codegen/cli@6.3.1(@parcel/watcher@2.5.6)(@types/node@22.20.1)(crossws@0.3.5)(graphql@16.14.2)(typescript@5.9.3))(graphql-config@5.1.6(@types/node@26.1.1)(crossws@0.3.5)(graphql@16.14.2)(typescript@5.9.3))(graphql@16.14.2)(react-dom@19.2.4(react@18.3.1))(react@18.3.1)(vite@6.4.3(@types/node@26.1.1)(jiti@2.6.1)(sass@1.100.0)(tsx@4.23.1)(yaml@2.9.0))': dependencies: '@ast-grep/napi': 0.34.1 - '@oclif/core': 3.26.5 + '@oclif/core': 4.8.3 '@shopify/cli-kit': link:packages/cli-kit - '@shopify/oxygen-cli': 4.6.18(@oclif/core@3.26.5)(@shopify/cli-kit@packages+cli-kit)(graphql@16.14.2) - '@shopify/plugin-cloudflare': link:packages/plugin-cloudflare + '@shopify/oxygen-cli': 4.6.18(@oclif/core@4.8.3)(@shopify/cli-kit@packages+cli-kit)(graphql@16.14.2) ansi-escapes: 6.2.1 chokidar: 3.5.3 cli-truncate: 4.0.0 @@ -12500,12 +12412,12 @@ snapshots: dependencies: line-column: 1.0.2 - '@shopify/oxygen-cli@4.6.18(@oclif/core@3.26.5)(@shopify/cli-kit@packages+cli-kit)(graphql@16.14.2)': + '@shopify/oxygen-cli@4.6.18(@oclif/core@4.8.3)(@shopify/cli-kit@packages+cli-kit)(graphql@16.14.2)': dependencies: '@bugsnag/core': 8.9.0 '@bugsnag/js': 8.9.0 '@bugsnag/node': 8.9.0 - '@oclif/core': 3.26.5 + '@oclif/core': 4.8.3 '@shopify/cli-kit': link:packages/cli-kit async: 3.2.6 graphql-request: 7.4.0(graphql@16.14.2) @@ -12806,10 +12718,6 @@ snapshots: '@types/deep-eql': 4.0.2 assertion-error: 2.0.1 - '@types/cli-progress@3.11.6': - dependencies: - '@types/node': 22.20.1 - '@types/deep-eql@4.0.2': {} '@types/diff@5.2.3': {} @@ -13253,8 +13161,6 @@ snapshots: ansi-styles@6.2.3: {} - ansicolors@0.3.2: {} - ansis@3.17.0: {} anymatch@3.1.3: @@ -13389,8 +13295,6 @@ snapshots: ast-types-flow@0.0.8: {} - astral-regex@2.0.0: {} - async-function@1.0.0: {} async-retry@1.3.3: @@ -13635,11 +13539,6 @@ snapshots: tslib: 2.8.1 upper-case-first: 2.0.2 - cardinal@2.1.1: - dependencies: - ansicolors: 0.3.2 - redeyed: 2.1.1 - chai@6.2.2: {} chalk@2.4.2: @@ -13736,10 +13635,6 @@ snapshots: dependencies: restore-cursor: 5.1.0 - cli-progress@3.12.0: - dependencies: - string-width: 4.2.3 - cli-spinners@2.6.1: {} cli-spinners@2.9.2: {} @@ -13790,16 +13685,6 @@ snapshots: color-name@1.1.4: {} - color-string@1.9.1: - dependencies: - color-name: 1.1.4 - simple-swizzle: 0.2.4 - - color@4.2.3: - dependencies: - color-convert: 2.0.1 - color-string: 1.9.1 - colorette@2.0.20: {} columnify@1.6.0: @@ -15357,8 +15242,6 @@ snapshots: human-signals@5.0.0: {} - hyperlinker@1.0.0: {} - iconv-lite@0.6.3: dependencies: safer-buffer: 2.1.2 @@ -15500,8 +15383,6 @@ snapshots: is-arrayish@0.2.1: {} - is-arrayish@0.3.4: {} - is-async-function@2.1.1: dependencies: async-function: 1.0.0 @@ -16272,8 +16153,6 @@ snapshots: natural-compare@1.4.0: {} - natural-orderby@2.0.3: {} - natural-orderby@3.0.2: {} no-case@3.0.4: @@ -16492,8 +16371,6 @@ snapshots: object-keys@1.1.1: {} - object-treeify@1.1.33: {} - object-treeify@4.0.1: {} object.assign@4.1.7: @@ -16731,11 +16608,6 @@ snapshots: no-case: 3.0.4 tslib: 2.8.1 - password-prompt@1.1.3: - dependencies: - ansi-escapes: 4.3.2 - cross-spawn: 7.0.6 - patch-console@2.0.0: {} path-browserify@1.0.1: {} @@ -17063,10 +16935,6 @@ snapshots: indent-string: 4.0.0 strip-indent: 3.0.0 - redeyed@2.1.1: - dependencies: - esprima: 4.0.1 - reduce-flatten@2.0.0: {} reflect.getprototypeof@1.0.10: @@ -17408,18 +17276,8 @@ snapshots: transitivePeerDependencies: - supports-color - simple-swizzle@0.2.4: - dependencies: - is-arrayish: 0.3.4 - slash@3.0.0: {} - slice-ansi@4.0.0: - dependencies: - ansi-styles: 4.3.0 - astral-regex: 2.0.0 - is-fullwidth-code-point: 3.0.0 - slice-ansi@5.0.0: dependencies: ansi-styles: 6.2.3