Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
34 changes: 0 additions & 34 deletions docs-shopify.dev/commands/app-execute.doc.ts

This file was deleted.

This file was deleted.

68 changes: 0 additions & 68 deletions docs-shopify.dev/commands/interfaces/app-execute.interface.ts

This file was deleted.

137 changes: 0 additions & 137 deletions docs-shopify.dev/generated/generated_docs_data.json
Original file line number Diff line number Diff line change
Expand Up @@ -998,143 +998,6 @@
"category": "app",
"related": []
},
{
"name": "app execute",
"description": "Executes an Admin API GraphQL query or mutation on the specified dev store.",
"overviewPreviewDescription": "Execute GraphQL queries and mutations.",
"type": "command",
"isVisualComponent": false,
"defaultExample": {
"codeblock": {
"tabs": [
{
"title": "app execute",
"code": "shopify app execute [flags]",
"language": "bash"
}
],
"title": "app execute"
}
},
"definitions": [
{
"title": "Flags",
"description": "The following flags are available for the `app execute` command:",
"type": "appexecute",
"typeDefinitions": {
"appexecute": {
"filePath": "docs-shopify.dev/commands/interfaces/app-execute.interface.ts",
"name": "appexecute",
"description": "",
"members": [
{
"filePath": "docs-shopify.dev/commands/interfaces/app-execute.interface.ts",
"syntaxKind": "PropertySignature",
"name": "--client-id <value>",
"value": "string",
"description": "The Client ID of your app.",
"isOptional": true,
"environmentValue": "SHOPIFY_FLAG_CLIENT_ID"
},
{
"filePath": "docs-shopify.dev/commands/interfaces/app-execute.interface.ts",
"syntaxKind": "PropertySignature",
"name": "--no-color",
"value": "\"\"",
"description": "Disable color output.",
"isOptional": true,
"environmentValue": "SHOPIFY_FLAG_NO_COLOR"
},
{
"filePath": "docs-shopify.dev/commands/interfaces/app-execute.interface.ts",
"syntaxKind": "PropertySignature",
"name": "--output-file <value>",
"value": "string",
"description": "The file name where results should be written, instead of STDOUT.",
"isOptional": true,
"environmentValue": "SHOPIFY_FLAG_OUTPUT_FILE"
},
{
"filePath": "docs-shopify.dev/commands/interfaces/app-execute.interface.ts",
"syntaxKind": "PropertySignature",
"name": "--path <value>",
"value": "string",
"description": "The path to your app directory.",
"isOptional": true,
"environmentValue": "SHOPIFY_FLAG_PATH"
},
{
"filePath": "docs-shopify.dev/commands/interfaces/app-execute.interface.ts",
"syntaxKind": "PropertySignature",
"name": "--reset",
"value": "\"\"",
"description": "Reset all your settings.",
"isOptional": true,
"environmentValue": "SHOPIFY_FLAG_RESET"
},
{
"filePath": "docs-shopify.dev/commands/interfaces/app-execute.interface.ts",
"syntaxKind": "PropertySignature",
"name": "--verbose",
"value": "\"\"",
"description": "Increase the verbosity of the output.",
"isOptional": true,
"environmentValue": "SHOPIFY_FLAG_VERBOSE"
},
{
"filePath": "docs-shopify.dev/commands/interfaces/app-execute.interface.ts",
"syntaxKind": "PropertySignature",
"name": "--version <value>",
"value": "string",
"description": "The API version to use for the query or mutation. Defaults to the latest stable version.",
"isOptional": true,
"environmentValue": "SHOPIFY_FLAG_VERSION"
},
{
"filePath": "docs-shopify.dev/commands/interfaces/app-execute.interface.ts",
"syntaxKind": "PropertySignature",
"name": "-c, --config <value>",
"value": "string",
"description": "The name of the app configuration.",
"isOptional": true,
"environmentValue": "SHOPIFY_FLAG_APP_CONFIG"
},
{
"filePath": "docs-shopify.dev/commands/interfaces/app-execute.interface.ts",
"syntaxKind": "PropertySignature",
"name": "-q, --query <value>",
"value": "string",
"description": "The GraphQL query or mutation, as a string.",
"isOptional": true,
"environmentValue": "SHOPIFY_FLAG_QUERY"
},
{
"filePath": "docs-shopify.dev/commands/interfaces/app-execute.interface.ts",
"syntaxKind": "PropertySignature",
"name": "-s, --store <value>",
"value": "string",
"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.",
"isOptional": true,
"environmentValue": "SHOPIFY_FLAG_STORE"
},
{
"filePath": "docs-shopify.dev/commands/interfaces/app-execute.interface.ts",
"syntaxKind": "PropertySignature",
"name": "-v, --variables <value>",
"value": "string",
"description": "The values for any GraphQL variables in your query or mutation, in JSON format.",
"isOptional": true,
"environmentValue": "SHOPIFY_FLAG_VARIABLES"
}
],
"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}"
}
}
}
],
"category": "app",
"related": []
},
{
"name": "app function build",
"description": "Compiles the function in your current directory to WebAssembly (Wasm) for testing purposes.",
Expand Down
2 changes: 2 additions & 0 deletions packages/app/src/cli/commands/app/execute.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ import {globalFlags} from '@shopify/cli-kit/node/cli'
export default class Execute extends AppLinkedCommand {
static summary = 'Execute GraphQL queries and mutations.'

static hidden = true

static description = 'Executes an Admin API GraphQL query or mutation on the specified dev store.'

static flags = {
Expand Down
30 changes: 0 additions & 30 deletions packages/cli/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@
* [`shopify app dev clean`](#shopify-app-dev-clean)
* [`shopify app env pull`](#shopify-app-env-pull)
* [`shopify app env show`](#shopify-app-env-show)
* [`shopify app execute`](#shopify-app-execute)
* [`shopify app function build`](#shopify-app-function-build)
* [`shopify app function info`](#shopify-app-function-info)
* [`shopify app function replay`](#shopify-app-function-replay)
Expand Down Expand Up @@ -352,35 +351,6 @@ DESCRIPTION
Displays environment variables that can be used to deploy apps and app extensions.
```

## `shopify app execute`

Execute GraphQL queries and mutations.

```
USAGE
$ shopify app execute [--client-id <value> | -c <value>] [--no-color] [--output-file <value>] [--path <value>]
[-q <value>] [--reset | ] [-s <value>] [-v <value>] [--verbose] [--version <value>]

FLAGS
-c, --config=<value> The name of the app configuration.
-q, --query=<value> The GraphQL query or mutation, as a string.
-s, --store=<value> 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.
-v, --variables=<value> The values for any GraphQL variables in your query or mutation, in JSON format.
--client-id=<value> The Client ID of your app.
--no-color Disable color output.
--output-file=<value> The file name where results should be written, instead of STDOUT.
--path=<value> The path to your app directory.
--reset Reset all your settings.
--verbose Increase the verbosity of the output.
--version=<value> The API version to use for the query or mutation. Defaults to the latest stable version.

DESCRIPTION
Execute GraphQL queries and mutations.

Executes an Admin API GraphQL query or mutation on the specified dev store.
```

## `shopify app function build`

Compile a function to wasm.
Expand Down
1 change: 1 addition & 0 deletions packages/cli/oclif.manifest.json
Original file line number Diff line number Diff line change
Expand Up @@ -1239,6 +1239,7 @@
}
},
"hasDynamicHelp": false,
"hidden": true,
"hiddenAliases": [
],
"id": "app:execute",
Expand Down
1 change: 0 additions & 1 deletion packages/features/snapshots/commands.txt
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@
│ ├─ env
│ │ ├─ pull
│ │ └─ show
│ ├─ execute
│ ├─ function
│ │ ├─ build
│ │ ├─ info
Expand Down
Loading