Skip to content

Make --output-file flag dependent on --watch in bulk operations #6691

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
nickwesselman wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Make --output-file flag dependent on --watch in bulk operations #6691

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7468a22
`app bulk execute` should require `--watch` when using `--output-file`
nickwesselman Dec 6, 2025
31337c0
clarify dependency in description
nickwesselman Dec 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion packages/app/src/cli/commands/app/bulk/execute.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ export default class BulkExecute extends AppLinkedCommand {
query,
variables: flags.variables,
variableFile: flags['variable-file'],
watch: flags.watch,
watch: flags.watch ?? false,
outputFile: flags['output-file'],
...(flags.version && {version: flags.version}),
})
Expand Down
7 changes: 4 additions & 3 deletions packages/app/src/cli/flags.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,13 +64,14 @@ export const bulkOperationFlags = {
parse: async (input) => normalizeStoreFqdn(input),
}),
watch: Flags.boolean({
description: 'Wait for bulk operation results before exiting.',
description: 'Wait for bulk operation results before exiting. Defaults to false.',
env: 'SHOPIFY_FLAG_WATCH',
default: false,
}),
'output-file': Flags.string({
description: 'The file path where results should be written. If not specified, results will be written to STDOUT.',
description:
'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',
dependsOn: ['watch'],
}),
version: Flags.string({
description: 'The API version to use for the bulk operation. If not specified, uses the latest stable version.',
Expand Down
7 changes: 5 additions & 2 deletions packages/cli/oclif.manifest.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,10 @@
"type": "boolean"
},
"output-file": {
"description": "The file path where results should be written. If not specified, results will be written to STDOUT.",
"dependsOn": [
"watch"
],
"description": "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",
"hasDynamicHelp": false,
"multiple": false,
Expand Down Expand Up @@ -212,7 +215,7 @@
},
"watch": {
"allowNo": false,
"description": "Wait for bulk operation results before exiting.",
"description": "Wait for bulk operation results before exiting. Defaults to false.",
"env": "SHOPIFY_FLAG_WATCH",
"name": "watch",
"type": "boolean"
Expand Down