Clarify app config link flag descriptions

Author: gonzaloriestra

.changeset/config-link-flag-error.md

@@ -2,4 +2,4 @@
 '@shopify/app': patch
 ---
 
-Recommend `--file-name` when `app config link` receives both `--config` and `--client-id`
+Clarify `app config link` flags and recommend `--file-name` when both `--config` and `--client-id` are provided

docs-shopify.dev/generated/generated_docs_data_v2.json

@@ -504,7 +504,7 @@
           "syntaxKind": "PropertySignature",
           "name": "--client-id <value>",
           "value": "string",
-          "description": "The Client ID of your app. Required if non interactive.",
+          "description": "The Client ID of the remote app to link. Use --file-name to specify the destination configuration file. Required if non interactive.",
           "isOptional": true,
           "environmentValue": "SHOPIFY_FLAG_CLIENT_ID"
         },
@@ -513,7 +513,7 @@
           "syntaxKind": "PropertySignature",
           "name": "--file-name <value>",
           "value": "string",
-          "description": "The name of the app configuration file to create or overwrite.",
+          "description": "The name of the app configuration file to create or overwrite. Requires --force to overwrite an existing file.",
           "isOptional": true,
           "environmentValue": "SHOPIFY_FLAG_APP_CONFIG_FILE_NAME"
         },
@@ -585,12 +585,12 @@
           "syntaxKind": "PropertySignature",
           "name": "-c, --config <value>",
           "value": "string",
-          "description": "The name of the app configuration.",
+          "description": "The name of the local app configuration to read and overwrite. Use --file-name instead when specifying --client-id.",
           "isOptional": true,
           "environmentValue": "SHOPIFY_FLAG_APP_CONFIG"
         }
       ],
