shopify theme dev
Uploads the current theme as a development theme to the connected store, then prints theme editor and preview URLs to your terminal. While running, changes
Uploads the current theme as the specified theme, or a development theme, to a store so you can preview it.
This command returns the following information:
-
A link to your development theme at http://127.0.0.1:9292. This URL can hot reload local changes to CSS and sections, or refresh the entire page when a file changes, enabling you to preview changes in real time using the store's data.
You can specify a different network interface and port using
--hostand--port. -
A link to the editor for the theme in the Shopify admin.
-
A preview link that you can share with other developers.
If you already have a development theme for your current environment, then this command replaces the development theme with your local theme. You can override this using the --theme-editor-sync flag.
Note: You can't preview checkout customizations using http://127.0.0.1:9292.
Development themes are deleted when you run shopify auth logout. If you need a preview link that can be used after you log out, then you should share your theme or push to an unpublished theme on your store.
You can run this command only in a directory that matches the default Shopify theme folder structure.
Usage
shopify theme dev [flags]Summary
Uploads the current theme as a development theme to the connected store, then prints theme editor and preview URLs to your terminal. While running, changes will push to the store in real time.
Flags
--error-overlay <value>string— Controls the visibility of the error overlay when an theme asset upload fails:- silent Prevents the error overlay from appearing.
- default Displays the error overlay. optional Environment:
SHOPIFY_FLAG_ERROR_OVERLAY. --host <value>string— Set which network interface the web server listens on. The default value is 127.0.0.1. optional Environment:SHOPIFY_FLAG_HOST.--listing <value>string— The listing preset to use for multi-preset themes. Applies preset files from listings/[preset-name] directory. optional Environment:SHOPIFY_FLAG_LISTING.--live-reload <value>string— The live reload mode switches the server behavior when a file is modified:- hot-reload Hot reloads local changes to CSS and sections (default)
- full-page Always refreshes the entire page
- off Deactivate live reload optional Environment:
SHOPIFY_FLAG_LIVE_RELOAD. --no-color— Disable color output. optional Environment:SHOPIFY_FLAG_NO_COLOR.--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.--open— Automatically launch the theme preview in your default web browser. optional Environment:SHOPIFY_FLAG_OPEN.--password <value>string— Password generated from the Theme Access app or an Admin API token. optional Environment:SHOPIFY_CLI_THEME_TOKEN.--path <value>string— The path where you want to run the command. Defaults to the current working directory. optional Environment:SHOPIFY_FLAG_PATH.--port <value>string— Local port to serve theme preview from. optional Environment:SHOPIFY_FLAG_PORT.--store-password <value>string— The password for storefronts with password protection. optional Environment:SHOPIFY_FLAG_STORE_PASSWORD.--theme-editor-sync— Synchronize Theme Editor updates in the local theme files. optional Environment:SHOPIFY_FLAG_THEME_EDITOR_SYNC.--verbose— Increase the verbosity of the output. optional Environment:SHOPIFY_FLAG_VERBOSE.-a, --allow-live— Allow development on a live theme. optional Environment:SHOPIFY_FLAG_ALLOW_LIVE.-e, --environment <value>string— The environment to apply to the current command. optional Environment:SHOPIFY_FLAG_ENVIRONMENT.-n, --nodelete— Prevents files from being deleted in the remote theme when a file has been deleted locally. This applies to files that are deleted while the command is running, and files that have been deleted locally before the command is run. optional Environment:SHOPIFY_FLAG_NODELETE.-o, --only <value>string— Hot reload only files that match the specified pattern. optional Environment:SHOPIFY_FLAG_ONLY.-s, --store <value>string— Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com). optional Environment:SHOPIFY_FLAG_STORE.-t, --theme <value>string— Theme ID or name of the remote theme. optional Environment:SHOPIFY_FLAG_THEME_ID.-x, --ignore <value>string— Skip hot reloading any files that match the specified pattern. optional Environment:SHOPIFY_FLAG_IGNORE.