Shopify CLI Docs

shopify app dev

Run the app.

Builds and previews your app on a dev store, and watches for changes. Read more about testing apps locally.

Usage

shopify app dev [flags]

Summary

Run the app.

Flags

  • --checkout-cart-url <value> string — Resource URL for checkout UI extension. Format: "/cart/{productVariantID}:{productQuantity}" optional Environment: SHOPIFY_FLAG_CHECKOUT_CART_URL.
  • --client-id <value> string — The Client ID of your app. optional Environment: SHOPIFY_FLAG_CLIENT_ID.
  • --localhost-port <value> string — Port to use for localhost. optional Environment: SHOPIFY_FLAG_LOCALHOST_PORT.
  • --no-color — Disable color output. optional Environment: SHOPIFY_FLAG_NO_COLOR.
  • --no-update — Uses the app URL from the toml file instead an autogenerated URL for dev. optional Environment: SHOPIFY_FLAG_NO_UPDATE.
  • --notify <value> string — The file path or URL. The file path is to a file that you want updated on idle. The URL path is where you want a webhook posted to report on file changes. optional Environment: SHOPIFY_FLAG_NOTIFY.
  • --path <value> string — The path to your app directory. optional Environment: SHOPIFY_FLAG_PATH.
  • --reset — Reset all your settings. optional Environment: SHOPIFY_FLAG_RESET.
  • --skip-dependencies-installation — Skips the installation of dependencies. Deprecated, use workspaces instead. optional Environment: SHOPIFY_FLAG_SKIP_DEPENDENCIES_INSTALLATION.
  • --subscription-product-url <value> string — Resource URL for subscription UI extension. Format: "/products/{productId}" optional Environment: SHOPIFY_FLAG_SUBSCRIPTION_PRODUCT_URL.
  • --theme-app-extension-port <value> string — Local port of the theme app extension development server. optional Environment: SHOPIFY_FLAG_THEME_APP_EXTENSION_PORT.
  • --tunnel-url <value> string — Use a custom tunnel, it must be running before executing dev. Format: "https://my-tunnel-url:port". optional Environment: SHOPIFY_FLAG_TUNNEL_URL.
  • --use-localhost — Service entry point will listen to localhost. A tunnel won't be used. Will work for testing many app features, but not those that directly invoke your app (E.g: Webhooks) optional Environment: SHOPIFY_FLAG_USE_LOCALHOST.
  • --verbose — Increase the verbosity of the output. optional Environment: SHOPIFY_FLAG_VERBOSE.
  • -c, --config <value> string — The name of the app configuration. optional Environment: SHOPIFY_FLAG_APP_CONFIG.
  • -s, --store <value> string — Store URL. Must be an existing development or Shopify Plus sandbox store. optional Environment: SHOPIFY_FLAG_STORE.
  • -t, --theme <value> string — Theme ID or name of the theme app extension host theme. optional Environment: SHOPIFY_FLAG_THEME.

Official source

On this page