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](/docs/api/shopify-cli/hydrogen/hydrogen-link) then the Oxygen deployment token for the linked storefront will be used automatically.
shopify hydrogen deploy [flags]The following flags are available for the `hydrogen deploy` command:
env: AUTH_BYPASS_TOKEN
Generate an authentication bypass token, which can be used to perform end-to-end tests against the deployment.
env: AUTH_BYPASS_TOKEN_DURATION
Specify the duration (in hours) up to 12 hours for the authentication bypass token. Defaults to `2`
Specify a build command to run before deploying. If not specified, `shopify hydrogen build` will be used.
env: SHOPIFY_HYDROGEN_FLAG_ENTRY
Entry file for the worker. Defaults to `./server`.
Specifies the environment to perform the operation using its handle. Fetch the handle using the `env list` command.
env: SHOPIFY_HYDROGEN_ENVIRONMENT_BRANCH
Specifies the environment to perform the operation using its Git branch name.
Path to an environment file to override existing environment variables for the deployment.
Create a JSON file containing the deployment details in CI environments. Defaults to true, use `--no-json-output` to disable.
env: SHOPIFY_HYDROGEN_FLAG_LOCKFILE_CHECK
Checks that there is exactly one valid lockfile in the project. Defaults to `true`. Deactivate with `--no-lockfile-check`.
env: SHOPIFY_HYDROGEN_FLAG_METADATA_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_USER
User that initiated the deployment. Will be saved and displayed in the Shopify admin
Skip the routability verification step after deployment.
env: SHOPIFY_HYDROGEN_FLAG_PATH
The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.
Deploys to the Preview environment.
env: SHOPIFY_HYDROGEN_FLAG_FORCE
Forces a deployment to proceed if there are uncommited changes in its Git repository.
env: SHOPIFY_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_HYDROGEN_DEPLOYMENT_TOKEN
Oxygen deployment token. Defaults to the linked storefront's token if available.