Update message of 'ignore' and 'only' flags

aswamy · aswamy · commit 1161f7a08bbc · 2025-08-05T15:10:43.000-04:00
diff --git a/.changeset/gentle-kids-draw.md b/.changeset/gentle-kids-draw.md
@@ -0,0 +1,6 @@
+---
+'@shopify/theme': patch
+'@shopify/cli': patch
+---
+
+Update docs for 'ignore' and 'only' flags for theme push/pull
diff --git a/docs-shopify.dev/commands/interfaces/theme-pull.interface.ts b/docs-shopify.dev/commands/interfaces/theme-pull.interface.ts
@@ -13,7 +13,7 @@ export interface themepull {
   '-e, --environment <value>'?: string
 
   /**
-   * Skip downloading the specified files (Multiple flags allowed).
+   * Skip downloading the specified files (Multiple flags allowed). Wrap the value in double quotes if you're using wildcards.
    * @environment SHOPIFY_FLAG_IGNORE
    */
   '-x, --ignore <value>'?: string
@@ -37,7 +37,7 @@ export interface themepull {
   '-n, --nodelete'?: ''
 
   /**
-   * Download only the specified files (Multiple flags allowed).
+   * Download only the specified files (Multiple flags allowed). Wrap the value in double quotes if you're using wildcards.
    * @environment SHOPIFY_FLAG_ONLY
    */
   '-o, --only <value>'?: string
diff --git a/docs-shopify.dev/commands/interfaces/theme-push.interface.ts b/docs-shopify.dev/commands/interfaces/theme-push.interface.ts
@@ -19,7 +19,7 @@ export interface themepush {
   '-e, --environment <value>'?: string
 
   /**
-   * Skip uploading the specified files (Multiple flags allowed).
+   * Skip uploading the specified files (Multiple flags allowed). Wrap the value in double quotes if you're using wildcards.
    * @environment SHOPIFY_FLAG_IGNORE
    */
   '-x, --ignore <value>'?: string
@@ -49,7 +49,7 @@ export interface themepush {
   '-n, --nodelete'?: ''
 
   /**
-   * Push only the specified files (Multiple flags allowed).
+   * Upload only the specified files (Multiple flags allowed). Wrap the value in double quotes if you're using wildcards.
    * @environment SHOPIFY_FLAG_ONLY
    */
   '-o, --only <value>'?: string
diff --git a/docs-shopify.dev/generated/generated_docs_data.json b/docs-shopify.dev/generated/generated_docs_data.json
@@ -6411,7 +6411,7 @@
                 "syntaxKind": "PropertySignature",
                 "name": "-o, --only <value>",
                 "value": "string",
-                "description": "Download only the specified files (Multiple flags allowed).",
+                "description": "Download only the specified files (Multiple flags allowed). Wrap the value in double quotes if you're using wildcards.",
                 "isOptional": true,
                 "environmentValue": "SHOPIFY_FLAG_ONLY"
               },
@@ -6438,12 +6438,12 @@
                 "syntaxKind": "PropertySignature",
                 "name": "-x, --ignore <value>",
                 "value": "string",
-                "description": "Skip downloading the specified files (Multiple flags allowed).",
+                "description": "Skip downloading the specified files (Multiple flags allowed). Wrap the value in double quotes if you're using wildcards.",
                 "isOptional": true,
                 "environmentValue": "SHOPIFY_FLAG_IGNORE"
               }
             ],
-            "value": "export interface themepull {\n  /**\n   * Pull theme files from your remote development theme.\n   * @environment SHOPIFY_FLAG_DEVELOPMENT\n   */\n  '-d, --development'?: ''\n\n  /**\n   * The environment to apply to the current command.\n   * @environment SHOPIFY_FLAG_ENVIRONMENT\n   */\n  '-e, --environment <value>'?: string\n\n  /**\n   * Skip downloading the specified files (Multiple flags allowed).\n   * @environment SHOPIFY_FLAG_IGNORE\n   */\n  '-x, --ignore <value>'?: string\n\n  /**\n   * Pull theme files from your remote live theme.\n   * @environment SHOPIFY_FLAG_LIVE\n   */\n  '-l, --live'?: ''\n\n  /**\n   * Disable color output.\n   * @environment SHOPIFY_FLAG_NO_COLOR\n   */\n  '--no-color'?: ''\n\n  /**\n   * Prevent deleting local files that don't exist remotely.\n   * @environment SHOPIFY_FLAG_NODELETE\n   */\n  '-n, --nodelete'?: ''\n\n  /**\n   * Download only the specified files (Multiple flags allowed).\n   * @environment SHOPIFY_FLAG_ONLY\n   */\n  '-o, --only <value>'?: string\n\n  /**\n   * Password generated from the Theme Access app.\n   * @environment SHOPIFY_CLI_THEME_TOKEN\n   */\n  '--password <value>'?: string\n\n  /**\n   * The path where you want to run the command. Defaults to the current working directory.\n   * @environment SHOPIFY_FLAG_PATH\n   */\n  '--path <value>'?: string\n\n  /**\n   * Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).\n   * @environment SHOPIFY_FLAG_STORE\n   */\n  '-s, --store <value>'?: string\n\n  /**\n   * Theme ID or name of the remote theme.\n   * @environment SHOPIFY_FLAG_THEME_ID\n   */\n  '-t, --theme <value>'?: string\n\n  /**\n   * Increase the verbosity of the output.\n   * @environment SHOPIFY_FLAG_VERBOSE\n   */\n  '--verbose'?: ''\n}"
+            "value": "export interface themepull {\n  /**\n   * Pull theme files from your remote development theme.\n   * @environment SHOPIFY_FLAG_DEVELOPMENT\n   */\n  '-d, --development'?: ''\n\n  /**\n   * The environment to apply to the current command.\n   * @environment SHOPIFY_FLAG_ENVIRONMENT\n   */\n  '-e, --environment <value>'?: string\n\n  /**\n   * Skip downloading the specified files (Multiple flags allowed). Wrap the value in double quotes if you're using wildcards.\n   * @environment SHOPIFY_FLAG_IGNORE\n   */\n  '-x, --ignore <value>'?: string\n\n  /**\n   * Pull theme files from your remote live theme.\n   * @environment SHOPIFY_FLAG_LIVE\n   */\n  '-l, --live'?: ''\n\n  /**\n   * Disable color output.\n   * @environment SHOPIFY_FLAG_NO_COLOR\n   */\n  '--no-color'?: ''\n\n  /**\n   * Prevent deleting local files that don't exist remotely.\n   * @environment SHOPIFY_FLAG_NODELETE\n   */\n  '-n, --nodelete'?: ''\n\n  /**\n   * Download only the specified files (Multiple flags allowed). Wrap the value in double quotes if you're using wildcards.\n   * @environment SHOPIFY_FLAG_ONLY\n   */\n  '-o, --only <value>'?: string\n\n  /**\n   * Password generated from the Theme Access app.\n   * @environment SHOPIFY_CLI_THEME_TOKEN\n   */\n  '--password <value>'?: string\n\n  /**\n   * The path where you want to run the command. Defaults to the current working directory.\n   * @environment SHOPIFY_FLAG_PATH\n   */\n  '--path <value>'?: string\n\n  /**\n   * Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).\n   * @environment SHOPIFY_FLAG_STORE\n   */\n  '-s, --store <value>'?: string\n\n  /**\n   * Theme ID or name of the remote theme.\n   * @environment SHOPIFY_FLAG_THEME_ID\n   */\n  '-t, --theme <value>'?: string\n\n  /**\n   * Increase the verbosity of the output.\n   * @environment SHOPIFY_FLAG_VERBOSE\n   */\n  '--verbose'?: ''\n}"
           }
         }
       }
