@shopify/cli

{ "commands": { "app:build": { "aliases": [ ], "args": { }, "customPluginName": "@shopify/app", "description": "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).\n\n 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.", "descriptionWithMarkdown": "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).\n\n 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.", "flags": { "client-id": { "description": "The Client ID of your app.", "env": "SHOPIFY_FLAG_CLIENT_ID", "exclusive": [ "config" ], "hasDynamicHelp": false, "hidden": false, "multiple": false, "name": "client-id", "type": "option" }, "config": { "char": "c", "description": "The name of the app configuration.", "env": "SHOPIFY_FLAG_APP_CONFIG", "hasDynamicHelp": false, "hidden": false, "multiple": false, "name": "config", "type": "option" }, "no-color": { "allowNo": false, "description": "Disable color output.", "env": "SHOPIFY_FLAG_NO_COLOR", "hidden": false, "name": "no-color", "type": "boolean" }, "path": { "description": "The path to your app directory.", "env": "SHOPIFY_FLAG_PATH", "hasDynamicHelp": false, "multiple": false, "name": "path", "noCacheDefault": true, "type": "option" }, "reset": { "allowNo": false, "description": "Reset all your settings.", "env": "SHOPIFY_FLAG_RESET", "exclusive": [ "config" ], "hidden": false, "name": "reset", "type": "boolean" }, "skip-dependencies-installation": { "allowNo": false, "description": "Skips the installation of dependencies. Deprecated, use workspaces instead.", "env": "SHOPIFY_FLAG_SKIP_DEPENDENCIES_INSTALLATION", "hidden": false, "name": "skip-dependencies-installation", "type": "boolean" }, "verbose": { "allowNo": false, "description": "Increase the verbosity of the output.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [ ], "id": "app:build", "pluginAlias": "@shopify/cli", "pluginName": "@shopify/cli", "pluginType": "core", "strict": true, "summary": "Build the app, including extensions." }, "app:bulk:status": { "aliases": [ ], "args": { }, "customPluginName": "@shopify/app", "description": "Check the status of a specific bulk operation by ID, or list all bulk operations in the last 7 days.", "flags": { "client-id": { "description": "The Client ID of your app.", "env": "SHOPIFY_FLAG_CLIENT_ID", "exclusive": [ "config" ], "hasDynamicHelp": false, "hidden": false, "multiple": false, "name": "client-id", "type": "option" }, "config": { "char": "c", "description": "The name of the app configuration.", "env": "SHOPIFY_FLAG_APP_CONFIG", "hasDynamicHelp": false, "hidden": false, "multiple": false, "name": "config", "type": "option" }, "id": { "description": "The bulk operation ID. If not provided, lists all bulk operations in the last 7 days.", "env": "SHOPIFY_FLAG_ID", "hasDynamicHelp": false, "multiple": false, "name": "id", "type": "option" }, "no-color": { "allowNo": false, "description": "Disable color output.", "env": "SHOPIFY_FLAG_NO_COLOR", "hidden": false, "name": "no-color", "type": "boolean" }, "path": { "description": "The path to your app directory.", "env": "SHOPIFY_FLAG_PATH", "hasDynamicHelp": false, "multiple": false, "name": "path", "noCacheDefault": true, "type": "option" }, "reset": { "allowNo": false, "description": "Reset all your settings.", "env": "SHOPIFY_FLAG_RESET", "exclusive": [ "config" ], "hidden": false, "name": "reset", "type": "boolean" }, "store": { "char": "s", "description": "The store domain. Must be an existing dev store.", "env": "SHOPIFY_FLAG_STORE", "hasDynamicHelp": false, "multiple": false, "name": "store", "type": "option" }, "verbose": { "allowNo": false, "description": "Increase the verbosity of the output.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "type": "boolean" } }, "hasDynamicHelp": false, "hidden": true, "hiddenAliases": [ ], "id": "app:bulk:status", "pluginAlias": "@shopify/cli", "pluginName": "@shopify/cli", "pluginType": "core", "strict": true, "summary": "Check the status of bulk operations." }, "app:config:link": { "aliases": [ ], "args": { }, "customPluginName": "@shopify/app", "description": "Pulls app configuration from the Developer Dashboard and creates or overwrites a configuration file. You can create a new app with this command to start with a default configuration file.\n\n 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.\n ", "descriptionWithMarkdown": "Pulls app configuration from the Developer Dashboard and creates or overwrites a configuration file. You can create a new app with this command to start with a default configuration file.\n\n 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.\n ", "flags": { "client-id": { "description": "The Client ID of your app.", "env": "SHOPIFY_FLAG_CLIENT_ID", "exclusive": [ "config" ], "hasDynamicHelp": false, "hidden": false, "multiple": false, "name": "client-id", "type": "option" }, "config": { "char": "c", "description": "The name of the app configuration.", "env": "SHOPIFY_FLAG_APP_CONFIG", "hasDynamicHelp": false, "hidden": false, "multiple": false, "name": "config", "type": "option" }, "no-color": { "allowNo": false, "description": "Disable color output.", "env": "SHOPIFY_FLAG_NO_COLOR", "hidden": false, "name": "no-color", "type": "boolean" }, "path": { "description": "The path to your app directory.", "env": "SHOPIFY_FLAG_PATH", "hasDynamicHelp": false, "multiple": false, "name": "path", "noCacheDefault": true, "type": "option" }, "reset": { "allowNo": false, "description": "Reset all your settings.", "env": "SHOPIFY_FLAG_RESET", "exclusive": [ "config" ], "hidden": false, "name": "reset", "type": "boolean" }, "verbose": { "allowNo": false, "description": "Increase the verbosity of the output.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [ ], "id": "app:config:link", "pluginAlias": "@shopify/cli", "pluginName": "@shopify/cli", "pluginType": "core", "strict": true, "summary": "Fetch your app configuration from the Developer Dashboard." }, "app:config:pull": { "aliases": [ ], "args": { }, "customPluginName": "@shopify/app", "description": "Pulls the latest configuration from the already-linked Shopify app and updates the selected configuration file.\n\nThis command reuses the existing linked app and organization and skips all interactive prompts. Use `--config` to target a specific configuration file, or omit it to use the default one.", "descriptionWithMarkdown": "Pulls the latest configuration from the already-linked Shopify app and updates the selected configuration file.\n\nThis command reuses the existing linked app and organization and skips all interactive prompts. Use `--config` to target a specific configuration file, or omit it to use the default one.", "flags": { "client-id": { "description": "The Client ID of your app.", "env": "SHOPIFY_FLAG_CLIENT_ID", "exclusive": [ "config" ], "hasDynamicHelp": false, "hidden": false, "multiple": false, "name": "client-id", "type": "option" }, "config": { "char": "c", "description": "The name of the app configuration.", "env": "SHOPIFY_FLAG_APP_CONFIG", "hasDynamicHelp": false, "hidden": false, "multiple": false, "name": "config", "type": "option" }, "no-color": { "allowNo": false, "description": "Disable color output.", "env": "SHOPIFY_FLAG_NO_COLOR", "hidden": false, "name": "no-color", "type": "boolean" }, "path": { "description": "The path to your app directory.", "env": "SHOPIFY_FLAG_PATH", "hasDynamicHelp": false, "multiple": false, "name": "path", "noCacheDefault": true, "type": "option" }, "reset": { "allowNo": false, "description": "Reset all your settings.", "env": "SHOPIFY_FLAG_RESET", "exclusive": [ "config" ], "hidden": false, "name": "reset", "type": "boolean" }, "verbose": { "allowNo": false, "description": "Increase the verbosity of the output.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [ ], "id": "app:config:pull", "pluginAlias": "@shopify/cli", "pluginName": "@shopify/cli", "pluginType": "core", "strict": true, "summary": "Refresh an already-linked app configuration without prompts." }, "app:config:use": { "aliases": [ ], "args": { "config": { "description": "The name of the app configuration. Can be 'shopify.app.staging.toml' or simply 'staging'.", "name": "config" } }, "customPluginName": "@shopify/app", "description": "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.", "descriptionWithMarkdown": "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.", "flags": { "client-id": { "description": "The Client ID of your app.", "env": "SHOPIFY_FLAG_CLIENT_ID", "exclusive": [ "config" ], "hasDynamicHelp": false, "hidden": false, "multiple": false, "name": "client-id", "type": "option" }, "no-color": { "allowNo": false, "description": "Disable color output.", "env": "SHOPIFY_FLAG_NO_COLOR", "hidden": false, "name": "no-color", "type": "boolean" }, "path": { "description": "The path to your app directory.", "env": "SHOPIFY_FLAG_PATH", "hasDynamicHelp": false, "multiple": false, "name": "path", "noCacheDefault": true, "type": "option" }, "reset": { "allowNo": false, "description": "Reset all your settings.", "env": "SHOPIFY_FLAG_RESET", "exclusive": [ "config" ], "hidden": false, "name": "reset", "type": "boolean" }, "verbose": { "allowNo": false, "description": "Increase the verbosity of the output.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [ ], "id": "app:config:use", "pluginAlias": "@shopify/cli", "pluginName": "@shopify/cli", "pluginType": "core", "strict": true, "summary": "Activate an app configuration.", "usage": "app config use [config] [flags]" }, "app:deploy": { "aliases": [ ], "args": { }, "customPluginName": "@shopify/app", "description": "\"Builds the app\" (https://shopify.dev/docs/api/shopify-cli/app/app-build), then deploys your app configuration and extensions.\n\n This command creates an app version, which is a snapshot of your app configuration and all extensions. This version is then released to users.\n\n 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.\n ", "descriptionWithMarkdown": "[Builds the app](https://shopify.dev/docs/api/shopify-cli/app/app-build), then deploys your app configuration and extensions.\n\n This command creates an app version, which is a snapshot of your app configuration and all extensions. This version is then released to users.\n\n 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.\n ", "flags": { "client-id": { "description": "The Client ID of your app.", "env": "SHOPIFY_FLAG_CLIENT_ID", "exclusive": [ "config" ], "hasDynamicHelp": false, "hidden": false, "multiple": false, "name": "client-id", "type": "option" }, "config": { "char": "c", "description": "The name of the app configuration.", "env": "SHOPIFY_FLAG_APP_CONFIG", "hasDynamicHelp": false, "hidden": false, "multiple": false, "name": "config", "type": "option" }, "force": { "allowNo": false, "char": "f", "description": "Deploy without asking for confirmation.", "env": "SHOPIFY_FLAG_FORCE", "hidden": false, "name": "force", "type": "boolean" }, "message": { "description": "Optional message that will be associated with this version. This is for internal use only and won't be available externally.", "env": "SHOPIFY_FLAG_MESSAGE", "hasDynamicHelp": false, "hidden": false, "multiple": false, "name": "message", "type": "option" }, "no-build": { "allowNo": false, "description": "Use with caution: Skips building any elements of the app that require building. You should ensure your app has been prepared in advance, such as by running `shopify app build` or by caching build artifacts.", "env": "SHOPIFY_FLAG_NO_BUILD", "name": "no-build", "type": "boolean" }, "no-color": { "allowNo": false, "description": "Disable color output.", "env": "SHOPIFY_FLAG_NO_COLOR", "hidden": false, "name": "no-color", "type": "boolean" }, "no-release": { "allowNo": false, "description": "Creates a version but doesn't release it - it's not made available to merchants.", "env": "SHOPIFY_FLAG_NO_RELEASE", "hidden": false, "name": "no-release", "type": "boolean" }, "path": { "description": "The path to your app directory.", "env": "SHOPIFY_FLAG_PATH", "hasDynamicHelp": false, "multiple": false, "name": "path", "noCacheDefault": true, "type": "option" }, "reset": { "allowNo": false, "description": "Reset all your settings.", "env": "SHOPIFY_FLAG_RESET", "exclusive": [ "config" ], "hidden": false, "name": "reset", "type": "boolean" }, "source-control-url": { "description": "URL associated with the new app version.", "env": "SHOPIFY_FLAG_SOURCE_CONTROL_URL", "hasDynamicHelp": false, "hidden": false, "multiple": false, "name": "source-control-url", "type": "option" }, "verbose": { "allowNo": false, "description": "Increase the verbosity of the output.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "type": "boolean" }, "version": { "description": "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.", "env": "SHOPIFY_FLAG_VERSION", "hasDynamicHelp": false, "hidden": false, "multiple": false, "name": "version", "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [ ], "id": "app:deploy", "pluginAlias": "@shopify/cli", "pluginName": "@shopify/cli", "pluginType": "core", "strict": true, "summary": "Deploy your Shopify app." }, "app:dev": { "aliases": [ ], "args": { }, "customPluginName": "@shopify/app", "description": "Builds and previews your app on a dev store, and watches for changes. \"Read more about testing apps locally\" (https://shopify.dev/docs/apps/build/cli-for-apps/test-apps-locally).", "descriptionWithMarkdown": "Builds and previews your app on a dev store, and watches for changes. [Read more about testing apps locally](https://shopify.dev/docs/apps/build/cli-for-apps/test-apps-locally).", "flags": { "checkout-cart-url": { "description": "Resource URL for checkout UI extension. Format: \"/cart/{productVariantID}:{productQuantity}\"", "env": "SHOPIFY_FLAG_CHECKOUT_CART_URL", "hasDynamicHelp": false, "multiple": false, "name": "checkout-cart-url", "type": "option" }, "client-id": { "description": "The Client ID of your app.", "env": "SHOPIFY_FLAG_CLIENT_ID", "exclusive": [ "config" ], "hasDynamicHelp": false, "hidden": false, "multiple": false, "name": "client-id", "type": "option" }, "config": { "char": "c", "description": "The name of the app configuration.", "env": "SHOPIFY_FLAG_APP_CONFIG", "hasDynamicHelp": false, "hidden": false, "multiple": false, "name": "config", "type": "option" }, "graphiql-key": { "description": "Key used to authenticate GraphiQL requests. Should be specified if exposing GraphiQL on a publicly accessible URL. By default, no key is required.", "env": "SHOPIFY_FLAG_GRAPHIQL_KEY", "hasDynamicHelp": false, "hidden": true, "multiple": false, "name": "graphiql-key", "type": "option" }, "graphiql-port": { "description": "Local port of the GraphiQL development server.", "env": "SHOPIFY_FLAG_GRAPHIQL_PORT", "hasDynamicHelp": false, "hidden": true, "multiple": false, "name": "graphiql-port", "type": "option" }, "localhost-port": { "description": "Port to use for localhost.", "env": "SHOPIFY_FLAG_LOCALHOST_PORT", "hasDynamicHelp": false, "multiple": false, "name": "localhost-port", "type": "option" }, "no-color": { "allowNo": false, "description": "Disable color output.", "env": "SHOPIFY_FLAG_NO_COLOR", "hidden": false, "name": "no-color", "type": "boolean" }, "no-update": { "allowNo": false, "description": "Uses the app URL from the toml file instead an autogenerated URL for dev.", "env": "SHOPIFY_FLAG_NO_UPDATE", "name": "no-update", "type": "boolean" }, "notify": { "description": "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.", "env": "SHOPIFY_FLAG_NOTIFY", "hasDynamicHelp": false, "multiple": false, "name": "notify", "type": "option" }, "path": { "description": "The path to your app directory.", "env": "SHOPIFY_FLAG_PATH", "hasDynamicHelp": false, "multiple": false, "name": "path", "noCacheDefault": true, "type": "option" }, "reset": { "allowNo": false, "description": "Reset all your settings.", "env": "SHOPIFY_FLAG_RESET", "exclusive": [ "config" ], "hidden": false, "name": "reset", "type": "boolean" }, "skip-dependencies-installation": { "allowNo": false, "description": "Skips the installation of dependencies. Deprecated, use workspaces instead.", "env": "SHOPIFY_FLAG_SKIP_DEPENDENCIES_INSTALLATION", "name": "skip-dependencies-installation", "type": "boolean" }, "store": { "char": "s", "description": "Store URL. Must be an existing development or Shopify Plus sandbox store.", "env": "SHOPIFY_FLAG_STORE", "hasDynamicHelp": false, "multiple": false, "name": "store", "type": "option" }, "subscription-product-url": { "description": "Resource URL for subscription UI extension. Format: \"/products/{productId}\"", "env": "SHOPIFY_FLAG_SUBSCRIPTION_PRODUCT_URL", "hasDynamicHelp": false, "multiple": false, "name": "subscription-product-url", "type": "option" }, "theme": { "char": "t", "description": "Theme ID or name of the theme app extension host theme.", "env": "SHOPIFY_FLAG_THEME", "hasDynamicHelp": false, "multiple": false, "name": "theme", "type": "option" }, "theme-app-extension-port": { "description": "Local port of the theme app extension development server.", "env": "SHOPIFY_FLAG_THEME_APP_EXTENSION_PORT", "hasDynamicHelp": false, "multiple": false, "name": "theme-app-extension-port", "type": "option" }, "tunnel-url": { "description": "Use a custom tunnel, it must be running before executing dev. Format: \"https://my-tunnel-url:port\".", "env": "SHOPIFY_FLAG_TUNNEL_URL", "exclusive": [ "tunnel" ], "hasDynamicHelp": false, "multiple": false, "name": "tunnel-url", "type": "option" }, "use-localhost": { "allowNo": false, "description": "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)", "env": "SHOPIFY_FLAG_USE_LOCALHOST", "exclusive": [ "tunnel-url" ], "name": "use-localhost", "type": "boolean" }, "verbose": { "allowNo": false, "description": "Increase the verbosity of the output.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [ ], "id": "app:dev", "pluginAlias": "@shopify/cli", "pluginName": "@shopify/cli", "pluginType": "core", "strict": true, "summary": "Run the app." }, "app:dev:clean": { "aliases": [ ], "args": { }, "customPluginName": "@shopify/app", "description": "Stop the dev preview that was started with `shopify app dev`.\n\n It restores the app's active version to the selected development store.\n ", "descriptionWithMarkdown": "Stop the dev preview that was started with `shopify app dev`.\n\n It restores the app's active version to the selected development store.\n ", "flags": { "client-id": { "description": "The Client ID of your app.", "env": "SHOPIFY_FLAG_CLIENT_ID", "exclusive": [ "config" ], "hasDynamicHelp": false, "hidden": false, "multiple": false, "name": "client-id", "type": "option" }, "config": { "char": "c", "description": "The name of the app configuration.", "env": "SHOPIFY_FLAG_APP_CONFIG", "hasDynamicHelp": false, "hidden": false, "multiple": false, "name": "config", "type": "option" }, "no-color": { "allowNo": false, "description": "Disable color output.", "env": "SHOPIFY_FLAG_NO_COLOR", "hidden": false, "name": "no-color", "type": "boolean" }, "path": { "description": "The path to your app directory.", "env": "SHOPIFY_FLAG_PATH", "hasDynamicHelp": false, "multiple": false, "name": "path", "noCacheDefault": true, "type": "option" }, "reset": { "allowNo": false, "description": "Reset all your settings.", "env": "SHOPIFY_FLAG_RESET", "exclusive": [ "config" ], "hidden": false, "name": "reset", "type": "boolean" }, "store": { "char": "s", "description": "Store URL. Must be an existing development store.", "env": "SHOPIFY_FLAG_STORE", "hasDynamicHelp": false, "hidden": false, "multiple": false, "name": "store", "type": "option" }, "verbose": { "allowNo": false, "description": "Increase the verbosity of the output.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [ ], "id": "app:dev:clean", "pluginAlias": "@shopify/cli", "pluginName": "@shopify/cli", "pluginType": "core", "strict": true, "summary": "Cleans up the dev preview from the selected store." }, "app:env:pull": { "aliases": [ ], "args": { }, "customPluginName": "@shopify/app", "description": "Creates or updates an `.env` files that contains app and app extension environment variables.\n\n When an existing `.env` file is updated, changes to the variables are displayed in the terminal output. Existing variables and commented variables are preserved.", "descriptionWithMarkdown": "Creates or updates an `.env` files that contains app and app extension environment variables.\n\n When an existing `.env` file is updated, changes to the variables are displayed in the terminal output. Existing variables and commented variables are preserved.", "flags": { "client-id": { "description": "The Client ID of your app.", "env": "SHOPIFY_FLAG_CLIENT_ID", "exclusive": [ "config" ], "hasDynamicHelp": false, "hidden": false, "multiple": false, "name": "client-id", "type": "option" }, "config": { "char": "c", "description": "The name of the app configuration.", "env": "SHOPIFY_FLAG_APP_CONFIG", "hasDynamicHelp": false, "hidden": false, "multiple": false, "name": "config", "type": "option" }, "env-file": { "description": "Specify an environment file to update if the update flag is set", "env": "SHOPIFY_FLAG_ENV_FILE", "hasDynamicHelp": false, "hidden": false, "multiple": false, "name": "env-file", "type": "option" }, "no-color": { "allowNo": false, "description": "Disable color output.", "env": "SHOPIFY_FLAG_NO_COLOR", "hidden": false, "name": "no-color", "type": "boolean" }, "path": { "description": "The path to your app directory.", "env": "SHOPIFY_FLAG_PATH", "hasDynamicHelp": false, "multiple": false, "name": "path", "noCacheDefault": true, "type": "option" }, "reset": { "allowNo": false, "description": "Reset all your settings.", "env": "SHOPIFY_FLAG_RESET", "exclusive": [ "config" ], "hidden": false, "name": "reset", "type": "boolean" }, "verbose": { "allowNo": false, "description": "Increase the verbosity of the output.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [ ], "id": "app:env:pull", "pluginAlias": "@shopify/cli", "pluginName": "@shopify/cli", "pluginType": "core", "strict": true, "summary": "Pull app and extensions environment variables." }, "app:env:show": { "aliases": [ ], "args": { }, "customPluginName": "@shopify/app", "description": "Displays environment variables that can be used to deploy apps and app extensions.", "descriptionWithMarkdown": "Displays environment variables that can be used to deploy apps and app extensions.", "flags": { "client-id": { "description": "The Client ID of your app.", "env": "SHOPIFY_FLAG_CLIENT_ID", "exclusive": [ "config" ], "hasDynamicHelp": false, "hidden": false, "multiple": false, "name": "client-id", "type": "option" }, "config": { "char": "c", "description": "The name of the app configuration.", "env": "SHOPIFY_FLAG_APP_CONFIG", "hasDynamicHelp": false, "hidden": false, "multiple": false, "name": "config", "type": "option" }, "no-color": { "allowNo": false, "description": "Disable color output.", "env": "SHOPIFY_FLAG_NO_COLOR", "hidden": false, "name": "no-color", "type": "boolean" }, "path": { "description": "The path to your app directory.", "env": "SHOPIFY_FLAG_PATH", "hasDynamicHelp": false, "multiple": false, "name": "path", "noCacheDefault": true, "type": "option" }, "reset": { "allowNo": false, "description": "Reset all your settings.", "env": "SHOPIFY_FLAG_RESET", "exclusive": [ "config" ], "hidden": false, "name": "reset", "type": "boolean" }, "verbose": { "allowNo": false, "description": "Increase the verbosity of the output.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [ ], "id": "app:env:show", "pluginAlias": "@shopify/cli", "pluginName": "@shopify/cli", "pluginType": "core", "strict": true, "summary": "Display app and extensions environment variables." }, "app:execute": { "aliases": [ ], "args": { }, "customPluginName": "@shopify/app", "description": "Execute bulk operations against the Shopify Admin API.", "flags": { "client-id": { "description": "The Client ID of your app.", "env": "SHOPIFY_FLAG_CLIENT_ID", "exclusive": [ "config" ], "hasDynamicHelp": false, "hidden": false, "multiple": false, "name": "client-id", "type": "option" }, "config": { "char": "c", "description": "The name of the app configuration.", "env": "SHOPIFY_FLAG_APP_CONFIG", "hasDynamicHelp": false, "hidden": false, "multiple": false, "name": "config", "type": "option" }, "no-color": { "allowNo": false, "description": "Disable color output.", "env": "SHOPIFY_FLAG_NO_COLOR", "hidden": false, "name": "no-color", "type": "boolean" }, "output-file": { "description": "The file path where results should be written. If not specified, results will be written to STDOUT.", "env": "SHOPIFY_FLAG_OUTPUT_FILE", "hasDynamicHelp": false, "multiple": false, "name": "output-file", "type": "option" }, "path": { "description": "The path to your app directory.", "env": "SHOPIFY_FLAG_PATH", "hasDynamicHelp": false, "multiple": false, "name": "path", "noCacheDefault": true, "type": "option" }, "query": { "char": "q", "description": "The GraphQL query or mutation to run as a bulk operation. If omitted, reads from standard input.", "env": "SHOPIFY_FLAG_QUERY", "hasDynamicHelp": false, "multiple": false, "name": "query", "required": false, "type": "option" }, "reset": { "allowNo": false, "description": "Reset all your settings.", "env": "SHOPIFY_FLAG_RESET", "exclusive": [ "config" ], "hidden": false, "name": "reset", "type": "boolean" }, "store": { "char": "s", "description": "The store domain. Must be an existing dev store.", "env": "SHOPIFY_FLAG_STORE", "hasDynamicHelp": false, "multiple": false, "name": "store", "type": "option" }, "variable-file": { "description": "Path to a file containing GraphQL variables in JSONL format (one JSON object per line). Can't be used with --variables.", "env": "SHOPIFY_FLAG_VARIABLE_FILE", "exclusive": [ "variables" ], "hasDynamicHelp": false, "multiple": false, "name": "variable-file", "type": "option" }, "variables": { "char": "v", "description": "The values for any GraphQL variables in your mutation, in JSON format. Can be specified multiple times.", "env": "SHOPIFY_FLAG_VARIABLES", "exclusive": [ "variable-file" ], "hasDynamicHelp": false, "multiple": true, "name": "variables", "type": "option" }, "verbose": { "allowNo": false, "description": "Increase the verbosity of the output.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "type": "boolean" }, "watch": { "allowNo": false, "description": "Wait for bulk operation results before exiting.", "env": "SHOPIFY_FLAG_WATCH", "name": "watch", "type": "boolean" } }, "hasDynamicHelp": false, "hidden": true, "hiddenAliases": [ ], "id": "app:execute", "pluginAlias": "@shopify/cli", "pluginName": "@shopify/cli", "pluginType": "core", "strict": true, "summary": "Execute bulk operations." }, "app:function:build": { "aliases": [ ], "args": { }, "customPluginName": "@shopify/app", "description": "Compiles the function in your current directory to WebAssembly (Wasm) for testing purposes.", "descriptionWithMarkdown": "Compiles the function in your current directory to WebAssembly (Wasm) for testing purposes.", "flags": { "client-id": { "description": "The Client ID of your app.", "env": "SHOPIFY_FLAG_CLIENT_ID", "exclusive": [ "config" ], "hasDynamicHelp": false, "hidden": false, "multiple": false, "name": "client-id", "type": "option" }, "config": { "char": "c", "description": "The name of the app configuration.", "env": "SHOPIFY_FLAG_APP_CONFIG", "hasDynamicHelp": false, "hidden": false, "multiple": false, "name": "config", "type": "option" }, "no-color": { "allowNo": false, "description": "Disable color output.", "env": "SHOPIFY_FLAG_NO_COLOR", "hidden": false, "name": "no-color", "type": "boolean" }, "path": { "description": "The path to your function directory.", "env": "SHOPIFY_FLAG_PATH", "hasDynamicHelp": false, "hidden": false, "multiple": false, "name": "path", "noCacheDefault": true, "type": "option" }, "reset": { "allowNo": false, "description": "Reset all your settings.", "env": "SHOPIFY_FLAG_RESET", "exclusive": [ "config" ], "hidden": false, "name": "reset", "type": "boolean" }, "verbose": { "allowNo": false, "description": "Increase the verbosity of the output.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [ ], "id": "app:function:build", "pluginAlias": "@shopify/cli", "pluginName": "@shopify/cli", "pluginType": "core", "strict": true, "summary": "Compile a function to wasm." }, "app:function:info": { "aliases": [ ], "args": { }, "customPluginName": "@shopify/app", "description": "The information returned includes the following:\n\n - The function handle\n - The function name\n - The function API version\n - The targeting configuration\n - The schema path\n - The WASM path\n - The function runner path", "descriptionWithMarkdown": "The information returned includes the following:\n\n - The function handle\n - The function name\n - The function API version\n - The targeting configuration\n - The schema path\n - The WASM path\n - The function runner path", "flags": { "client-id": { "description": "The Client ID of your app.", "env": "SHOPIFY_FLAG_CLIENT_ID", "exclusive": [ "config" ], "hasDynamicHelp": false, "hidden": false, "multiple": false, "name": "client-id", "type": "option" }, "config": { "char": "c", "description": "The name of the app configuration.", "env": "SHOPIFY_FLAG_APP_CONFIG", "hasDynamicHelp": false, "hidden": false, "multiple": false, "name": "config", "type": "option" }, "json": { "allowNo": false, "char": "j", "description": "Output the result as JSON.", "env": "SHOPIFY_FLAG_JSON", "hidden": false, "name": "json", "type": "boolean" }, "no-color": { "allowNo": false, "description": "Disable color output.", "env": "SHOPIFY_FLAG_NO_COLOR", "hidden": false, "name": "no-color", "type": "boolean" }, "path": { "description": "The path to your function directory.", "env": "SHOPIFY_FLAG_PATH", "hasDynamicHelp": false, "hidden": false, "multiple": false, "name": "path", "noCacheDefault": true, "type": "option" }, "reset": { "allowNo": false, "description": "Reset all your settings.", "env": "SHOPIFY_FLAG_RESET", "exclusive": [ "config" ], "hidden": false, "name": "reset", "type": "boolean" }, "verbose": { "allowNo": false, "description": "Increase the verbosity of the output.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [ ], "id": "app:function:info", "pluginAlias": "@shopify/cli", "pluginName": "@shopify/cli", "pluginType": "core", "strict": true, "summary": "Print basic information about your function." }, "app:function:replay": { "aliases": [ ], "args": { }, "customPluginName": "@shopify/app", "description": "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).", "descriptionWithMarkdown": "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).", "flags": { "client-id": { "description": "The Client ID of your app.", "env": "SHOPIFY_FLAG_CLIENT_ID", "exclusive": [ "config" ], "hasDynamicHelp": false, "hidden": false, "multiple": false, "name": "client-id", "type": "option" }, "config": { "char": "c", "description": "The name of the app configuration.", "env": "SHOPIFY_FLAG_APP_CONFIG", "hasDynamicHelp": false, "hidden": false, "multiple": false, "name": "config", "type": "option" }, "json": { "allowNo": false, "char": "j", "description": "Output the result as JSON.", "env": "SHOPIFY_FLAG_JSON", "hidden": false, "name": "json", "type": "boolean" }, "log": { "char": "l", "description": "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.", "env": "SHOPIFY_FLAG_LOG", "hasDynamicHelp": false, "multiple": false, "name": "log", "type": "option" }, "no-color": { "allowNo": false, "description": "Disable color output.", "env": "SHOPIFY_FLAG_NO_COLOR", "hidden": false, "name": "no-color", "type": "boolean" }, "path": { "description": "The path to your function directory.", "env": "SHOPIFY_FLAG_PATH", "hasDynamicHelp": false, "hidden": false, "multiple": false, "name": "path", "noCacheDefault": true, "type": "option" }, "reset": { "allowNo": false, "description": "Reset all your settings.", "env": "SHOPIFY_FLAG_RESET", "exclusive": [ "config" ], "hidden": false, "name": "reset", "type": "boolean" }, "verbose": { "allowNo": false, "description": "Increase the verbosity of the output.", "env": "SHOPIFY_FLAG_VERBOSE", "hidden": false, "name": "verbose", "type": "boolean" }, "watch": { "allowNo": true, "char": "w", "description": "Re-run the function when the source code changes.", "env": "SHOPIFY_FLAG_WATCH", "hidden": false, "name": "watch", "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [ ], "id": "app:function:replay", "pluginAlias": "@shopify/cli", "pluginName": "@shopify/cli", "pluginType": "core", "strict": true, "summary": "Replays a function run from an app log." }, "app:function:run": { "aliases": [ ], "args": { }, "customPluginName": "@shopify/app", "description": "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).", "descriptionWithMarkdown": "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).", "flags": { "client-id": { "description": "The Client ID of your app.", "env": "SHOPIFY_FLAG_CLIENT_ID", "exclusive": [ "config" ], "hasDynamicHelp": false, "hidden": false, "multiple": false, "name": "client-id", "type": "option" }, "config": { "char": "c", "description": "The name of the app configuration.", "env": "SHOPIFY_FLAG_APP_CONFIG", "hasDynamicHelp": false, "hidden": false, "multiple": false, "name": "config", "type": "option" }, "export": { "char": "e", "description": "N