Fix overwrite option not being used in data set and uss file downloads

packages/cli/CHANGELOG.md

@@ -1,6 +1,10 @@
 # Change Log
 All notable changes to the Zowe CLI package will be documented in this file.
 
+## Recent Changes
+
+- Added support for `--overwrite` option to all Download methods. The default behavior is no longer to always overwrite existing files. [#2620](https://github.com/zowe/zowe-cli/pull/2620)
+
 ## `8.27.4`
 
 - BugFix: Updated minimum supported version of Node from 18 to 20. Added Node 24 support. [#2616](https://github.com/zowe/zowe-cli/pull/2616)

packages/cli/__tests__/zosfiles/__unit__/download/am/__snapshots__/AllMembers.definition.unit.test.ts.snap

@@ -57,6 +57,14 @@ The maximum number of TSO address spaces have been created. When you specify 0,
     ],
     "type": "number",
   },
+  Object {
+    "aliases": Array [
+      "ow",
+    ],
+    "description": "Overwrite files that already exist in your local environment.",
+    "name": "overwrite",
+    "type": "boolean",
+  },
   Object {
     "aliases": Array [
       "po",

packages/cli/__tests__/zosfiles/__unit__/download/amm/__snapshots__/AllMembersMatching.definition.unit.test.ts.snap

@@ -57,6 +57,14 @@ The maximum number of TSO address spaces have been created. When you specify 0,
     ],
     "type": "number",
   },
