Skip to content

Commit 299cf56

Browse files
nickwesselmannickwesselman
authored
Merge pull request #6718 from Shopify/hide_app_execute
hide the `app execute` command for now
2 parents aa19356 + 56452f3 commit 299cf56

File tree

8 files changed

+3
-271
lines changed

8 files changed

+3
-271
lines changed

‎docs-shopify.dev/commands/app-execute.doc.ts‎

Lines changed: 0 additions & 34 deletions
This file was deleted.

‎docs-shopify.dev/commands/examples/app-execute.example.sh‎

Lines changed: 0 additions & 1 deletion
This file was deleted.

‎docs-shopify.dev/commands/interfaces/app-execute.interface.ts‎

Lines changed: 0 additions & 68 deletions
This file was deleted.

‎docs-shopify.dev/generated/generated_docs_data.json‎

Lines changed: 0 additions & 137 deletions
Original file line numberDiff line numberDiff line change
@@ -998,143 +998,6 @@
998998
"category": "app",
999999
"related": []
10001000
},
1001-
{
1002-
"name": "app execute",
1003-
"description": "Executes an Admin API GraphQL query or mutation on the specified dev store.",
1004-
"overviewPreviewDescription": "Execute GraphQL queries and mutations.",
1005-
"type": "command",
1006-
"isVisualComponent": false,
1007-
"defaultExample": {
1008-
"codeblock": {
1009-
"tabs": [
1010-
{
1011-
"title": "app execute",
1012-
"code": "shopify app execute [flags]",
1013-
"language": "bash"
1014-
}
1015-
],
1016-
"title": "app execute"
1017-
}
1018-
},
1019-
"definitions": [
1020-
{
1021-
"title": "Flags",
1022-
"description": "The following flags are available for the `app execute` command:",
1023-
"type": "appexecute",
1024-
"typeDefinitions": {
1025-
"appexecute": {
1026-
"filePath": "docs-shopify.dev/commands/interfaces/app-execute.interface.ts",
1027-
"name": "appexecute",
1028-
"description": "",
1029-
"members": [
1030-
{
1031-
"filePath": "docs-shopify.dev/commands/interfaces/app-execute.interface.ts",
1032-
"syntaxKind": "PropertySignature",
1033-
"name": "--client-id <value>",
1034-
"value": "string",
1035-
"description": "The Client ID of your app.",
1036-
"isOptional": true,
1037-
"environmentValue": "SHOPIFY_FLAG_CLIENT_ID"
1038-
},
1039-
{
1040-
"filePath": "docs-shopify.dev/commands/interfaces/app-execute.interface.ts",
1041-
"syntaxKind": "PropertySignature",
1042-
"name": "--no-color",
1043-
"value": "\"\"",
1044-
"description": "Disable color output.",
1045-
"isOptional": true,
1046-
"environmentValue": "SHOPIFY_FLAG_NO_COLOR"
1047-
},
1048-
{
1049-
"filePath": "docs-shopify.dev/commands/interfaces/app-execute.interface.ts",
1050-
"syntaxKind": "PropertySignature",
1051-
"name": "--output-file <value>",
1052-
"value": "string",
1053-
"description": "The file name where results should be written, instead of STDOUT.",
1054-
"isOptional": true,
1055-
"environmentValue": "SHOPIFY_FLAG_OUTPUT_FILE"
1056-
},
1057-
{
1058-
"filePath": "docs-shopify.dev/commands/interfaces/app-execute.interface.ts",
1059-
"syntaxKind": "PropertySignature",
1060-
"name": "--path <value>",
1061-
"value": "string",
1062-
"description": "The path to your app directory.",
1063-
"isOptional": true,
1064-
"environmentValue": "SHOPIFY_FLAG_PATH"
1065-
},
1066-
{
1067-
"filePath": "docs-shopify.dev/commands/interfaces/app-execute.interface.ts",
1068-
"syntaxKind": "PropertySignature",
1069-
"name": "--reset",
1070-
"value": "\"\"",
1071-
"description": "Reset all your settings.",
1072-
"isOptional": true,
1073-
"environmentValue": "SHOPIFY_FLAG_RESET"
1074-
},
1075-
{
1076-
"filePath": "docs-shopify.dev/commands/interfaces/app-execute.interface.ts",
1077-
"syntaxKind": "PropertySignature",
1078-
"name": "--verbose",
1079-
"value": "\"\"",
1080-
"description": "Increase the verbosity of the output.",
1081-
"isOptional": true,
1082-
"environmentValue": "SHOPIFY_FLAG_VERBOSE"
1083-
},
1084-
{
1085-
"filePath": "docs-shopify.dev/commands/interfaces/app-execute.interface.ts",
1086-
"syntaxKind": "PropertySignature",
1087-
"name": "--version <value>",
1088-
"value": "string",
1089-
"description": "The API version to use for the query or mutation. Defaults to the latest stable version.",
1090-
"isOptional": true,
1091-
"environmentValue": "SHOPIFY_FLAG_VERSION"
1092-
},
1093-
{
1094-
"filePath": "docs-shopify.dev/commands/interfaces/app-execute.interface.ts",
1095-
"syntaxKind": "PropertySignature",
1096-
"name": "-c, --config <value>",
1097-
"value": "string",
1098-
"description": "The name of the app configuration.",
1099-
"isOptional": true,
1100-
"environmentValue": "SHOPIFY_FLAG_APP_CONFIG"
1101-
},
1102-
{
1103-
"filePath": "docs-shopify.dev/commands/interfaces/app-execute.interface.ts",
1104-
"syntaxKind": "PropertySignature",
1105-
"name": "-q, --query <value>",
1106-
"value": "string",
1107-
"description": "The GraphQL query or mutation, as a string.",
1108-
"isOptional": true,
1109-
"environmentValue": "SHOPIFY_FLAG_QUERY"
1110-
},
1111-
{
1112-
"filePath": "docs-shopify.dev/commands/interfaces/app-execute.interface.ts",
1113-
"syntaxKind": "PropertySignature",
1114-
"name": "-s, --store <value>",
1115-
"value": "string",
1116-
"description": "The myshopify.com domain of the store to execute against. The app must be installed on the store. If not specified, you will be prompted to select a store.",
1117-
"isOptional": true,
1118-
"environmentValue": "SHOPIFY_FLAG_STORE"
1119-
},
1120-
{
1121-
"filePath": "docs-shopify.dev/commands/interfaces/app-execute.interface.ts",
1122-
"syntaxKind": "PropertySignature",
1123-
"name": "-v, --variables <value>",
1124-
"value": "string",
1125-
"description": "The values for any GraphQL variables in your query or mutation, in JSON format.",
1126-
"isOptional": true,
1127-
"environmentValue": "SHOPIFY_FLAG_VARIABLES"
1128-
}
1129-
],
1130-
"value": "export interface appexecute {\n /**\n * The Client ID of your app.\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 * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * The file name where results should be written, instead of STDOUT.\n * @environment SHOPIFY_FLAG_OUTPUT_FILE\n */\n '--output-file <value>'?: string\n\n /**\n * The path to your app directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path <value>'?: string\n\n /**\n * The GraphQL query or mutation, as a string.\n * @environment SHOPIFY_FLAG_QUERY\n */\n '-q, --query <value>'?: string\n\n /**\n * Reset all your settings.\n * @environment SHOPIFY_FLAG_RESET\n */\n '--reset'?: ''\n\n /**\n * The myshopify.com domain of the store to execute against. The app must be installed on the store. If not specified, you will be prompted to select a store.\n * @environment SHOPIFY_FLAG_STORE\n */\n '-s, --store <value>'?: string\n\n /**\n * The values for any GraphQL variables in your query or mutation, in JSON format.\n * @environment SHOPIFY_FLAG_VARIABLES\n */\n '-v, --variables <value>'?: string\n\n /**\n * Increase the verbosity of the output.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n\n /**\n * The API version to use for the query or mutation. Defaults to the latest stable version.\n * @environment SHOPIFY_FLAG_VERSION\n */\n '--version <value>'?: string\n}"
1131-
}
1132-
}
1133-
}
1134-
],
1135-
"category": "app",
1136-
"related": []
1137-
},
11381001
{
11391002
"name": "app function build",
11401003
"description": "Compiles the function in your current directory to WebAssembly (Wasm) for testing purposes.",

‎packages/app/src/cli/commands/app/execute.ts‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ import {globalFlags} from '@shopify/cli-kit/node/cli'
77
export default class Execute extends AppLinkedCommand {
88
static summary = 'Execute GraphQL queries and mutations.'
99

10+
static hidden = true
11+
1012
static description = 'Executes an Admin API GraphQL query or mutation on the specified dev store.'
1113

1214
static flags = {

‎packages/cli/README.md‎

Lines changed: 0 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,6 @@
99
* [`shopify app dev clean`](#shopify-app-dev-clean)
1010
* [`shopify app env pull`](#shopify-app-env-pull)
1111
* [`shopify app env show`](#shopify-app-env-show)
12-
* [`shopify app execute`](#shopify-app-execute)
1312
* [`shopify app function build`](#shopify-app-function-build)
1413
* [`shopify app function info`](#shopify-app-function-info)
1514
* [`shopify app function replay`](#shopify-app-function-replay)
@@ -352,35 +351,6 @@ DESCRIPTION
352351
Displays environment variables that can be used to deploy apps and app extensions.
353352
```
354353

355-
## `shopify app execute`
356-
357-
Execute GraphQL queries and mutations.
358-
359-
```
360-
USAGE
361-
$ shopify app execute [--client-id <value> | -c <value>] [--no-color] [--output-file <value>] [--path <value>]
362-
[-q <value>] [--reset | ] [-s <value>] [-v <value>] [--verbose] [--version <value>]
363-
364-
FLAGS
365-
-c, --config=<value> The name of the app configuration.
366-
-q, --query=<value> The GraphQL query or mutation, as a string.
367-
-s, --store=<value> The myshopify.com domain of the store to execute against. The app must be installed on the
368-
store. If not specified, you will be prompted to select a store.
369-
-v, --variables=<value> The values for any GraphQL variables in your query or mutation, in JSON format.
370-
--client-id=<value> The Client ID of your app.
371-
--no-color Disable color output.
372-
--output-file=<value> The file name where results should be written, instead of STDOUT.
373-
--path=<value> The path to your app directory.
374-
--reset Reset all your settings.
375-
--verbose Increase the verbosity of the output.
376-
--version=<value> The API version to use for the query or mutation. Defaults to the latest stable version.
377-
378-
DESCRIPTION
379-
Execute GraphQL queries and mutations.
380-
381-
Executes an Admin API GraphQL query or mutation on the specified dev store.
382-
```
383-
384354
## `shopify app function build`
385355

386356
Compile a function to wasm.

‎packages/cli/oclif.manifest.json‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1239,6 +1239,7 @@
12391239
}
12401240
},
12411241
"hasDynamicHelp": false,
1242+
"hidden": true,
12421243
"hiddenAliases": [
12431244
],
12441245
"id": "app:execute",

‎packages/features/snapshots/commands.txt‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,6 @@
1010
│ ├─ env
1111
│ │ ├─ pull
1212
│ │ └─ show
13-
│ ├─ execute
1413
│ ├─ function
1514
│ │ ├─ build
1615
│ │ ├─ info

0 commit comments

Comments
 (0)