app devcommand
Builds and previews your app on a development store, and watches for changes. Read more about testing apps locally.
Anchor to flagsFlags
The following flags are available for the app dev
command:
- Anchor to --checkout-cart-url <value>--checkout-cart-url <value>stringenv: SHOPIFY_FLAG_CHECKOUT_CART_URL
Resource URL for checkout UI extension. Format: "/cart/{productVariantID}:{productQuantity}"
- Anchor to --client-id <value>--client-id <value>stringenv: SHOPIFY_FLAG_CLIENT_ID
The Client ID of your app.
- Anchor to --localhost-port <value>--localhost-port <value>stringenv: SHOPIFY_FLAG_LOCALHOST_PORT
Port to use for localhost.
- Anchor to --no-color--no-colorenv: SHOPIFY_FLAG_NO_COLOR
Disable color output.
- Anchor to --no-update--no-updateenv: SHOPIFY_FLAG_NO_UPDATE
Skips the Partners Dashboard URL update step.
- Anchor to --notify <value>--notify <value>stringenv: SHOPIFY_FLAG_NOTIFY
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.
- Anchor to --path <value>--path <value>stringenv: SHOPIFY_FLAG_PATH
The path to your app directory.
- Anchor to --reset--resetenv: SHOPIFY_FLAG_RESET
Reset all your settings.
- Anchor to --skip-dependencies-installation--skip-dependencies-installationenv: SHOPIFY_FLAG_SKIP_DEPENDENCIES_INSTALLATION
Skips the installation of dependencies. Deprecated, use workspaces instead.
- Anchor to --subscription-product-url <value>--subscription-product-url <value>stringenv: SHOPIFY_FLAG_SUBSCRIPTION_PRODUCT_URL
Resource URL for subscription UI extension. Format: "/products/{productId}"
- Anchor to --theme-app-extension-port <value>--theme-app-extension-port <value>stringenv: SHOPIFY_FLAG_THEME_APP_EXTENSION_PORT
Local port of the theme app extension development server.
- Anchor to --tunnel-url <value>--tunnel-url <value>stringenv: SHOPIFY_FLAG_TUNNEL_URL
Use a custom tunnel, it must be running before executing dev. Format: "https://my-tunnel-url:port".
- Anchor to --use-localhost--use-localhostenv: SHOPIFY_FLAG_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)
- Anchor to --verbose--verboseenv: SHOPIFY_FLAG_VERBOSE
Increase the verbosity of the output.
- Anchor to -c, --config <value>-c, --config <value>stringenv: SHOPIFY_FLAG_APP_CONFIG
The name of the app configuration.
- Anchor to -s, --store <value>-s, --store <value>stringenv: SHOPIFY_FLAG_STORE
Store URL. Must be an existing development or Shopify Plus sandbox store.
- Anchor to -t, --theme <value>-t, --theme <value>stringenv: SHOPIFY_FLAG_THEME
Theme ID or name of the theme app extension host theme.
App dev
Examples
app dev
app dev
shopify app dev [flags]