hydrogen init

command

hydrogeninit

• --git

  Init Git and create initial commits.

  ""

• --install-deps

  Auto installs dependencies using the active package manager.

  ""

• --language <value>

  Sets the template language to use. One of `js` or `ts`.

  string

• --markets <value>

  Sets the URL structure to support multiple markets. Must be one of: `subfolders`, `domains`, `subdomains`, `none`. Example: `--markets subfolders`.

  string

• --mock-shop

  Use mock.shop as the data source for the storefront.

  ""

• --path <value>

  The path to the directory of the new Hydrogen storefront.

  string

• --quickstart

  Scaffolds a new Hydrogen project with a set of sensible defaults. Equivalent to `shopify hydrogen init --path hydrogen-quickstart --mock-shop --language js --shortcut --routes --markets none`

  ""

• --routes

  Generate routes for all pages.

  ""

• --shortcut

  Creates a global h2 shortcut for Shopify CLI using shell aliases. Deactivate with `--no-shortcut`.

  ""

• --styling <value>

  Sets the styling strategy to use. One of `tailwind`, `vanilla-extract`, `css-modules`, `postcss`, `none`.

  string

• --template <value>

  Scaffolds project based on an existing template or example from the Hydrogen repository.

  string

• -f, --force

  Overwrites the destination directory and files if they already exist.

  ""

export interface hydrogeninit {
  /**
   * Overwrites the destination directory and files if they already exist.
   * @environment SHOPIFY_HYDROGEN_FLAG_FORCE
   */
  '-f, --force'?: ''

  /**
   * Init Git and create initial commits.
   * @environment SHOPIFY_HYDROGEN_FLAG_GIT
   */
  '--git'?: ''

  /**
   * Auto installs dependencies using the active package manager.
   * @environment SHOPIFY_HYDROGEN_FLAG_INSTALL_DEPS
   */
  '--install-deps'?: ''

  /**
   * Sets the template language to use. One of `js` or `ts`.
   * @environment SHOPIFY_HYDROGEN_FLAG_LANGUAGE
   */
  '--language <value>'?: string

  /**
   * 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

  /**
   * Use mock.shop as the data source for the storefront.
   * @environment SHOPIFY_HYDROGEN_FLAG_MOCK_DATA
   */
  '--mock-shop'?: ''

  /**
   * The path to the directory of the new Hydrogen storefront.
   * @environment SHOPIFY_HYDROGEN_FLAG_PATH
   */
  '--path <value>'?: string

  /**
   * Scaffolds a new Hydrogen project with a set of sensible defaults. Equivalent to `shopify hydrogen init --path hydrogen-quickstart --mock-shop --language js --shortcut --routes --markets none`
   * @environment SHOPIFY_HYDROGEN_FLAG_QUICKSTART
   */
  '--quickstart'?: ''

  /**
   * Generate routes for all pages.
   * @environment SHOPIFY_HYDROGEN_FLAG_ROUTES
   */
  '--routes'?: ''

  /**
   * Creates a global h2 shortcut for Shopify CLI using shell aliases. Deactivate with `--no-shortcut`.
   * @environment SHOPIFY_HYDROGEN_FLAG_SHORTCUT
   */
  '--shortcut'?: ''

  /**
   * Sets the styling strategy to use. One of `tailwind`, `vanilla-extract`, `css-modules`, `postcss`, `none`.
   * @environment SHOPIFY_HYDROGEN_FLAG_STYLING
   */
  '--styling <value>'?: string

  /**
   * Scaffolds project based on an existing template or example from the Hydrogen repository.
   * @environment SHOPIFY_HYDROGEN_FLAG_TEMPLATE
   */
  '--template <value>'?: string
}