hydrogen dev
Runs a Hydrogen storefront in a local runtime that emulates an Oxygen worker for development.
If your project is linked to a Hydrogen storefront, then its environment variables will be loaded with the runtime.
Anchor to flagsFlags
The following flags are available for the hydrogen dev command:
- Anchor to --codegen--codegen--codegen''''
Automatically generates GraphQL types for your project’s Storefront API queries.
- Anchor to --codegen-config-path <value>--codegen-config-path <value>--codegen-config-path <value>stringstring
Specifies a path to a codegen configuration file. Defaults to
<root>/codegen.tsif this file exists.- Anchor to --customer-account-push--customer-account-push--customer-account-push''''env: SHOPIFY_HYDROGEN_FLAG_CUSTOMER_ACCOUNT_PUSHenv: SHOPIFY_HYDROGEN_FLAG_CUSTOMER_ACCOUNT_PUSH
Use tunneling for local development and push the tunneling domain to admin. Required to use Customer Account API's OAuth flow
- Anchor to --debug--debug--debug''''env: SHOPIFY_HYDROGEN_FLAG_DEBUGenv: SHOPIFY_HYDROGEN_FLAG_DEBUG
Enables inspector connections to the server with a debugger such as Visual Studio Code or Chrome DevTools.
- Anchor to --disable-deps-optimizer--disable-deps-optimizer--disable-deps-optimizer''''env: SHOPIFY_HYDROGEN_FLAG_DISABLE_DEPS_OPTIMIZERenv: SHOPIFY_HYDROGEN_FLAG_DISABLE_DEPS_OPTIMIZER
Disable adding dependencies to Vite's
automatically- Anchor to --disable-version-check--disable-version-check--disable-version-check''''
Skip the version check when running
hydrogen dev- Anchor to --disable-virtual-routes--disable-virtual-routes--disable-virtual-routes''''env: SHOPIFY_HYDROGEN_FLAG_DISABLE_VIRTUAL_ROUTESenv: SHOPIFY_HYDROGEN_FLAG_DISABLE_VIRTUAL_ROUTES
Disable rendering fallback routes when a route file doesn't exist.
- Anchor to --entry <value>--entry <value>--entry <value>stringstringenv: SHOPIFY_HYDROGEN_FLAG_ENTRYenv: SHOPIFY_HYDROGEN_FLAG_ENTRY
Entry file for the worker. Defaults to
./server.- Anchor to --env <value>--env <value>--env <value>stringstring
Specifies the environment to perform the operation using its handle. Fetch the handle using the
env listcommand.- Anchor to --env-branch <value>--env-branch <value>--env-branch <value>stringstringenv: SHOPIFY_HYDROGEN_ENVIRONMENT_BRANCHenv: SHOPIFY_HYDROGEN_ENVIRONMENT_BRANCH
Specifies the environment to perform the operation using its Git branch name.
- Anchor to --env-file <value>--env-file <value>--env-file <value>stringstring
Path to an environment file to override existing environment variables. Defaults to the '.env' located in your project path
--path.- Anchor to --host--host--host''''
Expose the server to the local network
- Anchor to --inspector-port <value>--inspector-port <value>--inspector-port <value>stringstringenv: SHOPIFY_HYDROGEN_FLAG_INSPECTOR_PORTenv: SHOPIFY_HYDROGEN_FLAG_INSPECTOR_PORT
The port where the inspector is available. Defaults to 9229.
- Anchor to --path <value>--path <value>--path <value>stringstringenv: SHOPIFY_HYDROGEN_FLAG_PATHenv: SHOPIFY_HYDROGEN_FLAG_PATH
The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.
- Anchor to --port <value>--port <value>--port <value>stringstringenv: SHOPIFY_HYDROGEN_FLAG_PORTenv: SHOPIFY_HYDROGEN_FLAG_PORT
The port to run the server on. Defaults to 3000.
- Anchor to --verbose--verbose--verbose''''env: SHOPIFY_HYDROGEN_FLAG_VERBOSEenv: SHOPIFY_HYDROGEN_FLAG_VERBOSE
Outputs more information about the command's execution.