hydrogen deploy

command

Anchor to flagsFlags

Anchor to --auth-bypass-token

--auth-bypass-token

env: AUTH_BYPASS_TOKEN

Generate an authentication bypass token, which can be used to perform end-to-end tests against the deployment.

Anchor to --auth-bypass-token-duration <value>

--auth-bypass-token-duration <value>

string

env: AUTH_BYPASS_TOKEN_DURATION

Specify the duration (in hours) up to 12 hours for the authentication bypass token. Defaults to 2

Anchor to --build-command <value>

--build-command <value>

string

Specify a build command to run before deploying. If not specified, shopify hydrogen build will be used.

Anchor to --entry <value>

--entry <value>

string

env: SHOPIFY_HYDROGEN_FLAG_ENTRY

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

Anchor to --env <value>

--env <value>

string

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

Anchor to --env-branch <value>

--env-branch <value>

string

env: SHOPIFY_HYDROGEN_ENVIRONMENT_BRANCH

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

Anchor to --env-file <value>

--env-file <value>

string

Path to an environment file to override existing environment variables for the deployment.

Anchor to --json-output

--json-output

Create a JSON file containing the deployment details in CI environments. Defaults to true, use --no-json-output to disable.

Anchor to --lockfile-check

--lockfile-check

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.

Anchor to --metadata-description <value>

--metadata-description <value>

string

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.

Anchor to --metadata-user <value>

--metadata-user <value>

string

env: SHOPIFY_HYDROGEN_FLAG_METADATA_USER

User that initiated the deployment. Will be saved and displayed in the Shopify admin

Anchor to --no-verify

--no-verify

Skip the routability verification step after deployment.

Anchor to --path <value>

--path <value>

string

env: 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 --preview

--preview

Deploys to the Preview environment.

Anchor to -f, --force

-f, --force

env: SHOPIFY_HYDROGEN_FLAG_FORCE

Forces a deployment to proceed if there are uncommited changes in its Git repository.

Anchor to -s, --shop <value>

-s, --shop <value>

string

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).

Anchor to -t, --token <value>

-t, --token <value>

string

env: SHOPIFY_HYDROGEN_DEPLOYMENT_TOKEN

Oxygen deployment token. Defaults to the linked storefront's token if available.