hydrogen setupcommand
Scaffold routes and core functionality.
Anchor to flagsFlags
The following flags are available for the hydrogen setup
command:
- Anchor to --install-deps--install-depsenv: SHOPIFY_HYDROGEN_FLAG_INSTALL_DEPS
Auto installs dependencies using the active package manager.
- Anchor to --markets <value>--markets <value>stringenv: SHOPIFY_HYDROGEN_FLAG_I18N
Sets the URL structure to support multiple markets. Must be one of:
subfolders
,domains
,subdomains
,none
. Example:--markets subfolders
.- 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 --shortcut--shortcutenv: SHOPIFY_HYDROGEN_FLAG_SHORTCUT
Creates a global h2 shortcut for Shopify CLI using shell aliases. Deactivate with
--no-shortcut
.- Anchor to -f, --force-f, --forceenv: SHOPIFY_HYDROGEN_FLAG_FORCE
Overwrites the destination directory and files if they already exist.
hydrogensetup
- --install-deps
Auto installs dependencies using the active package manager.
""
- --markets <value>
Sets the URL structure to support multiple markets. Must be one of: `subfolders`, `domains`, `subdomains`, `none`. Example: `--markets subfolders`.
string
- --path <value>
The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.
string
- --shortcut
Creates a global h2 shortcut for Shopify CLI using shell aliases. Deactivate with `--no-shortcut`.
""
- -f, --force
Overwrites the destination directory and files if they already exist.
""
export interface hydrogensetup {
/**
* Overwrites the destination directory and files if they already exist.
* @environment SHOPIFY_HYDROGEN_FLAG_FORCE
*/
'-f, --force'?: ''
/**
* Auto installs dependencies using the active package manager.
* @environment SHOPIFY_HYDROGEN_FLAG_INSTALL_DEPS
*/
'--install-deps'?: ''
/**
* Sets the URL structure to support multiple markets. Must be one of: `subfolders`, `domains`, `subdomains`, `none`. Example: `--markets subfolders`.
* @environment SHOPIFY_HYDROGEN_FLAG_I18N
*/
'--markets <value>'?: string
/**
* 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
/**
* Creates a global h2 shortcut for Shopify CLI using shell aliases. Deactivate with `--no-shortcut`.
* @environment SHOPIFY_HYDROGEN_FLAG_SHORTCUT
*/
'--shortcut'?: ''
}
Hydrogen setup
examples
hydrogen setup
hydrogen setup
shopify hydrogen setup [flags]