diff --git a/docs-shopify.dev/commands/app-bulk-execute.doc.ts b/docs-shopify.dev/commands/app-bulk-execute.doc.ts new file mode 100644 index 00000000000..bf247d23688 --- /dev/null +++ b/docs-shopify.dev/commands/app-bulk-execute.doc.ts @@ -0,0 +1,38 @@ +// This is an autogenerated file. Don't edit this file manually. +import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs' + +const data: ReferenceEntityTemplateSchema = { + name: 'app bulk execute', + description: `Executes an Admin API GraphQL query or mutation on the specified dev store, as a bulk operation. + + Bulk operations allow you to process large amounts of data asynchronously. Learn more about [bulk query operations](/docs/api/usage/bulk-operations/queries) and [bulk mutation operations](/docs/api/usage/bulk-operations/imports). + + Use [\`bulk status\`](/docs/api/shopify-cli/app/app-bulk-status) to check the status of your bulk operations.`, + overviewPreviewDescription: `Execute bulk operations.`, + type: 'command', + isVisualComponent: false, + defaultExample: { + codeblock: { + tabs: [ + { + title: 'app bulk execute', + code: './examples/app-bulk-execute.example.sh', + language: 'bash', + }, + ], + title: 'app bulk execute', + }, + }, + definitions: [ + { + title: 'Flags', + description: 'The following flags are available for the `app bulk execute` command:', + type: 'appbulkexecute', + }, + ], + category: 'app', + related: [ + ], +} + +export default data \ No newline at end of file diff --git a/docs-shopify.dev/commands/app-bulk-status.doc.ts b/docs-shopify.dev/commands/app-bulk-status.doc.ts new file mode 100644 index 00000000000..60ae1c6b2d0 --- /dev/null +++ b/docs-shopify.dev/commands/app-bulk-status.doc.ts @@ -0,0 +1,38 @@ +// This is an autogenerated file. Don't edit this file manually. +import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs' + +const data: ReferenceEntityTemplateSchema = { + name: 'app bulk status', + description: `Check the status of a specific bulk operation by ID, or list all bulk operations in the last 7 days. + + Bulk operations allow you to process large amounts of data asynchronously. Learn more about [bulk query operations](/docs/api/usage/bulk-operations/queries) and [bulk mutation operations](/docs/api/usage/bulk-operations/imports). + + Use [\`bulk execute\`](/docs/api/shopify-cli/app/app-bulk-execute) to start a new bulk operation.`, + overviewPreviewDescription: `Check the status of bulk operations.`, + type: 'command', + isVisualComponent: false, + defaultExample: { + codeblock: { + tabs: [ + { + title: 'app bulk status', + code: './examples/app-bulk-status.example.sh', + language: 'bash', + }, + ], + title: 'app bulk status', + }, + }, + definitions: [ + { + title: 'Flags', + description: 'The following flags are available for the `app bulk status` command:', + type: 'appbulkstatus', + }, + ], + category: 'app', + related: [ + ], +} + +export default data \ No newline at end of file diff --git a/docs-shopify.dev/commands/app-execute.doc.ts b/docs-shopify.dev/commands/app-execute.doc.ts new file mode 100644 index 00000000000..9bbd525f6c8 --- /dev/null +++ b/docs-shopify.dev/commands/app-execute.doc.ts @@ -0,0 +1,36 @@ +// This is an autogenerated file. Don't edit this file manually. +import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs' + +const data: ReferenceEntityTemplateSchema = { + name: 'app execute', + description: `Executes an Admin API GraphQL query or mutation on the specified dev store. + + For operations that process large amounts of data, use [\`bulk execute\`](/docs/api/shopify-cli/app/app-bulk-execute) instead.`, + overviewPreviewDescription: `Execute GraphQL queries and mutations.`, + type: 'command', + isVisualComponent: false, + defaultExample: { + codeblock: { + tabs: [ + { + title: 'app execute', + code: './examples/app-execute.example.sh', + language: 'bash', + }, + ], + title: 'app execute', + }, + }, + definitions: [ + { + title: 'Flags', + description: 'The following flags are available for the `app execute` command:', + type: 'appexecute', + }, + ], + category: 'app', + related: [ + ], +} + +export default data \ No newline at end of file diff --git a/docs-shopify.dev/commands/examples/app-bulk-execute.example.sh b/docs-shopify.dev/commands/examples/app-bulk-execute.example.sh new file mode 100644 index 00000000000..96bdb985b20 --- /dev/null +++ b/docs-shopify.dev/commands/examples/app-bulk-execute.example.sh @@ -0,0 +1 @@ +shopify app bulk execute [flags] \ No newline at end of file diff --git a/docs-shopify.dev/commands/examples/app-bulk-status.example.sh b/docs-shopify.dev/commands/examples/app-bulk-status.example.sh new file mode 100644 index 00000000000..94caa5e7782 --- /dev/null +++ b/docs-shopify.dev/commands/examples/app-bulk-status.example.sh @@ -0,0 +1 @@ +shopify app bulk status [flags] \ No newline at end of file diff --git a/docs-shopify.dev/commands/examples/app-execute.example.sh b/docs-shopify.dev/commands/examples/app-execute.example.sh new file mode 100644 index 00000000000..5139767a4c7 --- /dev/null +++ b/docs-shopify.dev/commands/examples/app-execute.example.sh @@ -0,0 +1 @@ +shopify app execute [flags] \ No newline at end of file diff --git a/docs-shopify.dev/commands/interfaces/app-bulk-execute.interface.ts b/docs-shopify.dev/commands/interfaces/app-bulk-execute.interface.ts new file mode 100644 index 00000000000..5836d541822 --- /dev/null +++ b/docs-shopify.dev/commands/interfaces/app-bulk-execute.interface.ts @@ -0,0 +1,86 @@ +// This is an autogenerated file. Don't edit this file manually. +export interface appbulkexecute { + /** + * The Client ID of your app. + * @environment SHOPIFY_FLAG_CLIENT_ID + */ + '--client-id '?: string + + /** + * The name of the app configuration. + * @environment SHOPIFY_FLAG_APP_CONFIG + */ + '-c, --config '?: string + + /** + * Disable color output. + * @environment SHOPIFY_FLAG_NO_COLOR + */ + '--no-color'?: '' + + /** + * The file path where results should be written if --watch is specified. If not specified, results will be written to STDOUT. + * @environment SHOPIFY_FLAG_OUTPUT_FILE + */ + '--output-file '?: string + + /** + * The path to your app directory. + * @environment SHOPIFY_FLAG_PATH + */ + '--path '?: string + + /** + * The GraphQL query or mutation to run as a bulk operation. + * @environment SHOPIFY_FLAG_QUERY + */ + '-q, --query '?: string + + /** + * Path to a file containing the GraphQL query or mutation. Can't be used with --query. + * @environment SHOPIFY_FLAG_QUERY_FILE + */ + '--query-file '?: string + + /** + * Reset all your settings. + * @environment SHOPIFY_FLAG_RESET + */ + '--reset'?: '' + + /** + * The store domain. Must be an existing dev store. + * @environment SHOPIFY_FLAG_STORE + */ + '-s, --store '?: string + + /** + * Path to a file containing GraphQL variables in JSONL format (one JSON object per line). Can't be used with --variables. + * @environment SHOPIFY_FLAG_VARIABLE_FILE + */ + '--variable-file '?: string + + /** + * The values for any GraphQL variables in your mutation, in JSON format. Can be specified multiple times. + * @environment SHOPIFY_FLAG_VARIABLES + */ + '-v, --variables '?: string + + /** + * Increase the verbosity of the output. + * @environment SHOPIFY_FLAG_VERBOSE + */ + '--verbose'?: '' + + /** + * The API version to use for the bulk operation. If not specified, uses the latest stable version. + * @environment SHOPIFY_FLAG_VERSION + */ + '--version '?: string + + /** + * Wait for bulk operation results before exiting. Defaults to false. + * @environment SHOPIFY_FLAG_WATCH + */ + '--watch'?: '' +} diff --git a/docs-shopify.dev/commands/interfaces/app-bulk-status.interface.ts b/docs-shopify.dev/commands/interfaces/app-bulk-status.interface.ts new file mode 100644 index 00000000000..cf861aa17a6 --- /dev/null +++ b/docs-shopify.dev/commands/interfaces/app-bulk-status.interface.ts @@ -0,0 +1,50 @@ +// This is an autogenerated file. Don't edit this file manually. +export interface appbulkstatus { + /** + * The Client ID of your app. + * @environment SHOPIFY_FLAG_CLIENT_ID + */ + '--client-id '?: string + + /** + * The name of the app configuration. + * @environment SHOPIFY_FLAG_APP_CONFIG + */ + '-c, --config '?: string + + /** + * The bulk operation ID (numeric ID or full GID). If not provided, lists all bulk operations in the last 7 days. + * @environment SHOPIFY_FLAG_ID + */ + '--id '?: string + + /** + * Disable color output. + * @environment SHOPIFY_FLAG_NO_COLOR + */ + '--no-color'?: '' + + /** + * The path to your app directory. + * @environment SHOPIFY_FLAG_PATH + */ + '--path '?: string + + /** + * Reset all your settings. + * @environment SHOPIFY_FLAG_RESET + */ + '--reset'?: '' + + /** + * The store domain. Must be an existing dev store. + * @environment SHOPIFY_FLAG_STORE + */ + '-s, --store '?: string + + /** + * Increase the verbosity of the output. + * @environment SHOPIFY_FLAG_VERBOSE + */ + '--verbose'?: '' +} diff --git a/docs-shopify.dev/commands/interfaces/app-execute.interface.ts b/docs-shopify.dev/commands/interfaces/app-execute.interface.ts new file mode 100644 index 00000000000..ef1e8cb1afd --- /dev/null +++ b/docs-shopify.dev/commands/interfaces/app-execute.interface.ts @@ -0,0 +1,80 @@ +// This is an autogenerated file. Don't edit this file manually. +export interface appexecute { + /** + * The Client ID of your app. + * @environment SHOPIFY_FLAG_CLIENT_ID + */ + '--client-id '?: string + + /** + * The name of the app configuration. + * @environment SHOPIFY_FLAG_APP_CONFIG + */ + '-c, --config '?: string + + /** + * Disable color output. + * @environment SHOPIFY_FLAG_NO_COLOR + */ + '--no-color'?: '' + + /** + * The file name where results should be written, instead of STDOUT. + * @environment SHOPIFY_FLAG_OUTPUT_FILE + */ + '--output-file '?: string + + /** + * The path to your app directory. + * @environment SHOPIFY_FLAG_PATH + */ + '--path '?: string + + /** + * The GraphQL query or mutation, as a string. + * @environment SHOPIFY_FLAG_QUERY + */ + '-q, --query '?: string + + /** + * Path to a file containing the GraphQL query or mutation. Can't be used with --query. + * @environment SHOPIFY_FLAG_QUERY_FILE + */ + '--query-file '?: string + + /** + * Reset all your settings. + * @environment SHOPIFY_FLAG_RESET + */ + '--reset'?: '' + + /** + * 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. + * @environment SHOPIFY_FLAG_STORE + */ + '-s, --store '?: string + + /** + * Path to a file containing GraphQL variables in JSON format. Can't be used with --variables. + * @environment SHOPIFY_FLAG_VARIABLE_FILE + */ + '--variable-file '?: string + + /** + * The values for any GraphQL variables in your query or mutation, in JSON format. + * @environment SHOPIFY_FLAG_VARIABLES + */ + '-v, --variables '?: string + + /** + * Increase the verbosity of the output. + * @environment SHOPIFY_FLAG_VERBOSE + */ + '--verbose'?: '' + + /** + * The API version to use for the query or mutation. Defaults to the latest stable version. + * @environment SHOPIFY_FLAG_VERSION + */ + '--version '?: string +} diff --git a/docs-shopify.dev/generated/generated_docs_data.json b/docs-shopify.dev/generated/generated_docs_data.json index 0d1e110a135..9706df65e66 100644 --- a/docs-shopify.dev/generated/generated_docs_data.json +++ b/docs-shopify.dev/generated/generated_docs_data.json @@ -100,6 +100,280 @@ "category": "app", "related": [] }, + { + "name": "app bulk execute", + "description": "Executes an Admin API GraphQL query or mutation on the specified dev store, as a bulk operation.\n\n Bulk operations allow you to process large amounts of data asynchronously. Learn more about [bulk query operations](/docs/api/usage/bulk-operations/queries) and [bulk mutation operations](/docs/api/usage/bulk-operations/imports).\n\n Use [`bulk status`](/docs/api/shopify-cli/app/app-bulk-status) to check the status of your bulk operations.", + "overviewPreviewDescription": "Execute bulk operations.", + "type": "command", + "isVisualComponent": false, + "defaultExample": { + "codeblock": { + "tabs": [ + { + "title": "app bulk execute", + "code": "shopify app bulk execute [flags]", + "language": "bash" + } + ], + "title": "app bulk execute" + } + }, + "definitions": [ + { + "title": "Flags", + "description": "The following flags are available for the `app bulk execute` command:", + "type": "appbulkexecute", + "typeDefinitions": { + "appbulkexecute": { + "filePath": "docs-shopify.dev/commands/interfaces/app-bulk-execute.interface.ts", + "name": "appbulkexecute", + "description": "", + "members": [ + { + "filePath": "docs-shopify.dev/commands/interfaces/app-bulk-execute.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--client-id ", + "value": "string", + "description": "The Client ID of your app.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_CLIENT_ID" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-bulk-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-bulk-execute.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--output-file ", + "value": "string", + "description": "The file path where results should be written if --watch is specified. If not specified, results will be written to STDOUT.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_OUTPUT_FILE" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-bulk-execute.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--path ", + "value": "string", + "description": "The path to your app directory.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_PATH" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-bulk-execute.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--query-file ", + "value": "string", + "description": "Path to a file containing the GraphQL query or mutation. Can't be used with --query.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_QUERY_FILE" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-bulk-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-bulk-execute.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--variable-file ", + "value": "string", + "description": "Path to a file containing GraphQL variables in JSONL format (one JSON object per line). Can't be used with --variables.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_VARIABLE_FILE" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-bulk-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-bulk-execute.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--version ", + "value": "string", + "description": "The API version to use for the bulk operation. If not specified, uses the latest stable version.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_VERSION" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-bulk-execute.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--watch", + "value": "\"\"", + "description": "Wait for bulk operation results before exiting. Defaults to false.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_WATCH" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-bulk-execute.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-c, --config ", + "value": "string", + "description": "The name of the app configuration.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_APP_CONFIG" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-bulk-execute.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-q, --query ", + "value": "string", + "description": "The GraphQL query or mutation to run as a bulk operation.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_QUERY" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-bulk-execute.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-s, --store ", + "value": "string", + "description": "The store domain. Must be an existing dev store.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_STORE" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-bulk-execute.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-v, --variables ", + "value": "string", + "description": "The values for any GraphQL variables in your mutation, in JSON format. Can be specified multiple times.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_VARIABLES" + } + ], + "value": "export interface appbulkexecute {\n /**\n * The Client ID of your app.\n * @environment SHOPIFY_FLAG_CLIENT_ID\n */\n '--client-id '?: string\n\n /**\n * The name of the app configuration.\n * @environment SHOPIFY_FLAG_APP_CONFIG\n */\n '-c, --config '?: string\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * The file path where results should be written if --watch is specified. If not specified, results will be written to STDOUT.\n * @environment SHOPIFY_FLAG_OUTPUT_FILE\n */\n '--output-file '?: string\n\n /**\n * The path to your app directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * The GraphQL query or mutation to run as a bulk operation.\n * @environment SHOPIFY_FLAG_QUERY\n */\n '-q, --query '?: string\n\n /**\n * Path to a file containing the GraphQL query or mutation. Can't be used with --query.\n * @environment SHOPIFY_FLAG_QUERY_FILE\n */\n '--query-file '?: string\n\n /**\n * Reset all your settings.\n * @environment SHOPIFY_FLAG_RESET\n */\n '--reset'?: ''\n\n /**\n * The store domain. Must be an existing dev store.\n * @environment SHOPIFY_FLAG_STORE\n */\n '-s, --store '?: string\n\n /**\n * Path to a file containing GraphQL variables in JSONL format (one JSON object per line). Can't be used with --variables.\n * @environment SHOPIFY_FLAG_VARIABLE_FILE\n */\n '--variable-file '?: string\n\n /**\n * The values for any GraphQL variables in your mutation, in JSON format. Can be specified multiple times.\n * @environment SHOPIFY_FLAG_VARIABLES\n */\n '-v, --variables '?: 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 bulk operation. If not specified, uses the latest stable version.\n * @environment SHOPIFY_FLAG_VERSION\n */\n '--version '?: string\n\n /**\n * Wait for bulk operation results before exiting. Defaults to false.\n * @environment SHOPIFY_FLAG_WATCH\n */\n '--watch'?: ''\n}" + } + } + } + ], + "category": "app", + "related": [] + }, + { + "name": "app bulk status", + "description": "Check the status of a specific bulk operation by ID, or list all bulk operations in the last 7 days.\n\n Bulk operations allow you to process large amounts of data asynchronously. Learn more about [bulk query operations](/docs/api/usage/bulk-operations/queries) and [bulk mutation operations](/docs/api/usage/bulk-operations/imports).\n\n Use [`bulk execute`](/docs/api/shopify-cli/app/app-bulk-execute) to start a new bulk operation.", + "overviewPreviewDescription": "Check the status of bulk operations.", + "type": "command", + "isVisualComponent": false, + "defaultExample": { + "codeblock": { + "tabs": [ + { + "title": "app bulk status", + "code": "shopify app bulk status [flags]", + "language": "bash" + } + ], + "title": "app bulk status" + } + }, + "definitions": [ + { + "title": "Flags", + "description": "The following flags are available for the `app bulk status` command:", + "type": "appbulkstatus", + "typeDefinitions": { + "appbulkstatus": { + "filePath": "docs-shopify.dev/commands/interfaces/app-bulk-status.interface.ts", + "name": "appbulkstatus", + "description": "", + "members": [ + { + "filePath": "docs-shopify.dev/commands/interfaces/app-bulk-status.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--client-id ", + "value": "string", + "description": "The Client ID of your app.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_CLIENT_ID" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-bulk-status.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--id ", + "value": "string", + "description": "The bulk operation ID (numeric ID or full GID). If not provided, lists all bulk operations in the last 7 days.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_ID" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-bulk-status.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-bulk-status.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--path ", + "value": "string", + "description": "The path to your app directory.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_PATH" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-bulk-status.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-bulk-status.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-bulk-status.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-c, --config ", + "value": "string", + "description": "The name of the app configuration.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_APP_CONFIG" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-bulk-status.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-s, --store ", + "value": "string", + "description": "The store domain. Must be an existing dev store.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_STORE" + } + ], + "value": "export interface appbulkstatus {\n /**\n * The Client ID of your app.\n * @environment SHOPIFY_FLAG_CLIENT_ID\n */\n '--client-id '?: string\n\n /**\n * The name of the app configuration.\n * @environment SHOPIFY_FLAG_APP_CONFIG\n */\n '-c, --config '?: string\n\n /**\n * The bulk operation ID (numeric ID or full GID). If not provided, lists all bulk operations in the last 7 days.\n * @environment SHOPIFY_FLAG_ID\n */\n '--id '?: string\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * The path to your app directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Reset all your settings.\n * @environment SHOPIFY_FLAG_RESET\n */\n '--reset'?: ''\n\n /**\n * The store domain. Must be an existing dev store.\n * @environment SHOPIFY_FLAG_STORE\n */\n '-s, --store '?: string\n\n /**\n * Increase the verbosity of the output.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" + } + } + } + ], + "category": "app", + "related": [] + }, { "name": "app config link", "description": "Pulls app configuration from the Developer Dashboard and creates or overwrites a configuration file. You can create a new app with this command to start with a default configuration file.\n\n For more information on the format of the created TOML configuration file, refer to the [App configuration](/docs/apps/tools/cli/configuration) page.\n ", @@ -998,6 +1272,161 @@ "category": "app", "related": [] }, + { + "name": "app execute", + "description": "Executes an Admin API GraphQL query or mutation on the specified dev store.\n\n For operations that process large amounts of data, use [`bulk execute`](/docs/api/shopify-cli/app/app-bulk-execute) instead.", + "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": "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": "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": "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": "--query-file ", + "value": "string", + "description": "Path to a file containing the GraphQL query or mutation. Can't be used with --query.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_QUERY_FILE" + }, + { + "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": "--variable-file ", + "value": "string", + "description": "Path to a file containing GraphQL variables in JSON format. Can't be used with --variables.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_VARIABLE_FILE" + }, + { + "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": "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": "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": "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": "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": "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 '?: string\n\n /**\n * The name of the app configuration.\n * @environment SHOPIFY_FLAG_APP_CONFIG\n */\n '-c, --config '?: 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 '?: string\n\n /**\n * The path to your app directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * The GraphQL query or mutation, as a string.\n * @environment SHOPIFY_FLAG_QUERY\n */\n '-q, --query '?: string\n\n /**\n * Path to a file containing the GraphQL query or mutation. Can't be used with --query.\n * @environment SHOPIFY_FLAG_QUERY_FILE\n */\n '--query-file '?: 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 '?: string\n\n /**\n * Path to a file containing GraphQL variables in JSON format. Can't be used with --variables.\n * @environment SHOPIFY_FLAG_VARIABLE_FILE\n */\n '--variable-file '?: 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 '?: 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 '?: string\n}" + } + } + } + ], + "category": "app", + "related": [] + }, { "name": "app function build", "description": "Compiles the function in your current directory to WebAssembly (Wasm) for testing purposes.", diff --git a/packages/app/src/cli/commands/app/bulk/execute.ts b/packages/app/src/cli/commands/app/bulk/execute.ts index 8ea3f21dafd..9ea0c095662 100644 --- a/packages/app/src/cli/commands/app/bulk/execute.ts +++ b/packages/app/src/cli/commands/app/bulk/execute.ts @@ -7,10 +7,13 @@ import {globalFlags} from '@shopify/cli-kit/node/cli' export default class BulkExecute extends AppLinkedCommand { static summary = 'Execute bulk operations.' - static description = - 'Executes an Admin API GraphQL query or mutation on the specified dev store, as a bulk operation.' + static descriptionWithMarkdown = `Executes an Admin API GraphQL query or mutation on the specified dev store, as a bulk operation. - static hidden = true + Bulk operations allow you to process large amounts of data asynchronously. Learn more about [bulk query operations](https://shopify.dev/docs/api/usage/bulk-operations/queries) and [bulk mutation operations](https://shopify.dev/docs/api/usage/bulk-operations/imports). + + Use [\`bulk status\`](https://shopify.dev/docs/api/shopify-cli/app/app-bulk-status) to check the status of your bulk operations.` + + static description = this.descriptionWithoutMarkdown() static flags = { ...globalFlags, diff --git a/packages/app/src/cli/commands/app/bulk/status.ts b/packages/app/src/cli/commands/app/bulk/status.ts index 4b2e28951a8..e5a2e5a969b 100644 --- a/packages/app/src/cli/commands/app/bulk/status.ts +++ b/packages/app/src/cli/commands/app/bulk/status.ts @@ -13,10 +13,13 @@ import {normalizeStoreFqdn} from '@shopify/cli-kit/node/context/fqdn' export default class BulkStatus extends AppLinkedCommand { static summary = 'Check the status of bulk operations.' - static description = - 'Check the status of a specific bulk operation by ID, or list all bulk operations in the last 7 days.' + static descriptionWithMarkdown = `Check the status of a specific bulk operation by ID, or list all bulk operations in the last 7 days. - static hidden = true + Bulk operations allow you to process large amounts of data asynchronously. Learn more about [bulk query operations](https://shopify.dev/docs/api/usage/bulk-operations/queries) and [bulk mutation operations](https://shopify.dev/docs/api/usage/bulk-operations/imports). + + Use [\`bulk execute\`](https://shopify.dev/docs/api/shopify-cli/app/app-bulk-execute) to start a new bulk operation.` + + static description = this.descriptionWithoutMarkdown() static flags = { ...globalFlags, diff --git a/packages/app/src/cli/commands/app/execute.ts b/packages/app/src/cli/commands/app/execute.ts index 743e7cf565c..0de31130bf4 100644 --- a/packages/app/src/cli/commands/app/execute.ts +++ b/packages/app/src/cli/commands/app/execute.ts @@ -7,9 +7,11 @@ 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 descriptionWithMarkdown = `Executes an Admin API GraphQL query or mutation on the specified dev store. - static description = 'Executes an Admin API GraphQL query or mutation on the specified dev store.' + For operations that process large amounts of data, use [\`bulk execute\`](https://shopify.dev/docs/api/shopify-cli/app/app-bulk-execute) instead.` + + static description = this.descriptionWithoutMarkdown() static flags = { ...globalFlags, diff --git a/packages/cli/README.md b/packages/cli/README.md index c01aaaa8d26..6189d22dd45 100644 --- a/packages/cli/README.md +++ b/packages/cli/README.md @@ -1,6 +1,8 @@ # Commands * [`shopify app build`](#shopify-app-build) +* [`shopify app bulk execute`](#shopify-app-bulk-execute) +* [`shopify app bulk status`](#shopify-app-bulk-status) * [`shopify app config link`](#shopify-app-config-link) * [`shopify app config pull`](#shopify-app-config-pull) * [`shopify app config use [config] [flags]`](#shopify-app-config-use-config-flags) @@ -9,6 +11,7 @@ * [`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) @@ -118,6 +121,81 @@ DESCRIPTION extension to ensure that it's valid. ``` +## `shopify app bulk execute` + +Execute bulk operations. + +``` +USAGE + $ shopify app bulk execute [--client-id | -c ] [--no-color] [--output-file --watch] [--path + ] [-q ] [--query-file ] [--reset | ] [-s ] [--variable-file | -v ...] + [--verbose] [--version ] + +FLAGS + -c, --config= The name of the app configuration. + -q, --query= The GraphQL query or mutation to run as a bulk operation. + -s, --store= The store domain. Must be an existing dev store. + -v, --variables=... The values for any GraphQL variables in your mutation, in JSON format. Can be specified + multiple times. + --client-id= The Client ID of your app. + --no-color Disable color output. + --output-file= The file path where results should be written if --watch is specified. If not specified, + results will be written to STDOUT. + --path= The path to your app directory. + --query-file= Path to a file containing the GraphQL query or mutation. Can't be used with --query. + --reset Reset all your settings. + --variable-file= Path to a file containing GraphQL variables in JSONL format (one JSON object per line). + Can't be used with --variables. + --verbose Increase the verbosity of the output. + --version= The API version to use for the bulk operation. If not specified, uses the latest stable + version. + --watch Wait for bulk operation results before exiting. Defaults to false. + +DESCRIPTION + Execute bulk operations. + + Executes an Admin API GraphQL query or mutation on the specified dev store, as a bulk operation. + + Bulk operations allow you to process large amounts of data asynchronously. Learn more about "bulk query operations" + (https://shopify.dev/docs/api/usage/bulk-operations/queries) and "bulk mutation operations" + (https://shopify.dev/docs/api/usage/bulk-operations/imports). + + Use "`bulk status`" (https://shopify.dev/docs/api/shopify-cli/app/app-bulk-status) to check the status of your bulk + operations. +``` + +## `shopify app bulk status` + +Check the status of bulk operations. + +``` +USAGE + $ shopify app bulk status [--client-id | -c ] [--id ] [--no-color] [--path ] [--reset + | ] [-s ] [--verbose] + +FLAGS + -c, --config= The name of the app configuration. + -s, --store= The store domain. Must be an existing dev store. + --client-id= The Client ID of your app. + --id= The bulk operation ID (numeric ID or full GID). If not provided, lists all bulk operations in + the last 7 days. + --no-color Disable color output. + --path= The path to your app directory. + --reset Reset all your settings. + --verbose Increase the verbosity of the output. + +DESCRIPTION + Check the status of bulk operations. + + Check the status of a specific bulk operation by ID, or list all bulk operations in the last 7 days. + + Bulk operations allow you to process large amounts of data asynchronously. Learn more about "bulk query operations" + (https://shopify.dev/docs/api/usage/bulk-operations/queries) and "bulk mutation operations" + (https://shopify.dev/docs/api/usage/bulk-operations/imports). + + Use "`bulk execute`" (https://shopify.dev/docs/api/shopify-cli/app/app-bulk-execute) to start a new bulk operation. +``` + ## `shopify app config link` Fetch your app configuration from the Developer Dashboard. @@ -352,6 +430,42 @@ 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 | -c ] [--no-color] [--output-file ] [--path ] + [-q ] [--query-file ] [--reset | ] [-s ] [--variable-file | -v ] [--verbose] + [--version ] + +FLAGS + -c, --config= The name of the app configuration. + -q, --query= The GraphQL query or mutation, as a string. + -s, --store= 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= The values for any GraphQL variables in your query or mutation, in JSON format. + --client-id= The Client ID of your app. + --no-color Disable color output. + --output-file= The file name where results should be written, instead of STDOUT. + --path= The path to your app directory. + --query-file= Path to a file containing the GraphQL query or mutation. Can't be used with --query. + --reset Reset all your settings. + --variable-file= Path to a file containing GraphQL variables in JSON format. Can't be used with + --variables. + --verbose Increase the verbosity of the output. + --version= 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. + + For operations that process large amounts of data, use "`bulk execute`" + (https://shopify.dev/docs/api/shopify-cli/app/app-bulk-execute) instead. +``` + ## `shopify app function build` Compile a function to wasm. diff --git a/packages/cli/oclif.manifest.json b/packages/cli/oclif.manifest.json index 14650db5415..8da189e807f 100644 --- a/packages/cli/oclif.manifest.json +++ b/packages/cli/oclif.manifest.json @@ -188,7 +188,8 @@ "args": { }, "customPluginName": "@shopify/app", - "description": "Executes an Admin API GraphQL query or mutation on the specified dev store, as a bulk operation.", + "description": "Executes an Admin API GraphQL query or mutation on the specified dev store, as a bulk operation.\n\n Bulk operations allow you to process large amounts of data asynchronously. Learn more about \"bulk query operations\" (https://shopify.dev/docs/api/usage/bulk-operations/queries) and \"bulk mutation operations\" (https://shopify.dev/docs/api/usage/bulk-operations/imports).\n\n Use \"`bulk status`\" (https://shopify.dev/docs/api/shopify-cli/app/app-bulk-status) to check the status of your bulk operations.", + "descriptionWithMarkdown": "Executes an Admin API GraphQL query or mutation on the specified dev store, as a bulk operation.\n\n Bulk operations allow you to process large amounts of data asynchronously. Learn more about [bulk query operations](https://shopify.dev/docs/api/usage/bulk-operations/queries) and [bulk mutation operations](https://shopify.dev/docs/api/usage/bulk-operations/imports).\n\n Use [`bulk status`](https://shopify.dev/docs/api/shopify-cli/app/app-bulk-status) to check the status of your bulk operations.", "flags": { "client-id": { "description": "The Client ID of your app.", @@ -326,7 +327,6 @@ } }, "hasDynamicHelp": false, - "hidden": true, "hiddenAliases": [ ], "id": "app:bulk:execute", @@ -342,7 +342,8 @@ "args": { }, "customPluginName": "@shopify/app", - "description": "Check the status of a specific bulk operation by ID, or list all bulk operations in the last 7 days.", + "description": "Check the status of a specific bulk operation by ID, or list all bulk operations in the last 7 days.\n\n Bulk operations allow you to process large amounts of data asynchronously. Learn more about \"bulk query operations\" (https://shopify.dev/docs/api/usage/bulk-operations/queries) and \"bulk mutation operations\" (https://shopify.dev/docs/api/usage/bulk-operations/imports).\n\n Use \"`bulk execute`\" (https://shopify.dev/docs/api/shopify-cli/app/app-bulk-execute) to start a new bulk operation.", + "descriptionWithMarkdown": "Check the status of a specific bulk operation by ID, or list all bulk operations in the last 7 days.\n\n Bulk operations allow you to process large amounts of data asynchronously. Learn more about [bulk query operations](https://shopify.dev/docs/api/usage/bulk-operations/queries) and [bulk mutation operations](https://shopify.dev/docs/api/usage/bulk-operations/imports).\n\n Use [`bulk execute`](https://shopify.dev/docs/api/shopify-cli/app/app-bulk-execute) to start a new bulk operation.", "flags": { "client-id": { "description": "The Client ID of your app.", @@ -421,7 +422,6 @@ } }, "hasDynamicHelp": false, - "hidden": true, "hiddenAliases": [ ], "id": "app:bulk:status", @@ -1237,7 +1237,8 @@ "args": { }, "customPluginName": "@shopify/app", - "description": "Executes an Admin API GraphQL query or mutation on the specified dev store.", + "description": "Executes an Admin API GraphQL query or mutation on the specified dev store.\n\n For operations that process large amounts of data, use \"`bulk execute`\" (https://shopify.dev/docs/api/shopify-cli/app/app-bulk-execute) instead.", + "descriptionWithMarkdown": "Executes an Admin API GraphQL query or mutation on the specified dev store.\n\n For operations that process large amounts of data, use [`bulk execute`](https://shopify.dev/docs/api/shopify-cli/app/app-bulk-execute) instead.", "flags": { "client-id": { "description": "The Client ID of your app.", @@ -1365,7 +1366,6 @@ } }, "hasDynamicHelp": false, - "hidden": true, "hiddenAliases": [ ], "id": "app:execute", diff --git a/packages/features/snapshots/commands.txt b/packages/features/snapshots/commands.txt index c3e97bdf2ab..3a960471837 100644 --- a/packages/features/snapshots/commands.txt +++ b/packages/features/snapshots/commands.txt @@ -1,5 +1,8 @@ ├─ app │ ├─ build +│ ├─ bulk +│ │ ├─ execute +│ │ └─ status │ ├─ config │ │ ├─ link │ │ ├─ pull @@ -10,6 +13,7 @@ │ ├─ env │ │ ├─ pull │ │ └─ show +│ ├─ execute │ ├─ function │ │ ├─ build │ │ ├─ info