-      "value": "export interface appconfiglink {\n  /**\n   * Alias of the Shopify account to use for authentication.\n   * @environment SHOPIFY_FLAG_AUTH_ALIAS\n   */\n  '--auth-alias <value>'?: string\n\n  /**\n   * The Client ID of your app. Required if non interactive.\n   * @environment SHOPIFY_FLAG_CLIENT_ID\n   */\n  '--client-id <value>'?: string\n\n  /**\n   * The name of the app configuration.\n   * @environment SHOPIFY_FLAG_APP_CONFIG\n   */\n  '-c, --config <value>'?: string\n\n  /**\n   * The name of the app configuration file to create or overwrite.\n   * @environment SHOPIFY_FLAG_APP_CONFIG_FILE_NAME\n   */\n  '--file-name <value>'?: string\n\n  /**\n   * Overwrite an existing configuration file without prompting.\n   * @environment SHOPIFY_FLAG_FORCE\n   */\n  '--force'?: ''\n\n  /**\n   * Print the command's JSON schemas.\n   * @environment SHOPIFY_FLAG_JSON_SCHEMA\n   */\n  '--json-schema'?: ''\n\n  /**\n   * Disable color output.\n   * @environment SHOPIFY_FLAG_NO_COLOR\n   */\n  '--no-color'?: ''\n\n  /**\n   * Disable interactive prompts and browser authentication.\n   * @environment SHOPIFY_FLAG_NO_INPUT\n   */\n  '--no-input'?: ''\n\n  /**\n   * The path to your app directory.\n   * @environment SHOPIFY_FLAG_PATH\n   */\n  '--path <value>'?: string\n\n  /**\n   * Reset all your settings.\n   * @environment SHOPIFY_FLAG_RESET\n   */\n  '--reset'?: ''\n\n  /**\n   * Increase the verbosity of the output. May include sensitive data.\n   * @environment SHOPIFY_FLAG_VERBOSE\n   */\n  '--verbose'?: ''\n}"
+      "value": "export interface appconfiglink {\n  /**\n   * Alias of the Shopify account to use for authentication.\n   * @environment SHOPIFY_FLAG_AUTH_ALIAS\n   */\n  '--auth-alias <value>'?: string\n\n  /**\n   * The Client ID of the remote app to link. Use --file-name to specify the destination configuration file. Required if non interactive.\n   * @environment SHOPIFY_FLAG_CLIENT_ID\n   */\n  '--client-id <value>'?: string\n\n  /**\n   * The name of the local app configuration to read and overwrite. Use --file-name instead when specifying --client-id.\n   * @environment SHOPIFY_FLAG_APP_CONFIG\n   */\n  '-c, --config <value>'?: string\n\n  /**\n   * The name of the app configuration file to create or overwrite. Requires --force to overwrite an existing file.\n   * @environment SHOPIFY_FLAG_APP_CONFIG_FILE_NAME\n   */\n  '--file-name <value>'?: string\n\n  /**\n   * Overwrite an existing configuration file without prompting.\n   * @environment SHOPIFY_FLAG_FORCE\n   */\n  '--force'?: ''\n\n  /**\n   * Print the command's JSON schemas.\n   * @environment SHOPIFY_FLAG_JSON_SCHEMA\n   */\n  '--json-schema'?: ''\n\n  /**\n   * Disable color output.\n   * @environment SHOPIFY_FLAG_NO_COLOR\n   */\n  '--no-color'?: ''\n\n  /**\n   * Disable interactive prompts and browser authentication.\n   * @environment SHOPIFY_FLAG_NO_INPUT\n   */\n  '--no-input'?: ''\n\n  /**\n   * The path to your app directory.\n   * @environment SHOPIFY_FLAG_PATH\n   */\n  '--path <value>'?: string\n\n  /**\n   * Reset all your settings.\n   * @environment SHOPIFY_FLAG_RESET\n   */\n  '--reset'?: ''\n\n  /**\n   * Increase the verbosity of the output. May include sensitive data.\n   * @environment SHOPIFY_FLAG_VERBOSE\n   */\n  '--verbose'?: ''\n}"
     }
   },
   "appconfigpull": {

packages/app/src/cli/commands/app/config/link.ts

@@ -19,6 +19,13 @@ export default class ConfigLink extends AppLinkedCommand {
   static flags = {
     ...globalFlags,
     ...appFlags,
+    config: Flags.string({
+      hidden: false,
+      char: 'c',
+      description:
+        'The name of the local app configuration to read and overwrite. Use --file-name instead when specifying --client-id.',
+      env: 'SHOPIFY_FLAG_APP_CONFIG',
+    }),
     'organization-id': Flags.string({
       hidden: true,
       env: 'SHOPIFY_FLAG_ORGANIZATION_ID',
@@ -28,13 +35,15 @@ export default class ConfigLink extends AppLinkedCommand {
     'client-id': requiredIfNonInteractive(
       Flags.string({
         hidden: false,
-        description: 'The Client ID of your app.',
+        description:
+          'The Client ID of the remote app to link. Use --file-name to specify the destination configuration file.',
         env: 'SHOPIFY_FLAG_CLIENT_ID',
       }),
     ),
     'file-name': Flags.string({
       hidden: false,
-      description: 'The name of the app configuration file to create or overwrite.',
+      description:
+        'The name of the app configuration file to create or overwrite. Requires --force to overwrite an existing file.',
       env: 'SHOPIFY_FLAG_APP_CONFIG_FILE_NAME',
       exclusive: ['config'],
     }),

packages/cli/README.md

@@ -415,19 +415,20 @@ USAGE
 
 FLAGS
   -c, --config=<value>
-      The name of the app configuration.
+      The name of the local app configuration to read and overwrite. Use --file-name instead when specifying --client-id.
       [env: SHOPIFY_FLAG_APP_CONFIG]
 
   --auth-alias=<value>
       Alias of the Shopify account to use for authentication.
       [env: SHOPIFY_FLAG_AUTH_ALIAS]
 
   --client-id=<value>
-      The Client ID of your app. Required if non interactive.
+      The Client ID of the remote app to link. Use --file-name to specify the destination configuration file. Required if
+      non interactive.
       [env: SHOPIFY_FLAG_CLIENT_ID]
 
   --file-name=<value>
-      The name of the app configuration file to create or overwrite.
+      The name of the app configuration file to create or overwrite. Requires --force to overwrite an existing file.
       [env: SHOPIFY_FLAG_APP_CONFIG_FILE_NAME]
 
   --force

packages/cli/oclif.manifest.json

@@ -536,7 +536,7 @@
           "type": "option"
         },
         "client-id": {
-          "description": "The Client ID of your app. Required if non interactive.",
+          "description": "The Client ID of the remote app to link. Use --file-name to specify the destination configuration file. Required if non interactive.",
           "env": "SHOPIFY_FLAG_CLIENT_ID",
           "hasDynamicHelp": false,
           "hidden": false,
@@ -546,7 +546,7 @@
         },
         "config": {
           "char": "c",
-          "description": "The name of the app configuration.",
+          "description": "The name of the local app configuration to read and overwrite. Use --file-name instead when specifying --client-id.",
           "env": "SHOPIFY_FLAG_APP_CONFIG",
           "hasDynamicHelp": false,
           "hidden": false,
@@ -555,7 +555,7 @@
           "type": "option"
         },
         "file-name": {
-          "description": "The name of the app configuration file to create or overwrite.",
+          "description": "The name of the app configuration file to create or overwrite. Requires --force to overwrite an existing file.",
           "env": "SHOPIFY_FLAG_APP_CONFIG_FILE_NAME",
           "exclusive": [
             "config"