hydrogen preview

Runs a server in your local development environment that serves your Hydrogen app's production build. Requires running the [build](/docs/api/shopify-cli/hydrogen/hydrogen-build) command first.

shopify hydrogen preview [flags]

Flags

The following flags are available for the `hydrogen preview` command:

hydrogenpreview

--build

Builds the app before starting the preview server.

--codegen

Automatically generates GraphQL types for your project’s Storefront API queries.

--codegen-config-path <value>

Specifies a path to a codegen configuration file. Defaults to `<root>/codegen.ts` if this file exists.

--debug

env: SHOPIFY_HYDROGEN_FLAG_DEBUG

Enables inspector connections to the server with a debugger such as Visual Studio Code or Chrome DevTools.

--entry <value>

env: SHOPIFY_HYDROGEN_FLAG_ENTRY

Entry file for the worker. Defaults to `./server`.

--env <value>

Specifies the environment to perform the operation using its handle. Fetch the handle using the `env list` command.

--env-branch <value>

env: SHOPIFY_HYDROGEN_ENVIRONMENT_BRANCH

Specifies the environment to perform the operation using its Git branch name.

--env-file <value>

Path to an environment file to override existing environment variables. Defaults to the '.env' located in your project path `--path`.

--inspector-port <value>

env: SHOPIFY_HYDROGEN_FLAG_INSPECTOR_PORT

The port where the inspector is available. Defaults to 9229.

--legacy-runtime

env: SHOPIFY_HYDROGEN_FLAG_LEGACY_RUNTIME

Runs the app in a Node.js sandbox instead of an Oxygen worker.

--path <value>

env: SHOPIFY_HYDROGEN_FLAG_PATH

The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.

--port <value>

env: SHOPIFY_HYDROGEN_FLAG_PORT

The port to run the server on. Defaults to 3000.

--verbose

env: SHOPIFY_HYDROGEN_FLAG_VERBOSE

Outputs more information about the command's execution.

--watch

Watches for changes and rebuilds the project.