@@ -6584,7 +6584,7 @@
                 "syntaxKind": "PropertySignature",
                 "name": "-o, --only <value>",
                 "value": "string",
-                "description": "Push only the specified files (Multiple flags allowed).",
+                "description": "Upload only the specified files (Multiple flags allowed). Wrap the value in double quotes if you're using wildcards.",
                 "isOptional": true,
                 "environmentValue": "SHOPIFY_FLAG_ONLY"
               },
@@ -6629,12 +6629,12 @@
                 "syntaxKind": "PropertySignature",
                 "name": "-x, --ignore <value>",
                 "value": "string",
-                "description": "Skip uploading the specified files (Multiple flags allowed).",
+                "description": "Skip uploading the specified files (Multiple flags allowed). Wrap the value in double quotes if you're using wildcards.",
                 "isOptional": true,
                 "environmentValue": "SHOPIFY_FLAG_IGNORE"
               }
             ],
-            "value": "export interface themepush {\n  /**\n   * Allow push to a live theme.\n   * @environment SHOPIFY_FLAG_ALLOW_LIVE\n   */\n  '-a, --allow-live'?: ''\n\n  /**\n   * Push theme files from your remote development theme.\n   * @environment SHOPIFY_FLAG_DEVELOPMENT\n   */\n  '-d, --development'?: ''\n\n  /**\n   * The environment to apply to the current command.\n   * @environment SHOPIFY_FLAG_ENVIRONMENT\n   */\n  '-e, --environment <value>'?: string\n\n  /**\n   * Skip uploading the specified files (Multiple flags allowed).\n   * @environment SHOPIFY_FLAG_IGNORE\n   */\n  '-x, --ignore <value>'?: string\n\n  /**\n   * Output the result as JSON.\n   * @environment SHOPIFY_FLAG_JSON\n   */\n  '-j, --json'?: ''\n\n  /**\n   * Push theme files from your remote live theme.\n   * @environment SHOPIFY_FLAG_LIVE\n   */\n  '-l, --live'?: ''\n\n  /**\n   * Disable color output.\n   * @environment SHOPIFY_FLAG_NO_COLOR\n   */\n  '--no-color'?: ''\n\n  /**\n   * Prevent deleting remote files that don't exist locally.\n   * @environment SHOPIFY_FLAG_NODELETE\n   */\n  '-n, --nodelete'?: ''\n\n  /**\n   * Push only the specified files (Multiple flags allowed).\n   * @environment SHOPIFY_FLAG_ONLY\n   */\n  '-o, --only <value>'?: string\n\n  /**\n   * Password generated from the Theme Access app.\n   * @environment SHOPIFY_CLI_THEME_TOKEN\n   */\n  '--password <value>'?: string\n\n  /**\n   * The path where you want to run the command. Defaults to the current working directory.\n   * @environment SHOPIFY_FLAG_PATH\n   */\n  '--path <value>'?: string\n\n  /**\n   * Publish as the live theme after uploading.\n   * @environment SHOPIFY_FLAG_PUBLISH\n   */\n  '-p, --publish'?: ''\n\n  /**\n   * Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).\n   * @environment SHOPIFY_FLAG_STORE\n   */\n  '-s, --store <value>'?: string\n\n  /**\n   * Require theme check to pass without errors before pushing. Warnings are allowed.\n   * @environment SHOPIFY_FLAG_STRICT_PUSH\n   */\n  '--strict'?: ''\n\n  /**\n   * Theme ID or name of the remote theme.\n   * @environment SHOPIFY_FLAG_THEME_ID\n   */\n  '-t, --theme <value>'?: string\n\n  /**\n   * Create a new unpublished theme and push to it.\n   * @environment SHOPIFY_FLAG_UNPUBLISHED\n   */\n  '-u, --unpublished'?: ''\n\n  /**\n   * Increase the verbosity of the output.\n   * @environment SHOPIFY_FLAG_VERBOSE\n   */\n  '--verbose'?: ''\n}"
+            "value": "export interface themepush {\n  /**\n   * Allow push to a live theme.\n   * @environment SHOPIFY_FLAG_ALLOW_LIVE\n   */\n  '-a, --allow-live'?: ''\n\n  /**\n   * Push theme files from your remote development theme.\n   * @environment SHOPIFY_FLAG_DEVELOPMENT\n   */\n  '-d, --development'?: ''\n\n  /**\n   * The environment to apply to the current command.\n   * @environment SHOPIFY_FLAG_ENVIRONMENT\n   */\n  '-e, --environment <value>'?: string\n\n  /**\n   * Skip uploading the specified files (Multiple flags allowed). Wrap the value in double quotes if you're using wildcards.\n   * @environment SHOPIFY_FLAG_IGNORE\n   */\n  '-x, --ignore <value>'?: string\n\n  /**\n   * Output the result as JSON.\n   * @environment SHOPIFY_FLAG_JSON\n   */\n  '-j, --json'?: ''\n\n  /**\n   * Push theme files from your remote live theme.\n   * @environment SHOPIFY_FLAG_LIVE\n   */\n  '-l, --live'?: ''\n\n  /**\n   * Disable color output.\n   * @environment SHOPIFY_FLAG_NO_COLOR\n   */\n  '--no-color'?: ''\n\n  /**\n   * Prevent deleting remote files that don't exist locally.\n   * @environment SHOPIFY_FLAG_NODELETE\n   */\n  '-n, --nodelete'?: ''\n\n  /**\n   * Upload only the specified files (Multiple flags allowed). Wrap the value in double quotes if you're using wildcards.\n   * @environment SHOPIFY_FLAG_ONLY\n   */\n  '-o, --only <value>'?: string\n\n  /**\n   * Password generated from the Theme Access app.\n   * @environment SHOPIFY_CLI_THEME_TOKEN\n   */\n  '--password <value>'?: string\n\n  /**\n   * The path where you want to run the command. Defaults to the current working directory.\n   * @environment SHOPIFY_FLAG_PATH\n   */\n  '--path <value>'?: string\n\n  /**\n   * Publish as the live theme after uploading.\n   * @environment SHOPIFY_FLAG_PUBLISH\n   */\n  '-p, --publish'?: ''\n\n  /**\n   * Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).\n   * @environment SHOPIFY_FLAG_STORE\n   */\n  '-s, --store <value>'?: string\n\n  /**\n   * Require theme check to pass without errors before pushing. Warnings are allowed.\n   * @environment SHOPIFY_FLAG_STRICT_PUSH\n   */\n  '--strict'?: ''\n\n  /**\n   * Theme ID or name of the remote theme.\n   * @environment SHOPIFY_FLAG_THEME_ID\n   */\n  '-t, --theme <value>'?: string\n\n  /**\n   * Create a new unpublished theme and push to it.\n   * @environment SHOPIFY_FLAG_UNPUBLISHED\n   */\n  '-u, --unpublished'?: ''\n\n  /**\n   * Increase the verbosity of the output.\n   * @environment SHOPIFY_FLAG_VERBOSE\n   */\n  '--verbose'?: ''\n}"
           }
         }
       }
