From 0c4fa78f7f6d00273a9fe5aaa555ffb3d5885ddd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Isaac=20Rold=C3=A1n?= Date: Fri, 3 Jul 2026 13:26:08 +0200 Subject: [PATCH] Move [env: ...] label after flag description in --help Since oclif 4.8, flag help renders the backing SHOPIFY_FLAG_* environment variable before the description, which pushes the description far to the right and hurts readability. Add a custom oclif help class that relocates the env label to the end of each flag's description, reusing oclif's own formatting for everything else. Wired via oclif.helpClass in package.json and emitted as a bundle entry point for the published CLI. Co-authored-by: Isaac Roldan Assisted-By: devx/70100ba5-800c-4ca4-82a2-a4cc73e13e03 --- .changeset/env-help-after-description.md | 5 + packages/cli/README.md | 1612 +++++++++++----------- packages/cli/bin/bundle.js | 3 + packages/cli/package.json | 1 + packages/cli/src/cli/help.test.ts | 101 ++ packages/cli/src/cli/help.ts | 50 + 6 files changed, 968 insertions(+), 804 deletions(-) create mode 100644 .changeset/env-help-after-description.md create mode 100644 packages/cli/src/cli/help.test.ts create mode 100644 packages/cli/src/cli/help.ts diff --git a/.changeset/env-help-after-description.md b/.changeset/env-help-after-description.md new file mode 100644 index 00000000000..2564d18447d --- /dev/null +++ b/.changeset/env-help-after-description.md @@ -0,0 +1,5 @@ +--- +'@shopify/cli': patch +--- + +Move help output env labels after flag descriptions. diff --git a/packages/cli/README.md b/packages/cli/README.md index d7ea5e809c4..67cd030b0b4 100644 --- a/packages/cli/README.md +++ b/packages/cli/README.md @@ -116,14 +116,14 @@ USAGE [--skip-dependencies-installation] [--verbose] FLAGS - -c, --config= [env: SHOPIFY_FLAG_APP_CONFIG] The name of the app configuration. - --client-id= [env: SHOPIFY_FLAG_CLIENT_ID] The Client ID of your app. - --no-color [env: SHOPIFY_FLAG_NO_COLOR] Disable color output. - --path= [env: SHOPIFY_FLAG_PATH] The path to your app directory. - --reset [env: SHOPIFY_FLAG_RESET] Reset all your settings. - --skip-dependencies-installation [env: SHOPIFY_FLAG_SKIP_DEPENDENCIES_INSTALLATION] Skips the installation of - dependencies. Deprecated, use workspaces instead. - --verbose [env: SHOPIFY_FLAG_VERBOSE] Increase the verbosity of the output. + -c, --config= The name of the app configuration. [env: SHOPIFY_FLAG_APP_CONFIG] + --client-id= The Client ID of your app. [env: SHOPIFY_FLAG_CLIENT_ID] + --no-color Disable color output. [env: SHOPIFY_FLAG_NO_COLOR] + --path= The path to your app directory. [env: SHOPIFY_FLAG_PATH] + --reset Reset all your settings. [env: SHOPIFY_FLAG_RESET] + --skip-dependencies-installation Skips the installation of dependencies. Deprecated, use workspaces instead. + [env: SHOPIFY_FLAG_SKIP_DEPENDENCIES_INSTALLATION] + --verbose Increase the verbosity of the output. [env: SHOPIFY_FLAG_VERBOSE] DESCRIPTION Build the app, including extensions. @@ -147,14 +147,14 @@ USAGE ] [-s ] [--verbose] FLAGS - -c, --config= [env: SHOPIFY_FLAG_APP_CONFIG] The name of the app configuration. - -s, --store= [env: SHOPIFY_FLAG_STORE] The store domain. Must be an existing dev store. - --client-id= [env: SHOPIFY_FLAG_CLIENT_ID] The Client ID of your app. - --id= (required) [env: SHOPIFY_FLAG_ID] The bulk operation ID to cancel (numeric ID or full GID). - --no-color [env: SHOPIFY_FLAG_NO_COLOR] Disable color output. - --path= [env: SHOPIFY_FLAG_PATH] The path to your app directory. - --reset [env: SHOPIFY_FLAG_RESET] Reset all your settings. - --verbose [env: SHOPIFY_FLAG_VERBOSE] Increase the verbosity of the output. + -c, --config= The name of the app configuration. [env: SHOPIFY_FLAG_APP_CONFIG] + -s, --store= The store domain. Must be an existing dev store. [env: SHOPIFY_FLAG_STORE] + --client-id= The Client ID of your app. [env: SHOPIFY_FLAG_CLIENT_ID] + --id= (required) The bulk operation ID to cancel (numeric ID or full GID). [env: SHOPIFY_FLAG_ID] + --no-color Disable color output. [env: SHOPIFY_FLAG_NO_COLOR] + --path= The path to your app directory. [env: SHOPIFY_FLAG_PATH] + --reset Reset all your settings. [env: SHOPIFY_FLAG_RESET] + --verbose Increase the verbosity of the output. [env: SHOPIFY_FLAG_VERBOSE] DESCRIPTION Cancel a bulk operation. @@ -173,26 +173,26 @@ USAGE [--verbose] [--version ] FLAGS - -c, --config= [env: SHOPIFY_FLAG_APP_CONFIG] The name of the app configuration. - -q, --query= [env: SHOPIFY_FLAG_QUERY] The GraphQL query or mutation to run as a bulk operation. - -s, --store= [env: SHOPIFY_FLAG_STORE] The store domain. Must be an existing dev store. - -v, --variables=... [env: SHOPIFY_FLAG_VARIABLES] The values for any GraphQL variables in your mutation, in - JSON format. Can be specified multiple times. - --client-id= [env: SHOPIFY_FLAG_CLIENT_ID] The Client ID of your app. - --no-color [env: SHOPIFY_FLAG_NO_COLOR] Disable color output. - --output-file= [env: SHOPIFY_FLAG_OUTPUT_FILE] The file path where results should be written if --watch - is specified. If not specified, results will be written to STDOUT. - --path= [env: SHOPIFY_FLAG_PATH] The path to your app directory. - --query-file= [env: SHOPIFY_FLAG_QUERY_FILE] Path to a file containing the GraphQL query or mutation. - Can't be used with --query. - --reset [env: SHOPIFY_FLAG_RESET] Reset all your settings. - --variable-file= [env: SHOPIFY_FLAG_VARIABLE_FILE] Path to a file containing GraphQL variables in JSONL - format (one JSON object per line). Can't be used with --variables. - --verbose [env: SHOPIFY_FLAG_VERBOSE] Increase the verbosity of the output. - --version= [env: SHOPIFY_FLAG_VERSION] The API version to use for the bulk operation. If not - specified, uses the latest stable version. - --watch [env: SHOPIFY_FLAG_WATCH] Wait for bulk operation results before exiting. Defaults to - false. + -c, --config= The name of the app configuration. [env: SHOPIFY_FLAG_APP_CONFIG] + -q, --query= The GraphQL query or mutation to run as a bulk operation. [env: SHOPIFY_FLAG_QUERY] + -s, --store= The store domain. Must be an existing dev store. [env: SHOPIFY_FLAG_STORE] + -v, --variables=... The values for any GraphQL variables in your mutation, in JSON format. Can be specified + multiple times. [env: SHOPIFY_FLAG_VARIABLES] + --client-id= The Client ID of your app. [env: SHOPIFY_FLAG_CLIENT_ID] + --no-color Disable color output. [env: SHOPIFY_FLAG_NO_COLOR] + --output-file= The file path where results should be written if --watch is specified. If not specified, + results will be written to STDOUT. [env: SHOPIFY_FLAG_OUTPUT_FILE] + --path= The path to your app directory. [env: SHOPIFY_FLAG_PATH] + --query-file= Path to a file containing the GraphQL query or mutation. Can't be used with --query. + [env: SHOPIFY_FLAG_QUERY_FILE] + --reset Reset all your settings. [env: SHOPIFY_FLAG_RESET] + --variable-file= 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] + --verbose Increase the verbosity of the output. [env: SHOPIFY_FLAG_VERBOSE] + --version= The API version to use for the bulk operation. If not specified, uses the latest stable + version. [env: SHOPIFY_FLAG_VERSION] + --watch Wait for bulk operation results before exiting. Defaults to false. [env: + SHOPIFY_FLAG_WATCH] DESCRIPTION Execute bulk operations. @@ -218,15 +218,15 @@ USAGE | ] [-s ] [--verbose] FLAGS - -c, --config= [env: SHOPIFY_FLAG_APP_CONFIG] The name of the app configuration. - -s, --store= [env: SHOPIFY_FLAG_STORE] The store domain. Must be an existing dev store. - --client-id= [env: SHOPIFY_FLAG_CLIENT_ID] The Client ID of your app. - --id= [env: SHOPIFY_FLAG_ID] The bulk operation ID (numeric ID or full GID). If not provided, lists - all bulk operations belonging to this app on this store in the last 7 days. - --no-color [env: SHOPIFY_FLAG_NO_COLOR] Disable color output. - --path= [env: SHOPIFY_FLAG_PATH] The path to your app directory. - --reset [env: SHOPIFY_FLAG_RESET] Reset all your settings. - --verbose [env: SHOPIFY_FLAG_VERBOSE] Increase the verbosity of the output. + -c, --config= The name of the app configuration. [env: SHOPIFY_FLAG_APP_CONFIG] + -s, --store= The store domain. Must be an existing dev store. [env: SHOPIFY_FLAG_STORE] + --client-id= The Client ID of your app. [env: SHOPIFY_FLAG_CLIENT_ID] + --id= The bulk operation ID (numeric ID or full GID). If not provided, lists all bulk operations + belonging to this app on this store in the last 7 days. [env: SHOPIFY_FLAG_ID] + --no-color Disable color output. [env: SHOPIFY_FLAG_NO_COLOR] + --path= The path to your app directory. [env: SHOPIFY_FLAG_PATH] + --reset Reset all your settings. [env: SHOPIFY_FLAG_RESET] + --verbose Increase the verbosity of the output. [env: SHOPIFY_FLAG_VERBOSE] DESCRIPTION Check the status of bulk operations. @@ -250,12 +250,12 @@ USAGE $ shopify app config link [--client-id | -c ] [--no-color] [--path ] [--reset | ] [--verbose] FLAGS - -c, --config= [env: SHOPIFY_FLAG_APP_CONFIG] The name of the app configuration. - --client-id= [env: SHOPIFY_FLAG_CLIENT_ID] The Client ID of your app. - --no-color [env: SHOPIFY_FLAG_NO_COLOR] Disable color output. - --path= [env: SHOPIFY_FLAG_PATH] The path to your app directory. - --reset [env: SHOPIFY_FLAG_RESET] Reset all your settings. - --verbose [env: SHOPIFY_FLAG_VERBOSE] Increase the verbosity of the output. + -c, --config= The name of the app configuration. [env: SHOPIFY_FLAG_APP_CONFIG] + --client-id= The Client ID of your app. [env: SHOPIFY_FLAG_CLIENT_ID] + --no-color Disable color output. [env: SHOPIFY_FLAG_NO_COLOR] + --path= The path to your app directory. [env: SHOPIFY_FLAG_PATH] + --reset Reset all your settings. [env: SHOPIFY_FLAG_RESET] + --verbose Increase the verbosity of the output. [env: SHOPIFY_FLAG_VERBOSE] DESCRIPTION Fetch your app configuration from the Developer Dashboard. @@ -276,12 +276,12 @@ USAGE $ shopify app config pull [--client-id | -c ] [--no-color] [--path ] [--reset | ] [--verbose] FLAGS - -c, --config= [env: SHOPIFY_FLAG_APP_CONFIG] The name of the app configuration. - --client-id= [env: SHOPIFY_FLAG_CLIENT_ID] The Client ID of your app. - --no-color [env: SHOPIFY_FLAG_NO_COLOR] Disable color output. - --path= [env: SHOPIFY_FLAG_PATH] The path to your app directory. - --reset [env: SHOPIFY_FLAG_RESET] Reset all your settings. - --verbose [env: SHOPIFY_FLAG_VERBOSE] Increase the verbosity of the output. + -c, --config= The name of the app configuration. [env: SHOPIFY_FLAG_APP_CONFIG] + --client-id= The Client ID of your app. [env: SHOPIFY_FLAG_CLIENT_ID] + --no-color Disable color output. [env: SHOPIFY_FLAG_NO_COLOR] + --path= The path to your app directory. [env: SHOPIFY_FLAG_PATH] + --reset Reset all your settings. [env: SHOPIFY_FLAG_RESET] + --verbose Increase the verbosity of the output. [env: SHOPIFY_FLAG_VERBOSE] DESCRIPTION Refresh an already-linked app configuration without prompts. @@ -304,11 +304,11 @@ ARGUMENTS [CONFIG] The name of the app configuration. Can be 'shopify.app.staging.toml' or simply 'staging'. FLAGS - --client-id= [env: SHOPIFY_FLAG_CLIENT_ID] The Client ID of your app. - --no-color [env: SHOPIFY_FLAG_NO_COLOR] Disable color output. - --path= [env: SHOPIFY_FLAG_PATH] The path to your app directory. - --reset [env: SHOPIFY_FLAG_RESET] Reset all your settings. - --verbose [env: SHOPIFY_FLAG_VERBOSE] Increase the verbosity of the output. + --client-id= The Client ID of your app. [env: SHOPIFY_FLAG_CLIENT_ID] + --no-color Disable color output. [env: SHOPIFY_FLAG_NO_COLOR] + --path= The path to your app directory. [env: SHOPIFY_FLAG_PATH] + --reset Reset all your settings. [env: SHOPIFY_FLAG_RESET] + --verbose Increase the verbosity of the output. [env: SHOPIFY_FLAG_VERBOSE] DESCRIPTION Activate an app configuration. @@ -327,13 +327,13 @@ USAGE [--verbose] FLAGS - -c, --config= [env: SHOPIFY_FLAG_APP_CONFIG] The name of the app configuration. - -j, --json [env: SHOPIFY_FLAG_JSON] Output the result as JSON. Automatically disables color output. - --client-id= [env: SHOPIFY_FLAG_CLIENT_ID] The Client ID of your app. - --no-color [env: SHOPIFY_FLAG_NO_COLOR] Disable color output. - --path= [env: SHOPIFY_FLAG_PATH] The path to your app directory. - --reset [env: SHOPIFY_FLAG_RESET] Reset all your settings. - --verbose [env: SHOPIFY_FLAG_VERBOSE] Increase the verbosity of the output. + -c, --config= The name of the app configuration. [env: SHOPIFY_FLAG_APP_CONFIG] + -j, --json Output the result as JSON. Automatically disables color output. [env: SHOPIFY_FLAG_JSON] + --client-id= The Client ID of your app. [env: SHOPIFY_FLAG_CLIENT_ID] + --no-color Disable color output. [env: SHOPIFY_FLAG_NO_COLOR] + --path= The path to your app directory. [env: SHOPIFY_FLAG_PATH] + --reset Reset all your settings. [env: SHOPIFY_FLAG_RESET] + --verbose Increase the verbosity of the output. [env: SHOPIFY_FLAG_VERBOSE] DESCRIPTION Validate your app configuration and extensions. @@ -353,29 +353,29 @@ USAGE [--verbose] [--version ] FLAGS - -c, --config= [env: SHOPIFY_FLAG_APP_CONFIG] The name of the app configuration. - --allow-deletes [env: SHOPIFY_FLAG_ALLOW_DELETES] Allows removing extensions and configuration - without requiring user confirmation. For CI/CD environments, the recommended flag is - --allow-updates. - --allow-updates [env: SHOPIFY_FLAG_ALLOW_UPDATES] Allows adding and updating extensions and - configuration without requiring user confirmation. Recommended option for CI/CD - environments. - --client-id= [env: SHOPIFY_FLAG_CLIENT_ID] The Client ID of your app. - --message= [env: SHOPIFY_FLAG_MESSAGE] Optional message that will be associated with this - version. This is for internal use only and won't be available externally. - --no-build [env: SHOPIFY_FLAG_NO_BUILD] 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. - --no-color [env: SHOPIFY_FLAG_NO_COLOR] Disable color output. - --no-release [env: SHOPIFY_FLAG_NO_RELEASE] Creates a version but doesn't release it - it's not - made available to merchants. With this flag, a user confirmation is not required. - --path= [env: SHOPIFY_FLAG_PATH] The path to your app directory. - --reset [env: SHOPIFY_FLAG_RESET] Reset all your settings. - --source-control-url= [env: SHOPIFY_FLAG_SOURCE_CONTROL_URL] URL associated with the new app version. - --verbose [env: SHOPIFY_FLAG_VERBOSE] Increase the verbosity of the output. - --version= [env: SHOPIFY_FLAG_VERSION] 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. + -c, --config= The name of the app configuration. [env: SHOPIFY_FLAG_APP_CONFIG] + --allow-deletes Allows removing extensions and configuration without requiring user confirmation. + For CI/CD environments, the recommended flag is --allow-updates. [env: + SHOPIFY_FLAG_ALLOW_DELETES] + --allow-updates Allows adding and updating extensions and configuration without requiring user + confirmation. Recommended option for CI/CD environments. [env: + SHOPIFY_FLAG_ALLOW_UPDATES] + --client-id= The Client ID of your app. [env: SHOPIFY_FLAG_CLIENT_ID] + --message= 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] + --no-build 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] + --no-color Disable color output. [env: SHOPIFY_FLAG_NO_COLOR] + --no-release Creates a version but doesn't release it - it's not made available to merchants. + With this flag, a user confirmation is not required. [env: SHOPIFY_FLAG_NO_RELEASE] + --path= The path to your app directory. [env: SHOPIFY_FLAG_PATH] + --reset Reset all your settings. [env: SHOPIFY_FLAG_RESET] + --source-control-url= URL associated with the new app version. [env: SHOPIFY_FLAG_SOURCE_CONTROL_URL] + --verbose Increase the verbosity of the output. [env: SHOPIFY_FLAG_VERBOSE] + --version= 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] DESCRIPTION Deploy your Shopify app. @@ -402,36 +402,37 @@ USAGE [--theme-app-extension-port ] [--use-localhost | [--tunnel-url | ]] [--verbose] FLAGS - -c, --config= [env: SHOPIFY_FLAG_APP_CONFIG] The name of the app configuration. - -s, --store= [env: SHOPIFY_FLAG_STORE] Store URL. Must be an existing development or - Shopify Plus sandbox store. - -t, --theme= [env: SHOPIFY_FLAG_THEME] Theme ID or name of the theme app extension host - theme. - --checkout-cart-url= [env: SHOPIFY_FLAG_CHECKOUT_CART_URL] Resource URL for checkout UI extension. - Format: "/cart/{productVariantID}:{productQuantity}" - --client-id= [env: SHOPIFY_FLAG_CLIENT_ID] The Client ID of your app. - --localhost-port= [env: SHOPIFY_FLAG_LOCALHOST_PORT] Port to use for localhost. Must be between - 1 and 65535. - --no-color [env: SHOPIFY_FLAG_NO_COLOR] Disable color output. - --no-update [env: SHOPIFY_FLAG_NO_UPDATE] Uses the app URL from the toml file instead an - autogenerated URL for dev. - --notify= [env: SHOPIFY_FLAG_NOTIFY] The file path or URL. The file path is to a file - that you want updated on idle. The URL path is where you want a webhook posted - to report on file changes. - --path= [env: SHOPIFY_FLAG_PATH] The path to your app directory. - --reset [env: SHOPIFY_FLAG_RESET] Reset all your settings. - --skip-dependencies-installation [env: SHOPIFY_FLAG_SKIP_DEPENDENCIES_INSTALLATION] Skips the installation of - dependencies. Deprecated, use workspaces instead. - --subscription-product-url= [env: SHOPIFY_FLAG_SUBSCRIPTION_PRODUCT_URL] Resource URL for subscription UI - extension. Format: "/products/{productId}" - --theme-app-extension-port= [env: SHOPIFY_FLAG_THEME_APP_EXTENSION_PORT] Local port of the theme app - extension development server. Must be between 1 and 65535. - --tunnel-url= [env: SHOPIFY_FLAG_TUNNEL_URL] Use a custom tunnel, it must be running before - executing dev. Format: "https://my-tunnel-url:port". - --use-localhost [env: SHOPIFY_FLAG_USE_LOCALHOST] Service entry point will listen to - localhost. A tunnel won't be used. Will work for testing many app features, - but not those that directly invoke your app (E.g: Webhooks) - --verbose [env: SHOPIFY_FLAG_VERBOSE] Increase the verbosity of the output. + -c, --config= The name of the app configuration. [env: SHOPIFY_FLAG_APP_CONFIG] + -s, --store= Store URL. Must be an existing development or Shopify Plus sandbox store. + [env: SHOPIFY_FLAG_STORE] + -t, --theme= Theme ID or name of the theme app extension host theme. [env: + SHOPIFY_FLAG_THEME] + --checkout-cart-url= Resource URL for checkout UI extension. Format: + "/cart/{productVariantID}:{productQuantity}" [env: + SHOPIFY_FLAG_CHECKOUT_CART_URL] + --client-id= The Client ID of your app. [env: SHOPIFY_FLAG_CLIENT_ID] + --localhost-port= Port to use for localhost. Must be between 1 and 65535. [env: + SHOPIFY_FLAG_LOCALHOST_PORT] + --no-color Disable color output. [env: SHOPIFY_FLAG_NO_COLOR] + --no-update Uses the app URL from the toml file instead an autogenerated URL for dev. + [env: SHOPIFY_FLAG_NO_UPDATE] + --notify= The file path or URL. The file path is to a file that you want updated on + idle. The URL path is where you want a webhook posted to report on file + changes. [env: SHOPIFY_FLAG_NOTIFY] + --path= The path to your app directory. [env: SHOPIFY_FLAG_PATH] + --reset Reset all your settings. [env: SHOPIFY_FLAG_RESET] + --skip-dependencies-installation Skips the installation of dependencies. Deprecated, use workspaces instead. + [env: SHOPIFY_FLAG_SKIP_DEPENDENCIES_INSTALLATION] + --subscription-product-url= Resource URL for subscription UI extension. Format: "/products/{productId}" + [env: SHOPIFY_FLAG_SUBSCRIPTION_PRODUCT_URL] + --theme-app-extension-port= Local port of the theme app extension development server. Must be between 1 + and 65535. [env: SHOPIFY_FLAG_THEME_APP_EXTENSION_PORT] + --tunnel-url= Use a custom tunnel, it must be running before executing dev. Format: + "https://my-tunnel-url:port". [env: SHOPIFY_FLAG_TUNNEL_URL] + --use-localhost Service entry point will listen to localhost. A tunnel won't be used. Will + work for testing many app features, but not those that directly invoke your + app (E.g: Webhooks) [env: SHOPIFY_FLAG_USE_LOCALHOST] + --verbose Increase the verbosity of the output. [env: SHOPIFY_FLAG_VERBOSE] DESCRIPTION Run the app. @@ -450,13 +451,13 @@ USAGE ] [--verbose] FLAGS - -c, --config= [env: SHOPIFY_FLAG_APP_CONFIG] The name of the app configuration. - -s, --store= [env: SHOPIFY_FLAG_STORE] Store URL. Must be an existing development store. - --client-id= [env: SHOPIFY_FLAG_CLIENT_ID] The Client ID of your app. - --no-color [env: SHOPIFY_FLAG_NO_COLOR] Disable color output. - --path= [env: SHOPIFY_FLAG_PATH] The path to your app directory. - --reset [env: SHOPIFY_FLAG_RESET] Reset all your settings. - --verbose [env: SHOPIFY_FLAG_VERBOSE] Increase the verbosity of the output. + -c, --config= The name of the app configuration. [env: SHOPIFY_FLAG_APP_CONFIG] + -s, --store= Store URL. Must be an existing development store. [env: SHOPIFY_FLAG_STORE] + --client-id= The Client ID of your app. [env: SHOPIFY_FLAG_CLIENT_ID] + --no-color Disable color output. [env: SHOPIFY_FLAG_NO_COLOR] + --path= The path to your app directory. [env: SHOPIFY_FLAG_PATH] + --reset Reset all your settings. [env: SHOPIFY_FLAG_RESET] + --verbose Increase the verbosity of the output. [env: SHOPIFY_FLAG_VERBOSE] DESCRIPTION Cleans up the dev preview from the selected store. @@ -476,13 +477,13 @@ USAGE [--reset | ] [--verbose] FLAGS - -c, --config= [env: SHOPIFY_FLAG_APP_CONFIG] The name of the app configuration. - --client-id= [env: SHOPIFY_FLAG_CLIENT_ID] The Client ID of your app. - --env-file= [env: SHOPIFY_FLAG_ENV_FILE] Specify an environment file to update if the update flag is set - --no-color [env: SHOPIFY_FLAG_NO_COLOR] Disable color output. - --path= [env: SHOPIFY_FLAG_PATH] The path to your app directory. - --reset [env: SHOPIFY_FLAG_RESET] Reset all your settings. - --verbose [env: SHOPIFY_FLAG_VERBOSE] Increase the verbosity of the output. + -c, --config= The name of the app configuration. [env: SHOPIFY_FLAG_APP_CONFIG] + --client-id= The Client ID of your app. [env: SHOPIFY_FLAG_CLIENT_ID] + --env-file= Specify an environment file to update if the update flag is set [env: SHOPIFY_FLAG_ENV_FILE] + --no-color Disable color output. [env: SHOPIFY_FLAG_NO_COLOR] + --path= The path to your app directory. [env: SHOPIFY_FLAG_PATH] + --reset Reset all your settings. [env: SHOPIFY_FLAG_RESET] + --verbose Increase the verbosity of the output. [env: SHOPIFY_FLAG_VERBOSE] DESCRIPTION Pull app and extensions environment variables. @@ -502,12 +503,12 @@ USAGE $ shopify app env show [--client-id | -c ] [--no-color] [--path ] [--reset | ] [--verbose] FLAGS - -c, --config= [env: SHOPIFY_FLAG_APP_CONFIG] The name of the app configuration. - --client-id= [env: SHOPIFY_FLAG_CLIENT_ID] The Client ID of your app. - --no-color [env: SHOPIFY_FLAG_NO_COLOR] Disable color output. - --path= [env: SHOPIFY_FLAG_PATH] The path to your app directory. - --reset [env: SHOPIFY_FLAG_RESET] Reset all your settings. - --verbose [env: SHOPIFY_FLAG_VERBOSE] Increase the verbosity of the output. + -c, --config= The name of the app configuration. [env: SHOPIFY_FLAG_APP_CONFIG] + --client-id= The Client ID of your app. [env: SHOPIFY_FLAG_CLIENT_ID] + --no-color Disable color output. [env: SHOPIFY_FLAG_NO_COLOR] + --path= The path to your app directory. [env: SHOPIFY_FLAG_PATH] + --reset Reset all your settings. [env: SHOPIFY_FLAG_RESET] + --verbose Increase the verbosity of the output. [env: SHOPIFY_FLAG_VERBOSE] DESCRIPTION Display app and extensions environment variables. @@ -526,26 +527,26 @@ USAGE [--version ] FLAGS - -c, --config= [env: SHOPIFY_FLAG_APP_CONFIG] The name of the app configuration. - -q, --query= [env: SHOPIFY_FLAG_QUERY] The GraphQL query or mutation, as a string. - -s, --store= [env: SHOPIFY_FLAG_STORE] The myshopify.com domain of the store to execute against. The - app must be installed on the store. If not specified, you will be prompted to select a - store. - -v, --variables= [env: SHOPIFY_FLAG_VARIABLES] The values for any GraphQL variables in your query or - mutation, in JSON format. - --client-id= [env: SHOPIFY_FLAG_CLIENT_ID] The Client ID of your app. - --no-color [env: SHOPIFY_FLAG_NO_COLOR] Disable color output. - --output-file= [env: SHOPIFY_FLAG_OUTPUT_FILE] The file name where results should be written, instead of - STDOUT. - --path= [env: SHOPIFY_FLAG_PATH] The path to your app directory. - --query-file= [env: SHOPIFY_FLAG_QUERY_FILE] Path to a file containing the GraphQL query or mutation. - Can't be used with --query. - --reset [env: SHOPIFY_FLAG_RESET] Reset all your settings. - --variable-file= [env: SHOPIFY_FLAG_VARIABLE_FILE] Path to a file containing GraphQL variables in JSON - format. Can't be used with --variables. - --verbose [env: SHOPIFY_FLAG_VERBOSE] Increase the verbosity of the output. - --version= [env: SHOPIFY_FLAG_VERSION] The API version to use for the query or mutation. Defaults to - the latest stable version. + -c, --config= The name of the app configuration. [env: SHOPIFY_FLAG_APP_CONFIG] + -q, --query= The GraphQL query or mutation, as a string. [env: SHOPIFY_FLAG_QUERY] + -s, --store= The myshopify.com domain of the store to execute against. The app must be installed on + the store. If not specified, you will be prompted to select a store. [env: + SHOPIFY_FLAG_STORE] + -v, --variables= The values for any GraphQL variables in your query or mutation, in JSON format. [env: + SHOPIFY_FLAG_VARIABLES] + --client-id= The Client ID of your app. [env: SHOPIFY_FLAG_CLIENT_ID] + --no-color Disable color output. [env: SHOPIFY_FLAG_NO_COLOR] + --output-file= The file name where results should be written, instead of STDOUT. [env: + SHOPIFY_FLAG_OUTPUT_FILE] + --path= The path to your app directory. [env: SHOPIFY_FLAG_PATH] + --query-file= Path to a file containing the GraphQL query or mutation. Can't be used with --query. + [env: SHOPIFY_FLAG_QUERY_FILE] + --reset Reset all your settings. [env: SHOPIFY_FLAG_RESET] + --variable-file= Path to a file containing GraphQL variables in JSON format. Can't be used with + --variables. [env: SHOPIFY_FLAG_VARIABLE_FILE] + --verbose Increase the verbosity of the output. [env: SHOPIFY_FLAG_VERBOSE] + --version= The API version to use for the query or mutation. Defaults to the latest stable version. + [env: SHOPIFY_FLAG_VERSION] DESCRIPTION Execute GraphQL queries and mutations. @@ -565,12 +566,12 @@ USAGE $ shopify app function build [--client-id | -c ] [--no-color] [--path ] [--reset | ] [--verbose] FLAGS - -c, --config= [env: SHOPIFY_FLAG_APP_CONFIG] The name of the app configuration. - --client-id= [env: SHOPIFY_FLAG_CLIENT_ID] The Client ID of your app. - --no-color [env: SHOPIFY_FLAG_NO_COLOR] Disable color output. - --path= [env: SHOPIFY_FLAG_PATH] The path to your function directory. - --reset [env: SHOPIFY_FLAG_RESET] Reset all your settings. - --verbose [env: SHOPIFY_FLAG_VERBOSE] Increase the verbosity of the output. + -c, --config= The name of the app configuration. [env: SHOPIFY_FLAG_APP_CONFIG] + --client-id= The Client ID of your app. [env: SHOPIFY_FLAG_CLIENT_ID] + --no-color Disable color output. [env: SHOPIFY_FLAG_NO_COLOR] + --path= The path to your function directory. [env: SHOPIFY_FLAG_PATH] + --reset Reset all your settings. [env: SHOPIFY_FLAG_RESET] + --verbose Increase the verbosity of the output. [env: SHOPIFY_FLAG_VERBOSE] DESCRIPTION Compile a function to wasm. @@ -588,13 +589,13 @@ USAGE [--verbose] FLAGS - -c, --config= [env: SHOPIFY_FLAG_APP_CONFIG] The name of the app configuration. - -j, --json [env: SHOPIFY_FLAG_JSON] Output the result as JSON. Automatically disables color output. - --client-id= [env: SHOPIFY_FLAG_CLIENT_ID] The Client ID of your app. - --no-color [env: SHOPIFY_FLAG_NO_COLOR] Disable color output. - --path= [env: SHOPIFY_FLAG_PATH] The path to your function directory. - --reset [env: SHOPIFY_FLAG_RESET] Reset all your settings. - --verbose [env: SHOPIFY_FLAG_VERBOSE] Increase the verbosity of the output. + -c, --config= The name of the app configuration. [env: SHOPIFY_FLAG_APP_CONFIG] + -j, --json Output the result as JSON. Automatically disables color output. [env: SHOPIFY_FLAG_JSON] + --client-id= The Client ID of your app. [env: SHOPIFY_FLAG_CLIENT_ID] + --no-color Disable color output. [env: SHOPIFY_FLAG_NO_COLOR] + --path= The path to your function directory. [env: SHOPIFY_FLAG_PATH] + --reset Reset all your settings. [env: SHOPIFY_FLAG_RESET] + --verbose Increase the verbosity of the output. [env: SHOPIFY_FLAG_VERBOSE] DESCRIPTION Print basic information about your function. @@ -620,17 +621,17 @@ USAGE [--reset | ] [--verbose] [-w] FLAGS - -c, --config= [env: SHOPIFY_FLAG_APP_CONFIG] The name of the app configuration. - -j, --json [env: SHOPIFY_FLAG_JSON] Output the result as JSON. Automatically disables color output. - -l, --log= [env: SHOPIFY_FLAG_LOG] 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 [env: SHOPIFY_FLAG_WATCH] Re-run the function when the source code changes. - --client-id= [env: SHOPIFY_FLAG_CLIENT_ID] The Client ID of your app. - --no-color [env: SHOPIFY_FLAG_NO_COLOR] Disable color output. - --path= [env: SHOPIFY_FLAG_PATH] The path to your function directory. - --reset [env: SHOPIFY_FLAG_RESET] Reset all your settings. - --verbose [env: SHOPIFY_FLAG_VERBOSE] Increase the verbosity of the output. + -c, --config= The name of the app configuration. [env: SHOPIFY_FLAG_APP_CONFIG] + -j, --json Output the result as JSON. Automatically disables color output. [env: SHOPIFY_FLAG_JSON] + -l, --log= 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] + -w, --[no-]watch Re-run the function when the source code changes. [env: SHOPIFY_FLAG_WATCH] + --client-id= The Client ID of your app. [env: SHOPIFY_FLAG_CLIENT_ID] + --no-color Disable color output. [env: SHOPIFY_FLAG_NO_COLOR] + --path= The path to your function directory. [env: SHOPIFY_FLAG_PATH] + --reset Reset all your settings. [env: SHOPIFY_FLAG_RESET] + --verbose Increase the verbosity of the output. [env: SHOPIFY_FLAG_VERBOSE] DESCRIPTION Replays a function run from an app log. @@ -650,16 +651,16 @@ USAGE ] [--reset | ] [--verbose] FLAGS - -c, --config= [env: SHOPIFY_FLAG_APP_CONFIG] The name of the app configuration. - -e, --export= [env: SHOPIFY_FLAG_EXPORT] Name of the WebAssembly export to invoke. - -i, --input= [env: SHOPIFY_FLAG_INPUT] The input JSON to pass to the function. If omitted, standard input - is used. - -j, --json [env: SHOPIFY_FLAG_JSON] Output the result as JSON. Automatically disables color output. - --client-id= [env: SHOPIFY_FLAG_CLIENT_ID] The Client ID of your app. - --no-color [env: SHOPIFY_FLAG_NO_COLOR] Disable color output. - --path= [env: SHOPIFY_FLAG_PATH] The path to your function directory. - --reset [env: SHOPIFY_FLAG_RESET] Reset all your settings. - --verbose [env: SHOPIFY_FLAG_VERBOSE] Increase the verbosity of the output. + -c, --config= The name of the app configuration. [env: SHOPIFY_FLAG_APP_CONFIG] + -e, --export= Name of the WebAssembly export to invoke. [env: SHOPIFY_FLAG_EXPORT] + -i, --input= The input JSON to pass to the function. If omitted, standard input is used. [env: + SHOPIFY_FLAG_INPUT] + -j, --json Output the result as JSON. Automatically disables color output. [env: SHOPIFY_FLAG_JSON] + --client-id= The Client ID of your app. [env: SHOPIFY_FLAG_CLIENT_ID] + --no-color Disable color output. [env: SHOPIFY_FLAG_NO_COLOR] + --path= The path to your function directory. [env: SHOPIFY_FLAG_PATH] + --reset Reset all your settings. [env: SHOPIFY_FLAG_RESET] + --verbose Increase the verbosity of the output. [env: SHOPIFY_FLAG_VERBOSE] DESCRIPTION Run a function locally for testing. @@ -679,13 +680,13 @@ USAGE [--verbose] FLAGS - -c, --config= [env: SHOPIFY_FLAG_APP_CONFIG] The name of the app configuration. - --client-id= [env: SHOPIFY_FLAG_CLIENT_ID] The Client ID of your app. - --no-color [env: SHOPIFY_FLAG_NO_COLOR] Disable color output. - --path= [env: SHOPIFY_FLAG_PATH] The path to your function directory. - --reset [env: SHOPIFY_FLAG_RESET] Reset all your settings. - --stdout [env: SHOPIFY_FLAG_STDOUT] Output the schema to stdout instead of writing to a file. - --verbose [env: SHOPIFY_FLAG_VERBOSE] Increase the verbosity of the output. + -c, --config= The name of the app configuration. [env: SHOPIFY_FLAG_APP_CONFIG] + --client-id= The Client ID of your app. [env: SHOPIFY_FLAG_CLIENT_ID] + --no-color Disable color output. [env: SHOPIFY_FLAG_NO_COLOR] + --path= The path to your function directory. [env: SHOPIFY_FLAG_PATH] + --reset Reset all your settings. [env: SHOPIFY_FLAG_RESET] + --stdout Output the schema to stdout instead of writing to a file. [env: SHOPIFY_FLAG_STDOUT] + --verbose Increase the verbosity of the output. [env: SHOPIFY_FLAG_VERBOSE] DESCRIPTION Fetch the latest GraphQL schema for a function. @@ -707,12 +708,12 @@ USAGE [--verbose] FLAGS - -c, --config= [env: SHOPIFY_FLAG_APP_CONFIG] The name of the app configuration. - --client-id= [env: SHOPIFY_FLAG_CLIENT_ID] The Client ID of your app. - --no-color [env: SHOPIFY_FLAG_NO_COLOR] Disable color output. - --path= [env: SHOPIFY_FLAG_PATH] The path to your function directory. - --reset [env: SHOPIFY_FLAG_RESET] Reset all your settings. - --verbose [env: SHOPIFY_FLAG_VERBOSE] Increase the verbosity of the output. + -c, --config= The name of the app configuration. [env: SHOPIFY_FLAG_APP_CONFIG] + --client-id= The Client ID of your app. [env: SHOPIFY_FLAG_CLIENT_ID] + --no-color Disable color output. [env: SHOPIFY_FLAG_NO_COLOR] + --path= The path to your function directory. [env: SHOPIFY_FLAG_PATH] + --reset Reset all your settings. [env: SHOPIFY_FLAG_RESET] + --verbose Increase the verbosity of the output. [env: SHOPIFY_FLAG_VERBOSE] DESCRIPTION Generate GraphQL types for a function. @@ -732,16 +733,16 @@ USAGE ] [--verbose] FLAGS - -c, --config= [env: SHOPIFY_FLAG_APP_CONFIG] The name of the app configuration. - -n, --name= [env: SHOPIFY_FLAG_NAME] name of your Extension - -t, --template= [env: SHOPIFY_FLAG_EXTENSION_TEMPLATE] Extension template - --client-id= [env: SHOPIFY_FLAG_CLIENT_ID] The Client ID of your app. - --flavor=