hydrogen linkcommand
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.
Anchor to flagsFlags
The following flags are available for the hydrogen link command:
- Anchor to --path <value>--path <value>stringenv: 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 --storefront <value>--storefront <value>stringenv: SHOPIFY_HYDROGEN_STOREFRONT
The name of a Hydrogen Storefront (e.g. "Jane's Apparel")
- Anchor to -f, --force-f, --forceenv: SHOPIFY_HYDROGEN_FLAG_FORCE
Overwrites the destination directory and files if they already exist.
hydrogenlink
- --path <value>
The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.
string - --storefront <value>
The name of a Hydrogen Storefront (e.g. "Jane's Apparel")
string - -f, --force
Overwrites the destination directory and files if they already exist.
""
export interface hydrogenlink {
/**
* Overwrites the destination directory and files if they already exist.
* @environment SHOPIFY_HYDROGEN_FLAG_FORCE
*/
'-f, --force'?: ''
/**
* The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.
* @environment SHOPIFY_HYDROGEN_FLAG_PATH
*/
'--path <value>'?: string
/**
* The name of a Hydrogen Storefront (e.g. "Jane's Apparel")
* @environment SHOPIFY_HYDROGEN_STOREFRONT
*/
'--storefront <value>'?: string
}Hydrogen link
examples
hydrogen link
hydrogen link
shopify hydrogen link [flags]