Skip to main content

Shopify CLI Hydrogen commands

hydrogen build

Builds a Hydrogen storefront for production. The client and app worker files are compiled to a /dist folder in your Hydrogen project directory.

hydrogen check

Checks whether your Hydrogen app includes a set of standard Shopify routes.

hydrogen codegen

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

hydrogen customer-account-push

Push project configuration to admin

hydrogen debug cpu

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 that cause failed deployments in Oxygen. 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.

hydrogen deploy

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 then the Oxygen deployment token for the linked storefront will be used automatically.

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.

hydrogen env list

Lists all environments available on the linked Hydrogen storefront.

hydrogen env pull

Pulls environment variables from the linked Hydrogen storefront and writes them to an .env file.

hydrogen env push

Push environment variables from the local .env file to your linked Hydrogen storefront.

hydrogen generate route

Generates a set of default routes from the starter template.

hydrogen generate routes

Generates all supported standard shopify routes.

hydrogen init

Creates a new Hydrogen storefront.

hydrogen link

Links your local development environment to a remote Hydrogen storefront. You can link an unlimited number of development environments to a single Hydrogen storefront. Linking to a Hydrogen storefront enables you to run dev and automatically inject your linked Hydrogen storefront's environment variables directly into the server runtime. After you run the link command, you can access the env list, env pull, and unlink commands.

hydrogen list

Lists all remote Hydrogen storefronts available to link to your local development environment.

hydrogen login

Logs in to the specified shop and saves the shop domain to the project.

hydrogen logout

Log out from the current shop.

hydrogen preview

Runs a server in your local development environment that serves your Hydrogen app's production build. Requires running the build command first.

hydrogen setup

Scaffold routes and core functionality.

hydrogen setup css

Adds support for certain CSS strategies to your project.

hydrogen setup markets

Adds support for multiple markets to your project by using the URL structure.

hydrogen setup vite

EXPERIMENTAL: Upgrades the project to use Vite.

hydrogen shortcut

Creates a global h2 shortcut for Shopify CLI using shell aliases. The following shells are supported: - Bash (using ~/.bashrc) - ZSH (using ~/.zshrc) - Fish (using ~/.config/fish/functions) - PowerShell (added to $PROFILE) After the alias is created, you can call Shopify CLI from anywhere in your project using h2 <command>.

hydrogen unlink

Unlinks your local development environment from a remote Hydrogen storefront.

hydrogen upgrade

Upgrade Hydrogen project dependencies, preview features, fixes and breaking changes. The command also generates an instruction file for each upgrade.