Merge pull request #6103 from Shopify/rb-update-store-copy-help-content

Update store copy help content and add examples

Author: odacrem

packages/cli/oclif.manifest.json

@@ -4878,10 +4878,10 @@
       "args": {
       },
       "customPluginName": "@shopify/store",
-      "description": "Copy data between stores, export store data to SQLite, or import data from SQLite to a store",
+      "description": "Examples:\n\n    COPY data from one store to another in your organization\n    shopify store copy --from-store source.myshopify.com --to-store target.myshopify.com\n\n    EXPORT store data to SQLite\n    shopify store copy --from-store source.myshopify.com --to-file path/to/file.sqlite\n\n    IMPORT data from SQLite to a store\n    shopify store copy --from-file path/to/file.sqlite --to-store target.myshopify.com\n",
       "flags": {
         "from-file": {
-          "description": "The SQLite file to import data from.",
+          "description": "The SQLite file to import data from. Can't be used with --to-file.",
           "env": "SHOPIFY_FLAG_FROM_FILE",
           "hasDynamicHelp": false,
           "multiple": false,
@@ -4902,7 +4902,7 @@
           "default": [
             "products:handle"
           ],
-          "description": "The identity key to use to match resources",
+          "description": "The identity key to use to match resources. ID metafields can be specified as <object_type>:metafield:<metafield_namespace>:<key>",
           "env": "SHOPIFY_FLAG_IDENTITY_KEY",
           "hasDynamicHelp": false,
           "multiple": true,
@@ -4938,7 +4938,7 @@
           "type": "boolean"
         },
         "to-file": {
-          "description": "The SQLite file path to export data to. Omit to auto-generate filename.",
+          "description": "The SQLite file path to export data to. Omit to auto-generate filename. Can't be used with --from-file.",
           "env": "SHOPIFY_FLAG_TO_FILE",
           "hasDynamicHelp": false,
           "multiple": false,

packages/store/src/commands/store/copy.ts

@@ -14,7 +14,18 @@ import {loadHelpClass} from '@oclif/core'
 
 export default class Copy extends BaseBDCommand {
   static summary = 'Copy, export, or import store data'
-  static description = 'Copy data between stores, export store data to SQLite, or import data from SQLite to a store'
+  static description = `Examples:
+
+    COPY data from one store to another in your organization
+    shopify store copy --from-store source.myshopify.com --to-store target.myshopify.com
+
+    EXPORT store data to SQLite
+    shopify store copy --from-store source.myshopify.com --to-file path/to/file.sqlite
+
+    IMPORT data from SQLite to a store
+    shopify store copy --from-file path/to/file.sqlite --to-store target.myshopify.com
+`
+
   static hidden = true
   static flags = {
     ...storeFlags,

packages/store/src/lib/flags.ts

@@ -15,12 +15,13 @@ export const storeFlags = {
 
 export const fileFlags = {
   'from-file': Flags.string({
-    description: 'The SQLite file to import data from.',
+    description: "The SQLite file to import data from. Can't be used with --to-file.",
     required: false,
     env: 'SHOPIFY_FLAG_FROM_FILE',
   }),
   'to-file': Flags.string({
-    description: 'The SQLite file path to export data to. Omit to auto-generate filename.',
+    description:
+      "The SQLite file path to export data to. Omit to auto-generate filename. Can't be used with --from-file.",
     required: false,
     env: 'SHOPIFY_FLAG_TO_FILE',
     default: undefined,
@@ -29,7 +30,8 @@ export const fileFlags = {
 
 export const resourceConfigFlags = {
   key: Flags.string({
-    description: 'The identity key to use to match resources',
+    description:
+      'The identity key to use to match resources. ID metafields can be specified as <object_type>:metafield:<metafield_namespace>:<key>',
     multiple: true,
     required: false,
     env: 'SHOPIFY_FLAG_IDENTITY_KEY',