diff --git a/packages/cli/README.md b/packages/cli/README.md
@@ -2269,11 +2269,13 @@ FLAGS
   -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).
+  -o, --only=<value>...         Download only the specified files (Multiple flags allowed). Wrap the value in double
+                                quotes if you're using wildcards.
   -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).
+  -x, --ignore=<value>...       Skip downloading the specified files (Multiple flags allowed). Wrap the value in double
+                                quotes if you're using wildcards.
       --no-color                Disable color output.
       --password=<value>        Password generated from the Theme Access app.
       --path=<value>            The path where you want to run the command. Defaults to the current working directory.
@@ -2303,13 +2305,15 @@ FLAGS
   -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>...         Push only the specified files (Multiple flags allowed).
+  -o, --only=<value>...         Upload only the specified files (Multiple flags allowed). Wrap the value in double
+                                quotes if you're using wildcards.
   -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 uploading the specified files (Multiple flags allowed).
+  -x, --ignore=<value>...       Skip uploading the specified files (Multiple flags allowed). Wrap the value in double
+                                quotes if you're using wildcards.
       --no-color                Disable color output.
       --password=<value>        Password generated from the Theme Access app.
       --path=<value>            The path where you want to run the command. Defaults to the current working directory.
diff --git a/packages/cli/oclif.manifest.json b/packages/cli/oclif.manifest.json
@@ -6393,7 +6393,7 @@
         },
         "ignore": {
           "char": "x",
-          "description": "Skip downloading the specified files (Multiple flags allowed).",
+          "description": "Skip downloading the specified files (Multiple flags allowed). Wrap the value in double quotes if you're using wildcards.",
           "env": "SHOPIFY_FLAG_IGNORE",
           "hasDynamicHelp": false,
           "multiple": true,
@@ -6426,7 +6426,7 @@
         },
         "only": {
           "char": "o",
-          "description": "Download only the specified files (Multiple flags allowed).",
+          "description": "Download only the specified files (Multiple flags allowed). Wrap the value in double quotes if you're using wildcards.",
           "env": "SHOPIFY_FLAG_ONLY",
           "hasDynamicHelp": false,
           "multiple": true,
@@ -6532,7 +6532,7 @@
         },
         "ignore": {
           "char": "x",
-          "description": "Skip uploading the specified files (Multiple flags allowed).",
+          "description": "Skip uploading the specified files (Multiple flags allowed). Wrap the value in double quotes if you're using wildcards.",
           "env": "SHOPIFY_FLAG_IGNORE",
           "hasDynamicHelp": false,
           "multiple": true,
@@ -6574,7 +6574,7 @@
         },
         "only": {
           "char": "o",
-          "description": "Push only the specified files (Multiple flags allowed).",
+          "description": "Upload only the specified files (Multiple flags allowed). Wrap the value in double quotes if you're using wildcards.",
           "env": "SHOPIFY_FLAG_ONLY",
           "hasDynamicHelp": false,
           "multiple": true,
diff --git a/packages/theme/src/cli/commands/theme/pull.ts b/packages/theme/src/cli/commands/theme/pull.ts
@@ -1,4 +1,4 @@
-import {themeFlags} from '../../flags.js'
+import {globFlags, themeFlags} from '../../flags.js'
 import ThemeCommand from '../../utilities/theme-command.js'
 import {pull, PullFlags} from '../../services/pull.js'
 import {globalFlags} from '@shopify/cli-kit/node/cli'
@@ -16,6 +16,7 @@ If no theme is specified, then you're prompted to select the theme to pull from
   static flags = {
     ...globalFlags,
     ...themeFlags,
+    ...globFlags('download'),
     theme: Flags.string({
       char: 't',
       description: 'Theme ID or name of the remote theme.',
@@ -36,18 +37,6 @@ If no theme is specified, then you're prompted to select the theme to pull from
       description: `Prevent deleting local files that don't exist remotely.`,
       env: 'SHOPIFY_FLAG_NODELETE',
     }),
-    only: Flags.string({
-      char: 'o',
-      multiple: true,
-      description: 'Download only the specified files (Multiple flags allowed).',
-      env: 'SHOPIFY_FLAG_ONLY',
-    }),
-    ignore: Flags.string({
-      char: 'x',
-      multiple: true,
-      description: 'Skip downloading the specified files (Multiple flags allowed).',
-      env: 'SHOPIFY_FLAG_IGNORE',
-    }),
     force: Flags.boolean({
       hidden: true,
       char: 'f',
diff --git a/packages/theme/src/cli/commands/theme/push.ts b/packages/theme/src/cli/commands/theme/push.ts
@@ -1,4 +1,4 @@
-import {themeFlags} from '../../flags.js'
+import {globFlags, themeFlags} from '../../flags.js'
 import ThemeCommand from '../../utilities/theme-command.js'
 import {push, PushFlags} from '../../services/push.js'
 import {Flags} from '@oclif/core'
@@ -43,6 +43,7 @@ export default class Push extends ThemeCommand {
   static flags = {
     ...globalFlags,
     ...themeFlags,
+    ...globFlags('upload'),
     ...jsonFlag,
     theme: Flags.string({
       char: 't',
@@ -69,18 +70,6 @@ export default class Push extends ThemeCommand {
       description: `Prevent deleting remote files that don't exist locally.`,
       env: 'SHOPIFY_FLAG_NODELETE',
     }),
-    only: Flags.string({
-      char: 'o',
-      description: 'Push only the specified files (Multiple flags allowed).',
-      multiple: true,
-      env: 'SHOPIFY_FLAG_ONLY',
-    }),
-    ignore: Flags.string({
-      char: 'x',
-      description: 'Skip uploading the specified files (Multiple flags allowed).',
-      multiple: true,
-      env: 'SHOPIFY_FLAG_IGNORE',
-    }),
     'allow-live': Flags.boolean({
       char: 'a',
       description: 'Allow push to a live theme.',
diff --git a/packages/theme/src/cli/flags.ts b/packages/theme/src/cli/flags.ts
@@ -41,3 +41,22 @@ export const themeFlags = {
     multiple: true,
   }),
 }
+
+const globQuotesDescription = "Wrap the value in double quotes if you're using wildcards."
+
+export const globFlags = (action: 'download' | 'upload') => ({
+  only: Flags.string({
+    char: 'o',
+    multiple: true,
+    description: `${
+      action.charAt(0).toUpperCase() + action.slice(1)
+    } only the specified files (Multiple flags allowed). ${globQuotesDescription}`,
+    env: 'SHOPIFY_FLAG_ONLY',
+  }),
+  ignore: Flags.string({
+    char: 'x',
+    multiple: true,
+    description: `Skip ${action}ing the specified files (Multiple flags allowed). ${globQuotesDescription}`,
+    env: 'SHOPIFY_FLAG_IGNORE',
+  }),
+})