+  Object {
+    "aliases": Array [
+      "ow",
+    ],
+    "description": "Overwrite files that already exist in your local environment.",
+    "name": "overwrite",
+    "type": "boolean",
+  },
   Object {
     "aliases": Array [
       "po",

packages/cli/__tests__/zosfiles/__unit__/download/ds/__snapshots__/Dataset.definition.unit.test.ts.snap

@@ -34,6 +34,14 @@ Array [
     "name": "file",
     "type": "string",
   },
+  Object {
+    "aliases": Array [
+      "ow",
+    ],
+    "description": "Overwrite files that already exist in your local environment.",
+    "name": "overwrite",
+    "type": "boolean",
+  },
   Object {
     "aliases": Array [
       "po",

packages/cli/__tests__/zosfiles/__unit__/download/dsm/__snapshots__/DataSetMatching.definition.unit.test.ts.snap

@@ -76,6 +76,14 @@ The maximum number of TSO address spaces have been created. When you specify 0,
     ],
     "type": "number",
   },
+  Object {
+    "aliases": Array [
+      "ow",
+    ],
+    "description": "Overwrite files that already exist in your local environment.",
+    "name": "overwrite",
+    "type": "boolean",
+  },
   Object {
     "aliases": Array [
       "po",

packages/cli/__tests__/zosfiles/__unit__/download/uss/__snapshots__/UssFile.definition.unit.test.ts.snap

@@ -38,6 +38,14 @@ Array [
     "name": "file",
     "type": "string",
   },
+  Object {
+    "aliases": Array [
+      "ow",
+    ],
+    "description": "Overwrite files that already exist in your local environment.",
+    "name": "overwrite",
+    "type": "boolean",
+  },
 ]
 `;
 

packages/cli/src/zosfiles/download/Download.options.ts

@@ -199,7 +199,7 @@ export const DownloadOptions: { [key: string]: ICommandOptionDefinition } = {
     },
 
     /**
-     * The include hidden option for download
+     * The overwrite option for downloads
      */
     overwrite: {
         name: "overwrite",

packages/cli/src/zosfiles/download/am/AllMembers.definition.ts

@@ -47,7 +47,8 @@ export const AllMembersDefinition: ICommandDefinition = {
         DownloadOptions.extension,
         DownloadOptions.maxConcurrentRequests,
         DownloadOptions.preserveOriginalLetterCase,
-        DownloadOptions.failFast
+        DownloadOptions.failFast,
+        DownloadOptions.overwrite
     ].sort((a, b) => a.name.localeCompare(b.name)),
     examples: [
         {

packages/cli/src/zosfiles/download/am/AllMembers.handler.ts

@@ -35,6 +35,7 @@ export default class AllMembersHandler extends ZosFilesBaseHandler {
             maxConcurrentRequests: commandParameters.arguments.maxConcurrentRequests,
             preserveOriginalLetterCase: commandParameters.arguments.preserveOriginalLetterCase,
             failFast: commandParameters.arguments.failFast,
+            overwrite: commandParameters.arguments.overwrite,
             task: status,
             responseTimeout: commandParameters.arguments.responseTimeout
         });

packages/cli/src/zosfiles/download/amm/AllMembersMatching.definition.ts

@@ -54,7 +54,8 @@ export const AllMembersMatchingDefinition: ICommandDefinition = {
         DownloadOptions.excludePattern,
         DownloadOptions.maxConcurrentRequests,
         DownloadOptions.preserveOriginalLetterCase,
-        DownloadOptions.failFast
+        DownloadOptions.failFast,
+        DownloadOptions.overwrite
     ].sort((a, b) => a.name.localeCompare(b.name)),
     examples: [
         {
@@ -66,4 +67,4 @@ export const AllMembersMatchingDefinition: ICommandDefinition = {
             options: `"ibmuser.cntl" "test*,M*" --exclude-patterns "M2*" --directory output`
         }
     ]
-};
+};

packages/cli/src/zosfiles/download/amm/AllMembersMatching.handler.ts

@@ -55,9 +55,10 @@ export default class AllMembersMatchingHandler extends ZosFilesBaseHandler {
             maxConcurrentRequests: commandParameters.arguments.maxConcurrentRequests,
             preserveOriginalLetterCase: commandParameters.arguments.preserveOriginalLetterCase,
             failFast: commandParameters.arguments.failFast,
+            overwrite: commandParameters.arguments.overwrite,
             task: status,
             responseTimeout: commandParameters.arguments.responseTimeout,
             memberPatternResponse: response.apiResponse,
         });
     }
-}
+}

packages/cli/src/zosfiles/download/ds/Dataset.definition.ts

@@ -45,7 +45,8 @@ export const DatasetDefinition: ICommandDefinition = {
         DownloadOptions.binary,
         DownloadOptions.record,
         DownloadOptions.preserveOriginalLetterCase,
-        DownloadOptions.encoding
+        DownloadOptions.encoding,
+        DownloadOptions.overwrite
     ].sort((a, b) => a.name.localeCompare(b.name)),
     examples: [
         {

packages/cli/src/zosfiles/download/dsm/DataSetMatching.definition.ts

@@ -49,7 +49,8 @@ export const DataSetMatchingDefinition: ICommandDefinition = {
         DownloadOptions.extensionMap,
         DownloadOptions.maxConcurrentRequests,
         DownloadOptions.preserveOriginalLetterCase,
-        DownloadOptions.failFast
+        DownloadOptions.failFast,
+        DownloadOptions.overwrite
     ].sort((a, b) => a.name.localeCompare(b.name)),
     examples: [
         {

packages/cli/src/zosfiles/download/dsm/DataSetMatching.handler.ts

@@ -72,6 +72,7 @@ export default class DataSetMatchingHandler extends ZosFilesBaseHandler {
             maxConcurrentRequests: commandParameters.arguments.maxConcurrentRequests,
             preserveOriginalLetterCase: commandParameters.arguments.preserveOriginalLetterCase,
             failFast: commandParameters.arguments.failFast,
+            overwrite: commandParameters.arguments.overwrite,
             task: downloadStatus,
             responseTimeout: commandParameters.arguments.responseTimeout
         };

packages/cli/src/zosfiles/download/uss/UssFile.definition.ts

@@ -42,7 +42,8 @@ export const UssFileDefinition: ICommandDefinition = {
         DownloadOptions.attributes,
         DownloadOptions.file,
         DownloadOptions.binary,
-        DownloadOptions.encoding
+        DownloadOptions.encoding,
+        DownloadOptions.overwrite
     ].sort((a, b) => a.name.localeCompare(b.name)),
     examples: [
         {

packages/zosfiles/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 All notable changes to the Zowe z/OS files SDK package will be documented in this file.
 
+## Recent Changes
+
+- BugFix: Fixed all the `Download` methods to now use the `overwrite` option. The default is no longer always overwriting existing files. Added new interfaces `IDownloadAmResult` and `IDownloadAmResponse` to provide detailed results when downloading all members of a PDS. [#2620](https://github.com/zowe/zowe-cli/pull/2620)
+
 ## `8.27.4`
 
 - BugFix: Updated minimum supported version of Node from 18 to 20. Added Node 24 support. [#2616](https://github.com/zowe/zowe-cli/pull/2616)