Add stdin support for shopify app execute
#6663
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ericlee878
changed the title
shopify app execute
This was referenced Nov 24, 2025
Contributor
Author
This stack of pull requests is managed by Graphite. Learn more about stacking. |
Contributor
Coverage report
Show new covered files 🐣
Show files with reduced coverage 🔻
Test suite run success3434 tests passing in 1393 suites. Report generated by 🧪jest coverage report action from b4e7710 |
Contributor
|
We detected some changes at Caution DO NOT create changesets for features which you do not wish to be included in the public changelog of the next CLI release. |
ericlee878
force-pushed
the
11-24-Stdin-for-query-input-BulkOps-CLI
branch
2 times, most recently
from
87db939 to
0a2627f
Compare
isaacroldan
reviewed
Nov 25, 2025
Comment on lines
210
to
220
| export function isStdinPiped(): boolean { | ||
| return !process.stdin.isTTY | ||
| } |
Contributor
There was a problem hiding this comment.
I think that piped implies non TTY, but non TTY doesn't always mean piped 🤔
I might be wrong, but CI environments are non TTY by default and that doesn't mean you are receiving an input via stdin
Contributor
Author
There was a problem hiding this comment.
You are right! I changed it so that the function now checks what stdin actually is using fstatSync(0): isFIFO() for pipes, isFile() for file redirects.
ericlee878
force-pushed
the
11-24-Stdin-for-query-input-BulkOps-CLI
branch
from
0a2627f to
48b819c
Compare
ericlee878
force-pushed
the
11-24-Stdin-for-query-input-BulkOps-CLI
branch
from
48b819c to
d6cdf64
Compare
ericlee878
force-pushed
the
11-19-implement-ensureAuthenticatedAdminAsApp
branch
from
e9bb7f5 to
a0b57c8
Compare
ericlee878
force-pushed
the
11-24-Stdin-for-query-input-BulkOps-CLI
branch
from
d6cdf64 to
38bd5b0
Compare
graphite-app
bot
changed the base branch from
11-19-implement-ensureAuthenticatedAdminAsApp
to
graphite-base/6663
jordanverasamy
force-pushed
the
11-24-Stdin-for-query-input-BulkOps-CLI
branch
from
38bd5b0 to
e6c20a9
Compare
jordanverasamy
force-pushed
the
graphite-base/6663
branch
from
a0b57c8 to
386074f
Compare
jordanverasamy
changed the base branch from
graphite-base/6663
to
11-19-implement-ensureAuthenticatedAdminAsApp
jordanverasamy
force-pushed
the
11-19-implement-ensureAuthenticatedAdminAsApp
branch
from
386074f to
479bccb
Compare
jordanverasamy
force-pushed
the
11-24-Stdin-for-query-input-BulkOps-CLI
branch
from
e6c20a9 to
bf064cc
Compare
jordanverasamy
changed the base branch from
11-19-implement-ensureAuthenticatedAdminAsApp
to
graphite-base/6663
jordanverasamy
force-pushed
the
11-24-Stdin-for-query-input-BulkOps-CLI
branch
from
bf064cc to
6d3b3fc
Compare
jordanverasamy
force-pushed
the
graphite-base/6663
branch
from
479bccb to
02b54ed
Compare
jordanverasamy
changed the base branch from
graphite-base/6663
to
11-19-implement-ensureAuthenticatedAdminAsApp
Base automatically changed from
11-19-implement-ensureAuthenticatedAdminAsApp
to
main
November 27, 2025 17:42
dmerand
reviewed
Dec 1, 2025
| return query | ||
| } | ||
|
|
||
| const stdinContent = await readStdin() |
Contributor
There was a problem hiding this comment.
I wonder if this is the right layer to read from STDIN? Perhaps the command layer e.g. execute where input flags etc. are being parsed would be the right moment to check whether we've been given an input text/file?
Contributor
Author
There was a problem hiding this comment.
Good call. I refactored it this way and made the code way more organized. Thanks!
dmerand
reviewed
Dec 1, 2025
ericlee878
force-pushed
the
11-24-Stdin-for-query-input-BulkOps-CLI
branch
from
6d3b3fc to
b4e7710
Compare
Contributor
Differences in type declarationsWe detected differences in the type declarations generated by Typescript for this branch compared to the baseline ('main' branch). Please, review them to ensure they are backward-compatible. Here are some important things to keep in mind:
New type declarationsWe found no new type declarations in this PR Existing type declarationspackages/cli-kit/dist/public/node/system.d.ts@@ -62,4 +62,23 @@ export declare function isCI(): boolean;
*
* @returns True if the current environment is a WSL environment.
*/
-export declare function isWsl(): Promise<boolean>;
\ No newline at end of file
+export declare function isWsl(): Promise<boolean>;
+/**
+ * Check if stdin has piped data available.
+ * This distinguishes between actual piped input (e.g., )
+ * and non-TTY environments without input (e.g., CI).
+ *
+ * @returns True if stdin is receiving piped data or file redirect, false otherwise.
+ */
+export declare function isStdinPiped(): boolean;
+/**
+ * Reads all data from stdin and returns it as a string.
+ * This is useful for commands that accept input via piping.
+ *
+ * @example
+ * // Usage: echo "your query" | shopify app execute
+ * const query = await readStdin()
+ *
+ * @returns A promise that resolves with the stdin content, or undefined if stdin is a TTY.
+ */
+export declare function readStdin(): Promise<string | undefined>;
\ No newline at end of file
|
dmerand
approved these changes
Dec 1, 2025
Contributor
dmerand
left a comment
dmerand
left a comment
There was a problem hiding this comment.
I didn't tophat, but code LGTM. Thanks for the changes!
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Resolves: https://github.com/orgs/shop/projects/208/views/34?pane=issue&itemId=139444955&issue=shop%7Cissues-api-foundations%7C1111
Inspired by: https://app.graphite.com/github/pr/Shopify/cli/6588/Initial-Setup-Bulk-Operations-Infrastructure-for-Shopify-CLI#comment-PRRC_kwDOHibhHs6WnBvj
Summary
This PR enables users to pipe GraphQL queries into
shopify app executevia stdin, improving the developer experience for bulk operations.Why This Change Matters
Before: Users had to pass queries inline via --query, which is cumbersome for complex multi-line GraphQL:
After: Users can pipe from files or other commands:
This aligns with Unix conventions and how developers already work with GraphQL tooling.
Design Decisions
cli-kit/system.tsisStdinPiped()andreadStdin()insystem.tsalongside other process utilities makes them discoverable and reusable for future commands.readStdin()returns undefined immediately when stdin is interactive. This prevents the command from hanging waiting for user input — a common pitfall in CLI tools.Thoughts for Future