shopify app buildshopify app config linkshopify app config use [CONFIG]shopify app deployshopify app devshopify app env pullshopify app env showshopify app function buildshopify app function replayshopify app function runshopify app function schemashopify app function typegenshopify app generate extension [FILE]shopify app import-extensionsshopify app infoshopify app initshopify app logsshopify app logs sourcesshopify app:release --version <version>shopify app versions list [FILE]shopify app webhook triggershopify auth logoutshopify commandsshopify config autocorrect offshopify config autocorrect onshopify config autocorrect statusshopify help [COMMAND]shopify hydrogen buildshopify hydrogen check RESOURCEshopify hydrogen codegenshopify hydrogen customer-account-pushshopify hydrogen debug cpushopify hydrogen deployshopify hydrogen devshopify hydrogen env listshopify hydrogen env pullshopify hydrogen env pushshopify hydrogen generate route ROUTENAMEshopify hydrogen generate routesshopify hydrogen initshopify hydrogen linkshopify hydrogen listshopify hydrogen loginshopify hydrogen logoutshopify hydrogen previewshopify hydrogen setupshopify hydrogen setup css [STRATEGY]shopify hydrogen setup markets [STRATEGY]shopify hydrogen setup viteshopify hydrogen shortcutshopify hydrogen unlinkshopify hydrogen upgradeshopify plugins add PLUGINshopify plugins:inspect PLUGIN...shopify plugins install PLUGINshopify plugins link PATHshopify plugins remove [PLUGIN]shopify plugins resetshopify plugins uninstall [PLUGIN]shopify plugins unlink [PLUGIN]shopify plugins updateshopify search [QUERY]shopify theme checkshopify theme consoleshopify theme deleteshopify theme devshopify theme infoshopify theme init [name]shopify theme language-servershopify theme listshopify theme metafields pullshopify theme openshopify theme packageshopify theme publishshopify theme pullshopify theme pushshopify theme renameshopify theme shareshopify upgradeshopify version
Build the app, including extensions.
USAGE
$ shopify app build [--client-id <value> | -c <value>] [--no-color] [--path <value>] [--reset | ]
[--skip-dependencies-installation] [--verbose]
FLAGS
-c, --config=<value> The name of the app configuration.
--client-id=<value> The Client ID of your app.
--no-color Disable color output.
--path=<value> The path to your app directory.
--reset Reset all your settings.
--skip-dependencies-installation Skips the installation of dependencies. Deprecated, use workspaces instead.
--verbose Increase the verbosity of the output.
DESCRIPTION
Build the app, including extensions.
This command executes the build script specified in the element's TOML file. You can specify a custom script in the
file. To learn about configuration files in Shopify apps, refer to "App configuration"
(https://shopify.dev/docs/apps/tools/cli/configuration).
If you're building a "theme app extension" (https://shopify.dev/docs/apps/online-store/theme-app-extensions), then
running the `build` command runs "Theme Check" (https://shopify.dev/docs/themes/tools/theme-check) against your
extension to ensure that it's valid.
Fetch your app configuration from the Partner Dashboard.
USAGE
$ shopify app config link [--client-id <value> | -c <value>] [--no-color] [--path <value>] [--reset | ] [--verbose]
FLAGS
-c, --config=<value> The name of the app configuration.
--client-id=<value> The Client ID of your app.
--no-color Disable color output.
--path=<value> The path to your app directory.
--reset Reset all your settings.
--verbose Increase the verbosity of the output.
DESCRIPTION
Fetch your app configuration from the Partner Dashboard.
Pulls app configuration from the Partner Dashboard and creates or overwrites a configuration file. You can create a
new app with this command to start with a default configuration file.
For more information on the format of the created TOML configuration file, refer to the "App configuration"
(https://shopify.dev/docs/apps/tools/cli/configuration) page.
Activate an app configuration.
USAGE
$ shopify app config use [CONFIG] [--client-id <value> | ] [--no-color] [--path <value>] [--reset | ] [--verbose]
ARGUMENTS
CONFIG The name of the app configuration. Can be 'shopify.app.staging.toml' or simply 'staging'.
FLAGS
--client-id=<value> The Client ID of your app.
--no-color Disable color output.
--path=<value> The path to your app directory.
--reset Reset all your settings.
--verbose Increase the verbosity of the output.
DESCRIPTION
Activate an app configuration.
Sets default configuration when you run app-related CLI commands. If you omit the `config-name` parameter, then you'll
be prompted to choose from the configuration files in your project.
Deploy your Shopify app.
USAGE
$ shopify app deploy [--client-id <value> | -c <value>] [-f] [--message <value>] [--no-color] [--no-release]
[--path <value>] [--reset | ] [--source-control-url <value>] [--verbose] [--version <value>]
FLAGS
-c, --config=<value> The name of the app configuration.
-f, --force Deploy without asking for confirmation.
--client-id=<value> The Client ID of your app.
--message=<value> Optional message that will be associated with this version. This is for internal use
only and won't be available externally.
--no-color Disable color output.
--no-release Creates a version but doesn't release it - it's not made available to merchants.
--path=<value> The path to your app directory.
--reset Reset all your settings.
--source-control-url=<value> URL associated with the new app version.
--verbose Increase the verbosity of the output.
--version=<value> Optional version tag that will be associated with this app version. If not provided,
an auto-generated identifier will be generated for this app version.
DESCRIPTION
Deploy your Shopify app.
"Builds the app" (https://shopify.dev/docs/api/shopify-cli/app/app-build), then deploys your app configuration and
extensions.
This command creates an app version, which is a snapshot of your app configuration and all extensions, including the
app extensions that you manage in the Partner Dashboard. This version is then released to users.
This command doesn't deploy your "web app" (https://shopify.dev/docs/apps/tools/cli/structure#web-components). You
need to "deploy your web app" (https://shopify.dev/docs/apps/deployment/web) to your own hosting solution.
Run the app.
USAGE
$ shopify app dev [--checkout-cart-url <value>] [--client-id <value> | -c <value>] [--no-color]
[--no-update] [--notify <value>] [--path <value>] [--reset | ] [--skip-dependencies-installation] [-s <value>]
[--subscription-product-url <value>] [-t <value>] [--theme-app-extension-port <value>] [--tunnel-url <value> | | ]
[--verbose]
FLAGS
-c, --config=<value> The name of the app configuration.
-s, --store=<value> Store URL. Must be an existing development or Shopify Plus sandbox store.
-t, --theme=<value> Theme ID or name of the theme app extension host theme.
--checkout-cart-url=<value> Resource URL for checkout UI extension. Format:
"/cart/{productVariantID}:{productQuantity}"
--client-id=<value> The Client ID of your app.
--no-color Disable color output.
--no-update Skips the Partners Dashboard URL update step.
--notify=<value> 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.
--path=<value> The path to your app directory.
--reset Reset all your settings.
--skip-dependencies-installation Skips the installation of dependencies. Deprecated, use workspaces instead.
--subscription-product-url=<value> Resource URL for subscription UI extension. Format: "/products/{productId}"
--theme-app-extension-port=<value> Local port of the theme app extension development server.
--tunnel-url=<value> Use a custom tunnel, it must be running before executing dev. Format:
"https://my-tunnel-url:port".
--verbose Increase the verbosity of the output.
DESCRIPTION
Run the app.
"Builds the app" (https://shopify.dev/docs/api/shopify-cli/app/app-build) and lets you preview it on a "development
store" (https://shopify.dev/docs/apps/tools/development-stores) or "Plus sandbox store"
(https://help.shopify.com/partners/dashboard/managing-stores/plus-sandbox-store).
> Note: Development store preview of extension drafts is not supported for Plus sandbox stores. You must `deploy` your
app.
To preview your app on a development store or Plus sandbox store, Shopify CLI walks you through the following steps.
If you've run `dev` before, then your settings are saved and some of these steps are skipped. You can reset these
configurations using `dev --reset` to go through all of them again:
- Associating your project with an app associated with your Partner account or organization, or creating a new app.
- Selecting a development store or Plus sandbox store to use for testing. If you have only one store, then it's
selected automatically.
- Installing your app on the store using the provided install link.
- Creating a tunnel between your local environment and the store using Cloudflare.
You can use your own tunneling software instead, by passing your tunnel URL with the `--tunnel-url` flag.
- Updating the app URLs that are set in the Partner Dashboard.
To avoid overwriting any URLs that are already set, select the No, never option. If you select this option, then
you're provided with URLs that you can manually add in the Partner Dashboard so you can preview your app.
- Enabling development store preview for extensions.
- Serving "GraphiQL for the Admin API"
(https://shopify.dev/docs/apps/tools/graphiql-admin-api#use-a-local-graphiql-instance) using your app's credentials
and access scopes.
- Building and serving your app and app extensions.
If you're using the Ruby app template, then you need to complete the following steps outlined in the "README"
(https://github.com/Shopify/shopify-app-template-ruby#setting-up-your-rails-app) before you can preview your app for
the first time.
> Caution: To use a development store or Plus sandbox store with Shopify CLI, you need to be the store owner, or have
a "staff account" (https://help.shopify.com/manual/your-account/staff-accounts) on the store. Staff accounts are
created automatically the first time you access a development store with your Partner staff account through the
Partner Dashboard.
Pull app and extensions environment variables.
USAGE
$ shopify app env pull [--client-id <value> | -c <value>] [--env-file <value>] [--no-color] [--path <value>]
[--reset | ] [--verbose]
FLAGS
-c, --config=<value> The name of the app configuration.
--client-id=<value> The Client ID of your app.
--env-file=<value> Specify an environment file to update if the update flag is set
--no-color Disable color output.
--path=<value> The path to your app directory.
--reset Reset all your settings.
--verbose Increase the verbosity of the output.
DESCRIPTION
Pull app and extensions environment variables.
Creates or updates an `.env` files that contains app and app extension environment variables.
When an existing `.env` file is updated, changes to the variables are displayed in the terminal output. Existing
variables and commented variables are preserved.
Display app and extensions environment variables.
USAGE
$ shopify app env show [--client-id <value> | -c <value>] [--no-color] [--path <value>] [--reset | ] [--verbose]
FLAGS
-c, --config=<value> The name of the app configuration.
--client-id=<value> The Client ID of your app.
--no-color Disable color output.
--path=<value> The path to your app directory.
--reset Reset all your settings.
--verbose Increase the verbosity of the output.
DESCRIPTION
Display app and extensions environment variables.
Displays environment variables that can be used to deploy apps and app extensions.
Compile a function to wasm.
USAGE
$ shopify app function build [--client-id <value> | -c <value>] [--no-color] [--path <value>] [--reset | ] [--verbose]
FLAGS
-c, --config=<value> The name of the app configuration.
--client-id=<value> The Client ID of your app.
--no-color Disable color output.
--path=<value> The path to your function directory.
--reset Reset all your settings.
--verbose Increase the verbosity of the output.
DESCRIPTION
Compile a function to wasm.
Compiles the function in your current directory to WebAssembly (Wasm) for testing purposes.
Replays a function run from an app log.
USAGE
$ shopify app function replay [--client-id <value> | -c <value>] [-j] [-l <value>] [--no-color] [--path <value>]
[--reset | ] [--verbose] [-w]
FLAGS
-c, --config=<value> The name of the app configuration.
-j, --json Output the result as JSON.
-l, --log=<value> Specifies a log identifier to replay instead of selecting from a list. The identifier is
provided in the output of `shopify app dev` and is the suffix of the log file name.
-w, --[no-]watch Re-run the function when the source code changes.
--client-id=<value> The Client ID of your app.
--no-color Disable color output.
--path=<value> The path to your function directory.
--reset Reset all your settings.
--verbose Increase the verbosity of the output.
DESCRIPTION
Replays a function run from an app log.
Runs the function from your current directory for "testing purposes"
(https://shopify.dev/docs/apps/functions/testing-and-debugging). To learn how you can monitor and debug functions when
errors occur, refer to "Shopify Functions error handling" (https://shopify.dev/docs/api/functions/errors).
Run a function locally for testing.
USAGE
$ shopify app function run [--client-id <value> | -c <value>] [-e <value>] [-i <value>] [-j] [--no-color] [--path
<value>] [--reset | ] [--verbose]
FLAGS
-c, --config=<value> The name of the app configuration.
-e, --export=<value> Name of the WebAssembly export to invoke.
-i, --input=<value> The input JSON to pass to the function. If omitted, standard input is used.
-j, --json Output the result as JSON.
--client-id=<value> The Client ID of your app.
--no-color Disable color output.
--path=<value> The path to your function directory.
--reset Reset all your settings.
--verbose Increase the verbosity of the output.
DESCRIPTION
Run a function locally for testing.
Runs the function from your current directory for "testing purposes"
(https://shopify.dev/docs/apps/functions/testing-and-debugging). To learn how you can monitor and debug functions when
errors occur, refer to "Shopify Functions error handling" (https://shopify.dev/docs/api/functions/errors).
Fetch the latest GraphQL schema for a function.
USAGE
$ shopify app function schema [--client-id <value> | -c <value>] [--no-color] [--path <value>] [--reset | ] [--stdout]
[--verbose]
FLAGS
-c, --config=<value> The name of the app configuration.
--client-id=<value> The Client ID of your app.
--no-color Disable color output.
--path=<value> The path to your function directory.
--reset Reset all your settings.
--stdout Output the schema to stdout instead of writing to a file.
--verbose Increase the verbosity of the output.
DESCRIPTION
Fetch the latest GraphQL schema for a function.
Generates the latest "GraphQL schema" (https://shopify.dev/docs/apps/functions/input-output#graphql-schema) for a
function in your app. Run this command from the function directory.
This command uses the API type and version of your function, as defined in your extension TOML file, to generate the
latest GraphQL schema. The schema is written to the `schema.graphql` file.
Generate GraphQL types for a JavaScript function.
USAGE
$ shopify app function typegen [--client-id <value> | -c <value>] [--no-color] [--path <value>] [--reset | ]
[--verbose]
FLAGS
-c, --config=<value> The name of the app configuration.
--client-id=<value> The Client ID of your app.
--no-color Disable color output.
--path=<value> The path to your function directory.
--reset Reset all your settings.
--verbose Increase the verbosity of the output.
DESCRIPTION
Generate GraphQL types for a JavaScript function.
Creates GraphQL types based on your "input query" (https://shopify.dev/docs/apps/functions/input-output#input) for a
function written in JavaScript.
Generate a new app Extension.
USAGE
$ shopify app generate extension [FILE] [--client-id <value> | -c <value>] [--flavor
vanilla-js|react|typescript|typescript-react|wasm|rust] [-n <value>] [--no-color] [--path <value>] [--reset | ] [-t
<value>] [-t <value>] [--verbose]
FLAGS
-c, --config=<value> The name of the app configuration.
-n, --name=<value> name of your Extension
-t, --template=<value> Extension template
-t, --type=<value> Deprecated. Please use --template
--client-id=<value> The Client ID of your app.
--flavor=<option> Choose a starting template for your extension, where applicable
<options: vanilla-js|react|typescript|typescript-react|wasm|rust>
--no-color Disable color output.
--path=<value> The path to your app directory.
--reset Reset all your settings.
--verbose Increase the verbosity of the output.
DESCRIPTION
Generate a new app Extension.
Generates a new "app extension" (https://shopify.dev/docs/apps/app-extensions). For a list of app extensions that you
can generate using this command, refer to "Supported extensions"
(https://shopify.dev/docs/apps/structure/app-extensions/list).
Each new app extension is created in a folder under `extensions/`. To learn more about the extensions file structure,
refer to "App structure" (https://shopify.dev/docs/apps/tools/cli/structure) and the documentation for your extension.
EXAMPLES
$ shopify app generate extension
Import dashboard-managed extensions into your app.
USAGE
$ shopify app import-extensions [--client-id <value> | -c <value>] [--no-color] [--path <value>] [--reset | ]
[--verbose]
FLAGS
-c, --config=<value> The name of the app configuration.
--client-id=<value> The Client ID of your app.
--no-color Disable color output.
--path=<value> The path to your app directory.
--reset Reset all your settings.
--verbose Increase the verbosity of the output.
DESCRIPTION
Import dashboard-managed extensions into your app.
Print basic information about your app and extensions.
USAGE
$ shopify app info [--client-id <value> | -c <value>] [-j] [--no-color] [--path <value>] [--reset | ]
[--verbose] [--web-env]
FLAGS
-c, --config=<value> The name of the app configuration.
-j, --json Output the result as JSON.
--client-id=<value> The Client ID of your app.
--no-color Disable color output.
--path=<value> The path to your app directory.
--reset Reset all your settings.
--verbose Increase the verbosity of the output.
--web-env Outputs environment variables necessary for running and deploying web/.
DESCRIPTION
Print basic information about your app and extensions.
The information returned includes the following:
- The app and development store or Plus sandbox store that's used when you run the "dev"
(https://shopify.dev/docs/api/shopify-cli/app/app-dev) command. You can reset these configurations using "`dev
--reset`" (https://shopify.dev/docs/api/shopify-cli/app/app-dev#flags-propertydetail-reset).
- The "structure" (https://shopify.dev/docs/apps/tools/cli/structure) of your app project.
- The "access scopes" (https://shopify.dev/docs/api/usage) your app has requested.
- System information, including the package manager and version of Shopify CLI used in the project.
Create a new app project
USAGE
$ shopify app init [--client-id <value> | ] [--flavor <value>] [-n <value>] [--no-color] [-d
npm|yarn|pnpm|bun] [-p <value>] [--template <value>] [--verbose]
FLAGS
-d, --package-manager=<option> <options: npm|yarn|pnpm|bun>
-n, --name=<value>
-p, --path=<value> [default: .]
--client-id=<value> The Client ID of your app. Use this to automatically link your new project to an
existing app. Using this flag avoids the app selection prompt.
--flavor=<value> Which flavor of the given template to use.
--no-color Disable color output.
--template=<value> The app template. Accepts one of the following:
- <remix|none>
- Any GitHub repo with optional branch and subpath, e.g.,
https://github.com/Shopify/<repository>/[subpath]#[branch]
--verbose Increase the verbosity of the output.
Stream detailed logs for your Shopify app.
USAGE
$ shopify app logs [--client-id <value> | -c <value>] [-j] [--no-color] [--path <value>] [--reset | ]
[--source <value>] [--status success|failure] [-s <value>] [--verbose]
FLAGS
-c, --config=<value> The name of the app configuration.
-j, --json Output the result as JSON.
-s, --store=<value>... Store URL. Must be an existing development or Shopify Plus sandbox store.
--client-id=<value> The Client ID of your app.
--no-color Disable color output.
--path=<value> The path to your app directory.
--reset Reset all your settings.
--source=<value>... Filters output to the specified log source.
--status=<option> Filters output to the specified status (success or failure).
<options: success|failure>
--verbose Increase the verbosity of the output.
DESCRIPTION
Stream detailed logs for your Shopify app.
Opens a real-time stream of detailed app logs from the selected app and store.
Use the `--source` argument to limit output to a particular log source, such as a specific Shopify Function handle.
Use the `shopify app logs sources` command to view a list of sources.
Use the `--status` argument to filter on status, either `success` or `failure`.
shopify app logs --status=success --source=extension.discount-function
Print out a list of sources that may be used with the logs command.
USAGE
$ shopify app logs sources [--client-id <value> | -c <value>] [--no-color] [--path <value>] [--reset | ] [--verbose]
FLAGS
-c, --config=<value> The name of the app configuration.
--client-id=<value> The Client ID of your app.
--no-color Disable color output.
--path=<value> The path to your app directory.
--reset Reset all your settings.
--verbose Increase the verbosity of the output.
DESCRIPTION
Print out a list of sources that may be used with the logs command.
The output source names can be used with the `--source` argument of `shopify app logs` to filter log output. Currently
only function extensions are supported as sources.
Release an app version.
USAGE
$ shopify app release --version <version>
FLAGS
-c, --config=<value> The name of the app configuration.
-f, --force Release without asking for confirmation.
--client-id=<value> The Client ID of your app.
--no-color Disable color output.
--path=<value> The path to your app directory.
--reset Reset all your settings.
--verbose Increase the verbosity of the output.
--version=<value> (required) The name of the app version to release.
DESCRIPTION
Release an app version.
Releases an existing app version. Pass the name of the version that you want to release using the `--version` flag.
List deployed versions of your app.
USAGE
$ shopify app versions list [FILE] [--client-id <value> | -c <value>] [-j] [--no-color] [--path <value>] [--reset | ]
[--verbose]
FLAGS
-c, --config=<value> The name of the app configuration.
-j, --json Output the result as JSON.
--client-id=<value> The Client ID of your app.
--no-color Disable color output.
--path=<value> The path to your app directory.
--reset Reset all your settings.
--verbose Increase the verbosity of the output.
DESCRIPTION
List deployed versions of your app.
Lists the deployed app versions. An app version is a snapshot of your app extensions.
EXAMPLES
$ shopify app versions list
Trigger delivery of a sample webhook topic payload to a designated address.
USAGE
$ shopify app webhook trigger [--address <value>] [--api-version <value>] [--client-id <value> | -c <value>]
[--client-secret <value>] [--delivery-method http|google-pub-sub|event-bridge] [--help] [--path <value>] [--reset |
] [--shared-secret <value>] [--topic <value>]
FLAGS
-c, --config=<value>
The name of the app configuration.
--address=<value>
The URL where the webhook payload should be sent.
You will need a different address type for each delivery-method:
· For remote HTTP testing, use a URL that starts with https://
· For local HTTP testing, use http://localhost:{port}/{url-path}
· For Google Pub/Sub, use pubsub://{project-id}:{topic-id}
· For Amazon EventBridge, use an Amazon Resource Name (ARN) starting with arn:aws:events:
--api-version=<value>
The API Version of the webhook topic.
--client-id=<value>
The Client ID of your app.
--client-secret=<value>
Your app's client secret. This secret allows us to return the X-Shopify-Hmac-SHA256 header that lets you validate
the origin of the response that you receive.
--delivery-method=<option>
Method chosen to deliver the topic payload. If not passed, it's inferred from the address.
<options: http|google-pub-sub|event-bridge>
--help
This help. When you run the trigger command the CLI will prompt you for any information that isn't passed using
flags.
--path=<value>
The path to your app directory.
--reset
Reset all your settings.
--shared-secret=<value>
Deprecated. Please use client-secret.
--topic=<value>
The requested webhook topic.
DESCRIPTION
Trigger delivery of a sample webhook topic payload to a designated address.
Triggers the delivery of a sample Admin API event topic payload to a designated address.
You should use this command to experiment with webhooks, to initially test your webhook configuration, or for unit
testing. However, to test your webhook configuration from end to end, you should always trigger webhooks by performing
the related action in Shopify.
Because most webhook deliveries use remote endpoints, you can trigger the command from any directory where you can use
Shopify CLI, and send the webhook to any of the supported endpoint types. For example, you can run the command from
your app's local directory, but send the webhook to a staging environment endpoint.
To learn more about using webhooks in a Shopify app, refer to "Webhooks overview"
(https://shopify.dev/docs/apps/webhooks).
### Limitations
- Webhooks triggered using this method always have the same payload, so they can't be used to test scenarios that
differ based on the payload contents.
- Webhooks triggered using this method aren't retried when they fail.
- Trigger requests are rate-limited using the "Partner API rate limit"
(https://shopify.dev/docs/api/partner#rate_limits).
- You can't use this method to validate your API webhook subscriptions.
Logs you out of the Shopify account or Partner account and store.
USAGE
$ shopify auth logout
DESCRIPTION
Logs you out of the Shopify account or Partner account and store.
list all the commands
USAGE
$ shopify commands [--columns <value> | -x] [--deprecated] [--filter <value>] [-h] [--hidden] [--json]
[--no-header | [--csv | --no-truncate]] [--output csv|json|yaml | | ] [--sort <value>] [--tree]
FLAGS
-h, --help Show CLI help.
-x, --extended show extra columns
--columns=<value> only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--deprecated show deprecated commands
--filter=<value> filter property by partial string matching, ex: name=foo
--hidden show hidden commands
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=<option> output in a more machine friendly format
<options: csv|json|yaml>
--sort=<value> property to sort by (prepend '-' for descending)
--tree show tree of commands
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
list all the commands
Disable autocorrect. Off by default.
USAGE
$ shopify config autocorrect off
DESCRIPTION
Disable autocorrect. Off by default.
Disable autocorrect. Off by default.
When autocorrection is enabled, Shopify CLI automatically runs a corrected version of your command if a correction is
available.
When autocorrection is disabled, you need to confirm that you want to run corrections for mistyped commands.
Enable autocorrect. Off by default.
USAGE
$ shopify config autocorrect on
DESCRIPTION
Enable autocorrect. Off by default.
Enable autocorrect. Off by default.
When autocorrection is enabled, Shopify CLI automatically runs a corrected version of your command if a correction is
available.
When autocorrection is disabled, you need to confirm that you want to run corrections for mistyped commands.
Check whether autocorrect is enabled or disabled. On by default.
USAGE
$ shopify config autocorrect status
DESCRIPTION
Check whether autocorrect is enabled or disabled. On by default.
Check whether autocorrect is enabled or disabled. On by default.
When autocorrection is enabled, Shopify CLI automatically runs a corrected version of your command if a correction is
available.
When autocorrection is disabled, you need to confirm that you want to run corrections for mistyped commands.
Display help for Shopify CLI
USAGE
$ shopify help [COMMAND...] [-n]
ARGUMENTS
COMMAND... Command to show help for.
FLAGS
-n, --nested-commands Include all nested commands in the output.
DESCRIPTION
Display help for Shopify CLI
Builds a Hydrogen storefront for production.
USAGE
$ shopify hydrogen build [--bundle-stats] [--codegen-config-path <value> --codegen] [--disable-route-warning]
[--entry <value>] [--force-client-sourcemap] [--lockfile-check] [--path <value>] [--sourcemap] [--watch]
FLAGS
--[no-]bundle-stats Show a bundle size summary after building. Defaults to true, use `--no-bundle-stats` to
disable.
--codegen Automatically generates GraphQL types for your project’s Storefront API queries.
--codegen-config-path=<value> Specifies a path to a codegen configuration file. Defaults to `<root>/codegen.ts` if
this file exists.
--disable-route-warning Disables any warnings about missing standard routes.
--entry=<value> Entry file for the worker. Defaults to `./server`.
--force-client-sourcemap Client sourcemapping is avoided by default because it makes backend code visible in the
browser. Use this flag to force enabling it.
--[no-]lockfile-check Checks that there is exactly one valid lockfile in the project. Defaults to `true`.
Deactivate with `--no-lockfile-check`.
--path=<value> The path to the directory of the Hydrogen storefront. Defaults to the current directory
where the command is run.
--[no-]sourcemap Controls whether server sourcemaps are generated. Default to `true`. Deactivate
`--no-sourcemaps`.
--watch Watches for changes and rebuilds the project writing output to disk.
DESCRIPTION
Builds a Hydrogen storefront for production.
Returns diagnostic information about a Hydrogen storefront.
USAGE
$ shopify hydrogen check RESOURCE [--path <value>]
ARGUMENTS
RESOURCE (routes) The resource to check. Currently only 'routes' is supported.
FLAGS
--path=<value> The path to the directory of the Hydrogen storefront. Defaults to the current directory where the
command is run.
DESCRIPTION
Returns diagnostic information about a Hydrogen storefront.
Generate types for the Storefront API queries found in your project.
USAGE
$ shopify hydrogen codegen [--codegen-config-path <value>] [--path <value>] [--watch]
FLAGS
--codegen-config-path=<value> Specify a path to a codegen configuration file. Defaults to `<root>/codegen.ts` if it
exists.
--path=<value> The path to the directory of the Hydrogen storefront. Defaults to the current directory
where the command is run.
--watch Watch the project for changes to update types on file save.
DESCRIPTION
Generate types for the Storefront API queries found in your project.
Push project configuration to admin
USAGE
$ shopify hydrogen customer-account-push --dev-origin <value> [--path <value>] [--relative-logout-uri <value>]
[--relative-redirect-uri <value>] [--storefront-id <value>]
FLAGS
--dev-origin=<value> (required) The development domain of your application.
--path=<value> The path to the directory of the Hydrogen storefront. Defaults to the current
directory where the command is run.
--relative-logout-uri=<value> The relative url of allowed url that will be redirected to post-logout for Customer
Account API OAuth flow. Default to nothing.
--relative-redirect-uri=<value> The relative url of allowed callback url for Customer Account API OAuth flow. Default
is '/account/authorize'
--storefront-id=<value> The id of the storefront the configuration should be pushed to. Must start with
'gid://shopify/HydrogenStorefront/'
DESCRIPTION
Push project configuration to admin
Builds and profiles the server startup time the app.
USAGE
$ shopify hydrogen debug cpu [--entry <value>] [--output <value>] [--path <value>]
FLAGS
--entry=<value> Entry file for the worker. Defaults to `./server`.
--output=<value> [default: startup.cpuprofile] Specify a path to generate the profile file. Defaults to
"startup.cpuprofile".
--path=<value> The path to the directory of the Hydrogen storefront. Defaults to the current directory where the
command is run.
DESCRIPTION
Builds and profiles the server startup time the app.
Builds and deploys a Hydrogen storefront to Oxygen.
USAGE
$ shopify hydrogen deploy [--auth-bypass-token-duration <value> --auth-bypass-token] [--build-command <value>]
[--entry <value>] [--env <value> | --env-branch <value>] [--env-file <value>] [-f] [--json-output]
[--lockfile-check] [--metadata-description <value>] [--metadata-user <value>] [--no-verify] [--path <value>]
[--preview] [-s <value>] [-t <value>]
FLAGS
-f, --force Forces a deployment to proceed if there are uncommited changes in its Git
repository.
-s, --shop=<value> Shop URL. It can be the shop prefix (janes-apparel) or the full
myshopify.com URL (janes-apparel.myshopify.com,
https://janes-apparel.myshopify.com).
-t, --token=<value> Oxygen deployment token. Defaults to the linked storefront's token if
available.
--auth-bypass-token Generate an authentication bypass token, which can be used to perform
end-to-end tests against the deployment.
--auth-bypass-token-duration=<value> Specify the duration (in hours) up to 12 hours for the authentication bypass
token. Defaults to `2`
--build-command=<value> Specify a build command to run before deploying. If not specified, `shopify
hydrogen build` will be used.
--entry=<value> Entry file for the worker. Defaults to `./server`.
--env=<value> Specifies the environment to perform the operation using its handle. Fetch
the handle using the `env list` command.
--env-branch=<value> Specifies the environment to perform the operation using its Git branch
name.
--env-file=<value> Path to an environment file to override existing environment variables for
the deployment.
--[no-]json-output Create a JSON file containing the deployment details in CI environments.
Defaults to true, use `--no-json-output` to disable.
--[no-]lockfile-check Checks that there is exactly one valid lockfile in the project. Defaults to
`true`. Deactivate with `--no-lockfile-check`.
--metadata-description=<value> Description of the changes in the deployment. Defaults to the commit message
of the latest commit if there are no uncommited changes.
--metadata-user=<value> User that initiated the deployment. Will be saved and displayed in the
Shopify admin
--no-verify Skip the routability verification step after deployment.
--path=<value> The path to the directory of the Hydrogen storefront. Defaults to the
current directory where the command is run.
--preview Deploys to the Preview environment.
DESCRIPTION
Builds and deploys a Hydrogen storefront to Oxygen.
Runs Hydrogen storefront in an Oxygen worker for development.
USAGE
$ shopify hydrogen dev [--codegen-config-path <value> --codegen] [--debug] [--disable-deps-optimizer]
[--disable-version-check] [--disable-virtual-routes] [--entry <value>] [--env <value> | --env-branch <value>]
[--env-file <value>] [--host] [--inspector-port <value>] [--legacy-runtime] [--path <value>] [--port <value>]
[--sourcemap] [--verbose]
FLAGS
--codegen Automatically generates GraphQL types for your project’s Storefront API queries.
--codegen-config-path=<value> Specifies a path to a codegen configuration file. Defaults to `<root>/codegen.ts` if
this file exists.
--debug Enables inspector connections to the server with a debugger such as Visual Studio Code
or Chrome DevTools.
--disable-deps-optimizer Disable adding dependencies to Vite's `ssr.optimizeDeps.include` automatically
--disable-version-check Skip the version check when running `hydrogen dev`
--disable-virtual-routes Disable rendering fallback routes when a route file doesn't exist.
--entry=<value> Entry file for the worker. Defaults to `./server`.
--env=<value> Specifies the environment to perform the operation using its handle. Fetch the handle
using the `env list` command.
--env-branch=<value> Specifies the environment to perform the operation using its Git branch name.
--env-file=<value> [default: .env] Path to an environment file to override existing environment variables.
Defaults to the '.env' located in your project path `--path`.
--host Expose the server to the local network
--inspector-port=<value> The port where the inspector is available. Defaults to 9229.
--legacy-runtime [Classic Remix Compiler] Runs the app in a Node.js sandbox instead of an Oxygen worker.
--path=<value> The path to the directory of the Hydrogen storefront. Defaults to the current directory
where the command is run.
--port=<value> The port to run the server on. Defaults to 3000.
--[no-]sourcemap [Classic Remix Compiler] Controls whether server sourcemaps are generated. Default to
`true`. Deactivate `--no-sourcemaps`.
--verbose Outputs more information about the command's execution.
DESCRIPTION
Runs Hydrogen storefront in an Oxygen worker for development.
List the environments on your linked Hydrogen storefront.
USAGE
$ shopify hydrogen env list [--path <value>]
FLAGS
--path=<value> The path to the directory of the Hydrogen storefront. Defaults to the current directory where the
command is run.
DESCRIPTION
List the environments on your linked Hydrogen storefront.
Populate your .env with variables from your Hydrogen storefront.
USAGE
$ shopify hydrogen env pull [--env <value> | --env-branch <value>] [--env-file <value>] [-f] [--path <value>]
FLAGS
-f, --force Overwrites the destination directory and files if they already exist.
--env=<value> Specifies the environment to perform the operation using its handle. Fetch the handle using
the `env list` command.
--env-branch=<value> Specifies the environment to perform the operation using its Git branch name.
--env-file=<value> [default: .env] Path to an environment file to override existing environment variables.
Defaults to the '.env' located in your project path `--path`.
--path=<value> The path to the directory of the Hydrogen storefront. Defaults to the current directory
where the command is run.
DESCRIPTION
Populate your .env with variables from your Hydrogen storefront.
Push environment variables from the local .env file to your linked Hydrogen storefront.
USAGE
$ shopify hydrogen env push [--env <value> | ] [--env-file <value>] [--path <value>]
FLAGS
--env=<value> Specifies the environment to perform the operation using its handle. Fetch the handle using the
`env list` command.
--env-file=<value> [default: .env] Path to an environment file to override existing environment variables. Defaults
to the '.env' located in your project path `--path`.
--path=<value> The path to the directory of the Hydrogen storefront. Defaults to the current directory where the
command is run.
DESCRIPTION
Push environment variables from the local .env file to your linked Hydrogen storefront.
Generates a standard Shopify route.
USAGE
$ shopify hydrogen generate route ROUTENAME [--adapter <value>] [-f] [--locale-param <value>] [--path <value>]
[--typescript]
ARGUMENTS
ROUTENAME (home|page|cart|products|collections|policies|blogs|account|search|robots|sitemap|all) The route to
generate. One of home,page,cart,products,collections,policies,blogs,account,search,robots,sitemap,all.
FLAGS
-f, --force Overwrites the destination directory and files if they already exist.
--adapter=<value> Remix adapter used in the route. The default is `@shopify/remix-oxygen`.
--locale-param=<value> The param name in Remix routes for the i18n locale, if any. Example: `locale` becomes
($locale).
--path=<value> The path to the directory of the Hydrogen storefront. Defaults to the current directory
where the command is run.
--typescript Generate TypeScript files
DESCRIPTION
Generates a standard Shopify route.
Generates all supported standard shopify routes.
USAGE
$ shopify hydrogen generate routes [--adapter <value>] [-f] [--locale-param <value>] [--path <value>] [--typescript]
FLAGS
-f, --force Overwrites the destination directory and files if they already exist.
--adapter=<value> Remix adapter used in the route. The default is `@shopify/remix-oxygen`.
--locale-param=<value> The param name in Remix routes for the i18n locale, if any. Example: `locale` becomes
($locale).
--path=<value> The path to the directory of the Hydrogen storefront. Defaults to the current directory
where the command is run.
--typescript Generate TypeScript files
DESCRIPTION
Generates all supported standard shopify routes.
Creates a new Hydrogen storefront.
USAGE
$ shopify hydrogen init [-f] [--git] [--install-deps] [--language <value>] [--markets <value>] [--mock-shop]
[--path <value>] [--quickstart] [--routes] [--shortcut] [--styling <value>] [--template <value>]
FLAGS
-f, --force Overwrites the destination directory and files if they already exist.
--[no-]git Init Git and create initial commits.
--[no-]install-deps Auto installs dependencies using the active package manager.
--language=<value> Sets the template language to use. One of `js` or `ts`.
--markets=<value> Sets the URL structure to support multiple markets. Must be one of: `subfolders`, `domains`,
`subdomains`, `none`. Example: `--markets subfolders`.
--mock-shop Use mock.shop as the data source for the storefront.
--path=<value> The path to the directory of the new Hydrogen storefront.
--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`
--[no-]routes Generate routes for all pages.
--[no-]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`.
--template=<value> Scaffolds project based on an existing template or example from the Hydrogen repository.
DESCRIPTION
Creates a new Hydrogen storefront.
Link a local project to one of your shop's Hydrogen storefronts.
USAGE
$ shopify hydrogen link [-f] [--path <value>] [--storefront <value>]
FLAGS
-f, --force Overwrites the destination directory and files if they already exist.
--path=<value> The path to the directory of the Hydrogen storefront. Defaults to the current directory
where the command is run.
--storefront=<value> The name of a Hydrogen Storefront (e.g. "Jane's Apparel")
DESCRIPTION
Link a local project to one of your shop's Hydrogen storefronts.
Returns a list of Hydrogen storefronts available on a given shop.
USAGE
$ shopify hydrogen list [--path <value>]
FLAGS
--path=<value> The path to the directory of the Hydrogen storefront. Defaults to the current directory where the
command is run.
DESCRIPTION
Returns a list of Hydrogen storefronts available on a given shop.
Login to your Shopify account.
USAGE
$ shopify hydrogen login [--path <value>] [-s <value>]
FLAGS
-s, --shop=<value> Shop URL. It can be the shop prefix (janes-apparel) or the full myshopify.com URL
(janes-apparel.myshopify.com, https://janes-apparel.myshopify.com).
--path=<value> The path to the directory of the Hydrogen storefront. Defaults to the current directory where the
command is run.
DESCRIPTION
Login to your Shopify account.
Logout of your local session.
USAGE
$ shopify hydrogen logout [--path <value>]
FLAGS
--path=<value> The path to the directory of the Hydrogen storefront. Defaults to the current directory where the
command is run.
DESCRIPTION
Logout of your local session.
Runs a Hydrogen storefront in an Oxygen worker for production.
USAGE
$ shopify hydrogen preview [--codegen-config-path <value> [--codegen --build]] [--debug] [--entry <value> ] [--env
<value> | --env-branch <value>] [--env-file <value>] [--inspector-port <value>] [--legacy-runtime] [--path <value>]
[--port <value>] [--verbose] [--watch ]
FLAGS
--build Builds the app before starting the preview server.
--codegen Automatically generates GraphQL types for your project’s Storefront API queries.
--codegen-config-path=<value> Specifies a path to a codegen configuration file. Defaults to `<root>/codegen.ts` if
this file exists.
--debug Enables inspector connections to the server with a debugger such as Visual Studio Code
or Chrome DevTools.
--entry=<value> Entry file for the worker. Defaults to `./server`.
--env=<value> Specifies the environment to perform the operation using its handle. Fetch the handle
using the `env list` command.
--env-branch=<value> Specifies the environment to perform the operation using its Git branch name.
--env-file=<value> [default: .env] Path to an environment file to override existing environment variables.
Defaults to the '.env' located in your project path `--path`.
--inspector-port=<value> The port where the inspector is available. Defaults to 9229.
--legacy-runtime Runs the app in a Node.js sandbox instead of an Oxygen worker.
--path=<value> The path to the directory of the Hydrogen storefront. Defaults to the current directory
where the command is run.
--port=<value> The port to run the server on. Defaults to 3000.
--verbose Outputs more information about the command's execution.
--watch Watches for changes and rebuilds the project.
DESCRIPTION
Runs a Hydrogen storefront in an Oxygen worker for production.
Scaffold routes and core functionality.
USAGE
$ shopify hydrogen setup [-f] [--install-deps] [--markets <value>] [--path <value>] [--shortcut]
FLAGS
-f, --force Overwrites the destination directory and files if they already exist.
--[no-]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`.
--path=<value> The path to the directory of the Hydrogen storefront. Defaults to the current directory where
the command is run.
--[no-]shortcut Creates a global h2 shortcut for Shopify CLI using shell aliases. Deactivate with
`--no-shortcut`.
DESCRIPTION
Scaffold routes and core functionality.
Setup CSS strategies for your project.
USAGE
$ shopify hydrogen setup css [STRATEGY] [-f] [--install-deps] [--path <value>]
ARGUMENTS
STRATEGY (tailwind|vanilla-extract|css-modules|postcss) The CSS strategy to setup. One of
tailwind,vanilla-extract,css-modules,postcss
FLAGS
-f, --force Overwrites the destination directory and files if they already exist.
--[no-]install-deps Auto installs dependencies using the active package manager.
--path=<value> The path to the directory of the Hydrogen storefront. Defaults to the current directory where
the command is run.
DESCRIPTION
Setup CSS strategies for your project.
Setup support for multiple markets in your project.
USAGE
$ shopify hydrogen setup markets [STRATEGY] [--path <value>]
ARGUMENTS
STRATEGY (subfolders|domains|subdomains) The URL structure strategy to setup multiple markets. One of
subfolders,domains,subdomains
FLAGS
--path=<value> The path to the directory of the Hydrogen storefront. Defaults to the current directory where the
command is run.
DESCRIPTION
Setup support for multiple markets in your project.
EXPERIMENTAL: Upgrades the project to use Vite.
USAGE
$ shopify hydrogen setup vite [--path <value>]
FLAGS
--path=<value> The path to the directory of the Hydrogen storefront. Defaults to the current directory where the
command is run.
DESCRIPTION
EXPERIMENTAL: Upgrades the project to use Vite.
Creates a global h2 shortcut for the Hydrogen CLI
USAGE
$ shopify hydrogen shortcut
DESCRIPTION
Creates a global `h2` shortcut for the Hydrogen CLI
Unlink a local project from a Hydrogen storefront.
USAGE
$ shopify hydrogen unlink [--path <value>]
FLAGS
--path=<value> The path to the directory of the Hydrogen storefront. Defaults to the current directory where the
command is run.
DESCRIPTION
Unlink a local project from a Hydrogen storefront.
Upgrade Remix and Hydrogen npm dependencies.
USAGE
$ shopify hydrogen upgrade [-f] [--path <value>] [-v <value>]
FLAGS
-f, --force Ignore warnings and force the upgrade to the target version
-v, --version=<value> A target hydrogen version to update to
--path=<value> The path to the directory of the Hydrogen storefront. Defaults to the current directory where
the command is run.
DESCRIPTION
Upgrade Remix and Hydrogen npm dependencies.
Installs a plugin into shopify.
USAGE
$ shopify plugins add PLUGIN... [-f] [-h] [--json] [-s | -v]
ARGUMENTS
PLUGIN... Plugin to install.
FLAGS
-f, --force Force npm to fetch remote resources even if a local copy exists on disk.
-h, --help Show CLI help.
-s, --silent Silences npm output.
-v, --verbose Show verbose npm output.
GLOBAL FLAGS
--json Format output as json.
ALIASES
$ shopify plugins add
EXAMPLES
Install a plugin from npm registry.
$ shopify plugins add myplugin
Install a plugin from a github url.
$ shopify plugins add https://github.com/someuser/someplugin
Install a plugin from a github slug.
$ shopify plugins add someuser/someplugin
Displays installation properties of a plugin.
USAGE
$ shopify plugins inspect PLUGIN...
ARGUMENTS
PLUGIN... [default: .] Plugin to inspect.
FLAGS
-h, --help Show CLI help.
-v, --verbose
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Displays installation properties of a plugin.
EXAMPLES
$ shopify plugins inspect myplugin
Installs a plugin into shopify.
USAGE
$ shopify plugins install PLUGIN... [-f] [-h] [--json] [-s | -v]
ARGUMENTS
PLUGIN... Plugin to install.
FLAGS
-f, --force Force npm to fetch remote resources even if a local copy exists on disk.
-h, --help Show CLI help.
-s, --silent Silences npm output.
-v, --verbose Show verbose npm output.
GLOBAL FLAGS
--json Format output as json.
ALIASES
$ shopify plugins add
EXAMPLES
Install a plugin from npm registry.
$ shopify plugins install myplugin
Install a plugin from a github url.
$ shopify plugins install https://github.com/someuser/someplugin
Install a plugin from a github slug.
$ shopify plugins install someuser/someplugin
Links a plugin into the CLI for development.
USAGE
$ shopify plugins link PATH [-h] [--install] [-v]
ARGUMENTS
PATH [default: .] path to plugin
FLAGS
-h, --help Show CLI help.
-v, --verbose
--[no-]install Install dependencies after linking the plugin.
DESCRIPTION
Links a plugin into the CLI for development.
Installation of a linked plugin will override a user-installed or core plugin.
e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
command will override the user-installed or core plugin implementation. This is useful for development work.
EXAMPLES
$ shopify plugins link myplugin
Removes a plugin from the CLI.
USAGE
$ shopify plugins remove [PLUGIN...] [-h] [-v]
ARGUMENTS
PLUGIN... plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ shopify plugins unlink
$ shopify plugins remove
EXAMPLES
$ shopify plugins remove myplugin
Remove all user-installed and linked plugins.
USAGE
$ shopify plugins reset [--hard] [--reinstall]
FLAGS
--hard Delete node_modules and package manager related files in addition to uninstalling plugins.
--reinstall Reinstall all plugins after uninstalling.
Removes a plugin from the CLI.
USAGE
$ shopify plugins uninstall [PLUGIN...] [-h] [-v]
ARGUMENTS
PLUGIN... plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ shopify plugins unlink
$ shopify plugins remove
EXAMPLES
$ shopify plugins uninstall myplugin
Removes a plugin from the CLI.
USAGE
$ shopify plugins unlink [PLUGIN...] [-h] [-v]
ARGUMENTS
PLUGIN... plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ shopify plugins unlink
$ shopify plugins remove
EXAMPLES
$ shopify plugins unlink myplugin
Update installed plugins.
USAGE
$ shopify plugins update [-h] [-v]
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Update installed plugins.
Starts a search on shopify.dev.
USAGE
$ shopify search [QUERY]
DESCRIPTION
Starts a search on shopify.dev.
EXAMPLES
# open the search modal on Shopify.dev
shopify search
# search for a term on Shopify.dev
shopify search <query>
# search for a phrase on Shopify.dev
shopify search "<a search query separated by spaces>"
Validate the theme.
USAGE
$ shopify theme check [-a] [-C <value>] [-e <value>] [--fail-level crash|error|suggestion|style|warning|info]
[--init] [--list] [--no-color] [-o text|json] [--path <value>] [--print] [--verbose] [-v]
FLAGS
-C, --config=<value> Use the config provided, overriding .theme-check.yml if present
Supports all theme-check: config values, e.g., theme-check:theme-app-extension,
theme-check:recommended, theme-check:all
For backwards compatibility, :theme_app_extension is also supported
-a, --auto-correct Automatically fix offenses
-e, --environment=<value> The environment to apply to the current command.
-o, --output=<option> [default: text] The output format to use
<options: text|json>
-v, --version Print Theme Check version
--fail-level=<option> [default: error] Minimum severity for exit with error code
<options: crash|error|suggestion|style|warning|info>
--init Generate a .theme-check.yml file
--list List enabled checks
--no-color Disable color output.
--path=<value> The path to your theme directory.
--print Output active config to STDOUT
--verbose Increase the verbosity of the output.
DESCRIPTION
Validate the theme.
Calls and runs "Theme Check" (https://shopify.dev/docs/themes/tools/theme-check) to analyze your theme code for errors
and to ensure that it follows theme and Liquid best practices. "Learn more about the checks that Theme Check runs."
(https://shopify.dev/docs/themes/tools/theme-check/checks)
Shopify Liquid REPL (read-eval-print loop) tool
USAGE
$ shopify theme console
$ shopify theme console --url /products/classic-leather-jacket
FLAGS
-e, --environment=<value> The environment to apply to the current command.
-s, --store=<value> Store URL. It can be the store prefix (example) or the full myshopify.com URL
(example.myshopify.com, https://example.myshopify.com).
--no-color Disable color output.
--password=<value> Password generated from the Theme Access app.
--store-password=<value> The password for storefronts with password protection.
--url=<value> [default: /] The url to be used as context
--verbose Increase the verbosity of the output.
DESCRIPTION
Shopify Liquid REPL (read-eval-print loop) tool
Starts the Shopify Liquid REPL (read-eval-print loop) tool. This tool provides an interactive terminal interface for
evaluating Liquid code and exploring Liquid objects, filters, and tags using real store data.
You can also provide context to the console using a URL, as some Liquid objects are context-specific
Delete remote themes from the connected store. This command can't be undone.
USAGE
$ shopify theme delete [-d] [-e <value>] [-f] [--no-color] [--password <value>] [-a] [-s <value>] [-t <value>]
[--verbose]
FLAGS
-a, --show-all Include others development themes in theme list.
-d, --development Delete your development theme.
-e, --environment=<value> The environment to apply to the current command.
-f, --force Skip confirmation.
-s, --store=<value> Store URL. It can be the store prefix (example) or the full myshopify.com URL
(example.myshopify.com, https://example.myshopify.com).
-t, --theme=<value>... Theme ID or name of the remote theme.
--no-color Disable color output.
--password=<value> Password generated from the Theme Access app.
--verbose Increase the verbosity of the output.
DESCRIPTION
Delete remote themes from the connected store. This command can't be undone.
Deletes a theme from your store.
You can specify multiple themes by ID. If no theme is specified, then you're prompted to select the theme that you
want to delete from the list of themes in your store.
You're asked to confirm that you want to delete the specified themes before they are deleted. You can skip this
confirmation using the `--force` flag.
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.
USAGE
$ shopify theme dev [-e <value>] [--host <value>] [-x <value>] [--live-reload hot-reload|full-page|off]
[--no-color] [-n] [--notify <value>] [-o <value>] [--open] [--password <value>] [--path <value>] [--port <value>]
[-s <value>] [--store-password <value>] [-t <value>] [--theme-editor-sync] [--verbose]
FLAGS
-e, --environment=<value>
The environment to apply to the current command.
-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.
-o, --only=<value>...
Hot reload only files that match the specified pattern.
-s, --store=<value>
Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com,
https://example.myshopify.com).
-t, --theme=<value>
Theme ID or name of the remote theme.
-x, --ignore=<value>...
Skip hot reloading any files that match the specified pattern.
--host=<value>
Set which network interface the web server listens on. The default value is 127.0.0.1.
--live-reload=<option>
[default: hot-reload] 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
<options: hot-reload|full-page|off>
--no-color
Disable color output.
--notify=<value>
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.
--open
Automatically launch the theme preview in your default web browser.
--password=<value>
Password generated from the Theme Access app.
--path=<value>
The path to your theme directory.
--port=<value>
Local port to serve theme preview from.
--store-password=<value>
The password for storefronts with password protection.
--theme-editor-sync
Synchronize Theme Editor updates in the local theme files.
--verbose
Increase the verbosity of the output.
DESCRIPTION
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.
Uploads the current theme as the specified theme, or a "development theme"
(https://shopify.dev/docs/themes/tools/cli#development-themes), 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 `--host` and `--port`.
- A link to the "editor" (https://shopify.dev/docs/themes/tools/online-editor) for the theme in the Shopify admin.
- A "preview link"
(https://help.shopify.com/manual/online-store/themes/adding-themes#share-a-theme-preview-with-others) 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" (https://shopify.dev/docs/api/shopify-cli/theme/theme-share) your theme or "push"
(https://shopify.dev/docs/api/shopify-cli/theme/theme-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"
(https://shopify.dev/docs/themes/tools/cli#directory-structure).
Displays information about your theme environment, including your current store. Can also retrieve information about a specific theme.
USAGE
$ shopify theme info [-d] [-e <value>] [-j] [--no-color] [--password <value>] [-s <value>] [-t <value>]
[--verbose]
FLAGS
-d, --development Retrieve info from your development theme.
-e, --environment=<value> The environment to apply to the current command.
-j, --json Output the result as JSON.
-s, --store=<value> Store URL. It can be the store prefix (example) or the full myshopify.com URL
(example.myshopify.com, https://example.myshopify.com).
-t, --theme=<value> Theme ID or name of the remote theme.
--no-color Disable color output.
--password=<value> Password generated from the Theme Access app.
--verbose Increase the verbosity of the output.
DESCRIPTION
Displays information about your theme environment, including your current store. Can also retrieve information about a
specific theme.
Clones a Git repository to use as a starting point for building a new theme.
USAGE
$ shopify theme init [name]
ARGUMENTS
NAME Name of the new theme
FLAGS
-l, --latest Downloads the latest release of the `clone-url`
-u, --clone-url=<value> [default: https://github.com/Shopify/dawn.git] The Git URL to clone from. Defaults to
Shopify's example theme, Dawn: https://github.com/Shopify/dawn.git
--no-color Disable color output.
--path=<value> The path to your theme directory.
--verbose Increase the verbosity of the output.
DESCRIPTION
Clones a Git repository to use as a starting point for building a new theme.
Clones a Git repository to your local machine to use as the starting point for building a theme.
If no Git repository is specified, then this command creates a copy of "Dawn" (https://github.com/Shopify/dawn),
Shopify's example theme, with the specified name in the current folder. If no name is provided, then you're prompted
to enter one.
> Caution: If you're building a theme for the Shopify Theme Store, then you can use Dawn as a starting point. However,
the theme that you submit needs to be "substantively different from Dawn"
(https://shopify.dev/docs/themes/store/requirements#uniqueness) so that it provides added value for users. Learn about
the "ways that you can use Dawn" (https://shopify.dev/docs/themes/tools/dawn#ways-to-use-dawn).
Start a Language Server Protocol server.
USAGE
$ shopify theme language-server [--no-color] [--verbose]
FLAGS
--no-color Disable color output.
--verbose Increase the verbosity of the output.
DESCRIPTION
Start a Language Server Protocol server.
Starts the "Language Server" (https://shopify.dev/docs/themes/tools/cli/language-server).
Lists the themes in your store, along with their IDs and statuses.
USAGE
$ shopify theme list [-e <value>] [--id <value>] [-j] [--name <value>] [--no-color] [--password <value>]
[--role live|unpublished|development] [-s <value>] [--verbose]
FLAGS
-e, --environment=<value> The environment to apply to the current command.
-j, --json Output the result as JSON.
-s, --store=<value> Store URL. It can be the store prefix (example) or the full myshopify.com URL
(example.myshopify.com, https://example.myshopify.com).
--id=<value> Only list theme with the given ID.
--name=<value> Only list themes that contain the given name.
--no-color Disable color output.
--password=<value> Password generated from the Theme Access app.
--role=<option> Only list themes with the given role.
<options: live|unpublished|development>
--verbose Increase the verbosity of the output.
DESCRIPTION
Lists the themes in your store, along with their IDs and statuses.
Download metafields definitions from your shop into a local file.
USAGE
$ shopify theme metafields pull [-e <value>] [--no-color] [--password <value>] [--path <value>] [-s <value>]
[--verbose]
FLAGS
-e, --environment=<value> The environment to apply to the current command.
-s, --store=<value> Store URL. It can be the store prefix (example) or the full myshopify.com URL
(example.myshopify.com, https://example.myshopify.com).
--no-color Disable color output.
--password=<value> Password generated from the Theme Access app.
--path=<value> The path to your theme directory.
--verbose Increase the verbosity of the output.
DESCRIPTION
Download metafields definitions from your shop into a local file.
Retrieves metafields from Shopify Admin.
If the metafields file already exists, it will be overwritten.
Opens the preview of your remote theme.
USAGE
$ shopify theme open [-d] [-E] [-e <value>] [-l] [--no-color] [--password <value>] [-s <value>] [-t <value>]
[--verbose]
FLAGS
-E, --editor Open the theme editor for the specified theme in the browser.
-d, --development Open your development theme.
-e, --environment=<value> The environment to apply to the current command.
-l, --live Open your live (published) theme.
-s, --store=<value> Store URL. It can be the store prefix (example) or the full myshopify.com URL
(example.myshopify.com, https://example.myshopify.com).
-t, --theme=<value> Theme ID or name of the remote theme.
--no-color Disable color output.
--password=<value> Password generated from the Theme Access app.
--verbose Increase the verbosity of the output.
DESCRIPTION
Opens the preview of your remote theme.
Returns links that let you preview the specified theme. The following links are returned:
- A link to the "editor" (https://shopify.dev/docs/themes/tools/online-editor) for the theme in the Shopify admin.
- A "preview link"
(https://help.shopify.com/manual/online-store/themes/adding-themes#share-a-theme-preview-with-others) that you can
share with other developers.
If you don't specify a theme, then you're prompted to select the theme to open from the list of the themes in your
store.
Package your theme into a .zip file, ready to upload to the Online Store.
USAGE
$ shopify theme package [--no-color] [--path <value>] [--verbose]
FLAGS
--no-color Disable color output.
--path=<value> The path to your theme directory.
--verbose Increase the verbosity of the output.
DESCRIPTION
Package your theme into a .zip file, ready to upload to the Online Store.
Packages your local theme files into a ZIP file that can be uploaded to Shopify.
Only folders that match the "default Shopify theme folder structure"
(https://shopify.dev/docs/themes/tools/cli#directory-structure) are included in the package.
The ZIP file uses the name `theme_name-theme_version.zip`, based on parameters in your "settings_schema.json"
(https://shopify.dev/docs/themes/architecture/config/settings-schema-json) file.
Set a remote theme as the live theme.
USAGE
$ shopify theme publish [-e <value>] [-f] [--no-color] [--password <value>] [-s <value>] [-t <value>] [--verbose]
FLAGS
-e, --environment=<value> The environment to apply to the current command.
-f, --force Skip confirmation.
-s, --store=<value> Store URL. It can be the store prefix (example) or the full myshopify.com URL
(example.myshopify.com, https://example.myshopify.com).
-t, --theme=<value> Theme ID or name of the remote theme.
--no-color Disable color output.
--password=<value> Password generated from the Theme Access app.
--verbose Increase the verbosity of the output.
DESCRIPTION
Set a remote theme as the live theme.
Publishes an unpublished theme from your theme library.
If no theme ID is specified, then you're prompted to select the theme that you want to publish from the list of themes
in your store.
You can run this command only in a directory that matches the "default Shopify theme folder structure"
(https://shopify.dev/docs/themes/tools/cli#directory-structure).
If you want to publish your local theme, then you need to run `shopify theme push` first. You're asked to confirm that
you want to publish the specified theme. You can skip this confirmation using the `--force` flag.
Download your remote theme files locally.
USAGE
$ shopify theme pull [-d] [-e <value>] [-x <value>] [-l] [--no-color] [-n] [-o <value>] [--password <value>]
[--path <value>] [-s <value>] [-t <value>] [--verbose]
FLAGS
-d, --development Pull theme files from your remote development theme.
-e, --environment=<value> The environment to apply to the current command.
-l, --live Pull theme files from your remote live theme.
-n, --nodelete Prevent deleting local files that don't exist remotely.
-o, --only=<value>... Download only the specified files (Multiple flags allowed).
-s, --store=<value> Store URL. It can be the store prefix (example) or the full myshopify.com URL
(example.myshopify.com, https://example.myshopify.com).
-t, --theme=<value> Theme ID or name of the remote theme.
-x, --ignore=<value>... Skip downloading the specified files (Multiple flags allowed).
--no-color Disable color output.
--password=<value> Password generated from the Theme Access app.
--path=<value> The path to your theme directory.
--verbose Increase the verbosity of the output.
DESCRIPTION
Download your remote theme files locally.
Retrieves theme files from Shopify.
If no theme is specified, then you're prompted to select the theme to pull from the list of the themes in your store.
Uploads your local theme files to the connected store, overwriting the remote version if specified.
USAGE
$ shopify theme push
$ shopify theme push --unpublished --json
FLAGS
-a, --allow-live Allow push to a live theme.
-d, --development Push theme files from your remote development theme.
-e, --environment=<value> The environment to apply to the current command.
-j, --json Output the result as JSON.
-l, --live Push theme files from your remote live theme.
-n, --nodelete Prevent deleting remote files that don't exist locally.
-o, --only=<value>... Download only the specified files (Multiple flags allowed).
-p, --publish Publish as the live theme after uploading.
-s, --store=<value> Store URL. It can be the store prefix (example) or the full myshopify.com URL
(example.myshopify.com, https://example.myshopify.com).
-t, --theme=<value> Theme ID or name of the remote theme.
-u, --unpublished Create a new unpublished theme and push to it.
-x, --ignore=<value>... Skip downloading the specified files (Multiple flags allowed).
--no-color Disable color output.
--password=<value> Password generated from the Theme Access app.
--path=<value> The path to your theme directory.
--strict Require theme check to pass without errors before pushing. Warnings are allowed.
--verbose Increase the verbosity of the output.
DESCRIPTION
Uploads your local theme files to the connected store, overwriting the remote version if specified.
Uploads your local theme files to Shopify, overwriting the remote version if specified.
If no theme is specified, then you're prompted to select the theme to overwrite from the list of the themes in your
store.
You can run this command only in a directory that matches the "default Shopify theme folder structure"
(https://shopify.dev/docs/themes/tools/cli#directory-structure).
This command returns the following information:
- A link to the "editor" (https://shopify.dev/docs/themes/tools/online-editor) for the theme in the Shopify admin.
- A "preview link"
(https://help.shopify.com/manual/online-store/themes/adding-themes#share-a-theme-preview-with-others) that you can
share with others.
If you use the `--json` flag, then theme information is returned in JSON format, which can be used as a
machine-readable input for scripts or continuous integration.
Sample output:
```json
{
"theme": {
"id": 108267175958,
"name": "MyTheme",
"role": "unpublished",
"shop": "mystore.myshopify.com",
"editor_url": "https://mystore.myshopify.com/admin/themes/108267175958/editor",
"preview_url": "https://mystore.myshopify.com/?preview_theme_id=108267175958"
}
}
## `shopify theme rename`
Renames an existing theme.
USAGE $ shopify theme rename [-d] [-e ] [-l] [-n ] [--no-color] [--password ] [-s ] [-t ] [--verbose]
FLAGS -d, --development Rename your development theme. -e, --environment= The environment to apply to the current command. -l, --live Rename your remote live theme. -n, --name= The new name for the theme. -s, --store= Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com). -t, --theme= Theme ID or name of the remote theme. --no-color Disable color output. --password= Password generated from the Theme Access app. --verbose Increase the verbosity of the output.
DESCRIPTION Renames an existing theme.
Renames a theme in your store.
If no theme is specified, then you're prompted to select the theme that you want to rename from the list of themes in your store.
## `shopify theme share`
Creates a shareable, unpublished, and new theme on your theme library with a randomized name.
USAGE $ shopify theme share [-e ] [--no-color] [--password ] [--path ] [-s ] [--verbose]
FLAGS -e, --environment= The environment to apply to the current command. -s, --store= Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com). --no-color Disable color output. --password= Password generated from the Theme Access app. --path= The path to your theme directory. --verbose Increase the verbosity of the output.
DESCRIPTION Creates a shareable, unpublished, and new theme on your theme library with a randomized name.
Uploads your theme as a new, unpublished theme in your theme library. The theme is given a randomized name.
This command returns a "preview link" (https://help.shopify.com/manual/online-store/themes/adding-themes#share-a-theme-preview-with-others) that you can share with others.
## `shopify upgrade`
Shows details on how to upgrade Shopify CLI.
USAGE $ shopify upgrade
DESCRIPTION Shows details on how to upgrade Shopify CLI.
Shows details on how to upgrade Shopify CLI.
## `shopify version`
Shopify CLI version currently installed.
USAGE $ shopify version
DESCRIPTION Shopify CLI version currently installed.
<!-- commandsstop -->