{ "commands": { "hydrogen:build": { "aliases": [], "args": {}, "description": "Builds a Hydrogen storefront for production.", "flags": { "path": { "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.", "env": "SHOPIFY_HYDROGEN_FLAG_PATH", "name": "path", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "entry": { "description": "Entry file for the worker. Defaults to `./server`.", "env": "SHOPIFY_HYDROGEN_FLAG_ENTRY", "name": "entry", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "sourcemap": { "description": "Controls whether server sourcemaps are generated. Default to `true`. Deactivate `--no-sourcemaps`.", "env": "SHOPIFY_HYDROGEN_FLAG_SOURCEMAP", "name": "sourcemap", "allowNo": true, "type": "boolean" }, "lockfile-check": { "description": "Checks that there is exactly one valid lockfile in the project. Defaults to `true`. Deactivate with `--no-lockfile-check`.", "env": "SHOPIFY_HYDROGEN_FLAG_LOCKFILE_CHECK", "name": "lockfile-check", "allowNo": true, "type": "boolean" }, "disable-route-warning": { "description": "Disables any warnings about missing standard routes.", "env": "SHOPIFY_HYDROGEN_FLAG_DISABLE_ROUTE_WARNING", "name": "disable-route-warning", "allowNo": false, "type": "boolean" }, "codegen": { "description": "Automatically generates GraphQL types for your project’s Storefront API queries.", "name": "codegen", "required": false, "allowNo": false, "type": "boolean" }, "codegen-config-path": { "dependsOn": [ "codegen" ], "description": "Specifies a path to a codegen configuration file. Defaults to `/codegen.ts` if this file exists.", "name": "codegen-config-path", "required": false, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "watch": { "description": "Watches for changes and rebuilds the project writing output to disk.", "env": "SHOPIFY_HYDROGEN_FLAG_WATCH", "name": "watch", "allowNo": false, "type": "boolean" }, "bundle-stats": { "description": "Show a bundle size summary after building. Defaults to true, use `--no-bundle-stats` to disable.", "name": "bundle-stats", "allowNo": true, "type": "boolean" }, "force-client-sourcemap": { "description": "Client sourcemapping is avoided by default because it makes backend code visible in the browser. Use this flag to force enabling it.", "env": "SHOPIFY_HYDROGEN_FLAG_FORCE_CLIENT_SOURCEMAP", "name": "force-client-sourcemap", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "hydrogen:build", "pluginAlias": "@shopify/cli-hydrogen", "pluginName": "@shopify/cli-hydrogen", "pluginType": "core", "strict": true, "enableJsonFlag": false, "descriptionWithMarkdown": "Builds a Hydrogen storefront for production. The client and app worker files are compiled to a `/dist` folder in your Hydrogen project directory.", "isESM": true, "relativePath": [ "dist", "commands", "hydrogen", "build.js" ] }, "hydrogen:check": { "aliases": [], "args": { "resource": { "description": "The resource to check. Currently only 'routes' is supported.", "name": "resource", "options": [ "routes" ], "required": true } }, "description": "Returns diagnostic information about a Hydrogen storefront.", "flags": { "path": { "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.", "env": "SHOPIFY_HYDROGEN_FLAG_PATH", "name": "path", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "hydrogen:check", "pluginAlias": "@shopify/cli-hydrogen", "pluginName": "@shopify/cli-hydrogen", "pluginType": "core", "strict": true, "enableJsonFlag": false, "descriptionWithMarkdown": "Checks whether your Hydrogen app includes a set of standard Shopify routes.", "isESM": true, "relativePath": [ "dist", "commands", "hydrogen", "check.js" ] }, "hydrogen:codegen": { "aliases": [], "args": {}, "description": "Generate types for the Storefront API queries found in your project.", "flags": { "path": { "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.", "env": "SHOPIFY_HYDROGEN_FLAG_PATH", "name": "path", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "codegen-config-path": { "description": "Specify a path to a codegen configuration file. Defaults to `/codegen.ts` if it exists.", "name": "codegen-config-path", "required": false, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "force-sfapi-version": { "description": "Force generating Storefront API types for a specific version instead of using the one provided in Hydrogen. A token can also be provided with this format: `:`.", "hidden": true, "name": "force-sfapi-version", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "watch": { "description": "Watch the project for changes to update types on file save.", "name": "watch", "required": false, "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "hydrogen:codegen", "pluginAlias": "@shopify/cli-hydrogen", "pluginName": "@shopify/cli-hydrogen", "pluginType": "core", "strict": true, "enableJsonFlag": false, "descriptionWithMarkdown": "Automatically generates GraphQL types for your project’s Storefront API queries.", "isESM": true, "relativePath": [ "dist", "commands", "hydrogen", "codegen.js" ] }, "hydrogen:customer-account:push": { "aliases": [], "args": {}, "description": "Push project configuration to admin", "flags": { "path": { "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.", "env": "SHOPIFY_HYDROGEN_FLAG_PATH", "name": "path", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "storefront-id": { "description": "The id of the storefront the configuration should be pushed to. Must start with 'gid://shopify/HydrogenStorefront/'", "name": "storefront-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "dev-origin": { "description": "The development domain of your application.", "name": "dev-origin", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "relative-redirect-uri": { "description": "The relative url of allowed callback url for Customer Account API OAuth flow. Default is '/account/authorize'", "name": "relative-redirect-uri", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "relative-logout-uri": { "description": "The relative url of allowed url that will be redirected to post-logout for Customer Account API OAuth flow. Default to nothing.", "name": "relative-logout-uri", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "hydrogen:customer-account:push", "pluginAlias": "@shopify/cli-hydrogen", "pluginName": "@shopify/cli-hydrogen", "pluginType": "core", "strict": true, "enableJsonFlag": false, "isESM": true, "relativePath": [ "dist", "commands", "hydrogen", "customer-account", "push.js" ] }, "hydrogen:debug:cpu": { "aliases": [], "args": {}, "description": "Builds and profiles the server startup time the app.", "flags": { "path": { "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.", "env": "SHOPIFY_HYDROGEN_FLAG_PATH", "name": "path", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "entry": { "description": "Entry file for the worker. Defaults to `./server`.", "env": "SHOPIFY_HYDROGEN_FLAG_ENTRY", "name": "entry", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "output": { "description": "Specify a path to generate the profile file. Defaults to \"startup.cpuprofile\".", "name": "output", "required": false, "default": "startup.cpuprofile", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "hydrogen:debug:cpu", "pluginAlias": "@shopify/cli-hydrogen", "pluginName": "@shopify/cli-hydrogen", "pluginType": "core", "strict": true, "enableJsonFlag": false, "descriptionWithMarkdown": "Builds the app and runs the resulting code to profile the server startup time, watching for changes. This command can be used to [debug slow app startup times](https://shopify.dev/docs/custom-storefronts/hydrogen/debugging/cpu-startup) that cause failed deployments in Oxygen.\n\n The profiling results are written to a `.cpuprofile` file that can be viewed with certain tools such as [Flame Chart Visualizer for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=ms-vscode.vscode-js-profile-flame).", "isESM": true, "relativePath": [ "dist", "commands", "hydrogen", "debug", "cpu.js" ] }, "hydrogen:deploy": { "aliases": [], "args": {}, "description": "Builds and deploys a Hydrogen storefront to Oxygen.", "flags": { "entry": { "description": "Entry file for the worker. Defaults to `./server`.", "env": "SHOPIFY_HYDROGEN_FLAG_ENTRY", "name": "entry", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "env": { "description": "Specifies the environment to perform the operation using its handle. Fetch the handle using the `env list` command.", "exclusive": [ "env-branch" ], "name": "env", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "env-branch": { "deprecated": { "to": "env", "message": "--env-branch is deprecated. Use --env instead." }, "description": "Specifies the environment to perform the operation using its Git branch name.", "env": "SHOPIFY_HYDROGEN_ENVIRONMENT_BRANCH", "name": "env-branch", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "env-file": { "description": "Path to an environment file to override existing environment variables for the deployment.", "name": "env-file", "required": false, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "preview": { "description": "Deploys to the Preview environment.", "name": "preview", "required": false, "allowNo": false, "type": "boolean" }, "force": { "char": "f", "description": "Forces a deployment to proceed if there are uncommited changes in its Git repository.", "env": "SHOPIFY_HYDROGEN_FLAG_FORCE", "name": "force", "required": false, "allowNo": false, "type": "boolean" }, "no-verify": { "description": "Skip the routability verification step after deployment.", "name": "no-verify", "required": false, "allowNo": false, "type": "boolean" }, "auth-bypass-token": { "description": "Generate an authentication bypass token, which can be used to perform end-to-end tests against the deployment.", "env": "AUTH_BYPASS_TOKEN", "name": "auth-bypass-token", "required": false, "allowNo": false, "type": "boolean" }, "auth-bypass-token-duration": { "dependsOn": [ "auth-bypass-token" ], "description": "Specify the duration (in hours) up to 12 hours for the authentication bypass token. Defaults to `2`", "env": "AUTH_BYPASS_TOKEN_DURATION", "name": "auth-bypass-token-duration", "required": false, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "build-command": { "description": "Specify a build command to run before deploying. If not specified, `shopify hydrogen build` will be used.", "name": "build-command", "required": false, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "lockfile-check": { "description": "Checks that there is exactly one valid lockfile in the project. Defaults to `true`. Deactivate with `--no-lockfile-check`.", "env": "SHOPIFY_HYDROGEN_FLAG_LOCKFILE_CHECK", "name": "lockfile-check", "allowNo": true, "type": "boolean" }, "path": { "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.", "env": "SHOPIFY_HYDROGEN_FLAG_PATH", "name": "path", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "shop": { "char": "s", "description": "Shop URL. It can be the shop prefix (janes-apparel) or the full myshopify.com URL (janes-apparel.myshopify.com, https://janes-apparel.myshopify.com).", "env": "SHOPIFY_SHOP", "name": "shop", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "json-output": { "description": "Create a JSON file containing the deployment details in CI environments. Defaults to true, use `--no-json-output` to disable.", "name": "json-output", "required": false, "allowNo": true, "type": "boolean" }, "token": { "char": "t", "description": "Oxygen deployment token. Defaults to the linked storefront's token if available.", "env": "SHOPIFY_HYDROGEN_DEPLOYMENT_TOKEN", "name": "token", "required": false, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "metadata-description": { "description": "Description of the changes in the deployment. Defaults to the commit message of the latest commit if there are no uncommited changes.", "env": "SHOPIFY_HYDROGEN_FLAG_METADATA_DESCRIPTION", "name": "metadata-description", "required": false, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "metadata-url": { "env": "SHOPIFY_HYDROGEN_FLAG_METADATA_URL", "hidden": true, "name": "metadata-url", "required": false, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "metadata-user": { "description": "User that initiated the deployment. Will be saved and displayed in the Shopify admin", "env": "SHOPIFY_HYDROGEN_FLAG_METADATA_USER", "name": "metadata-user", "required": false, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "metadata-version": { "env": "SHOPIFY_HYDROGEN_FLAG_METADATA_VERSION", "hidden": true, "name": "metadata-version", "required": false, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "force-client-sourcemap": { "description": "Client sourcemapping is avoided by default because it makes backend code visible in the browser. Use this flag to force enabling it.", "env": "SHOPIFY_HYDROGEN_FLAG_FORCE_CLIENT_SOURCEMAP", "name": "force-client-sourcemap", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "hydrogen:deploy", "pluginAlias": "@shopify/cli-hydrogen", "pluginName": "@shopify/cli-hydrogen", "pluginType": "core", "strict": true, "enableJsonFlag": false, "descriptionWithMarkdown": "Builds and deploys your Hydrogen storefront to Oxygen. Requires an Oxygen deployment token to be set with the `--token` flag or an environment variable (`SHOPIFY_HYDROGEN_DEPLOYMENT_TOKEN`). If the storefront is [linked](https://shopify.dev/docs/api/shopify-cli/hydrogen/hydrogen-link) then the Oxygen deployment token for the linked storefront will be used automatically.", "isESM": true, "relativePath": [ "dist", "commands", "hydrogen", "deploy.js" ] }, "hydrogen:dev": { "aliases": [], "args": {}, "description": "Runs Hydrogen storefront in an Oxygen worker for development.", "flags": { "path": { "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.", "env": "SHOPIFY_HYDROGEN_FLAG_PATH", "name": "path", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "entry": { "description": "Entry file for the worker. Defaults to `./server`.", "env": "SHOPIFY_HYDROGEN_FLAG_ENTRY", "name": "entry", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "port": { "description": "The port to run the server on. Defaults to 3000.", "env": "SHOPIFY_HYDROGEN_FLAG_PORT", "name": "port", "required": false, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "codegen": { "description": "Automatically generates GraphQL types for your project’s Storefront API queries.", "name": "codegen", "required": false, "allowNo": false, "type": "boolean" }, "codegen-config-path": { "dependsOn": [ "codegen" ], "description": "Specifies a path to a codegen configuration file. Defaults to `/codegen.ts` if this file exists.", "name": "codegen-config-path", "required": false, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "disable-virtual-routes": { "description": "Disable rendering fallback routes when a route file doesn't exist.", "env": "SHOPIFY_HYDROGEN_FLAG_DISABLE_VIRTUAL_ROUTES", "name": "disable-virtual-routes", "allowNo": false, "type": "boolean" }, "debug": { "description": "Enables inspector connections to the server with a debugger such as Visual Studio Code or Chrome DevTools.", "env": "SHOPIFY_HYDROGEN_FLAG_DEBUG", "name": "debug", "allowNo": false, "type": "boolean" }, "inspector-port": { "description": "The port where the inspector is available. Defaults to 9229.", "env": "SHOPIFY_HYDROGEN_FLAG_INSPECTOR_PORT", "name": "inspector-port", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "env": { "description": "Specifies the environment to perform the operation using its handle. Fetch the handle using the `env list` command.", "exclusive": [ "env-branch" ], "name": "env", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "env-branch": { "deprecated": { "to": "env", "message": "--env-branch is deprecated. Use --env instead." }, "description": "Specifies the environment to perform the operation using its Git branch name.", "env": "SHOPIFY_HYDROGEN_ENVIRONMENT_BRANCH", "name": "env-branch", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "env-file": { "description": "Path to an environment file to override existing environment variables. Defaults to the '.env' located in your project path `--path`.", "name": "env-file", "required": false, "default": ".env", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "disable-version-check": { "description": "Skip the version check when running `hydrogen dev`", "name": "disable-version-check", "required": false, "allowNo": false, "type": "boolean" }, "customer-account-push": { "description": "Use tunneling for local development and push the tunneling domain to admin. Required to use Customer Account API's OAuth flow", "env": "SHOPIFY_HYDROGEN_FLAG_CUSTOMER_ACCOUNT_PUSH", "name": "customer-account-push", "required": false, "allowNo": false, "type": "boolean" }, "verbose": { "description": "Outputs more information about the command's execution.", "env": "SHOPIFY_HYDROGEN_FLAG_VERBOSE", "name": "verbose", "required": false, "allowNo": false, "type": "boolean" }, "host": { "description": "Expose the server to the local network", "name": "host", "required": false, "allowNo": false, "type": "boolean" }, "disable-deps-optimizer": { "description": "Disable adding dependencies to Vite's `ssr.optimizeDeps.include` automatically", "env": "SHOPIFY_HYDROGEN_FLAG_DISABLE_DEPS_OPTIMIZER", "name": "disable-deps-optimizer", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "hydrogen:dev", "pluginAlias": "@shopify/cli-hydrogen", "pluginName": "@shopify/cli-hydrogen", "pluginType": "core", "strict": true, "enableJsonFlag": false, "descriptionWithMarkdown": "Runs a Hydrogen storefront in a local runtime that emulates an Oxygen worker for development.\n\n If your project is [linked](https://shopify.dev/docs/api/shopify-cli/hydrogen/hydrogen-link) to a Hydrogen storefront, then its environment variables will be loaded with the runtime.", "isESM": true, "relativePath": [ "dist", "commands", "hydrogen", "dev.js" ] }, "hydrogen:env:list": { "aliases": [], "args": {}, "description": "List the environments on your linked Hydrogen storefront.", "flags": { "path": { "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.", "env": "SHOPIFY_HYDROGEN_FLAG_PATH", "name": "path", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "hydrogen:env:list", "pluginAlias": "@shopify/cli-hydrogen", "pluginName": "@shopify/cli-hydrogen", "pluginType": "core", "strict": true, "enableJsonFlag": false, "descriptionWithMarkdown": "Lists all environments available on the linked Hydrogen storefront.", "isESM": true, "relativePath": [ "dist", "commands", "hydrogen", "env", "list.js" ] }, "hydrogen:env:pull": { "aliases": [], "args": {}, "description": "Populate your .env with variables from your Hydrogen storefront.", "flags": { "env": { "description": "Specifies the environment to perform the operation using its handle. Fetch the handle using the `env list` command.", "exclusive": [ "env-branch" ], "name": "env", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "env-branch": { "deprecated": { "to": "env", "message": "--env-branch is deprecated. Use --env instead." }, "description": "Specifies the environment to perform the operation using its Git branch name.", "env": "SHOPIFY_HYDROGEN_ENVIRONMENT_BRANCH", "name": "env-branch", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "env-file": { "description": "Path to an environment file to override existing environment variables. Defaults to the '.env' located in your project path `--path`.", "name": "env-file", "required": false, "default": ".env", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "path": { "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.", "env": "SHOPIFY_HYDROGEN_FLAG_PATH", "name": "path", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "force": { "char": "f", "description": "Overwrites the destination directory and files if they already exist.", "env": "SHOPIFY_HYDROGEN_FLAG_FORCE", "name": "force", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "hydrogen:env:pull", "pluginAlias": "@shopify/cli-hydrogen", "pluginName": "@shopify/cli-hydrogen", "pluginType": "core", "strict": true, "enableJsonFlag": false, "descriptionWithMarkdown": "Pulls environment variables from the linked Hydrogen storefront and writes them to an `.env` file.", "isESM": true, "relativePath": [ "dist", "commands", "hydrogen", "env", "pull.js" ] }, "hydrogen:env:push": { "aliases": [], "args": {}, "description": "Push environment variables from the local .env file to your linked Hydrogen storefront.", "flags": { "env": { "description": "Specifies the environment to perform the operation using its handle. Fetch the handle using the `env list` command.", "exclusive": [ "env-branch" ], "name": "env", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "env-file": { "description": "Path to an environment file to override existing environment variables. Defaults to the '.env' located in your project path `--path`.", "name": "env-file", "required": false, "default": ".env", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "path": { "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.", "env": "SHOPIFY_HYDROGEN_FLAG_PATH", "name": "path", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "hydrogen:env:push", "pluginAlias": "@shopify/cli-hydrogen", "pluginName": "@shopify/cli-hydrogen", "pluginType": "core", "strict": true, "enableJsonFlag": false, "isESM": true, "relativePath": [ "dist", "commands", "hydrogen", "env", "push.js" ] }, "hydrogen:g": { "aliases": [], "args": {}, "description": "Shortcut for `hydrogen generate`. See `hydrogen generate --help` for more information.", "flags": {}, "hasDynamicHelp": false, "hidden": true, "hiddenAliases": [], "id": "hydrogen:g", "pluginAlias": "@shopify/cli-hydrogen", "pluginName": "@shopify/cli-hydrogen", "pluginType": "core", "strict": false, "enableJsonFlag": false, "isESM": true, "relativePath": [ "dist", "commands", "hydrogen", "g.js" ] }, "hydrogen:generate:route": { "aliases": [], "args": { "routeName": { "description": "The route to generate. One of home,page,cart,products,collections,policies,blogs,account,search,robots,sitemap,all.", "name": "routeName", "options": [ "home", "page", "cart", "products", "collections", "policies", "blogs", "account", "search", "robots", "sitemap", "all" ], "required": true } }, "description": "Generates a standard Shopify route.", "flags": { "adapter": { "description": "Remix adapter used in the route. The default is `@shopify/remix-oxygen`.", "env": "SHOPIFY_HYDROGEN_FLAG_ADAPTER", "name": "adapter", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "typescript": { "description": "Generate TypeScript files", "env": "SHOPIFY_HYDROGEN_FLAG_TYPESCRIPT", "name": "typescript", "allowNo": false, "type": "boolean" }, "locale-param": { "description": "The param name in Remix routes for the i18n locale, if any. Example: `locale` becomes ($locale).", "env": "SHOPIFY_HYDROGEN_FLAG_ADAPTER", "name": "locale-param", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "force": { "char": "f", "description": "Overwrites the destination directory and files if they already exist.", "env": "SHOPIFY_HYDROGEN_FLAG_FORCE", "name": "force", "allowNo": false, "type": "boolean" }, "path": { "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.", "env": "SHOPIFY_HYDROGEN_FLAG_PATH", "name": "path", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "hydrogen:generate:route", "pluginAlias": "@shopify/cli-hydrogen", "pluginName": "@shopify/cli-hydrogen", "pluginType": "core", "strict": true, "enableJsonFlag": false, "descriptionWithMarkdown": "Generates a set of default routes from the starter template.", "isESM": true, "relativePath": [ "dist", "commands", "hydrogen", "generate", "route.js" ] }, "hydrogen:generate:routes": { "aliases": [], "args": {}, "description": "Generates all supported standard shopify routes.", "flags": { "adapter": { "description": "Remix adapter used in the route. The default is `@shopify/remix-oxygen`.", "env": "SHOPIFY_HYDROGEN_FLAG_ADAPTER", "name": "adapter", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "typescript": { "description": "Generate TypeScript files", "env": "SHOPIFY_HYDROGEN_FLAG_TYPESCRIPT", "name": "typescript", "allowNo": false, "type": "boolean" }, "locale-param": { "description": "The param name in Remix routes for the i18n locale, if any. Example: `locale` becomes ($locale).", "env": "SHOPIFY_HYDROGEN_FLAG_ADAPTER", "name": "locale-param", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "force": { "char": "f", "description": "Overwrites the destination directory and files if they already exist.", "env": "SHOPIFY_HYDROGEN_FLAG_FORCE", "name": "force", "allowNo": false, "type": "boolean" }, "path": { "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.", "env": "SHOPIFY_HYDROGEN_FLAG_PATH", "name": "path", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "hydrogen:generate:routes", "pluginAlias": "@shopify/cli-hydrogen", "pluginName": "@shopify/cli-hydrogen", "pluginType": "core", "strict": true, "enableJsonFlag": false, "isESM": true, "relativePath": [ "dist", "commands", "hydrogen", "generate", "routes.js" ] }, "hydrogen:init": { "aliases": [], "args": {}, "description": "Creates a new Hydrogen storefront.", "flags": { "force": { "char": "f", "description": "Overwrites the destination directory and files if they already exist.", "env": "SHOPIFY_HYDROGEN_FLAG_FORCE", "name": "force", "allowNo": false, "type": "boolean" }, "path": { "description": "The path to the directory of the new Hydrogen storefront.", "env": "SHOPIFY_HYDROGEN_FLAG_PATH", "name": "path", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "language": { "description": "Sets the template language to use. One of `js` or `ts`.", "env": "SHOPIFY_HYDROGEN_FLAG_LANGUAGE", "name": "language", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "template": { "description": "Scaffolds project based on an existing template or example from the Hydrogen repository.", "env": "SHOPIFY_HYDROGEN_FLAG_TEMPLATE", "name": "template", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "install-deps": { "description": "Auto installs dependencies using the active package manager.", "env": "SHOPIFY_HYDROGEN_FLAG_INSTALL_DEPS", "name": "install-deps", "allowNo": true, "type": "boolean" }, "mock-shop": { "description": "Use mock.shop as the data source for the storefront.", "env": "SHOPIFY_HYDROGEN_FLAG_MOCK_DATA", "name": "mock-shop", "allowNo": false, "type": "boolean" }, "styling": { "description": "Sets the styling strategy to use. One of `tailwind`, `vanilla-extract`, `css-modules`, `postcss`, `none`.", "env": "SHOPIFY_HYDROGEN_FLAG_STYLING", "name": "styling", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "markets": { "description": "Sets the URL structure to support multiple markets. Must be one of: `subfolders`, `domains`, `subdomains`, `none`. Example: `--markets subfolders`.", "env": "SHOPIFY_HYDROGEN_FLAG_I18N", "name": "markets", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "shortcut": { "description": "Creates a global h2 shortcut for Shopify CLI using shell aliases. Deactivate with `--no-shortcut`.", "env": "SHOPIFY_HYDROGEN_FLAG_SHORTCUT", "name": "shortcut", "allowNo": true, "type": "boolean" }, "git": { "description": "Init Git and create initial commits.", "env": "SHOPIFY_HYDROGEN_FLAG_GIT", "name": "git", "allowNo": true, "type": "boolean" }, "quickstart": { "description": "Scaffolds a new Hydrogen project with a set of sensible defaults. Equivalent to `shopify hydrogen init --path hydrogen-quickstart --mock-shop --language js --shortcut --markets none`", "env": "SHOPIFY_HYDROGEN_FLAG_QUICKSTART", "name": "quickstart", "allowNo": false, "type": "boolean" }, "package-manager": { "env": "SHOPIFY_HYDROGEN_FLAG_PACKAGE_MANAGER", "hidden": true, "name": "package-manager", "hasDynamicHelp": false, "multiple": false, "options": [ "npm", "yarn", "pnpm", "unknown" ], "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "hydrogen:init", "pluginAlias": "@shopify/cli-hydrogen", "pluginName": "@shopify/cli-hydrogen", "pluginType": "core", "strict": true, "enableJsonFlag": false, "descriptionWithMarkdown": "Creates a new Hydrogen storefront.", "isESM": true, "relativePath": [ "dist", "commands", "hydrogen", "init.js" ] }, "hydrogen:link": { "aliases": [], "args": {}, "description": "Link a local project to one of your shop's Hydrogen storefronts.", "flags": { "force": { "char": "f", "description": "Overwrites the destination directory and files if they already exist.", "env": "SHOPIFY_HYDROGEN_FLAG_FORCE", "name": "force", "allowNo": false, "type": "boolean" }, "path": { "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.", "env": "SHOPIFY_HYDROGEN_FLAG_PATH", "name": "path", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "storefront": { "description": "The name of a Hydrogen Storefront (e.g. \"Jane's Apparel\")", "env": "SHOPIFY_HYDROGEN_STOREFRONT", "name": "storefront", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "hydrogen:link", "pluginAlias": "@shopify/cli-hydrogen", "pluginName": "@shopify/cli-hydrogen", "pluginType": "core", "strict": true, "enableJsonFlag": false, "descriptionWithMarkdown": "Links your local development environment to a remote Hydrogen storefront. You can link an unlimited number of development environments to a single Hydrogen storefront.\n\n Linking to a Hydrogen storefront enables you to run [dev](https://shopify.dev/docs/api/shopify-cli/hydrogen/hydrogen-dev) and automatically inject your linked Hydrogen storefront's environment variables directly into the server runtime.\n\n After you run the `link` command, you can access the [env list](https://shopify.dev/docs/api/shopify-cli/hydrogen/hydrogen-env-list), [env pull](https://shopify.dev/docs/api/shopify-cli/hydrogen/hydrogen-env-pull), and [unlink](https://shopify.dev/docs/api/shopify-cli/hydrogen/hydrogen-unlink) commands.", "isESM": true, "relativePath": [ "dist", "commands", "hydrogen", "link.js" ] }, "hydrogen:list": { "aliases": [], "args": {}, "description": "Returns a list of Hydrogen storefronts available on a given shop.", "flags": { "path": { "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.", "env": "SHOPIFY_HYDROGEN_FLAG_PATH", "name": "path", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "hydrogen:list", "pluginAlias": "@shopify/cli-hydrogen", "pluginName": "@shopify/cli-hydrogen", "pluginType": "core", "strict": true, "enableJsonFlag": false, "descriptionWithMarkdown": "Lists all remote Hydrogen storefronts available to link to your local development environment.", "isESM": true, "relativePath": [ "dist", "commands", "hydrogen", "list.js" ] }, "hydrogen:login": { "aliases": [], "args": {}, "description": "Login to your Shopify account.", "flags": { "path": { "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.", "env": "SHOPIFY_HYDROGEN_FLAG_PATH", "name": "path", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "shop": { "char": "s", "description": "Shop URL. It can be the shop prefix (janes-apparel) or the full myshopify.com URL (janes-apparel.myshopify.com, https://janes-apparel.myshopify.com).", "env": "SHOPIFY_SHOP", "name": "shop", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "hydrogen:login", "pluginAlias": "@shopify/cli-hydrogen", "pluginName": "@shopify/cli-hydrogen", "pluginType": "core", "strict": true, "enableJsonFlag": false, "descriptionWithMarkdown": "Logs in to the specified shop and saves the shop domain to the project.", "isESM": true, "relativePath": [ "dist", "commands", "hydrogen", "login.js" ] }, "hydrogen:logout": { "aliases": [], "args": {}, "description": "Logout of your local session.", "flags": { "path": { "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.", "env": "SHOPIFY_HYDROGEN_FLAG_PATH", "name": "path", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "hydrogen:logout", "pluginAlias": "@shopify/cli-hydrogen", "pluginName": "@shopify/cli-hydrogen", "pluginType": "core", "strict": true, "enableJsonFlag": false, "descriptionWithMarkdown": "Log out from the current shop.", "isESM": true, "relativePath": [ "dist", "commands", "hydrogen", "logout.js" ] }, "hydrogen:preview": { "aliases": [], "args": {}, "description": "Runs a Hydrogen storefront in an Oxygen worker for production.", "flags": { "path": { "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.", "env": "SHOPIFY_HYDROGEN_FLAG_PATH", "name": "path", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "port": { "description": "The port to run the server on. Defaults to 3000.", "env": "SHOPIFY_HYDROGEN_FLAG_PORT", "name": "port", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "env": { "description": "Specifies the environment to perform the operation using its handle. Fetch the handle using the `env list` command.", "exclusive": [ "env-branch" ], "name": "env", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "env-branch": { "deprecated": { "to": "env", "message": "--env-branch is deprecated. Use --env instead." }, "description": "Specifies the environment to perform the operation using its Git branch name.", "env": "SHOPIFY_HYDROGEN_ENVIRONMENT_BRANCH", "name": "env-branch", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "env-file": { "description": "Path to an environment file to override existing environment variables. Defaults to the '.env' located in your project path `--path`.", "name": "env-file", "required": false, "default": ".env", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "inspector-port": { "description": "The port where the inspector is available. Defaults to 9229.", "env": "SHOPIFY_HYDROGEN_FLAG_INSPECTOR_PORT", "name": "inspector-port", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "debug": { "description": "Enables inspector connections to the server with a debugger such as Visual Studio Code or Chrome DevTools.", "env": "SHOPIFY_HYDROGEN_FLAG_DEBUG", "name": "debug", "allowNo": false, "type": "boolean" }, "verbose": { "description": "Outputs more information about the command's execution.", "env": "SHOPIFY_HYDROGEN_FLAG_VERBOSE", "name": "verbose", "required": false, "allowNo": false, "type": "boolean" }, "build": { "description": "Builds the app before starting the preview server.", "name": "build", "allowNo": false, "type": "boolean" }, "watch": { "dependsOn": [ "build" ], "description": "Watches for changes and rebuilds the project.", "name": "watch", "allowNo": false, "type": "boolean" }, "entry": { "dependsOn": [ "build" ], "description": "Entry file for the worker. Defaults to `./server`.", "env": "SHOPIFY_HYDROGEN_FLAG_ENTRY", "name": "entry", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "codegen": { "dependsOn": [ "build" ], "description": "Automatically generates GraphQL types for your project’s Storefront API queries.", "name": "codegen", "required": false, "allowNo": false, "type": "boolean" }, "codegen-config-path": { "dependsOn": [ "codegen" ], "description": "Specifies a path to a codegen configuration file. Defaults to `/codegen.ts` if this file exists.", "name": "codegen-config-path", "required": false, "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "hydrogen:preview", "pluginAlias": "@shopify/cli-hydrogen", "pluginName": "@shopify/cli-hydrogen", "pluginType": "core", "strict": true, "enableJsonFlag": false, "descriptionWithMarkdown": "Runs a server in your local development environment that serves your Hydrogen app's production build. Requires running the [build](https://shopify.dev/docs/api/shopify-cli/hydrogen/hydrogen-build) command first.", "isESM": true, "relativePath": [ "dist", "commands", "hydrogen", "preview.js" ] }, "hydrogen:setup": { "aliases": [], "args": {}, "description": "Scaffold routes and core functionality.", "flags": { "path": { "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.", "env": "SHOPIFY_HYDROGEN_FLAG_PATH", "name": "path", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "force": { "char": "f", "description": "Overwrites the destination directory and files if they already exist.", "env": "SHOPIFY_HYDROGEN_FLAG_FORCE", "name": "force", "allowNo": false, "type": "boolean" }, "markets": { "description": "Sets the URL structure to support multiple markets. Must be one of: `subfolders`, `domains`, `subdomains`, `none`. Example: `--markets subfolders`.", "env": "SHOPIFY_HYDROGEN_FLAG_I18N", "name": "markets", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "shortcut": { "description": "Creates a global h2 shortcut for Shopify CLI using shell aliases. Deactivate with `--no-shortcut`.", "env": "SHOPIFY_HYDROGEN_FLAG_SHORTCUT", "name": "shortcut", "allowNo": true, "type": "boolean" }, "install-deps": { "description": "Auto installs dependencies using the active package manager.", "env": "SHOPIFY_HYDROGEN_FLAG_INSTALL_DEPS", "name": "install-deps", "allowNo": true, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "hydrogen:setup", "pluginAlias": "@shopify/cli-hydrogen", "pluginName": "@shopify/cli-hydrogen", "pluginType": "core", "strict": true, "enableJsonFlag": false, "isESM": true, "relativePath": [ "dist", "commands", "hydrogen", "setup.js" ] }, "hydrogen:setup:css": { "aliases": [], "args": { "strategy": { "description": "The CSS strategy to setup. One of tailwind,vanilla-extract,css-modules,postcss", "name": "strategy", "options": [ "tailwind", "vanilla-extract", "css-modules", "postcss" ] } }, "description": "Setup CSS strategies for your project.", "flags": { "path": { "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.", "env": "SHOPIFY_HYDROGEN_FLAG_PATH", "name": "path", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "force": { "char": "f", "description": "Overwrites the destination directory and files if they already exist.", "env": "SHOPIFY_HYDROGEN_FLAG_FORCE", "name": "force", "allowNo": false, "type": "boolean" }, "install-deps": { "description": "Auto installs dependencies using the active package manager.", "env": "SHOPIFY_HYDROGEN_FLAG_INSTALL_DEPS", "name": "install-deps", "allowNo": true, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "hydrogen:setup:css", "pluginAlias": "@shopify/cli-hydrogen", "pluginName": "@shopify/cli-hydrogen", "pluginType": "core", "strict": true, "enableJsonFlag": false, "descriptionWithMarkdown": "Adds support for certain CSS strategies to your project.", "isESM": true, "relativePath": [ "dist", "commands", "hydrogen", "setup", "css.js" ] }, "hydrogen:setup:markets": { "aliases": [], "args": { "strategy": { "description": "The URL structure strategy to setup multiple markets. One of subfolders,domains,subdomains", "name": "strategy", "options": [ "subfolders", "domains", "subdomains" ] } }, "description": "Setup support for multiple markets in your project.", "flags": { "path": { "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.", "env": "SHOPIFY_HYDROGEN_FLAG_PATH", "name": "path", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "hydrogen:setup:markets", "pluginAlias": "@shopify/cli-hydrogen", "pluginName": "@shopify/cli-hydrogen", "pluginType": "core", "strict": true, "enableJsonFlag": false, "descriptionWithMarkdown": "Adds support for multiple [markets](https://shopify.dev/docs/custom-storefronts/hydrogen/markets) to your project by using the URL structure.", "isESM": true, "relativePath": [ "dist", "commands", "hydrogen", "setup", "markets.js" ] }, "hydrogen:setup:vite": { "aliases": [], "args": {}, "description": "EXPERIMENTAL: Upgrades the project to use Vite.", "flags": { "path": { "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.", "env": "SHOPIFY_HYDROGEN_FLAG_PATH", "name": "path", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "hydrogen:setup:vite", "pluginAlias": "@shopify/cli-hydrogen", "pluginName": "@shopify/cli-hydrogen", "pluginType": "core", "strict": true, "enableJsonFlag": false, "isESM": true, "relativePath": [ "dist", "commands", "hydrogen", "setup", "vite.js" ] }, "hydrogen:shortcut": { "aliases": [], "args": {}, "description": "Creates a global `h2` shortcut for the Hydrogen CLI", "flags": {}, "hasDynamicHelp": false, "hiddenAliases": [], "id": "hydrogen:shortcut", "pluginAlias": "@shopify/cli-hydrogen", "pluginName": "@shopify/cli-hydrogen", "pluginType": "core", "strict": true, "enableJsonFlag": false, "descriptionWithMarkdown": "Creates a global h2 shortcut for Shopify CLI using shell aliases.\n\n The following shells are supported:\n\n - Bash (using `~/.bashrc`)\n - ZSH (using `~/.zshrc`)\n - Fish (using `~/.config/fish/functions`)\n - PowerShell (added to `$PROFILE`)\n\n After the alias is created, you can call Shopify CLI from anywhere in your project using `h2 `.", "isESM": true, "relativePath": [ "dist", "commands", "hydrogen", "shortcut.js" ] }, "hydrogen:unlink": { "aliases": [], "args": {}, "description": "Unlink a local project from a Hydrogen storefront.", "flags": { "path": { "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.", "env": "SHOPIFY_HYDROGEN_FLAG_PATH", "name": "path", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "hydrogen:unlink", "pluginAlias": "@shopify/cli-hydrogen", "pluginName": "@shopify/cli-hydrogen", "pluginType": "core", "strict": true, "enableJsonFlag": false, "descriptionWithMarkdown": "Unlinks your local development environment from a remote Hydrogen storefront.", "isESM": true, "relativePath": [ "dist", "commands", "hydrogen", "unlink.js" ] }, "hydrogen:upgrade": { "aliases": [], "args": {}, "description": "Upgrade Remix and Hydrogen npm dependencies.", "flags": { "path": { "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.", "env": "SHOPIFY_HYDROGEN_FLAG_PATH", "name": "path", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "version": { "char": "v", "description": "A target hydrogen version to update to", "name": "version", "required": false, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "force": { "char": "f", "description": "Ignore warnings and force the upgrade to the target version", "env": "SHOPIFY_HYDROGEN_FLAG_FORCE", "name": "force", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "hydrogen:upgrade", "pluginAlias": "@shopify/cli-hydrogen", "pluginName": "@shopify/cli-hydrogen", "pluginType": "core", "strict": true, "enableJsonFlag": false, "descriptionWithMarkdown": "Upgrade Hydrogen project dependencies, preview features, fixes and breaking changes. The command also generates an instruction file for each upgrade.", "isESM": true, "relativePath": [ "dist", "commands", "hydrogen", "upgrade.js" ] } }, "version": "11.1.15" }