diff --git a/.changeset/tidy-command-help.md b/.changeset/tidy-command-help.md new file mode 100644 index 00000000000..f80f80e563c --- /dev/null +++ b/.changeset/tidy-command-help.md @@ -0,0 +1,4 @@ +--- +'@shopify/cli': patch +--- +Use third-person verb forms in command help summaries and opening descriptions. diff --git a/packages/app/src/cli/commands/app/app-logs/sources.ts b/packages/app/src/cli/commands/app/app-logs/sources.ts index 0d04ee8864b..843b9abf8ae 100644 --- a/packages/app/src/cli/commands/app/app-logs/sources.ts +++ b/packages/app/src/cli/commands/app/app-logs/sources.ts @@ -7,7 +7,7 @@ import AppLinkedCommand, {AppLinkedCommandOutput} from '../../../utilities/app-l import {globalFlags, jsonFlag} from '@shopify/cli-kit/node/cli' export default class Sources extends AppLinkedCommand { - static summary = 'Print out a list of sources that may be used with the logs command.' + static summary = 'Prints out a list of sources that may be used with the logs command.' static descriptionWithMarkdown = `The output source names can be used with the \`--source\` argument of \`shopify app logs\` to filter log output. Currently only function extensions are supported as sources.` diff --git a/packages/app/src/cli/commands/app/build.ts b/packages/app/src/cli/commands/app/build.ts index 71cd8839359..4ef5d68dd13 100644 --- a/packages/app/src/cli/commands/app/build.ts +++ b/packages/app/src/cli/commands/app/build.ts @@ -10,7 +10,7 @@ import {globalFlags, jsonFlag} from '@shopify/cli-kit/node/cli' import {addPublicMetadata} from '@shopify/cli-kit/node/metadata' export default class Build extends AppUnlinkedCommand { - static summary = 'Build the app, including extensions.' + static summary = 'Builds the app, including extensions.' static descriptionWithMarkdown = `This command executes the build script specified in the element's TOML file. You can specify a custom script in the file. To learn about configuration files in Shopify apps, refer to [App configuration](https://shopify.dev/docs/apps/tools/cli/configuration). diff --git a/packages/app/src/cli/commands/app/bulk/cancel.ts b/packages/app/src/cli/commands/app/bulk/cancel.ts index 466359a44ea..9451512f7a0 100644 --- a/packages/app/src/cli/commands/app/bulk/cancel.ts +++ b/packages/app/src/cli/commands/app/bulk/cancel.ts @@ -11,7 +11,7 @@ import {normalizeBulkOperationId} from '@shopify/cli-kit/node/api/bulk-operation import {normalizeStoreFqdn} from '@shopify/cli-kit/node/context/fqdn' export default class BulkCancel extends AppLinkedCommand { - static summary = 'Cancel a bulk operation.' + static summary = 'Cancels a bulk operation.' static descriptionWithMarkdown = 'Cancels a running bulk operation by ID.' diff --git a/packages/app/src/cli/commands/app/bulk/execute.ts b/packages/app/src/cli/commands/app/bulk/execute.ts index 24d150563f5..d4ccebe2470 100644 --- a/packages/app/src/cli/commands/app/bulk/execute.ts +++ b/packages/app/src/cli/commands/app/bulk/execute.ts @@ -8,7 +8,7 @@ import {prepareExecuteContext} from '../../../utilities/execute-command-helpers. import {globalFlags, jsonFlag} from '@shopify/cli-kit/node/cli' export default class BulkExecute extends AppLinkedCommand { - static summary = 'Execute bulk operations.' + static summary = 'Executes bulk operations.' static descriptionWithMarkdown = `Executes an Admin API GraphQL query or mutation on the specified store, as a bulk operation. Mutations are only allowed on dev stores. diff --git a/packages/app/src/cli/commands/app/bulk/status.ts b/packages/app/src/cli/commands/app/bulk/status.ts index a20a63ae5ea..f40d1757e74 100644 --- a/packages/app/src/cli/commands/app/bulk/status.ts +++ b/packages/app/src/cli/commands/app/bulk/status.ts @@ -11,9 +11,9 @@ import {normalizeBulkOperationId} from '@shopify/cli-kit/node/api/bulk-operation import {normalizeStoreFqdn} from '@shopify/cli-kit/node/context/fqdn' export default class BulkStatus extends AppLinkedCommand { - static summary = 'Check the status of bulk operations.' + static summary = 'Checks the status of bulk operations.' - static descriptionWithMarkdown = `Check the status of a specific bulk operation by ID, or list all bulk operations belonging to this app on this store in the last 7 days. + static descriptionWithMarkdown = `Checks the status of a specific bulk operation by ID, or lists all bulk operations belonging to this app on this store 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). diff --git a/packages/app/src/cli/commands/app/config/link.ts b/packages/app/src/cli/commands/app/config/link.ts index 75d24f612bc..2b6ff7c0c42 100644 --- a/packages/app/src/cli/commands/app/config/link.ts +++ b/packages/app/src/cli/commands/app/config/link.ts @@ -7,7 +7,7 @@ import {globalFlags, requiredIfNonInteractive} from '@shopify/cli-kit/node/cli' import {AbortError} from '@shopify/cli-kit/node/error' export default class ConfigLink extends AppLinkedCommand { - static summary = 'Fetch your app configuration from the Developer Dashboard.' + static summary = 'Fetches your app configuration from the Developer Dashboard.' static descriptionWithMarkdown = `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. diff --git a/packages/app/src/cli/commands/app/config/pull.ts b/packages/app/src/cli/commands/app/config/pull.ts index aeb7c267601..2c48e4c2914 100644 --- a/packages/app/src/cli/commands/app/config/pull.ts +++ b/packages/app/src/cli/commands/app/config/pull.ts @@ -7,7 +7,7 @@ import {globalFlags} from '@shopify/cli-kit/node/cli' import {basename} from '@shopify/cli-kit/node/path' export default class ConfigPull extends AppLinkedCommand { - static summary = 'Refresh an already-linked app configuration without prompts.' + static summary = 'Refreshes an already-linked app configuration without prompts.' static descriptionWithMarkdown = `Pulls the latest configuration from the already-linked Shopify app and updates the selected configuration file. diff --git a/packages/app/src/cli/commands/app/config/use.ts b/packages/app/src/cli/commands/app/config/use.ts index 5ab6dd8200a..f36880e35f6 100644 --- a/packages/app/src/cli/commands/app/config/use.ts +++ b/packages/app/src/cli/commands/app/config/use.ts @@ -11,7 +11,7 @@ import {globalFlags} from '@shopify/cli-kit/node/cli' const {config, ...appFlagsWithoutConfig} = appFlags export default class ConfigUse extends AppUnlinkedCommand { - static summary = 'Activate an app configuration.' + static summary = 'Activates an app configuration.' static descriptionWithMarkdown = `Sets default configuration when you run app-related CLI commands. If you omit the \`config-name\` parameter, then you'll be prompted to choose from the configuration files in your project.` diff --git a/packages/app/src/cli/commands/app/config/validate.ts b/packages/app/src/cli/commands/app/config/validate.ts index 0a77f195952..ae1501f55da 100644 --- a/packages/app/src/cli/commands/app/config/validate.ts +++ b/packages/app/src/cli/commands/app/config/validate.ts @@ -21,7 +21,7 @@ async function recordValidationFailure(issueCount: number, fileCount: number) { } export default class Validate extends AppLinkedCommand { - static summary = 'Validate your app configuration and extensions.' + static summary = 'Validates your app configuration and extensions.' static descriptionWithMarkdown = `Validates the selected app configuration file and all extension configurations against their schemas and reports any errors found.` diff --git a/packages/app/src/cli/commands/app/demo/watcher.ts b/packages/app/src/cli/commands/app/demo/watcher.ts index 10892e8456a..9dfadd75be4 100644 --- a/packages/app/src/cli/commands/app/demo/watcher.ts +++ b/packages/app/src/cli/commands/app/demo/watcher.ts @@ -8,7 +8,7 @@ import {outputInfo} from '@shopify/cli-kit/node/output' import {endHRTimeInMs} from '@shopify/cli-kit/node/hrtime' export default class DemoWatcher extends AppLinkedCommand { - static summary = 'Watch and prints out changes to an app.' + static summary = 'Watches and prints out changes to an app.' static hidden = true static flags = { diff --git a/packages/app/src/cli/commands/app/deploy.ts b/packages/app/src/cli/commands/app/deploy.ts index 7de8381964b..504908b3ccd 100644 --- a/packages/app/src/cli/commands/app/deploy.ts +++ b/packages/app/src/cli/commands/app/deploy.ts @@ -13,7 +13,7 @@ import {addPublicMetadata} from '@shopify/cli-kit/node/metadata' import type {NonTTYFlagRequirement} from '@shopify/cli-kit/node/base-command' export default class Deploy extends AppLinkedCommand { - static summary = 'Deploy your Shopify app.' + static summary = 'Deploys your Shopify app.' static descriptionWithMarkdown = `[Builds the app](https://shopify.dev/docs/api/shopify-cli/app/app-build), then deploys your app configuration and extensions. diff --git a/packages/app/src/cli/commands/app/dev.ts b/packages/app/src/cli/commands/app/dev.ts index 6fe12af0385..434d6d9c2a6 100644 --- a/packages/app/src/cli/commands/app/dev.ts +++ b/packages/app/src/cli/commands/app/dev.ts @@ -15,7 +15,7 @@ export default class Dev extends AppLinkedCommand { return true } - static summary = 'Run the app.' + static summary = 'Runs the app.' static descriptionWithMarkdown = `Builds and previews your app on a dev store, and watches for changes. [Read more about testing apps locally](https://shopify.dev/docs/apps/build/cli-for-apps/test-apps-locally).` diff --git a/packages/app/src/cli/commands/app/dev/clean.ts b/packages/app/src/cli/commands/app/dev/clean.ts index e5054492159..13aaddb82a3 100644 --- a/packages/app/src/cli/commands/app/dev/clean.ts +++ b/packages/app/src/cli/commands/app/dev/clean.ts @@ -12,7 +12,7 @@ import {normalizeStoreFqdn} from '@shopify/cli-kit/node/context/fqdn' export default class DevClean extends AppLinkedCommand { static summary = 'Cleans up the dev preview from the selected store.' - static descriptionWithMarkdown = `Stop the dev preview that was started with \`shopify app dev\`. + static descriptionWithMarkdown = `Stops the dev preview that was started with \`shopify app dev\`. It restores the app's active version to the selected development store. ` diff --git a/packages/app/src/cli/commands/app/env/pull.ts b/packages/app/src/cli/commands/app/env/pull.ts index dc0c89c29a0..cd0d64cce26 100644 --- a/packages/app/src/cli/commands/app/env/pull.ts +++ b/packages/app/src/cli/commands/app/env/pull.ts @@ -9,7 +9,7 @@ import {outputResult} from '@shopify/cli-kit/node/output' import {resolvePath} from '@shopify/cli-kit/node/path' export default class EnvPull extends AppLinkedCommand { - static summary = 'Pull app and extensions environment variables.' + static summary = 'Pulls app and extensions environment variables.' static descriptionWithMarkdown = `Creates or updates an \`.env\` files that contains app and app extension environment variables. diff --git a/packages/app/src/cli/commands/app/env/show.ts b/packages/app/src/cli/commands/app/env/show.ts index 73448ab9a95..9060b2fd048 100644 --- a/packages/app/src/cli/commands/app/env/show.ts +++ b/packages/app/src/cli/commands/app/env/show.ts @@ -6,7 +6,7 @@ import {globalFlags} from '@shopify/cli-kit/node/cli' import {outputResult} from '@shopify/cli-kit/node/output' export default class EnvShow extends AppLinkedCommand { - static summary = 'Display app and extensions environment variables.' + static summary = 'Displays app and extensions environment variables.' static descriptionWithMarkdown = `Displays environment variables that can be used to deploy apps and app extensions.` diff --git a/packages/app/src/cli/commands/app/execute.ts b/packages/app/src/cli/commands/app/execute.ts index 51c692f3e77..57e2a29f22b 100644 --- a/packages/app/src/cli/commands/app/execute.ts +++ b/packages/app/src/cli/commands/app/execute.ts @@ -7,7 +7,7 @@ import {prepareExecuteContext} from '../../utilities/execute-command-helpers.js' import {globalFlags, jsonFlag} from '@shopify/cli-kit/node/cli' export default class Execute extends AppLinkedCommand { - static summary = 'Execute GraphQL queries and mutations.' + static summary = 'Executes GraphQL queries and mutations.' static descriptionWithMarkdown = `Executes an Admin API GraphQL query or mutation on the specified store. Mutations are only allowed on dev stores. diff --git a/packages/app/src/cli/commands/app/function/build.ts b/packages/app/src/cli/commands/app/function/build.ts index f7a4af4c9fb..a66a9bd1b3e 100644 --- a/packages/app/src/cli/commands/app/function/build.ts +++ b/packages/app/src/cli/commands/app/function/build.ts @@ -7,7 +7,7 @@ import {globalFlags} from '@shopify/cli-kit/node/cli' import {renderSuccess} from '@shopify/cli-kit/node/ui' export default class FunctionBuild extends AppUnlinkedCommand { - static summary = 'Compile a function to wasm.' + static summary = 'Compiles a function to wasm.' static descriptionWithMarkdown = `Compiles the function in your current directory to WebAssembly (Wasm) for testing purposes.` diff --git a/packages/app/src/cli/commands/app/function/info.ts b/packages/app/src/cli/commands/app/function/info.ts index 063710dd5a9..b9f3aa6cd33 100644 --- a/packages/app/src/cli/commands/app/function/info.ts +++ b/packages/app/src/cli/commands/app/function/info.ts @@ -9,7 +9,7 @@ import {outputResult} from '@shopify/cli-kit/node/output' import {AlertCustomSection, renderInfo} from '@shopify/cli-kit/node/ui' export default class FunctionInfo extends AppUnlinkedCommand { - static summary = 'Print basic information about your function.' + static summary = 'Prints basic information about your function.' static descriptionWithMarkdown = `The information returned includes the following: diff --git a/packages/app/src/cli/commands/app/function/run.ts b/packages/app/src/cli/commands/app/function/run.ts index 8ca2eaca737..97f4fb7a4f6 100644 --- a/packages/app/src/cli/commands/app/function/run.ts +++ b/packages/app/src/cli/commands/app/function/run.ts @@ -11,7 +11,7 @@ import {outputDebug} from '@shopify/cli-kit/node/output' const DEFAULT_FUNCTION_EXPORT = '_start' export default class FunctionRun extends AppUnlinkedCommand { - static summary = 'Run a function locally for testing.' + static summary = 'Runs a function locally for testing.' static descriptionWithMarkdown = `Runs the function from your current directory for [testing purposes](https://shopify.dev/docs/apps/functions/testing-and-debugging). To learn how you can monitor and debug functions when errors occur, refer to [Shopify Functions error handling](https://shopify.dev/docs/api/functions/errors).` diff --git a/packages/app/src/cli/commands/app/function/schema.ts b/packages/app/src/cli/commands/app/function/schema.ts index e98a62810c2..76b0e8435dc 100644 --- a/packages/app/src/cli/commands/app/function/schema.ts +++ b/packages/app/src/cli/commands/app/function/schema.ts @@ -7,7 +7,7 @@ import {Flags} from '@oclif/core' import {globalFlags} from '@shopify/cli-kit/node/cli' export default class FetchSchema extends AppLinkedCommand { - static summary = 'Fetch the latest GraphQL schema for a function.' + static summary = 'Fetches the latest GraphQL schema for a function.' static descriptionWithMarkdown = `Generates the latest [GraphQL schema](https://shopify.dev/docs/apps/functions/input-output#graphql-schema) for a function in your app. Run this command from the function directory. diff --git a/packages/app/src/cli/commands/app/function/typegen.ts b/packages/app/src/cli/commands/app/function/typegen.ts index 9c81f39d7ee..611930d61de 100644 --- a/packages/app/src/cli/commands/app/function/typegen.ts +++ b/packages/app/src/cli/commands/app/function/typegen.ts @@ -7,7 +7,7 @@ import {globalFlags} from '@shopify/cli-kit/node/cli' import {renderSuccess} from '@shopify/cli-kit/node/ui' export default class FunctionTypegen extends AppUnlinkedCommand { - static summary = 'Generate GraphQL types for a function.' + static summary = 'Generates GraphQL types for a function.' static descriptionWithMarkdown = `Creates GraphQL types based on your [input query](https://shopify.dev/docs/apps/functions/input-output#input) for a function. Supports JavaScript functions out of the box, or any language via the \`build.typegen_command\` configuration.` diff --git a/packages/app/src/cli/commands/app/generate/extension.ts b/packages/app/src/cli/commands/app/generate/extension.ts index 98d482b5e44..6ccb3792178 100644 --- a/packages/app/src/cli/commands/app/generate/extension.ts +++ b/packages/app/src/cli/commands/app/generate/extension.ts @@ -8,7 +8,7 @@ import {Flags} from '@oclif/core' import {globalFlags, requiredIfNonInteractive} from '@shopify/cli-kit/node/cli' export default class AppGenerateExtension extends AppLinkedCommand { - static summary = 'Generate a new app Extension.' + static summary = 'Generates a new app Extension.' static descriptionWithMarkdown = `Generates a new [app extension](https://shopify.dev/docs/apps/build/app-extensions). For a list of app extensions that you can generate using this command, refer to [Supported extensions](https://shopify.dev/docs/apps/build/app-extensions/list-of-app-extensions). diff --git a/packages/app/src/cli/commands/app/graphiql.ts b/packages/app/src/cli/commands/app/graphiql.ts index 7a1d730abfa..0816444ef63 100644 --- a/packages/app/src/cli/commands/app/graphiql.ts +++ b/packages/app/src/cli/commands/app/graphiql.ts @@ -7,7 +7,7 @@ import {globalFlags, portFlag} from '@shopify/cli-kit/node/cli' import {Flags} from '@oclif/core' export default class AppGraphiQL extends AppLinkedCommand { - static summary = 'Open a local GraphiQL UI for your app and store.' + static summary = 'Opens a local GraphiQL UI for your app and store.' static descriptionWithMarkdown = `Opens an authenticated Admin API GraphiQL UI for your app and selected store. diff --git a/packages/app/src/cli/commands/app/import/channel-config.ts b/packages/app/src/cli/commands/app/import/channel-config.ts index f0602b2f0ba..0b18c9dcdd2 100644 --- a/packages/app/src/cli/commands/app/import/channel-config.ts +++ b/packages/app/src/cli/commands/app/import/channel-config.ts @@ -11,7 +11,7 @@ export default class ImportChannelConfig extends AppLinkedCommand { // Only available to allowlisted channel partners for now static hidden = true - static summary = "Import your app's default channel spec as a channel_config extension." + static summary = "Imports your app's default channel spec as a channel_config extension." static descriptionWithMarkdown = `Imports the Shopify-authored channel spec for your app as a \`channel_config\` extension. diff --git a/packages/app/src/cli/commands/app/import/custom-data-definitions.ts b/packages/app/src/cli/commands/app/import/custom-data-definitions.ts index ff586cc6024..f15a20211ea 100644 --- a/packages/app/src/cli/commands/app/import/custom-data-definitions.ts +++ b/packages/app/src/cli/commands/app/import/custom-data-definitions.ts @@ -13,9 +13,9 @@ import {renderSingleTask} from '@shopify/cli-kit/node/ui' import {outputContent} from '@shopify/cli-kit/node/output' export default class ImportCustomDataDefinitions extends AppLinkedCommand { - static summary = 'Import metafield and metaobject definitions.' + static summary = 'Imports metafield and metaobject definitions.' - static descriptionWithMarkdown = `Import metafield and metaobject definitions from your development store. [Read more about declarative custom data definitions](https://shopify.dev/docs/apps/build/custom-data/declarative-custom-data-definitions).` + static descriptionWithMarkdown = `Imports metafield and metaobject definitions from your development store. [Read more about declarative custom data definitions](https://shopify.dev/docs/apps/build/custom-data/declarative-custom-data-definitions).` static get jsonOutputSchema() { return importCustomDataDefinitionsJsonOutputSchema diff --git a/packages/app/src/cli/commands/app/import/dashboard-extensions.ts b/packages/app/src/cli/commands/app/import/dashboard-extensions.ts index ca75a7778b9..6c5f7d26c16 100644 --- a/packages/app/src/cli/commands/app/import/dashboard-extensions.ts +++ b/packages/app/src/cli/commands/app/import/dashboard-extensions.ts @@ -28,7 +28,7 @@ import {globalFlags, jsonFlag} from '@shopify/cli-kit/node/cli' import {renderSuccess} from '@shopify/cli-kit/node/ui' export default class ImportDashboardExtensions extends AppLinkedCommand { - static descriptionWithMarkdown = 'Import dashboard-managed extensions into your app.' + static descriptionWithMarkdown = 'Imports dashboard-managed extensions into your app.' static get jsonOutputSchema() { return importDashboardExtensionsJsonOutputSchema diff --git a/packages/app/src/cli/commands/app/info.ts b/packages/app/src/cli/commands/app/info.ts index c809d22fd10..b20cebd940c 100644 --- a/packages/app/src/cli/commands/app/info.ts +++ b/packages/app/src/cli/commands/app/info.ts @@ -8,7 +8,7 @@ import {Flags} from '@oclif/core' import {globalFlags, jsonFlag} from '@shopify/cli-kit/node/cli' export default class AppInfo extends AppLinkedCommand { - static summary = 'Print basic information about your app and extensions.' + static summary = 'Prints basic information about your app and extensions.' static descriptionWithMarkdown = `The information returned includes the following: diff --git a/packages/app/src/cli/commands/app/init.ts b/packages/app/src/cli/commands/app/init.ts index 6272a0d31cc..1905b4f6b5c 100644 --- a/packages/app/src/cli/commands/app/init.ts +++ b/packages/app/src/cli/commands/app/init.ts @@ -25,7 +25,7 @@ export default class Init extends AppLinkedCommand { return true } - static summary?: string | undefined = 'Create a new app project' + static summary?: string | undefined = 'Creates a new app project' static examples = [ '<%= config.bin %> <%= command.id %> --name my-app --organization-id 123 --template reactRouter --flavor typescript', diff --git a/packages/app/src/cli/commands/app/logs.ts b/packages/app/src/cli/commands/app/logs.ts index 54539ec1275..9b65f92802a 100644 --- a/packages/app/src/cli/commands/app/logs.ts +++ b/packages/app/src/cli/commands/app/logs.ts @@ -9,7 +9,7 @@ import {normalizeStoreFqdn} from '@shopify/cli-kit/node/context/fqdn' import {globalFlags, jsonFlag} from '@shopify/cli-kit/node/cli' export default class Logs extends AppLinkedCommand { - static summary = 'Stream detailed logs for your Shopify app.' + static summary = 'Streams detailed logs for your Shopify app.' static descriptionWithMarkdown = ` Opens a real-time stream of detailed app logs from the selected app and store. diff --git a/packages/app/src/cli/commands/app/release.ts b/packages/app/src/cli/commands/app/release.ts index 556872645da..9750b947c10 100644 --- a/packages/app/src/cli/commands/app/release.ts +++ b/packages/app/src/cli/commands/app/release.ts @@ -8,7 +8,7 @@ import {addPublicMetadata} from '@shopify/cli-kit/node/metadata' import type {NonTTYFlagRequirement} from '@shopify/cli-kit/node/base-command' export default class Release extends AppLinkedCommand { - static summary = 'Release an app version.' + static summary = 'Releases an app version.' static usage = `app release --version ` diff --git a/packages/app/src/cli/commands/app/security/check.ts b/packages/app/src/cli/commands/app/security/check.ts index 7651fe51a97..c82eb8d002f 100644 --- a/packages/app/src/cli/commands/app/security/check.ts +++ b/packages/app/src/cli/commands/app/security/check.ts @@ -7,7 +7,7 @@ import {globalFlags} from '@shopify/cli-kit/node/cli' export default class SecurityCheck extends BaseCommand { static summary = - 'Check an app for Shopify-specific security issues and write deterministic-findings.json and agent-checks.json.' + 'Checks an app for Shopify-specific security issues and writes deterministic-findings.json and agent-checks.json.' static descriptionWithMarkdown = `Runs an app security check locally and writes \`deterministic-findings.json\` and \`agent-checks.json\` to the results directory, \`.shopify/app-security//\`. The results key is \`--client-id\` when you pass it, and otherwise the name of the app configuration file without \`.toml\`; the other \`app security\` commands take the same selection flags and find the same directory. Every run replaces both files, so it's always safe to run the check again. diff --git a/packages/app/src/cli/commands/app/security/clean.ts b/packages/app/src/cli/commands/app/security/clean.ts index 10207761c1a..7c4edfb9da8 100644 --- a/packages/app/src/cli/commands/app/security/clean.ts +++ b/packages/app/src/cli/commands/app/security/clean.ts @@ -7,7 +7,7 @@ import BaseCommand from '@shopify/cli-kit/node/base-command' import {globalFlags} from '@shopify/cli-kit/node/cli' export default class SecurityClean extends BaseCommand { - static summary = 'Remove local app security check results.' + static summary = 'Removes local app security check results.' static descriptionWithMarkdown = `Deletes the results directory, \`.shopify/app-security//\`, without asking. The results key is \`--client-id\` when you pass it, and otherwise the name of the app configuration file without \`.toml\`. Other results directories are left alone. Prints each removed path. diff --git a/packages/app/src/cli/commands/app/security/instructions.ts b/packages/app/src/cli/commands/app/security/instructions.ts index 1b97d8d3c24..e88f81adb77 100644 --- a/packages/app/src/cli/commands/app/security/instructions.ts +++ b/packages/app/src/cli/commands/app/security/instructions.ts @@ -8,7 +8,7 @@ import {globalFlags} from '@shopify/cli-kit/node/cli' import {resolvePath} from '@shopify/cli-kit/node/path' export default class SecurityInstructions extends BaseCommand { - static summary = 'Provide app security check instructions to a coding agent.' + static summary = 'Provides app security check instructions to a coding agent.' static descriptionWithMarkdown = `Prints the complete workflow that a coding agent should follow to review app security check results. diff --git a/packages/app/src/cli/commands/app/security/record.ts b/packages/app/src/cli/commands/app/security/record.ts index 73645b7318d..25b628495a0 100644 --- a/packages/app/src/cli/commands/app/security/record.ts +++ b/packages/app/src/cli/commands/app/security/record.ts @@ -6,7 +6,7 @@ import BaseCommand from '@shopify/cli-kit/node/base-command' import {globalFlags} from '@shopify/cli-kit/node/cli' export default class SecurityRecord extends BaseCommand { - static summary = 'Record agent findings from an app security check.' + static summary = 'Records agent findings from an app security check.' static descriptionWithMarkdown = `Reads a coding agent's complete findings document from stdin, validates it, and replaces \`agent-findings.json\` in the results directory, \`.shopify/app-security//\`. The results key is \`--client-id\` when you pass it, and otherwise the name of the app configuration file without \`.toml\`. \`--client-id\` is checked against your Shopify account before anything is read, so it needs you to be logged in. diff --git a/packages/app/src/cli/commands/app/security/review.ts b/packages/app/src/cli/commands/app/security/review.ts index ab878717c8d..8523dc8af36 100644 --- a/packages/app/src/cli/commands/app/security/review.ts +++ b/packages/app/src/cli/commands/app/security/review.ts @@ -6,7 +6,7 @@ import BaseCommand from '@shopify/cli-kit/node/base-command' import {globalFlags} from '@shopify/cli-kit/node/cli' export default class SecurityReview extends BaseCommand { - static summary = 'Show the combined app security check results.' + static summary = 'Shows the combined app security check results.' static descriptionWithMarkdown = `Combines the deterministic results (\`deterministic-findings.json\`, written by \`shopify app security check\`) with the recorded agent results (\`agent-findings.json\`, written by \`shopify app security record\`) and shows one view of every check: its findings, status and source. Both files are in the results directory, \`.shopify/app-security//\`. \`--client-id\` is checked against your Shopify account before any results are read, so it needs you to be logged in. diff --git a/packages/app/src/cli/commands/app/versions/list.ts b/packages/app/src/cli/commands/app/versions/list.ts index 5f39b05a436..66a4b3064fd 100644 --- a/packages/app/src/cli/commands/app/versions/list.ts +++ b/packages/app/src/cli/commands/app/versions/list.ts @@ -7,7 +7,7 @@ import {linkedAppContext} from '../../../services/app-context.js' import {globalFlags, jsonFlag} from '@shopify/cli-kit/node/cli' export default class VersionsList extends AppLinkedCommand { - static summary = 'List deployed versions of your app.' + static summary = 'Lists deployed versions of your app.' static descriptionWithMarkdown = `Lists the deployed app versions. An app version is a snapshot of your app extensions.` diff --git a/packages/app/src/cli/commands/app/webhook/trigger.ts b/packages/app/src/cli/commands/app/webhook/trigger.ts index 050cbbbb87d..4b6e43898ca 100644 --- a/packages/app/src/cli/commands/app/webhook/trigger.ts +++ b/packages/app/src/cli/commands/app/webhook/trigger.ts @@ -10,7 +10,7 @@ import {Flags} from '@oclif/core' import {globalFlags, jsonFlag, requiredIfNonInteractive} from '@shopify/cli-kit/node/cli' export default class WebhookTrigger extends AppLinkedCommand { - static summary = 'Trigger delivery of a sample webhook topic payload to a designated address.' + static summary = 'Triggers delivery of a sample webhook topic payload to a designated address.' static descriptionWithMarkdown = ` Triggers the delivery of a sample Admin API event topic payload to a designated address. diff --git a/packages/app/src/cli/commands/organization/list.ts b/packages/app/src/cli/commands/organization/list.ts index 4fb68679f87..5dbe52059fc 100644 --- a/packages/app/src/cli/commands/organization/list.ts +++ b/packages/app/src/cli/commands/organization/list.ts @@ -8,7 +8,7 @@ import BaseCommand from '@shopify/cli-kit/node/base-command' export default class OrganizationList extends BaseCommand { static baseFlags = {...BaseCommand.baseFlags, ...authAliasFlag} - static summary = 'List Shopify organizations you have access to.' + static summary = 'Lists Shopify organizations you have access to.' static descriptionWithMarkdown = `Lists the Shopify organizations that you have access to, along with their organization IDs.` diff --git a/packages/cli/README.md b/packages/cli/README.md index b2fa501c3b2..608d64eaf6c 100644 --- a/packages/cli/README.md +++ b/packages/cli/README.md @@ -126,7 +126,7 @@ ## `shopify app build` -Build the app, including extensions. +Builds the app, including extensions. ``` USAGE @@ -179,7 +179,7 @@ FLAGS [env: SHOPIFY_FLAG_VERBOSE] DESCRIPTION - Build the app, including extensions. + Builds the app, including extensions. This command executes the build script specified in the element's TOML file. You can specify a custom script in the file. To learn about configuration files in Shopify apps, refer to "App configuration" @@ -214,7 +214,7 @@ DESCRIPTION ## `shopify app bulk cancel` -Cancel a bulk operation. +Cancels a bulk operation. ``` USAGE @@ -271,7 +271,7 @@ FLAGS [env: SHOPIFY_FLAG_VERBOSE] DESCRIPTION - Cancel a bulk operation. + Cancels a bulk operation. Cancels a running bulk operation by ID. @@ -404,7 +404,7 @@ DESCRIPTION ## `shopify app bulk execute` -Execute bulk operations. +Executes bulk operations. ``` USAGE @@ -488,7 +488,7 @@ FLAGS [env: SHOPIFY_FLAG_WATCH] DESCRIPTION - Execute bulk operations. + Executes bulk operations. Executes an Admin API GraphQL query or mutation on the specified store, as a bulk operation. Mutations are only allowed on dev stores. @@ -673,7 +673,7 @@ DESCRIPTION ## `shopify app bulk status` -Check the status of bulk operations. +Checks the status of bulk operations. ``` USAGE @@ -731,9 +731,9 @@ FLAGS [env: SHOPIFY_FLAG_VERBOSE] DESCRIPTION - Check the status of bulk operations. + Checks the status of bulk operations. - Check the status of a specific bulk operation by ID, or list all bulk operations belonging to this app on this store + Checks the status of a specific bulk operation by ID, or lists all bulk operations belonging to this app on this store in the last 7 days. Bulk operations allow you to process large amounts of data asynchronously. Learn more about "bulk query operations" @@ -967,7 +967,7 @@ DESCRIPTION ## `shopify app config link` -Fetch your app configuration from the Developer Dashboard. +Fetches your app configuration from the Developer Dashboard. ``` USAGE @@ -1021,7 +1021,7 @@ FLAGS [env: SHOPIFY_FLAG_VERBOSE] DESCRIPTION - Fetch your app configuration from the Developer Dashboard. + Fetches your app configuration from the Developer Dashboard. 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. @@ -1032,7 +1032,7 @@ DESCRIPTION ## `shopify app config pull` -Refresh an already-linked app configuration without prompts. +Refreshes an already-linked app configuration without prompts. ``` USAGE @@ -1077,7 +1077,7 @@ FLAGS [env: SHOPIFY_FLAG_VERBOSE] DESCRIPTION - Refresh an already-linked app configuration without prompts. + Refreshes an already-linked app configuration without prompts. Pulls the latest configuration from the already-linked Shopify app and updates the selected configuration file. @@ -1087,7 +1087,7 @@ DESCRIPTION ## `shopify app config use [config] [flags]` -Activate an app configuration. +Activates an app configuration. ``` USAGE @@ -1130,7 +1130,7 @@ FLAGS [env: SHOPIFY_FLAG_VERBOSE] DESCRIPTION - Activate an app configuration. + Activates an app configuration. Sets default configuration when you run app-related CLI commands. If you omit the `config-name` parameter, then you'll be prompted to choose from the configuration files in your project. @@ -1138,7 +1138,7 @@ DESCRIPTION ## `shopify app config validate` -Validate your app configuration and extensions. +Validates your app configuration and extensions. ``` USAGE @@ -1187,7 +1187,7 @@ FLAGS [env: SHOPIFY_FLAG_VERBOSE] DESCRIPTION - Validate your app configuration and extensions. + Validates your app configuration and extensions. Validates the selected app configuration file and all extension configurations against their schemas and reports any errors found. @@ -1195,7 +1195,7 @@ DESCRIPTION ## `shopify app deploy` -Deploy your Shopify app. +Deploys your Shopify app. ``` USAGE @@ -1281,7 +1281,7 @@ FLAGS [env: SHOPIFY_FLAG_VERSION] DESCRIPTION - Deploy your Shopify app. + Deploys your Shopify app. "Builds the app" (https://shopify.dev/docs/api/shopify-cli/app/app-build), then deploys your app configuration and extensions. @@ -1534,7 +1534,7 @@ DESCRIPTION ## `shopify app dev` -Run the app. +Runs the app. ``` USAGE @@ -1641,7 +1641,7 @@ FLAGS [env: SHOPIFY_FLAG_VERBOSE] DESCRIPTION - Run the app. + Runs the app. Builds and previews your app on a dev store, and watches for changes. "Read more about testing apps locally" (https://shopify.dev/docs/apps/build/cli-for-apps/test-apps-locally). @@ -1705,7 +1705,7 @@ FLAGS DESCRIPTION Cleans up the dev preview from the selected store. - Stop the dev preview that was started with `shopify app dev`. + Stops the dev preview that was started with `shopify app dev`. It restores the app's active version to the selected development store. @@ -1766,7 +1766,7 @@ DESCRIPTION ## `shopify app env pull` -Pull app and extensions environment variables. +Pulls app and extensions environment variables. ``` USAGE @@ -1815,7 +1815,7 @@ FLAGS [env: SHOPIFY_FLAG_VERBOSE] DESCRIPTION - Pull app and extensions environment variables. + Pulls app and extensions environment variables. Creates or updates an `.env` files that contains app and app extension environment variables. @@ -1825,7 +1825,7 @@ DESCRIPTION ## `shopify app env show` -Display app and extensions environment variables. +Displays app and extensions environment variables. ``` USAGE @@ -1870,14 +1870,14 @@ FLAGS [env: SHOPIFY_FLAG_VERBOSE] DESCRIPTION - Display app and extensions environment variables. + Displays app and extensions environment variables. Displays environment variables that can be used to deploy apps and app extensions. ``` ## `shopify app execute` -Execute GraphQL queries and mutations. +Executes GraphQL queries and mutations. ``` USAGE @@ -1956,7 +1956,7 @@ FLAGS [env: SHOPIFY_FLAG_VERSION] DESCRIPTION - Execute GraphQL queries and mutations. + Executes GraphQL queries and mutations. Executes an Admin API GraphQL query or mutation on the specified store. Mutations are only allowed on dev stores. @@ -2035,7 +2035,7 @@ DESCRIPTION ## `shopify app function build` -Compile a function to wasm. +Compiles a function to wasm. ``` USAGE @@ -2080,14 +2080,14 @@ FLAGS [env: SHOPIFY_FLAG_VERBOSE] DESCRIPTION - Compile a function to wasm. + Compiles a function to wasm. Compiles the function in your current directory to WebAssembly (Wasm) for testing purposes. ``` ## `shopify app function info` -Print basic information about your function. +Prints basic information about your function. ``` USAGE @@ -2136,7 +2136,7 @@ FLAGS [env: SHOPIFY_FLAG_VERBOSE] DESCRIPTION - Print basic information about your function. + Prints basic information about your function. The information returned includes the following: @@ -2218,7 +2218,7 @@ DESCRIPTION ## `shopify app function run` -Run a function locally for testing. +Runs a function locally for testing. ``` USAGE @@ -2279,7 +2279,7 @@ FLAGS [env: SHOPIFY_FLAG_VERBOSE] DESCRIPTION - Run a function locally for testing. + Runs a function locally for testing. Runs the function from your current directory for "testing purposes" (https://shopify.dev/docs/apps/functions/testing-and-debugging). To learn how you can monitor and debug functions when @@ -2288,7 +2288,7 @@ DESCRIPTION ## `shopify app function schema` -Fetch the latest GraphQL schema for a function. +Fetches the latest GraphQL schema for a function. ``` USAGE @@ -2337,7 +2337,7 @@ FLAGS [env: SHOPIFY_FLAG_VERBOSE] DESCRIPTION - Fetch the latest GraphQL schema for a function. + Fetches the latest GraphQL schema for a function. Generates the latest "GraphQL schema" (https://shopify.dev/docs/apps/functions/input-output#graphql-schema) for a function in your app. Run this command from the function directory. @@ -2348,7 +2348,7 @@ DESCRIPTION ## `shopify app function typegen` -Generate GraphQL types for a function. +Generates GraphQL types for a function. ``` USAGE @@ -2393,7 +2393,7 @@ FLAGS [env: SHOPIFY_FLAG_VERBOSE] DESCRIPTION - Generate GraphQL types for a function. + Generates GraphQL types for a function. Creates GraphQL types based on your "input query" (https://shopify.dev/docs/apps/functions/input-output#input) for a function. Supports JavaScript functions out of the box, or any language via the `build.typegen_command` configuration. @@ -2401,7 +2401,7 @@ DESCRIPTION ## `shopify app generate extension` -Generate a new app Extension. +Generates a new app Extension. ``` USAGE @@ -2461,7 +2461,7 @@ FLAGS [env: SHOPIFY_FLAG_VERBOSE] DESCRIPTION - Generate a new app Extension. + Generates a new app Extension. Generates a new "app extension" (https://shopify.dev/docs/apps/build/app-extensions). For a list of app extensions that you can generate using this command, refer to "Supported extensions" @@ -2474,7 +2474,7 @@ DESCRIPTION ## `shopify app graphiql` -Open a local GraphiQL UI for your app and store. +Opens a local GraphiQL UI for your app and store. ``` USAGE @@ -2537,7 +2537,7 @@ FLAGS [env: SHOPIFY_FLAG_VERSION] DESCRIPTION - Open a local GraphiQL UI for your app and store. + Opens a local GraphiQL UI for your app and store. Opens an authenticated Admin API GraphiQL UI for your app and selected store. @@ -2551,7 +2551,7 @@ EXAMPLES ## `shopify app import custom-data-definitions` -Import metafield and metaobject definitions. +Imports metafield and metaobject definitions. ``` USAGE @@ -2608,9 +2608,9 @@ FLAGS [env: SHOPIFY_FLAG_VERBOSE] DESCRIPTION - Import metafield and metaobject definitions. + Imports metafield and metaobject definitions. - Import metafield and metaobject definitions from your development store. "Read more about declarative custom data + Imports metafield and metaobject definitions from your development store. "Read more about declarative custom data definitions" (https://shopify.dev/docs/apps/build/custom-data/declarative-custom-data-definitions). Use `--json-schema` to print the result, error, and event schemas. @@ -2712,7 +2712,7 @@ DESCRIPTION ## `shopify app import dashboard-extensions` -Import dashboard-managed extensions into your app. +Imports dashboard-managed extensions into your app. ``` USAGE @@ -2761,7 +2761,7 @@ FLAGS [env: SHOPIFY_FLAG_VERBOSE] DESCRIPTION - Import dashboard-managed extensions into your app. + Imports dashboard-managed extensions into your app. Use `--json-schema` to print the result, error, and event schemas. @@ -3061,7 +3061,7 @@ DESCRIPTION ## `shopify app info` -Print basic information about your app and extensions. +Prints basic information about your app and extensions. ``` USAGE @@ -3114,7 +3114,7 @@ FLAGS [env: SHOPIFY_FLAG_OUTPUT_WEB_ENV] DESCRIPTION - Print basic information about your app and extensions. + Prints basic information about your app and extensions. The information returned includes the following: @@ -4009,7 +4009,7 @@ DESCRIPTION ## `shopify app init` -Create a new app project +Creates a new app project ``` USAGE @@ -4081,7 +4081,7 @@ EXAMPLES ## `shopify app logs` -Stream detailed logs for your Shopify app. +Streams detailed logs for your Shopify app. ``` USAGE @@ -4144,7 +4144,7 @@ FLAGS [env: SHOPIFY_FLAG_VERBOSE] DESCRIPTION - Stream detailed logs for your Shopify app. + Streams detailed logs for your Shopify app. Opens a real-time stream of detailed app logs from the selected app and store. @@ -4158,7 +4158,7 @@ DESCRIPTION ## `shopify app logs sources` -Print out a list of sources that may be used with the logs command. +Prints out a list of sources that may be used with the logs command. ``` USAGE @@ -4207,7 +4207,7 @@ FLAGS [env: SHOPIFY_FLAG_VERBOSE] DESCRIPTION - Print out a list of sources that may be used with the logs command. + Prints out a list of sources that may be used with the logs command. The output source names can be used with the `--source` argument of `shopify app logs` to filter log output. Currently only function extensions are supported as sources. @@ -4317,7 +4317,7 @@ DESCRIPTION ## `shopify app release --version ` -Release an app version. +Releases an app version. ``` USAGE @@ -4375,14 +4375,14 @@ FLAGS [env: SHOPIFY_FLAG_VERSION] DESCRIPTION - Release an app version. + Releases an app version. Releases an existing app version. Pass the name of the version that you want to release using the `--version` flag. ``` ## `shopify app security check` -Check an app for Shopify-specific security issues and write deterministic-findings.json and agent-checks.json. +Checks an app for Shopify-specific security issues and writes deterministic-findings.json and agent-checks.json. ``` USAGE @@ -4456,7 +4456,7 @@ FLAGS [env: SHOPIFY_FLAG_YES] DESCRIPTION - Check an app for Shopify-specific security issues and write deterministic-findings.json and agent-checks.json. + Checks an app for Shopify-specific security issues and writes deterministic-findings.json and agent-checks.json. Runs an app security check locally and writes `deterministic-findings.json` and `agent-checks.json` to the results directory, `.shopify/app-security//`. The results key is `--client-id` when you pass it, and otherwise @@ -4493,7 +4493,7 @@ DESCRIPTION ## `shopify app security clean` -Remove local app security check results. +Removes local app security check results. ``` USAGE @@ -4537,7 +4537,7 @@ FLAGS [env: SHOPIFY_FLAG_WITHOUT_APP_CONFIG] DESCRIPTION - Remove local app security check results. + Removes local app security check results. Deletes the results directory, `.shopify/app-security//`, without asking. The results key is `--client-id` when you pass it, and otherwise the name of the app configuration file without `.toml`. Other results @@ -4549,7 +4549,7 @@ DESCRIPTION ## `shopify app security instructions` -Provide app security check instructions to a coding agent. +Provides app security check instructions to a coding agent. ``` USAGE @@ -4598,7 +4598,7 @@ FLAGS [env: SHOPIFY_FLAG_APP_SECURITY_INSTRUCTIONS_WRITE] DESCRIPTION - Provide app security check instructions to a coding agent. + Provides app security check instructions to a coding agent. Prints the complete workflow that a coding agent should follow to review app security check results. @@ -4609,7 +4609,7 @@ DESCRIPTION ## `shopify app security record` -Record agent findings from an app security check. +Records agent findings from an app security check. ``` USAGE @@ -4650,7 +4650,7 @@ FLAGS [env: SHOPIFY_FLAG_WITHOUT_APP_CONFIG] DESCRIPTION - Record agent findings from an app security check. + Records agent findings from an app security check. Reads a coding agent's complete findings document from stdin, validates it, and replaces `agent-findings.json` in the results directory, `.shopify/app-security//`. The results key is `--client-id` when you pass it, and @@ -4666,7 +4666,7 @@ DESCRIPTION ## `shopify app security review` -Show the combined app security check results. +Shows the combined app security check results. ``` USAGE @@ -4717,7 +4717,7 @@ FLAGS [env: SHOPIFY_FLAG_WITHOUT_APP_CONFIG] DESCRIPTION - Show the combined app security check results. + Shows the combined app security check results. Combines the deterministic results (`deterministic-findings.json`, written by `shopify app security check`) with the recorded agent results (`agent-findings.json`, written by `shopify app security record`) and shows one view of every @@ -6379,7 +6379,7 @@ EXAMPLES ## `shopify app versions list` -List deployed versions of your app. +Lists deployed versions of your app. ``` USAGE @@ -6428,7 +6428,7 @@ FLAGS [env: SHOPIFY_FLAG_VERBOSE] DESCRIPTION - List deployed versions of your app. + Lists deployed versions of your app. Lists the deployed app versions. An app version is a snapshot of your app extensions. @@ -6486,7 +6486,7 @@ DESCRIPTION ## `shopify app webhook trigger` -Trigger delivery of a sample webhook topic payload to a designated address. +Triggers delivery of a sample webhook topic payload to a designated address. ``` USAGE @@ -6569,7 +6569,7 @@ FLAGS [env: SHOPIFY_FLAG_VERBOSE] DESCRIPTION - Trigger delivery of a sample webhook topic payload to a designated address. + Triggers delivery of a sample webhook topic payload to a designated address. Triggers the delivery of a sample Admin API event topic payload to a designated address. @@ -6824,7 +6824,7 @@ DESCRIPTION ## `shopify config autocorrect off` -Disable autocorrect. Off by default. +Disables autocorrect. Off by default. ``` USAGE @@ -6836,9 +6836,9 @@ FLAGS [env: SHOPIFY_FLAG_JSON_SCHEMA] DESCRIPTION - Disable autocorrect. Off by default. + Disables autocorrect. Off by default. - Disable autocorrect. Off by default. + Disables autocorrect. Off by default. When autocorrection is enabled, Shopify CLI automatically runs a corrected version of your command if a correction is available. @@ -6848,7 +6848,7 @@ DESCRIPTION ## `shopify config autocorrect on` -Enable autocorrect. Off by default. +Enables autocorrect. Off by default. ``` USAGE @@ -6860,9 +6860,9 @@ FLAGS [env: SHOPIFY_FLAG_JSON_SCHEMA] DESCRIPTION - Enable autocorrect. Off by default. + Enables autocorrect. Off by default. - Enable autocorrect. Off by default. + Enables autocorrect. Off by default. When autocorrection is enabled, Shopify CLI automatically runs a corrected version of your command if a correction is available. @@ -6872,7 +6872,7 @@ DESCRIPTION ## `shopify config autocorrect status` -Check whether autocorrect is enabled or disabled. On by default. +Checks whether autocorrect is enabled or disabled. On by default. ``` USAGE @@ -6884,9 +6884,9 @@ FLAGS [env: SHOPIFY_FLAG_JSON_SCHEMA] DESCRIPTION - Check whether autocorrect is enabled or disabled. On by default. + Checks whether autocorrect is enabled or disabled. On by default. - Check whether autocorrect is enabled or disabled. On by default. + Checks whether autocorrect is enabled or disabled. On by default. When autocorrection is enabled, Shopify CLI automatically runs a corrected version of your command if a correction is available. @@ -6896,7 +6896,7 @@ DESCRIPTION ## `shopify config autoupgrade off` -Disable automatic upgrades for Shopify CLI. +Disables automatic upgrades for Shopify CLI. ``` USAGE @@ -6924,9 +6924,9 @@ FLAGS [env: SHOPIFY_FLAG_VERBOSE] DESCRIPTION - Disable automatic upgrades for Shopify CLI. + Disables automatic upgrades for Shopify CLI. - Disable automatic upgrades for Shopify CLI. + Disables automatic upgrades for Shopify CLI. When auto-upgrade is disabled, Shopify CLI won't automatically update. Run `shopify upgrade` to update manually. @@ -6957,7 +6957,7 @@ DESCRIPTION ## `shopify config autoupgrade on` -Enable automatic upgrades for Shopify CLI. +Enables automatic upgrades for Shopify CLI. ``` USAGE @@ -6985,9 +6985,9 @@ FLAGS [env: SHOPIFY_FLAG_VERBOSE] DESCRIPTION - Enable automatic upgrades for Shopify CLI. + Enables automatic upgrades for Shopify CLI. - Enable automatic upgrades for Shopify CLI. + Enables automatic upgrades for Shopify CLI. When auto-upgrade is enabled, Shopify CLI automatically updates to the latest version once per day. Major version upgrades are skipped and must be done manually. @@ -7019,7 +7019,7 @@ DESCRIPTION ## `shopify config autoupgrade status` -Check whether auto-upgrade is enabled, disabled, or not yet configured. +Checks whether auto-upgrade is enabled, disabled, or not yet configured. ``` USAGE @@ -7047,9 +7047,9 @@ FLAGS [env: SHOPIFY_FLAG_VERBOSE] DESCRIPTION - Check whether auto-upgrade is enabled, disabled, or not yet configured. + Checks whether auto-upgrade is enabled, disabled, or not yet configured. - Check whether auto-upgrade is enabled, disabled, or not yet configured. + Checks whether auto-upgrade is enabled, disabled, or not yet configured. When auto-upgrade is enabled, Shopify CLI automatically updates to the latest version after each command. @@ -7080,7 +7080,7 @@ DESCRIPTION ## `shopify doc fetch` -Download a complete document from shopify.dev. Every page on shopify.dev has a Markdown version, and that is what this tool returns. Use this to pull an entire document verbatim — for example, a set of instructions an agent follows like a centrally-served skill. Pass `--language` for the language of the app you are building so code examples match your stack. For finding the relevant pieces of content across shopify.dev instead, use `doc search`. +Downloads a complete document from shopify.dev. Every page on shopify.dev has a Markdown version, and that is what this tool returns. Use this to pull an entire document verbatim — for example, a set of instructions an agent follows like a centrally-served skill. Pass `--language` for the language of the app you are building so code examples match your stack. For finding the relevant pieces of content across shopify.dev instead, use `doc search`. ``` USAGE @@ -7126,10 +7126,10 @@ FLAGS [env: SHOPIFY_FLAG_VERBOSE] DESCRIPTION - Download a complete document from shopify.dev. Every page on shopify.dev has a Markdown version, and that is what this - tool returns. Use this to pull an entire document verbatim — for example, a set of instructions an agent follows like - a centrally-served skill. Pass `--language` for the language of the app you are building so code examples match your - stack. For finding the relevant pieces of content across shopify.dev instead, use `doc search`. + Downloads a complete document from shopify.dev. Every page on shopify.dev has a Markdown version, and that is what + this tool returns. Use this to pull an entire document verbatim — for example, a set of instructions an agent follows + like a centrally-served skill. Pass `--language` for the language of the app you are building so code examples match + your stack. For finding the relevant pieces of content across shopify.dev instead, use `doc search`. Use `--json-schema` to print the result, error, and event schemas. @@ -7220,7 +7220,7 @@ EXAMPLES ## `shopify doc search` -Query the shopify.dev vector store and print the most relevant documentation chunks as JSON. Best for programmatic discovery — surfacing the relevant pieces of documentation for a topic, rather than retrieving a whole document. To download a full document verbatim, use `doc fetch`. +Queries the shopify.dev vector store and prints the most relevant documentation chunks as JSON. Best for programmatic discovery — surfacing the relevant pieces of documentation for a topic, rather than retrieving a whole document. To download a full document verbatim, use `doc fetch`. ``` USAGE @@ -7262,7 +7262,7 @@ FLAGS [env: SHOPIFY_FLAG_VERBOSE] DESCRIPTION - Query the shopify.dev vector store and print the most relevant documentation chunks as JSON. Best for programmatic + Queries the shopify.dev vector store and prints the most relevant documentation chunks as JSON. Best for programmatic discovery — surfacing the relevant pieces of documentation for a topic, rather than retrieving a whole document. To download a full document verbatim, use `doc fetch`. @@ -7363,7 +7363,7 @@ EXAMPLES ## `shopify help [command] [flags]` -Display help for Shopify CLI +Displays help for Shopify CLI ``` USAGE @@ -7386,7 +7386,7 @@ FLAGS [env: SHOPIFY_FLAG_JSON_SCHEMA] DESCRIPTION - Display help for Shopify CLI + Displays help for Shopify CLI Use `--json-schema` to print the result, error, and event schemas. @@ -8672,7 +8672,7 @@ DESCRIPTION ## `shopify organization list` -List Shopify organizations you have access to. +Lists Shopify organizations you have access to. ``` USAGE @@ -8704,7 +8704,7 @@ FLAGS [env: SHOPIFY_FLAG_VERBOSE] DESCRIPTION - List Shopify organizations you have access to. + Lists Shopify organizations you have access to. Lists the Shopify organizations that you have access to, along with their organization IDs. @@ -9045,7 +9045,7 @@ DESCRIPTION ## `shopify search [query]` -Search shopify.dev for the most relevant content matching a query. Best for discovery — surfacing the relevant pieces of documentation for a topic, rather than retrieving a whole document. To download a full document verbatim, use `doc fetch`. +Searches shopify.dev for the most relevant content matching a query. Best for discovery — surfacing the relevant pieces of documentation for a topic, rather than retrieving a whole document. To download a full document verbatim, use `doc fetch`. ``` USAGE @@ -9073,9 +9073,9 @@ FLAGS [env: SHOPIFY_FLAG_VERBOSE] DESCRIPTION - Search shopify.dev for the most relevant content matching a query. Best for discovery — surfacing the relevant pieces - of documentation for a topic, rather than retrieving a whole document. To download a full document verbatim, use `doc - fetch`. + Searches shopify.dev for the most relevant content matching a query. Best for discovery — surfacing the relevant + pieces of documentation for a topic, rather than retrieving a whole document. To download a full document verbatim, + use `doc fetch`. Use `--json-schema` to print the result, error, and event schemas. @@ -9110,7 +9110,7 @@ EXAMPLES ## `shopify store auth` -Authenticate an app against a store for store commands. +Authenticates an app against a store for store commands. ``` USAGE @@ -9146,7 +9146,7 @@ FLAGS [env: SHOPIFY_FLAG_VERBOSE] DESCRIPTION - Authenticate an app against a store for store commands. + Authenticates an app against a store for store commands. Authenticates the app against the specified store for store commands and stores an online access token for later reuse. @@ -9236,7 +9236,7 @@ EXAMPLES ## `shopify store auth list` -List stores authenticated directly with store auth. +Lists stores authenticated directly with store auth. ``` USAGE @@ -9264,7 +9264,7 @@ FLAGS [env: SHOPIFY_FLAG_VERBOSE] DESCRIPTION - List stores authenticated directly with store auth. + Lists stores authenticated directly with store auth. Lists stores authenticated directly on this machine with `shopify store auth`. @@ -9375,7 +9375,7 @@ EXAMPLES ## `shopify store bulk cancel` -Cancel a bulk operation on a store. +Cancels a bulk operation on a store. ``` USAGE @@ -9411,7 +9411,7 @@ FLAGS [env: SHOPIFY_FLAG_VERBOSE] DESCRIPTION - Cancel a bulk operation on a store. + Cancels a bulk operation on a store. Cancels a running bulk operation by ID, using previously stored app authentication. @@ -9549,7 +9549,7 @@ EXAMPLES ## `shopify store bulk execute` -Execute bulk operations on a store. +Executes bulk operations on a store. ``` USAGE @@ -9617,7 +9617,7 @@ FLAGS [env: SHOPIFY_FLAG_WATCH] DESCRIPTION - Execute bulk operations on a store. + Executes bulk operations on a store. Executes an Admin API GraphQL query or mutation on the specified store as a bulk operation, using previously stored app authentication. @@ -9809,7 +9809,7 @@ EXAMPLES ## `shopify store bulk status` -Check the status of bulk operations on a store. +Checks the status of bulk operations on a store. ``` USAGE @@ -9846,9 +9846,9 @@ FLAGS [env: SHOPIFY_FLAG_VERBOSE] DESCRIPTION - Check the status of bulk operations on a store. + Checks the status of bulk operations on a store. - Check the status of a specific bulk operation by ID, or list all bulk operations on this store in the last 7 days, + Checks the status of a specific bulk operation by ID, or lists all bulk operations on this store in the last 7 days, using previously stored app authentication. Run `shopify store auth` first to create stored auth for the store. @@ -10086,7 +10086,7 @@ EXAMPLES ## `shopify store create dev` -Create a new dev store. +Creates a new dev store. ``` USAGE @@ -10140,7 +10140,7 @@ FLAGS [env: SHOPIFY_FLAG_VERBOSE] DESCRIPTION - Create a new dev store. + Creates a new dev store. Creates a new dev store in your organization. @@ -10276,7 +10276,7 @@ EXAMPLES ## `shopify store create preview` -Create a preview Shopify store. +Creates a preview Shopify store. ``` USAGE @@ -10313,7 +10313,7 @@ FLAGS [env: SHOPIFY_FLAG_VERBOSE] DESCRIPTION - Create a preview Shopify store. + Creates a preview Shopify store. Creates a new Shopify store, with no need for an existing account. @@ -10404,7 +10404,7 @@ EXAMPLES ## `shopify store delete` -Delete a dev store. +Deletes a dev store. ``` USAGE @@ -10445,7 +10445,7 @@ FLAGS [env: SHOPIFY_FLAG_VERBOSE] DESCRIPTION - Delete a dev store. + Deletes a dev store. Deletes a dev store from your organization. @@ -10561,7 +10561,7 @@ EXAMPLES ## `shopify store execute` -Execute GraphQL queries and mutations on a store. +Executes GraphQL queries and mutations on a store. ``` USAGE @@ -10623,7 +10623,7 @@ FLAGS [env: SHOPIFY_FLAG_VERSION] DESCRIPTION - Execute GraphQL queries and mutations on a store. + Executes GraphQL queries and mutations on a store. Executes an Admin API GraphQL query or mutation on the specified store using previously stored app authentication. @@ -10663,7 +10663,7 @@ EXAMPLES ## `shopify store graphiql` -Open a local GraphiQL UI for a store. +Opens a local GraphiQL UI for a store. ``` USAGE @@ -10708,7 +10708,7 @@ FLAGS [env: SHOPIFY_FLAG_VERSION] DESCRIPTION - Open a local GraphiQL UI for a store. + Opens a local GraphiQL UI for a store. Opens an authenticated Admin API GraphiQL UI for the specified store using previously stored app authentication. @@ -10726,7 +10726,7 @@ EXAMPLES ## `shopify store info` -Surface metadata about a Shopify store. +Surfaces metadata about a Shopify store. ``` USAGE @@ -10758,7 +10758,7 @@ FLAGS [env: SHOPIFY_FLAG_VERBOSE] DESCRIPTION - Surface metadata about a Shopify store. + Surfaces metadata about a Shopify store. Returns available metadata about a store you have access to, such as its id, display name, subdomain, organization, store owner, type, plan, feature preview, admin URL, and access and save URLs for preview stores. @@ -10853,7 +10853,7 @@ EXAMPLES ## `shopify store list` -List stores in a Shopify organization. +Lists stores in a Shopify organization. ``` USAGE @@ -10892,7 +10892,7 @@ FLAGS [env: SHOPIFY_FLAG_VERBOSE] DESCRIPTION - List stores in a Shopify organization. + Lists stores in a Shopify organization. Lists stores in a Shopify organization available to the current CLI account. @@ -11013,7 +11013,7 @@ EXAMPLES ## `shopify store open` -Open your Shopify store in the default web browser. +Opens your Shopify store in the default web browser. ``` USAGE @@ -11045,7 +11045,7 @@ FLAGS [env: SHOPIFY_FLAG_VERBOSE] DESCRIPTION - Open your Shopify store in the default web browser. + Opens your Shopify store in the default web browser. Opens the storefront for a store you have access to in your default web browser. @@ -11093,7 +11093,7 @@ EXAMPLES ## `shopify theme check` -Validate the theme. +Validates the theme. ``` USAGE @@ -11168,7 +11168,7 @@ FLAGS [env: SHOPIFY_FLAG_VERBOSE] DESCRIPTION - Validate the theme. + Validates the theme. Calls and runs "Theme Check" (https://shopify.dev/docs/themes/tools/theme-check) to analyze your theme code for errors and to ensure that it follows theme and Liquid best practices. "Learn more about the checks that Theme Check runs." @@ -11241,7 +11241,7 @@ DESCRIPTION ## `shopify theme delete` -Delete remote themes from the connected store. This command can't be undone. +Deletes remote themes from the connected store. This command can't be undone. ``` USAGE @@ -11304,7 +11304,7 @@ FLAGS [env: SHOPIFY_FLAG_VERBOSE] DESCRIPTION - Delete remote themes from the connected store. This command can't be undone. + Deletes remote themes from the connected store. This command can't be undone. Deletes a theme from your store. @@ -11698,7 +11698,7 @@ DESCRIPTION ## `shopify theme language-server` -Start a Language Server Protocol server. +Starts a Language Server Protocol server. ``` USAGE @@ -11726,7 +11726,7 @@ FLAGS [env: SHOPIFY_FLAG_VERBOSE] DESCRIPTION - Start a Language Server Protocol server. + Starts a Language Server Protocol server. Starts the "Language Server" (https://shopify.dev/docs/themes/tools/cli/language-server). ``` @@ -11802,7 +11802,7 @@ DESCRIPTION ## `shopify theme metafields pull` -Download metafields definitions from your shop into a local file. +Downloads metafields definitions from your shop into a local file. ``` USAGE @@ -11848,7 +11848,7 @@ FLAGS [env: SHOPIFY_FLAG_VERBOSE] DESCRIPTION - Download metafields definitions from your shop into a local file. + Downloads metafields definitions from your shop into a local file. Retrieves metafields from Shopify Admin. @@ -11934,7 +11934,7 @@ DESCRIPTION ## `shopify theme package` -Package your theme into a .zip file, ready to upload to the Online Store. +Packages your theme into a .zip file, ready to upload to the Online Store. ``` USAGE @@ -11967,7 +11967,7 @@ FLAGS [env: SHOPIFY_FLAG_VERBOSE] DESCRIPTION - Package your theme into a .zip file, ready to upload to the Online Store. + Packages your theme into a .zip file, ready to upload to the Online Store. Packages your local theme files into a ZIP file that can be uploaded to Shopify. @@ -12061,7 +12061,7 @@ DESCRIPTION ## `shopify theme profile` -Profile the Liquid rendering of a theme page. +Profiles the Liquid rendering of a theme page. ``` USAGE @@ -12123,9 +12123,9 @@ FLAGS [env: SHOPIFY_FLAG_VERBOSE] DESCRIPTION - Profile the Liquid rendering of a theme page. + Profiles the Liquid rendering of a theme page. - Profile the Shopify Liquid on a given page. + Profiles the Shopify Liquid on a given page. This command will open a web page with the Speedscope profiler detailing the time spent executing Liquid on the given page. @@ -12133,7 +12133,7 @@ DESCRIPTION ## `shopify theme publish` -Set a remote theme as the live theme. +Sets a remote theme as the live theme. ``` USAGE @@ -12187,7 +12187,7 @@ FLAGS [env: SHOPIFY_FLAG_VERBOSE] DESCRIPTION - Set a remote theme as the live theme. + Sets a remote theme as the live theme. Publishes an unpublished theme from your theme library. @@ -12203,7 +12203,7 @@ DESCRIPTION ## `shopify theme pull` -Download your remote theme files locally. +Downloads your remote theme files locally. ``` USAGE @@ -12277,7 +12277,7 @@ FLAGS [env: SHOPIFY_FLAG_VERBOSE] DESCRIPTION - Download your remote theme files locally. + Downloads your remote theme files locally. Retrieves theme files from Shopify. diff --git a/packages/cli/oclif.manifest.json b/packages/cli/oclif.manifest.json index bffa60065b2..c734f27762c 100644 --- a/packages/cli/oclif.manifest.json +++ b/packages/cli/oclif.manifest.json @@ -115,7 +115,7 @@ "pluginName": "@shopify/cli", "pluginType": "core", "strict": true, - "summary": "Build the app, including extensions." + "summary": "Builds the app, including extensions." }, "app:bulk:cancel": { "aliases": [ @@ -242,7 +242,7 @@ "pluginName": "@shopify/cli", "pluginType": "core", "strict": true, - "summary": "Cancel a bulk operation." + "summary": "Cancels a bulk operation." }, "app:bulk:execute": { "aliases": [ @@ -427,7 +427,7 @@ "pluginName": "@shopify/cli", "pluginType": "core", "strict": true, - "summary": "Execute bulk operations." + "summary": "Executes bulk operations." }, "app:bulk:status": { "aliases": [ @@ -435,8 +435,8 @@ "args": { }, "customPluginName": "@shopify/app", - "description": "Check the status of a specific bulk operation by ID, or list all bulk operations belonging to this app on this store 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.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `BulkOperationStatusResult` schema.\n\n```json\n{\n \"anyOf\": [\n {\n \"$ref\": \"#/definitions/GetBulkOperationStatusResult\"\n },\n {\n \"$ref\": \"#/definitions/ListBulkOperationsResult\"\n }\n ],\n \"title\": \"BulkOperationStatusResult\",\n \"definitions\": {\n \"GetBulkOperationStatusResult\": {\n \"type\": \"object\",\n \"properties\": {\n \"storeDomain\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"pattern\": \"^[^.]+\\\\.myshopify\\\\.com$\"\n },\n {\n \"type\": \"null\"\n }\n ]\n },\n \"apiVersion\": {\n \"type\": [\n \"string\",\n \"null\"\n ],\n \"description\": \"The API version selected for the request.\"\n },\n \"operationGid\": {\n \"type\": \"string\",\n \"pattern\": \"^gid:\\\\/\\\\/shopify\\\\/BulkOperation\\\\/[^/]+$\",\n \"description\": \"The Shopify global ID of a bulk operation.\"\n },\n \"operation\": {\n \"anyOf\": [\n {\n \"$ref\": \"#/definitions/BulkOperation\"\n },\n {\n \"type\": \"null\"\n }\n ]\n }\n },\n \"required\": [\n \"storeDomain\",\n \"apiVersion\",\n \"operationGid\",\n \"operation\"\n ],\n \"additionalProperties\": false\n },\n \"ListBulkOperationsResult\": {\n \"type\": \"object\",\n \"properties\": {\n \"storeDomain\": {\n \"$ref\": \"#/definitions/GetBulkOperationStatusResult/properties/storeDomain\"\n },\n \"apiVersion\": {\n \"$ref\": \"#/definitions/GetBulkOperationStatusResult/properties/apiVersion\"\n },\n \"operations\": {\n \"type\": \"array\",\n \"items\": {\n \"$ref\": \"#/definitions/ListedBulkOperation\"\n }\n },\n \"pageInfo\": {\n \"type\": \"object\",\n \"properties\": {\n \"hasNextPage\": {\n \"type\": [\n \"boolean\",\n \"null\"\n ],\n \"description\": \"Unknown when the API result reaches the fetch limit.\"\n }\n },\n \"required\": [\n \"hasNextPage\"\n ],\n \"additionalProperties\": false\n }\n },\n \"required\": [\n \"storeDomain\",\n \"apiVersion\",\n \"operations\",\n \"pageInfo\"\n ],\n \"additionalProperties\": false\n },\n \"BulkOperation\": {\n \"type\": \"object\",\n \"properties\": {\n \"gid\": {\n \"$ref\": \"#/definitions/GetBulkOperationStatusResult/properties/operationGid\"\n },\n \"type\": {\n \"type\": \"string\"\n },\n \"status\": {\n \"type\": \"string\"\n },\n \"errorCode\": {\n \"type\": [\n \"string\",\n \"null\"\n ]\n },\n \"createdAt\": {\n \"type\": \"string\",\n \"format\": \"date-time\",\n \"pattern\": \"^\\\\d{4}-\\\\d{2}-\\\\d{2}T\\\\d{2}:\\\\d{2}:\\\\d{2}Z$\",\n \"description\": \"A UTC ISO 8601 instant with whole seconds and the Z timezone marker.\"\n },\n \"completedAt\": {\n \"anyOf\": [\n {\n \"$ref\": \"#/definitions/BulkOperation/properties/createdAt\"\n },\n {\n \"type\": \"null\"\n }\n ],\n \"description\": \"A UTC ISO 8601 instant with whole seconds and the Z timezone marker.\"\n },\n \"objectCount\": {\n \"type\": \"string\",\n \"pattern\": \"^\\\\d+$\",\n \"description\": \"A nonnegative decimal count, without loss of integer precision.\"\n },\n \"url\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"format\": \"uri\"\n },\n {\n \"type\": \"null\"\n }\n ]\n },\n \"partialDataUrl\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"format\": \"uri\"\n },\n {\n \"type\": \"null\"\n }\n ]\n }\n },\n \"required\": [\n \"gid\",\n \"type\",\n \"status\",\n \"errorCode\",\n \"createdAt\",\n \"completedAt\",\n \"objectCount\",\n \"url\",\n \"partialDataUrl\"\n ],\n \"additionalProperties\": false\n },\n \"ListedBulkOperation\": {\n \"type\": \"object\",\n \"properties\": {\n \"gid\": {\n \"$ref\": \"#/definitions/GetBulkOperationStatusResult/properties/operationGid\"\n },\n \"status\": {\n \"$ref\": \"#/definitions/BulkOperation/properties/status\"\n },\n \"errorCode\": {\n \"$ref\": \"#/definitions/BulkOperation/properties/errorCode\"\n },\n \"createdAt\": {\n \"$ref\": \"#/definitions/BulkOperation/properties/createdAt\"\n },\n \"completedAt\": {\n \"$ref\": \"#/definitions/BulkOperation/properties/completedAt\"\n },\n \"objectCount\": {\n \"$ref\": \"#/definitions/BulkOperation/properties/objectCount\"\n },\n \"url\": {\n \"$ref\": \"#/definitions/BulkOperation/properties/url\"\n },\n \"partialDataUrl\": {\n \"$ref\": \"#/definitions/BulkOperation/properties/partialDataUrl\"\n }\n },\n \"required\": [\n \"gid\",\n \"status\",\n \"errorCode\",\n \"createdAt\",\n \"completedAt\",\n \"objectCount\",\n \"url\",\n \"partialDataUrl\"\n ],\n \"additionalProperties\": false\n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", - "descriptionWithMarkdown": "Check the status of a specific bulk operation by ID, or list all bulk operations belonging to this app on this store 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.", + "description": "Checks the status of a specific bulk operation by ID, or lists all bulk operations belonging to this app on this store 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.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `BulkOperationStatusResult` schema.\n\n```json\n{\n \"anyOf\": [\n {\n \"$ref\": \"#/definitions/GetBulkOperationStatusResult\"\n },\n {\n \"$ref\": \"#/definitions/ListBulkOperationsResult\"\n }\n ],\n \"title\": \"BulkOperationStatusResult\",\n \"definitions\": {\n \"GetBulkOperationStatusResult\": {\n \"type\": \"object\",\n \"properties\": {\n \"storeDomain\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"pattern\": \"^[^.]+\\\\.myshopify\\\\.com$\"\n },\n {\n \"type\": \"null\"\n }\n ]\n },\n \"apiVersion\": {\n \"type\": [\n \"string\",\n \"null\"\n ],\n \"description\": \"The API version selected for the request.\"\n },\n \"operationGid\": {\n \"type\": \"string\",\n \"pattern\": \"^gid:\\\\/\\\\/shopify\\\\/BulkOperation\\\\/[^/]+$\",\n \"description\": \"The Shopify global ID of a bulk operation.\"\n },\n \"operation\": {\n \"anyOf\": [\n {\n \"$ref\": \"#/definitions/BulkOperation\"\n },\n {\n \"type\": \"null\"\n }\n ]\n }\n },\n \"required\": [\n \"storeDomain\",\n \"apiVersion\",\n \"operationGid\",\n \"operation\"\n ],\n \"additionalProperties\": false\n },\n \"ListBulkOperationsResult\": {\n \"type\": \"object\",\n \"properties\": {\n \"storeDomain\": {\n \"$ref\": \"#/definitions/GetBulkOperationStatusResult/properties/storeDomain\"\n },\n \"apiVersion\": {\n \"$ref\": \"#/definitions/GetBulkOperationStatusResult/properties/apiVersion\"\n },\n \"operations\": {\n \"type\": \"array\",\n \"items\": {\n \"$ref\": \"#/definitions/ListedBulkOperation\"\n }\n },\n \"pageInfo\": {\n \"type\": \"object\",\n \"properties\": {\n \"hasNextPage\": {\n \"type\": [\n \"boolean\",\n \"null\"\n ],\n \"description\": \"Unknown when the API result reaches the fetch limit.\"\n }\n },\n \"required\": [\n \"hasNextPage\"\n ],\n \"additionalProperties\": false\n }\n },\n \"required\": [\n \"storeDomain\",\n \"apiVersion\",\n \"operations\",\n \"pageInfo\"\n ],\n \"additionalProperties\": false\n },\n \"BulkOperation\": {\n \"type\": \"object\",\n \"properties\": {\n \"gid\": {\n \"$ref\": \"#/definitions/GetBulkOperationStatusResult/properties/operationGid\"\n },\n \"type\": {\n \"type\": \"string\"\n },\n \"status\": {\n \"type\": \"string\"\n },\n \"errorCode\": {\n \"type\": [\n \"string\",\n \"null\"\n ]\n },\n \"createdAt\": {\n \"type\": \"string\",\n \"format\": \"date-time\",\n \"pattern\": \"^\\\\d{4}-\\\\d{2}-\\\\d{2}T\\\\d{2}:\\\\d{2}:\\\\d{2}Z$\",\n \"description\": \"A UTC ISO 8601 instant with whole seconds and the Z timezone marker.\"\n },\n \"completedAt\": {\n \"anyOf\": [\n {\n \"$ref\": \"#/definitions/BulkOperation/properties/createdAt\"\n },\n {\n \"type\": \"null\"\n }\n ],\n \"description\": \"A UTC ISO 8601 instant with whole seconds and the Z timezone marker.\"\n },\n \"objectCount\": {\n \"type\": \"string\",\n \"pattern\": \"^\\\\d+$\",\n \"description\": \"A nonnegative decimal count, without loss of integer precision.\"\n },\n \"url\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"format\": \"uri\"\n },\n {\n \"type\": \"null\"\n }\n ]\n },\n \"partialDataUrl\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"format\": \"uri\"\n },\n {\n \"type\": \"null\"\n }\n ]\n }\n },\n \"required\": [\n \"gid\",\n \"type\",\n \"status\",\n \"errorCode\",\n \"createdAt\",\n \"completedAt\",\n \"objectCount\",\n \"url\",\n \"partialDataUrl\"\n ],\n \"additionalProperties\": false\n },\n \"ListedBulkOperation\": {\n \"type\": \"object\",\n \"properties\": {\n \"gid\": {\n \"$ref\": \"#/definitions/GetBulkOperationStatusResult/properties/operationGid\"\n },\n \"status\": {\n \"$ref\": \"#/definitions/BulkOperation/properties/status\"\n },\n \"errorCode\": {\n \"$ref\": \"#/definitions/BulkOperation/properties/errorCode\"\n },\n \"createdAt\": {\n \"$ref\": \"#/definitions/BulkOperation/properties/createdAt\"\n },\n \"completedAt\": {\n \"$ref\": \"#/definitions/BulkOperation/properties/completedAt\"\n },\n \"objectCount\": {\n \"$ref\": \"#/definitions/BulkOperation/properties/objectCount\"\n },\n \"url\": {\n \"$ref\": \"#/definitions/BulkOperation/properties/url\"\n },\n \"partialDataUrl\": {\n \"$ref\": \"#/definitions/BulkOperation/properties/partialDataUrl\"\n }\n },\n \"required\": [\n \"gid\",\n \"status\",\n \"errorCode\",\n \"createdAt\",\n \"completedAt\",\n \"objectCount\",\n \"url\",\n \"partialDataUrl\"\n ],\n \"additionalProperties\": false\n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", + "descriptionWithMarkdown": "Checks the status of a specific bulk operation by ID, or lists all bulk operations belonging to this app on this store 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": { "auth-alias": { "description": "Alias of the Shopify account to use for authentication.", @@ -553,7 +553,7 @@ "pluginName": "@shopify/cli", "pluginType": "core", "strict": true, - "summary": "Check the status of bulk operations." + "summary": "Checks the status of bulk operations." }, "app:config:link": { "aliases": [ @@ -684,7 +684,7 @@ "pluginName": "@shopify/cli", "pluginType": "core", "strict": true, - "summary": "Fetch your app configuration from the Developer Dashboard." + "summary": "Fetches your app configuration from the Developer Dashboard." }, "app:config:pull": { "aliases": [ @@ -784,7 +784,7 @@ "pluginName": "@shopify/cli", "pluginType": "core", "strict": true, - "summary": "Refresh an already-linked app configuration without prompts." + "summary": "Refreshes an already-linked app configuration without prompts." }, "app:config:use": { "aliases": [ @@ -878,7 +878,7 @@ "pluginName": "@shopify/cli", "pluginType": "core", "strict": true, - "summary": "Activate an app configuration.", + "summary": "Activates an app configuration.", "usage": "app config use [config] [flags]" }, "app:config:validate": { @@ -988,7 +988,7 @@ "pluginName": "@shopify/cli", "pluginType": "core", "strict": true, - "summary": "Validate your app configuration and extensions." + "summary": "Validates your app configuration and extensions." }, "app:deploy": { "aliases": [ @@ -1156,7 +1156,7 @@ "pluginName": "@shopify/cli", "pluginType": "core", "strict": true, - "summary": "Deploy your Shopify app." + "summary": "Deploys your Shopify app." }, "app:dev": { "aliases": [ @@ -1389,7 +1389,7 @@ "pluginName": "@shopify/cli", "pluginType": "core", "strict": true, - "summary": "Run the app." + "summary": "Runs the app." }, "app:dev:clean": { "aliases": [ @@ -1397,8 +1397,8 @@ "args": { }, "customPluginName": "@shopify/app", - "description": "Stop the dev preview that was started with `shopify app dev`.\n\n It restores the app's active version to the selected development store.\n \n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `AppDevCleanResult` schema.\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"const\": \"success\"\n },\n \"app\": {\n \"$ref\": \"#/definitions/AppDevCleanApp\"\n },\n \"storeDomain\": {\n \"type\": [\n \"string\",\n \"null\"\n ],\n \"description\": \"The canonical *.myshopify.com hostname, or null when unknown.\"\n }\n },\n \"required\": [\n \"status\",\n \"app\",\n \"storeDomain\"\n ],\n \"additionalProperties\": false,\n \"title\": \"AppDevCleanResult\",\n \"definitions\": {\n \"AppDevCleanApp\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"clientId\": {\n \"type\": \"string\",\n \"minLength\": 1\n }\n },\n \"required\": [\n \"name\",\n \"clientId\"\n ],\n \"additionalProperties\": false\n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", - "descriptionWithMarkdown": "Stop the dev preview that was started with `shopify app dev`.\n\n It restores the app's active version to the selected development store.\n ", + "description": "Stops the dev preview that was started with `shopify app dev`.\n\n It restores the app's active version to the selected development store.\n \n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `AppDevCleanResult` schema.\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"const\": \"success\"\n },\n \"app\": {\n \"$ref\": \"#/definitions/AppDevCleanApp\"\n },\n \"storeDomain\": {\n \"type\": [\n \"string\",\n \"null\"\n ],\n \"description\": \"The canonical *.myshopify.com hostname, or null when unknown.\"\n }\n },\n \"required\": [\n \"status\",\n \"app\",\n \"storeDomain\"\n ],\n \"additionalProperties\": false,\n \"title\": \"AppDevCleanResult\",\n \"definitions\": {\n \"AppDevCleanApp\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"clientId\": {\n \"type\": \"string\",\n \"minLength\": 1\n }\n },\n \"required\": [\n \"name\",\n \"clientId\"\n ],\n \"additionalProperties\": false\n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", + "descriptionWithMarkdown": "Stops the dev preview that was started with `shopify app dev`.\n\n It restores the app's active version to the selected development store.\n ", "flags": { "auth-alias": { "description": "Alias of the Shopify account to use for authentication.", @@ -1614,7 +1614,7 @@ "pluginName": "@shopify/cli", "pluginType": "core", "strict": true, - "summary": "Pull app and extensions environment variables." + "summary": "Pulls app and extensions environment variables." }, "app:env:show": { "aliases": [ @@ -1714,7 +1714,7 @@ "pluginName": "@shopify/cli", "pluginType": "core", "strict": true, - "summary": "Display app and extensions environment variables." + "summary": "Displays app and extensions environment variables." }, "app:execute": { "aliases": [ @@ -1889,7 +1889,7 @@ "pluginName": "@shopify/cli", "pluginType": "core", "strict": true, - "summary": "Execute GraphQL queries and mutations." + "summary": "Executes GraphQL queries and mutations." }, "app:function:build": { "aliases": [ @@ -1990,7 +1990,7 @@ "pluginName": "@shopify/cli", "pluginType": "core", "strict": true, - "summary": "Compile a function to wasm." + "summary": "Compiles a function to wasm." }, "app:function:info": { "aliases": [ @@ -2100,7 +2100,7 @@ "pluginName": "@shopify/cli", "pluginType": "core", "strict": true, - "summary": "Print basic information about your function." + "summary": "Prints basic information about your function." }, "app:function:replay": { "aliases": [ @@ -2364,7 +2364,7 @@ "pluginName": "@shopify/cli", "pluginType": "core", "strict": true, - "summary": "Run a function locally for testing." + "summary": "Runs a function locally for testing." }, "app:function:schema": { "aliases": [ @@ -2473,7 +2473,7 @@ "pluginName": "@shopify/cli", "pluginType": "core", "strict": true, - "summary": "Fetch the latest GraphQL schema for a function." + "summary": "Fetches the latest GraphQL schema for a function." }, "app:function:typegen": { "aliases": [ @@ -2574,7 +2574,7 @@ "pluginName": "@shopify/cli", "pluginType": "core", "strict": true, - "summary": "Generate GraphQL types for a function." + "summary": "Generates GraphQL types for a function." }, "app:generate:extension": { "aliases": [ @@ -2721,7 +2721,7 @@ "pluginName": "@shopify/cli", "pluginType": "core", "strict": true, - "summary": "Generate a new app Extension." + "summary": "Generates a new app Extension." }, "app:graphiql": { "aliases": [ @@ -2859,7 +2859,7 @@ "pluginName": "@shopify/cli", "pluginType": "core", "strict": true, - "summary": "Open a local GraphiQL UI for your app and store." + "summary": "Opens a local GraphiQL UI for your app and store." }, "app:import-custom-data-definitions": { "aliases": [ @@ -2867,8 +2867,8 @@ "args": { }, "customPluginName": "@shopify/app", - "description": "Import metafield and metaobject definitions from your development store. \"Read more about declarative custom data definitions\" (https://shopify.dev/docs/apps/build/custom-data/declarative-custom-data-definitions).\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `ImportCustomDataDefinitionsResult` schema.\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"const\": \"success\"\n },\n \"storeDomain\": {\n \"type\": [\n \"string\",\n \"null\"\n ],\n \"description\": \"The full myshopify.com domain of the development store, or null when unavailable.\"\n },\n \"metafieldCount\": {\n \"type\": \"integer\",\n \"minimum\": 0,\n \"description\": \"The number of available metafields converted to TOML.\"\n },\n \"metaobjectCount\": {\n \"type\": \"integer\",\n \"minimum\": 0,\n \"description\": \"The number of available metaobjects converted to TOML.\"\n },\n \"toml\": {\n \"type\": \"string\",\n \"description\": \"Suggested native TOML for app-reserved definitions. No file is written.\"\n },\n \"skippedSections\": {\n \"type\": \"array\",\n \"items\": {\n \"anyOf\": [\n {\n \"$ref\": \"#/definitions/SkippedMetafields\"\n },\n {\n \"$ref\": \"#/definitions/SkippedMetaobjects\"\n }\n ]\n },\n \"description\": \"Sections skipped because required access scopes are unavailable. An empty array means all requests were authorized.\"\n }\n },\n \"required\": [\n \"status\",\n \"storeDomain\",\n \"metafieldCount\",\n \"metaobjectCount\",\n \"toml\",\n \"skippedSections\"\n ],\n \"additionalProperties\": false,\n \"title\": \"ImportCustomDataDefinitionsResult\",\n \"definitions\": {\n \"SkippedMetafields\": {\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"const\": \"metafields\"\n },\n \"ownerType\": {\n \"type\": \"string\",\n \"minLength\": 1,\n \"description\": \"The Admin API metafield owner type, such as PRODUCT.\"\n }\n },\n \"required\": [\n \"type\",\n \"ownerType\"\n ],\n \"additionalProperties\": false\n },\n \"SkippedMetaobjects\": {\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"const\": \"metaobjects\"\n }\n },\n \"required\": [\n \"type\"\n ],\n \"additionalProperties\": false\n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", - "descriptionWithMarkdown": "Import metafield and metaobject definitions from your development store. [Read more about declarative custom data definitions](https://shopify.dev/docs/apps/build/custom-data/declarative-custom-data-definitions).", + "description": "Imports metafield and metaobject definitions from your development store. \"Read more about declarative custom data definitions\" (https://shopify.dev/docs/apps/build/custom-data/declarative-custom-data-definitions).\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `ImportCustomDataDefinitionsResult` schema.\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"const\": \"success\"\n },\n \"storeDomain\": {\n \"type\": [\n \"string\",\n \"null\"\n ],\n \"description\": \"The full myshopify.com domain of the development store, or null when unavailable.\"\n },\n \"metafieldCount\": {\n \"type\": \"integer\",\n \"minimum\": 0,\n \"description\": \"The number of available metafields converted to TOML.\"\n },\n \"metaobjectCount\": {\n \"type\": \"integer\",\n \"minimum\": 0,\n \"description\": \"The number of available metaobjects converted to TOML.\"\n },\n \"toml\": {\n \"type\": \"string\",\n \"description\": \"Suggested native TOML for app-reserved definitions. No file is written.\"\n },\n \"skippedSections\": {\n \"type\": \"array\",\n \"items\": {\n \"anyOf\": [\n {\n \"$ref\": \"#/definitions/SkippedMetafields\"\n },\n {\n \"$ref\": \"#/definitions/SkippedMetaobjects\"\n }\n ]\n },\n \"description\": \"Sections skipped because required access scopes are unavailable. An empty array means all requests were authorized.\"\n }\n },\n \"required\": [\n \"status\",\n \"storeDomain\",\n \"metafieldCount\",\n \"metaobjectCount\",\n \"toml\",\n \"skippedSections\"\n ],\n \"additionalProperties\": false,\n \"title\": \"ImportCustomDataDefinitionsResult\",\n \"definitions\": {\n \"SkippedMetafields\": {\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"const\": \"metafields\"\n },\n \"ownerType\": {\n \"type\": \"string\",\n \"minLength\": 1,\n \"description\": \"The Admin API metafield owner type, such as PRODUCT.\"\n }\n },\n \"required\": [\n \"type\",\n \"ownerType\"\n ],\n \"additionalProperties\": false\n },\n \"SkippedMetaobjects\": {\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"const\": \"metaobjects\"\n }\n },\n \"required\": [\n \"type\"\n ],\n \"additionalProperties\": false\n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", + "descriptionWithMarkdown": "Imports metafield and metaobject definitions from your development store. [Read more about declarative custom data definitions](https://shopify.dev/docs/apps/build/custom-data/declarative-custom-data-definitions).", "flags": { "auth-alias": { "description": "Alias of the Shopify account to use for authentication.", @@ -2984,7 +2984,7 @@ "pluginAlias": "@shopify/cli", "pluginName": "@shopify/cli", "pluginType": "core", - "summary": "Import metafield and metaobject definitions." + "summary": "Imports metafield and metaobject definitions." }, "app:import-extensions": { "aliases": [ @@ -2992,8 +2992,8 @@ "args": { }, "customPluginName": "@shopify/app", - "description": "Import dashboard-managed extensions into your app.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `ImportDashboardExtensionsResult` schema.\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"enum\": [\n \"success\",\n \"partial\",\n \"skipped\",\n \"cancelled\"\n ]\n },\n \"reason\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"enum\": [\n \"no-extensions\",\n \"directory-selection-cancelled\"\n ]\n },\n {\n \"type\": \"null\"\n }\n ]\n },\n \"extensions\": {\n \"type\": \"array\",\n \"items\": {\n \"$ref\": \"#/definitions/ImportedDashboardExtension\"\n },\n \"description\": \"Completed extension imports and kept local directories, in selection order.\"\n },\n \"errors\": {\n \"type\": \"array\",\n \"items\": {\n \"$ref\": \"#/definitions/ExtensionImportFailure\"\n },\n \"description\": \"Failed selected imports or identifier persistence.\"\n },\n \"identifiersUpdated\": {\n \"type\": \"boolean\",\n \"description\": \"Whether the extension identifier persistence step completed.\"\n }\n },\n \"required\": [\n \"status\",\n \"reason\",\n \"extensions\",\n \"errors\",\n \"identifiersUpdated\"\n ],\n \"additionalProperties\": false,\n \"title\": \"ImportDashboardExtensionsResult\",\n \"definitions\": {\n \"ImportedDashboardExtension\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"type\": \"string\",\n \"format\": \"uuid\",\n \"description\": \"The dashboard extension registration UUID, not a Shopify GID.\"\n },\n \"name\": {\n \"type\": \"string\"\n },\n \"type\": {\n \"type\": \"string\",\n \"minLength\": 1,\n \"description\": \"The upstream dashboard extension type.\"\n },\n \"directory\": {\n \"type\": \"string\",\n \"description\": \"The absolute local extension directory.\"\n },\n \"configurationPath\": {\n \"anyOf\": [\n {\n \"$ref\": \"#/definitions/ImportedDashboardExtension/properties/directory\"\n },\n {\n \"type\": \"null\"\n }\n ],\n \"description\": \"The absolute local TOML path, or null when no TOML file exists in a kept directory.\"\n },\n \"changed\": {\n \"type\": \"boolean\",\n \"description\": \"Whether this import wrote the local extension TOML.\"\n }\n },\n \"required\": [\n \"id\",\n \"name\",\n \"type\",\n \"directory\",\n \"configurationPath\",\n \"changed\"\n ],\n \"additionalProperties\": false\n },\n \"ExtensionImportFailure\": {\n \"type\": \"object\",\n \"properties\": {\n \"extensionId\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"format\": \"uuid\"\n },\n {\n \"type\": \"null\"\n }\n ],\n \"description\": \"The registration UUID, or null for identifier persistence.\"\n },\n \"error\": {\n \"$ref\": \"#/definitions/JsonError\"\n }\n },\n \"required\": [\n \"extensionId\",\n \"error\"\n ],\n \"additionalProperties\": false\n },\n \"JsonError\": {\n \"anyOf\": [\n {\n \"$ref\": \"#/definitions/JsonAbortError\"\n },\n {\n \"$ref\": \"#/definitions/JsonBugError\"\n },\n {\n \"$ref\": \"#/definitions/JsonExternalError\"\n }\n ]\n },\n \"JsonErrorCustomSection\": {\n \"type\": \"object\",\n \"properties\": {\n \"title\": {\n \"type\": \"string\"\n },\n \"body\": {\n \"anyOf\": [\n {\n \"type\": \"string\"\n },\n {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n }\n ]\n }\n },\n \"required\": [\n \"body\"\n ],\n \"additionalProperties\": false\n },\n \"JsonAbortError\": {\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"const\": \"abort\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"code\": {\n \"type\": \"string\",\n \"minLength\": 1,\n \"description\": \"A stable error code, included only when known.\"\n },\n \"tryMessage\": {\n \"type\": \"string\"\n },\n \"nextSteps\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n },\n \"customSections\": {\n \"type\": \"array\",\n \"items\": {\n \"$ref\": \"#/definitions/JsonErrorCustomSection\"\n }\n },\n \"details\": {\n \"description\": \"Selected domain details, preserving native API payloads such as GraphQL errors, extensions, and data.\"\n }\n },\n \"required\": [\n \"type\",\n \"message\"\n ],\n \"additionalProperties\": false\n },\n \"JsonBugError\": {\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"const\": \"bug\"\n },\n \"message\": {\n \"$ref\": \"#/definitions/JsonAbortError/properties/message\"\n },\n \"code\": {\n \"$ref\": \"#/definitions/JsonAbortError/properties/code\"\n },\n \"tryMessage\": {\n \"$ref\": \"#/definitions/JsonAbortError/properties/tryMessage\"\n },\n \"nextSteps\": {\n \"$ref\": \"#/definitions/JsonAbortError/properties/nextSteps\"\n },\n \"customSections\": {\n \"$ref\": \"#/definitions/JsonAbortError/properties/customSections\"\n },\n \"details\": {\n \"$ref\": \"#/definitions/JsonAbortError/properties/details\"\n },\n \"stack\": {\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"type\",\n \"message\"\n ],\n \"additionalProperties\": false\n },\n \"JsonExternalError\": {\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"const\": \"external\"\n },\n \"message\": {\n \"$ref\": \"#/definitions/JsonAbortError/properties/message\"\n },\n \"code\": {\n \"$ref\": \"#/definitions/JsonAbortError/properties/code\"\n },\n \"tryMessage\": {\n \"$ref\": \"#/definitions/JsonAbortError/properties/tryMessage\"\n },\n \"nextSteps\": {\n \"$ref\": \"#/definitions/JsonAbortError/properties/nextSteps\"\n },\n \"customSections\": {\n \"$ref\": \"#/definitions/JsonAbortError/properties/customSections\"\n },\n \"details\": {\n \"$ref\": \"#/definitions/JsonAbortError/properties/details\"\n },\n \"command\": {\n \"type\": \"string\"\n },\n \"args\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n },\n \"required\": [\n \"type\",\n \"message\",\n \"command\",\n \"args\"\n ],\n \"additionalProperties\": false\n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", - "descriptionWithMarkdown": "Import dashboard-managed extensions into your app.", + "description": "Imports dashboard-managed extensions into your app.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `ImportDashboardExtensionsResult` schema.\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"enum\": [\n \"success\",\n \"partial\",\n \"skipped\",\n \"cancelled\"\n ]\n },\n \"reason\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"enum\": [\n \"no-extensions\",\n \"directory-selection-cancelled\"\n ]\n },\n {\n \"type\": \"null\"\n }\n ]\n },\n \"extensions\": {\n \"type\": \"array\",\n \"items\": {\n \"$ref\": \"#/definitions/ImportedDashboardExtension\"\n },\n \"description\": \"Completed extension imports and kept local directories, in selection order.\"\n },\n \"errors\": {\n \"type\": \"array\",\n \"items\": {\n \"$ref\": \"#/definitions/ExtensionImportFailure\"\n },\n \"description\": \"Failed selected imports or identifier persistence.\"\n },\n \"identifiersUpdated\": {\n \"type\": \"boolean\",\n \"description\": \"Whether the extension identifier persistence step completed.\"\n }\n },\n \"required\": [\n \"status\",\n \"reason\",\n \"extensions\",\n \"errors\",\n \"identifiersUpdated\"\n ],\n \"additionalProperties\": false,\n \"title\": \"ImportDashboardExtensionsResult\",\n \"definitions\": {\n \"ImportedDashboardExtension\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"type\": \"string\",\n \"format\": \"uuid\",\n \"description\": \"The dashboard extension registration UUID, not a Shopify GID.\"\n },\n \"name\": {\n \"type\": \"string\"\n },\n \"type\": {\n \"type\": \"string\",\n \"minLength\": 1,\n \"description\": \"The upstream dashboard extension type.\"\n },\n \"directory\": {\n \"type\": \"string\",\n \"description\": \"The absolute local extension directory.\"\n },\n \"configurationPath\": {\n \"anyOf\": [\n {\n \"$ref\": \"#/definitions/ImportedDashboardExtension/properties/directory\"\n },\n {\n \"type\": \"null\"\n }\n ],\n \"description\": \"The absolute local TOML path, or null when no TOML file exists in a kept directory.\"\n },\n \"changed\": {\n \"type\": \"boolean\",\n \"description\": \"Whether this import wrote the local extension TOML.\"\n }\n },\n \"required\": [\n \"id\",\n \"name\",\n \"type\",\n \"directory\",\n \"configurationPath\",\n \"changed\"\n ],\n \"additionalProperties\": false\n },\n \"ExtensionImportFailure\": {\n \"type\": \"object\",\n \"properties\": {\n \"extensionId\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"format\": \"uuid\"\n },\n {\n \"type\": \"null\"\n }\n ],\n \"description\": \"The registration UUID, or null for identifier persistence.\"\n },\n \"error\": {\n \"$ref\": \"#/definitions/JsonError\"\n }\n },\n \"required\": [\n \"extensionId\",\n \"error\"\n ],\n \"additionalProperties\": false\n },\n \"JsonError\": {\n \"anyOf\": [\n {\n \"$ref\": \"#/definitions/JsonAbortError\"\n },\n {\n \"$ref\": \"#/definitions/JsonBugError\"\n },\n {\n \"$ref\": \"#/definitions/JsonExternalError\"\n }\n ]\n },\n \"JsonErrorCustomSection\": {\n \"type\": \"object\",\n \"properties\": {\n \"title\": {\n \"type\": \"string\"\n },\n \"body\": {\n \"anyOf\": [\n {\n \"type\": \"string\"\n },\n {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n }\n ]\n }\n },\n \"required\": [\n \"body\"\n ],\n \"additionalProperties\": false\n },\n \"JsonAbortError\": {\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"const\": \"abort\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"code\": {\n \"type\": \"string\",\n \"minLength\": 1,\n \"description\": \"A stable error code, included only when known.\"\n },\n \"tryMessage\": {\n \"type\": \"string\"\n },\n \"nextSteps\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n },\n \"customSections\": {\n \"type\": \"array\",\n \"items\": {\n \"$ref\": \"#/definitions/JsonErrorCustomSection\"\n }\n },\n \"details\": {\n \"description\": \"Selected domain details, preserving native API payloads such as GraphQL errors, extensions, and data.\"\n }\n },\n \"required\": [\n \"type\",\n \"message\"\n ],\n \"additionalProperties\": false\n },\n \"JsonBugError\": {\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"const\": \"bug\"\n },\n \"message\": {\n \"$ref\": \"#/definitions/JsonAbortError/properties/message\"\n },\n \"code\": {\n \"$ref\": \"#/definitions/JsonAbortError/properties/code\"\n },\n \"tryMessage\": {\n \"$ref\": \"#/definitions/JsonAbortError/properties/tryMessage\"\n },\n \"nextSteps\": {\n \"$ref\": \"#/definitions/JsonAbortError/properties/nextSteps\"\n },\n \"customSections\": {\n \"$ref\": \"#/definitions/JsonAbortError/properties/customSections\"\n },\n \"details\": {\n \"$ref\": \"#/definitions/JsonAbortError/properties/details\"\n },\n \"stack\": {\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"type\",\n \"message\"\n ],\n \"additionalProperties\": false\n },\n \"JsonExternalError\": {\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"const\": \"external\"\n },\n \"message\": {\n \"$ref\": \"#/definitions/JsonAbortError/properties/message\"\n },\n \"code\": {\n \"$ref\": \"#/definitions/JsonAbortError/properties/code\"\n },\n \"tryMessage\": {\n \"$ref\": \"#/definitions/JsonAbortError/properties/tryMessage\"\n },\n \"nextSteps\": {\n \"$ref\": \"#/definitions/JsonAbortError/properties/nextSteps\"\n },\n \"customSections\": {\n \"$ref\": \"#/definitions/JsonAbortError/properties/customSections\"\n },\n \"details\": {\n \"$ref\": \"#/definitions/JsonAbortError/properties/details\"\n },\n \"command\": {\n \"type\": \"string\"\n },\n \"args\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n },\n \"required\": [\n \"type\",\n \"message\",\n \"command\",\n \"args\"\n ],\n \"additionalProperties\": false\n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", + "descriptionWithMarkdown": "Imports dashboard-managed extensions into your app.", "flags": { "auth-alias": { "description": "Alias of the Shopify account to use for authentication.", @@ -3209,7 +3209,7 @@ "pluginName": "@shopify/cli", "pluginType": "core", "strict": true, - "summary": "Import your app's default channel spec as a channel_config extension." + "summary": "Imports your app's default channel spec as a channel_config extension." }, "app:import:custom-data-definitions": { "aliases": [ @@ -3217,8 +3217,8 @@ "args": { }, "customPluginName": "@shopify/app", - "description": "Import metafield and metaobject definitions from your development store. \"Read more about declarative custom data definitions\" (https://shopify.dev/docs/apps/build/custom-data/declarative-custom-data-definitions).\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `ImportCustomDataDefinitionsResult` schema.\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"const\": \"success\"\n },\n \"storeDomain\": {\n \"type\": [\n \"string\",\n \"null\"\n ],\n \"description\": \"The full myshopify.com domain of the development store, or null when unavailable.\"\n },\n \"metafieldCount\": {\n \"type\": \"integer\",\n \"minimum\": 0,\n \"description\": \"The number of available metafields converted to TOML.\"\n },\n \"metaobjectCount\": {\n \"type\": \"integer\",\n \"minimum\": 0,\n \"description\": \"The number of available metaobjects converted to TOML.\"\n },\n \"toml\": {\n \"type\": \"string\",\n \"description\": \"Suggested native TOML for app-reserved definitions. No file is written.\"\n },\n \"skippedSections\": {\n \"type\": \"array\",\n \"items\": {\n \"anyOf\": [\n {\n \"$ref\": \"#/definitions/SkippedMetafields\"\n },\n {\n \"$ref\": \"#/definitions/SkippedMetaobjects\"\n }\n ]\n },\n \"description\": \"Sections skipped because required access scopes are unavailable. An empty array means all requests were authorized.\"\n }\n },\n \"required\": [\n \"status\",\n \"storeDomain\",\n \"metafieldCount\",\n \"metaobjectCount\",\n \"toml\",\n \"skippedSections\"\n ],\n \"additionalProperties\": false,\n \"title\": \"ImportCustomDataDefinitionsResult\",\n \"definitions\": {\n \"SkippedMetafields\": {\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"const\": \"metafields\"\n },\n \"ownerType\": {\n \"type\": \"string\",\n \"minLength\": 1,\n \"description\": \"The Admin API metafield owner type, such as PRODUCT.\"\n }\n },\n \"required\": [\n \"type\",\n \"ownerType\"\n ],\n \"additionalProperties\": false\n },\n \"SkippedMetaobjects\": {\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"const\": \"metaobjects\"\n }\n },\n \"required\": [\n \"type\"\n ],\n \"additionalProperties\": false\n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", - "descriptionWithMarkdown": "Import metafield and metaobject definitions from your development store. [Read more about declarative custom data definitions](https://shopify.dev/docs/apps/build/custom-data/declarative-custom-data-definitions).", + "description": "Imports metafield and metaobject definitions from your development store. \"Read more about declarative custom data definitions\" (https://shopify.dev/docs/apps/build/custom-data/declarative-custom-data-definitions).\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `ImportCustomDataDefinitionsResult` schema.\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"const\": \"success\"\n },\n \"storeDomain\": {\n \"type\": [\n \"string\",\n \"null\"\n ],\n \"description\": \"The full myshopify.com domain of the development store, or null when unavailable.\"\n },\n \"metafieldCount\": {\n \"type\": \"integer\",\n \"minimum\": 0,\n \"description\": \"The number of available metafields converted to TOML.\"\n },\n \"metaobjectCount\": {\n \"type\": \"integer\",\n \"minimum\": 0,\n \"description\": \"The number of available metaobjects converted to TOML.\"\n },\n \"toml\": {\n \"type\": \"string\",\n \"description\": \"Suggested native TOML for app-reserved definitions. No file is written.\"\n },\n \"skippedSections\": {\n \"type\": \"array\",\n \"items\": {\n \"anyOf\": [\n {\n \"$ref\": \"#/definitions/SkippedMetafields\"\n },\n {\n \"$ref\": \"#/definitions/SkippedMetaobjects\"\n }\n ]\n },\n \"description\": \"Sections skipped because required access scopes are unavailable. An empty array means all requests were authorized.\"\n }\n },\n \"required\": [\n \"status\",\n \"storeDomain\",\n \"metafieldCount\",\n \"metaobjectCount\",\n \"toml\",\n \"skippedSections\"\n ],\n \"additionalProperties\": false,\n \"title\": \"ImportCustomDataDefinitionsResult\",\n \"definitions\": {\n \"SkippedMetafields\": {\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"const\": \"metafields\"\n },\n \"ownerType\": {\n \"type\": \"string\",\n \"minLength\": 1,\n \"description\": \"The Admin API metafield owner type, such as PRODUCT.\"\n }\n },\n \"required\": [\n \"type\",\n \"ownerType\"\n ],\n \"additionalProperties\": false\n },\n \"SkippedMetaobjects\": {\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"const\": \"metaobjects\"\n }\n },\n \"required\": [\n \"type\"\n ],\n \"additionalProperties\": false\n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", + "descriptionWithMarkdown": "Imports metafield and metaobject definitions from your development store. [Read more about declarative custom data definitions](https://shopify.dev/docs/apps/build/custom-data/declarative-custom-data-definitions).", "flags": { "auth-alias": { "description": "Alias of the Shopify account to use for authentication.", @@ -3334,7 +3334,7 @@ "pluginName": "@shopify/cli", "pluginType": "core", "strict": true, - "summary": "Import metafield and metaobject definitions." + "summary": "Imports metafield and metaobject definitions." }, "app:import:dashboard-extensions": { "aliases": [ @@ -3342,8 +3342,8 @@ "args": { }, "customPluginName": "@shopify/app", - "description": "Import dashboard-managed extensions into your app.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `ImportDashboardExtensionsResult` schema.\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"enum\": [\n \"success\",\n \"partial\",\n \"skipped\",\n \"cancelled\"\n ]\n },\n \"reason\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"enum\": [\n \"no-extensions\",\n \"directory-selection-cancelled\"\n ]\n },\n {\n \"type\": \"null\"\n }\n ]\n },\n \"extensions\": {\n \"type\": \"array\",\n \"items\": {\n \"$ref\": \"#/definitions/ImportedDashboardExtension\"\n },\n \"description\": \"Completed extension imports and kept local directories, in selection order.\"\n },\n \"errors\": {\n \"type\": \"array\",\n \"items\": {\n \"$ref\": \"#/definitions/ExtensionImportFailure\"\n },\n \"description\": \"Failed selected imports or identifier persistence.\"\n },\n \"identifiersUpdated\": {\n \"type\": \"boolean\",\n \"description\": \"Whether the extension identifier persistence step completed.\"\n }\n },\n \"required\": [\n \"status\",\n \"reason\",\n \"extensions\",\n \"errors\",\n \"identifiersUpdated\"\n ],\n \"additionalProperties\": false,\n \"title\": \"ImportDashboardExtensionsResult\",\n \"definitions\": {\n \"ImportedDashboardExtension\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"type\": \"string\",\n \"format\": \"uuid\",\n \"description\": \"The dashboard extension registration UUID, not a Shopify GID.\"\n },\n \"name\": {\n \"type\": \"string\"\n },\n \"type\": {\n \"type\": \"string\",\n \"minLength\": 1,\n \"description\": \"The upstream dashboard extension type.\"\n },\n \"directory\": {\n \"type\": \"string\",\n \"description\": \"The absolute local extension directory.\"\n },\n \"configurationPath\": {\n \"anyOf\": [\n {\n \"$ref\": \"#/definitions/ImportedDashboardExtension/properties/directory\"\n },\n {\n \"type\": \"null\"\n }\n ],\n \"description\": \"The absolute local TOML path, or null when no TOML file exists in a kept directory.\"\n },\n \"changed\": {\n \"type\": \"boolean\",\n \"description\": \"Whether this import wrote the local extension TOML.\"\n }\n },\n \"required\": [\n \"id\",\n \"name\",\n \"type\",\n \"directory\",\n \"configurationPath\",\n \"changed\"\n ],\n \"additionalProperties\": false\n },\n \"ExtensionImportFailure\": {\n \"type\": \"object\",\n \"properties\": {\n \"extensionId\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"format\": \"uuid\"\n },\n {\n \"type\": \"null\"\n }\n ],\n \"description\": \"The registration UUID, or null for identifier persistence.\"\n },\n \"error\": {\n \"$ref\": \"#/definitions/JsonError\"\n }\n },\n \"required\": [\n \"extensionId\",\n \"error\"\n ],\n \"additionalProperties\": false\n },\n \"JsonError\": {\n \"anyOf\": [\n {\n \"$ref\": \"#/definitions/JsonAbortError\"\n },\n {\n \"$ref\": \"#/definitions/JsonBugError\"\n },\n {\n \"$ref\": \"#/definitions/JsonExternalError\"\n }\n ]\n },\n \"JsonErrorCustomSection\": {\n \"type\": \"object\",\n \"properties\": {\n \"title\": {\n \"type\": \"string\"\n },\n \"body\": {\n \"anyOf\": [\n {\n \"type\": \"string\"\n },\n {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n }\n ]\n }\n },\n \"required\": [\n \"body\"\n ],\n \"additionalProperties\": false\n },\n \"JsonAbortError\": {\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"const\": \"abort\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"code\": {\n \"type\": \"string\",\n \"minLength\": 1,\n \"description\": \"A stable error code, included only when known.\"\n },\n \"tryMessage\": {\n \"type\": \"string\"\n },\n \"nextSteps\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n },\n \"customSections\": {\n \"type\": \"array\",\n \"items\": {\n \"$ref\": \"#/definitions/JsonErrorCustomSection\"\n }\n },\n \"details\": {\n \"description\": \"Selected domain details, preserving native API payloads such as GraphQL errors, extensions, and data.\"\n }\n },\n \"required\": [\n \"type\",\n \"message\"\n ],\n \"additionalProperties\": false\n },\n \"JsonBugError\": {\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"const\": \"bug\"\n },\n \"message\": {\n \"$ref\": \"#/definitions/JsonAbortError/properties/message\"\n },\n \"code\": {\n \"$ref\": \"#/definitions/JsonAbortError/properties/code\"\n },\n \"tryMessage\": {\n \"$ref\": \"#/definitions/JsonAbortError/properties/tryMessage\"\n },\n \"nextSteps\": {\n \"$ref\": \"#/definitions/JsonAbortError/properties/nextSteps\"\n },\n \"customSections\": {\n \"$ref\": \"#/definitions/JsonAbortError/properties/customSections\"\n },\n \"details\": {\n \"$ref\": \"#/definitions/JsonAbortError/properties/details\"\n },\n \"stack\": {\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"type\",\n \"message\"\n ],\n \"additionalProperties\": false\n },\n \"JsonExternalError\": {\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"const\": \"external\"\n },\n \"message\": {\n \"$ref\": \"#/definitions/JsonAbortError/properties/message\"\n },\n \"code\": {\n \"$ref\": \"#/definitions/JsonAbortError/properties/code\"\n },\n \"tryMessage\": {\n \"$ref\": \"#/definitions/JsonAbortError/properties/tryMessage\"\n },\n \"nextSteps\": {\n \"$ref\": \"#/definitions/JsonAbortError/properties/nextSteps\"\n },\n \"customSections\": {\n \"$ref\": \"#/definitions/JsonAbortError/properties/customSections\"\n },\n \"details\": {\n \"$ref\": \"#/definitions/JsonAbortError/properties/details\"\n },\n \"command\": {\n \"type\": \"string\"\n },\n \"args\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n },\n \"required\": [\n \"type\",\n \"message\",\n \"command\",\n \"args\"\n ],\n \"additionalProperties\": false\n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", - "descriptionWithMarkdown": "Import dashboard-managed extensions into your app.", + "description": "Imports dashboard-managed extensions into your app.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `ImportDashboardExtensionsResult` schema.\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"enum\": [\n \"success\",\n \"partial\",\n \"skipped\",\n \"cancelled\"\n ]\n },\n \"reason\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"enum\": [\n \"no-extensions\",\n \"directory-selection-cancelled\"\n ]\n },\n {\n \"type\": \"null\"\n }\n ]\n },\n \"extensions\": {\n \"type\": \"array\",\n \"items\": {\n \"$ref\": \"#/definitions/ImportedDashboardExtension\"\n },\n \"description\": \"Completed extension imports and kept local directories, in selection order.\"\n },\n \"errors\": {\n \"type\": \"array\",\n \"items\": {\n \"$ref\": \"#/definitions/ExtensionImportFailure\"\n },\n \"description\": \"Failed selected imports or identifier persistence.\"\n },\n \"identifiersUpdated\": {\n \"type\": \"boolean\",\n \"description\": \"Whether the extension identifier persistence step completed.\"\n }\n },\n \"required\": [\n \"status\",\n \"reason\",\n \"extensions\",\n \"errors\",\n \"identifiersUpdated\"\n ],\n \"additionalProperties\": false,\n \"title\": \"ImportDashboardExtensionsResult\",\n \"definitions\": {\n \"ImportedDashboardExtension\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"type\": \"string\",\n \"format\": \"uuid\",\n \"description\": \"The dashboard extension registration UUID, not a Shopify GID.\"\n },\n \"name\": {\n \"type\": \"string\"\n },\n \"type\": {\n \"type\": \"string\",\n \"minLength\": 1,\n \"description\": \"The upstream dashboard extension type.\"\n },\n \"directory\": {\n \"type\": \"string\",\n \"description\": \"The absolute local extension directory.\"\n },\n \"configurationPath\": {\n \"anyOf\": [\n {\n \"$ref\": \"#/definitions/ImportedDashboardExtension/properties/directory\"\n },\n {\n \"type\": \"null\"\n }\n ],\n \"description\": \"The absolute local TOML path, or null when no TOML file exists in a kept directory.\"\n },\n \"changed\": {\n \"type\": \"boolean\",\n \"description\": \"Whether this import wrote the local extension TOML.\"\n }\n },\n \"required\": [\n \"id\",\n \"name\",\n \"type\",\n \"directory\",\n \"configurationPath\",\n \"changed\"\n ],\n \"additionalProperties\": false\n },\n \"ExtensionImportFailure\": {\n \"type\": \"object\",\n \"properties\": {\n \"extensionId\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"format\": \"uuid\"\n },\n {\n \"type\": \"null\"\n }\n ],\n \"description\": \"The registration UUID, or null for identifier persistence.\"\n },\n \"error\": {\n \"$ref\": \"#/definitions/JsonError\"\n }\n },\n \"required\": [\n \"extensionId\",\n \"error\"\n ],\n \"additionalProperties\": false\n },\n \"JsonError\": {\n \"anyOf\": [\n {\n \"$ref\": \"#/definitions/JsonAbortError\"\n },\n {\n \"$ref\": \"#/definitions/JsonBugError\"\n },\n {\n \"$ref\": \"#/definitions/JsonExternalError\"\n }\n ]\n },\n \"JsonErrorCustomSection\": {\n \"type\": \"object\",\n \"properties\": {\n \"title\": {\n \"type\": \"string\"\n },\n \"body\": {\n \"anyOf\": [\n {\n \"type\": \"string\"\n },\n {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n }\n ]\n }\n },\n \"required\": [\n \"body\"\n ],\n \"additionalProperties\": false\n },\n \"JsonAbortError\": {\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"const\": \"abort\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"code\": {\n \"type\": \"string\",\n \"minLength\": 1,\n \"description\": \"A stable error code, included only when known.\"\n },\n \"tryMessage\": {\n \"type\": \"string\"\n },\n \"nextSteps\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n },\n \"customSections\": {\n \"type\": \"array\",\n \"items\": {\n \"$ref\": \"#/definitions/JsonErrorCustomSection\"\n }\n },\n \"details\": {\n \"description\": \"Selected domain details, preserving native API payloads such as GraphQL errors, extensions, and data.\"\n }\n },\n \"required\": [\n \"type\",\n \"message\"\n ],\n \"additionalProperties\": false\n },\n \"JsonBugError\": {\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"const\": \"bug\"\n },\n \"message\": {\n \"$ref\": \"#/definitions/JsonAbortError/properties/message\"\n },\n \"code\": {\n \"$ref\": \"#/definitions/JsonAbortError/properties/code\"\n },\n \"tryMessage\": {\n \"$ref\": \"#/definitions/JsonAbortError/properties/tryMessage\"\n },\n \"nextSteps\": {\n \"$ref\": \"#/definitions/JsonAbortError/properties/nextSteps\"\n },\n \"customSections\": {\n \"$ref\": \"#/definitions/JsonAbortError/properties/customSections\"\n },\n \"details\": {\n \"$ref\": \"#/definitions/JsonAbortError/properties/details\"\n },\n \"stack\": {\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"type\",\n \"message\"\n ],\n \"additionalProperties\": false\n },\n \"JsonExternalError\": {\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"const\": \"external\"\n },\n \"message\": {\n \"$ref\": \"#/definitions/JsonAbortError/properties/message\"\n },\n \"code\": {\n \"$ref\": \"#/definitions/JsonAbortError/properties/code\"\n },\n \"tryMessage\": {\n \"$ref\": \"#/definitions/JsonAbortError/properties/tryMessage\"\n },\n \"nextSteps\": {\n \"$ref\": \"#/definitions/JsonAbortError/properties/nextSteps\"\n },\n \"customSections\": {\n \"$ref\": \"#/definitions/JsonAbortError/properties/customSections\"\n },\n \"details\": {\n \"$ref\": \"#/definitions/JsonAbortError/properties/details\"\n },\n \"command\": {\n \"type\": \"string\"\n },\n \"args\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n },\n \"required\": [\n \"type\",\n \"message\",\n \"command\",\n \"args\"\n ],\n \"additionalProperties\": false\n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", + "descriptionWithMarkdown": "Imports dashboard-managed extensions into your app.", "flags": { "auth-alias": { "description": "Alias of the Shopify account to use for authentication.", @@ -3559,7 +3559,7 @@ "pluginName": "@shopify/cli", "pluginType": "core", "strict": true, - "summary": "Print basic information about your app and extensions." + "summary": "Prints basic information about your app and extensions." }, "app:init": { "aliases": [ @@ -3702,7 +3702,7 @@ "pluginName": "@shopify/cli", "pluginType": "core", "strict": true, - "summary": "Create a new app project" + "summary": "Creates a new app project" }, "app:logs": { "aliases": [ @@ -3840,7 +3840,7 @@ "pluginName": "@shopify/cli", "pluginType": "core", "strict": true, - "summary": "Stream detailed logs for your Shopify app." + "summary": "Streams detailed logs for your Shopify app." }, "app:logs:sources": { "aliases": [ @@ -3949,7 +3949,7 @@ "pluginName": "@shopify/cli", "pluginType": "core", "strict": true, - "summary": "Print out a list of sources that may be used with the logs command." + "summary": "Prints out a list of sources that may be used with the logs command." }, "app:release": { "aliases": [ @@ -4075,7 +4075,7 @@ "pluginName": "@shopify/cli", "pluginType": "core", "strict": true, - "summary": "Release an app version.", + "summary": "Releases an app version.", "usage": "app release --version " }, "app:security:check": { @@ -4239,7 +4239,7 @@ "pluginName": "@shopify/cli", "pluginType": "core", "strict": true, - "summary": "Check an app for Shopify-specific security issues and write deterministic-findings.json and agent-checks.json." + "summary": "Checks an app for Shopify-specific security issues and writes deterministic-findings.json and agent-checks.json." }, "app:security:clean": { "aliases": [ @@ -4351,7 +4351,7 @@ "pluginName": "@shopify/cli", "pluginType": "core", "strict": true, - "summary": "Remove local app security check results." + "summary": "Removes local app security check results." }, "app:security:instructions": { "aliases": [ @@ -4467,7 +4467,7 @@ "pluginName": "@shopify/cli", "pluginType": "core", "strict": true, - "summary": "Provide app security check instructions to a coding agent." + "summary": "Provides app security check instructions to a coding agent." }, "app:security:record": { "aliases": [ @@ -4562,7 +4562,7 @@ "pluginName": "@shopify/cli", "pluginType": "core", "strict": true, - "summary": "Record agent findings from an app security check." + "summary": "Records agent findings from an app security check." }, "app:security:review": { "aliases": [ @@ -4680,7 +4680,7 @@ "pluginName": "@shopify/cli", "pluginType": "core", "strict": true, - "summary": "Show the combined app security check results." + "summary": "Shows the combined app security check results." }, "app:subscription-migrations:cancel": { "aliases": [ @@ -5451,7 +5451,7 @@ "pluginName": "@shopify/cli", "pluginType": "core", "strict": true, - "summary": "List deployed versions of your app." + "summary": "Lists deployed versions of your app." }, "app:webhook:trigger": { "aliases": [ @@ -5624,7 +5624,7 @@ "pluginName": "@shopify/cli", "pluginType": "core", "strict": true, - "summary": "Trigger delivery of a sample webhook topic payload to a designated address." + "summary": "Triggers delivery of a sample webhook topic payload to a designated address." }, "auth:login": { "aliases": [ @@ -5755,7 +5755,7 @@ ], "args": { }, - "description": "Clear the CLI cache, used to store some API responses and handle notifications status", + "description": "Clears the CLI cache, used to store some API responses and handle notifications status", "enableJsonFlag": false, "flags": { "json-schema": { @@ -5880,8 +5880,8 @@ "args": { }, "customPluginName": "@shopify/plugin-did-you-mean", - "description": "Disable autocorrect. Off by default.\n\n When autocorrection is enabled, Shopify CLI automatically runs a corrected version of your command if a correction is available.\n\n When autocorrection is disabled, you need to confirm that you want to run corrections for mistyped commands.\n", - "descriptionWithMarkdown": "Disable autocorrect. Off by default.\n\n When autocorrection is enabled, Shopify CLI automatically runs a corrected version of your command if a correction is available.\n\n When autocorrection is disabled, you need to confirm that you want to run corrections for mistyped commands.\n", + "description": "Disables autocorrect. Off by default.\n\n When autocorrection is enabled, Shopify CLI automatically runs a corrected version of your command if a correction is available.\n\n When autocorrection is disabled, you need to confirm that you want to run corrections for mistyped commands.\n", + "descriptionWithMarkdown": "Disables autocorrect. Off by default.\n\n When autocorrection is enabled, Shopify CLI automatically runs a corrected version of your command if a correction is available.\n\n When autocorrection is disabled, you need to confirm that you want to run corrections for mistyped commands.\n", "enableJsonFlag": false, "flags": { "json-schema": { @@ -5900,7 +5900,7 @@ "pluginName": "@shopify/cli", "pluginType": "core", "strict": true, - "summary": "Disable autocorrect. Off by default." + "summary": "Disables autocorrect. Off by default." }, "config:autocorrect:on": { "aliases": [ @@ -5908,8 +5908,8 @@ "args": { }, "customPluginName": "@shopify/plugin-did-you-mean", - "description": "Enable autocorrect. Off by default.\n\n When autocorrection is enabled, Shopify CLI automatically runs a corrected version of your command if a correction is available.\n\n When autocorrection is disabled, you need to confirm that you want to run corrections for mistyped commands.\n", - "descriptionWithMarkdown": "Enable autocorrect. Off by default.\n\n When autocorrection is enabled, Shopify CLI automatically runs a corrected version of your command if a correction is available.\n\n When autocorrection is disabled, you need to confirm that you want to run corrections for mistyped commands.\n", + "description": "Enables autocorrect. Off by default.\n\n When autocorrection is enabled, Shopify CLI automatically runs a corrected version of your command if a correction is available.\n\n When autocorrection is disabled, you need to confirm that you want to run corrections for mistyped commands.\n", + "descriptionWithMarkdown": "Enables autocorrect. Off by default.\n\n When autocorrection is enabled, Shopify CLI automatically runs a corrected version of your command if a correction is available.\n\n When autocorrection is disabled, you need to confirm that you want to run corrections for mistyped commands.\n", "enableJsonFlag": false, "flags": { "json-schema": { @@ -5928,7 +5928,7 @@ "pluginName": "@shopify/cli", "pluginType": "core", "strict": true, - "summary": "Enable autocorrect. Off by default." + "summary": "Enables autocorrect. Off by default." }, "config:autocorrect:status": { "aliases": [ @@ -5936,8 +5936,8 @@ "args": { }, "customPluginName": "@shopify/plugin-did-you-mean", - "description": "Check whether autocorrect is enabled or disabled. On by default.\n\n When autocorrection is enabled, Shopify CLI automatically runs a corrected version of your command if a correction is available.\n\n When autocorrection is disabled, you need to confirm that you want to run corrections for mistyped commands.\n", - "descriptionWithMarkdown": "Check whether autocorrect is enabled or disabled. On by default.\n\n When autocorrection is enabled, Shopify CLI automatically runs a corrected version of your command if a correction is available.\n\n When autocorrection is disabled, you need to confirm that you want to run corrections for mistyped commands.\n", + "description": "Checks whether autocorrect is enabled or disabled. On by default.\n\n When autocorrection is enabled, Shopify CLI automatically runs a corrected version of your command if a correction is available.\n\n When autocorrection is disabled, you need to confirm that you want to run corrections for mistyped commands.\n", + "descriptionWithMarkdown": "Checks whether autocorrect is enabled or disabled. On by default.\n\n When autocorrection is enabled, Shopify CLI automatically runs a corrected version of your command if a correction is available.\n\n When autocorrection is disabled, you need to confirm that you want to run corrections for mistyped commands.\n", "enableJsonFlag": false, "flags": { "json-schema": { @@ -5956,15 +5956,15 @@ "pluginName": "@shopify/cli", "pluginType": "core", "strict": true, - "summary": "Check whether autocorrect is enabled or disabled. On by default." + "summary": "Checks whether autocorrect is enabled or disabled. On by default." }, "config:autoupgrade:off": { "aliases": [ ], "args": { }, - "description": "Disable automatic upgrades for Shopify CLI.\n\n When auto-upgrade is disabled, Shopify CLI won't automatically update. Run `shopify upgrade` to update manually.\n\n To enable auto-upgrade, run `shopify config autoupgrade on`.\n\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `AutoUpgradeResult` schema.\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"enabled\": {\n \"type\": \"boolean\"\n }\n },\n \"required\": [\n \"enabled\"\n ],\n \"additionalProperties\": false,\n \"title\": \"AutoUpgradeResult\",\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", - "descriptionWithMarkdown": "Disable automatic upgrades for Shopify CLI.\n\n When auto-upgrade is disabled, Shopify CLI won't automatically update. Run `shopify upgrade` to update manually.\n\n To enable auto-upgrade, run `shopify config autoupgrade on`.\n", + "description": "Disables automatic upgrades for Shopify CLI.\n\n When auto-upgrade is disabled, Shopify CLI won't automatically update. Run `shopify upgrade` to update manually.\n\n To enable auto-upgrade, run `shopify config autoupgrade on`.\n\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `AutoUpgradeResult` schema.\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"enabled\": {\n \"type\": \"boolean\"\n }\n },\n \"required\": [\n \"enabled\"\n ],\n \"additionalProperties\": false,\n \"title\": \"AutoUpgradeResult\",\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", + "descriptionWithMarkdown": "Disables automatic upgrades for Shopify CLI.\n\n When auto-upgrade is disabled, Shopify CLI won't automatically update. Run `shopify upgrade` to update manually.\n\n To enable auto-upgrade, run `shopify config autoupgrade on`.\n", "enableJsonFlag": false, "flags": { "json": { @@ -6015,15 +6015,15 @@ "pluginName": "@shopify/cli", "pluginType": "core", "strict": true, - "summary": "Disable automatic upgrades for Shopify CLI." + "summary": "Disables automatic upgrades for Shopify CLI." }, "config:autoupgrade:on": { "aliases": [ ], "args": { }, - "description": "Enable automatic upgrades for Shopify CLI.\n\n When auto-upgrade is enabled, Shopify CLI automatically updates to the latest version once per day. Major version upgrades are skipped and must be done manually.\n\n To disable auto-upgrade, run `shopify config autoupgrade off`.\n\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `AutoUpgradeResult` schema.\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"enabled\": {\n \"type\": \"boolean\"\n }\n },\n \"required\": [\n \"enabled\"\n ],\n \"additionalProperties\": false,\n \"title\": \"AutoUpgradeResult\",\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", - "descriptionWithMarkdown": "Enable automatic upgrades for Shopify CLI.\n\n When auto-upgrade is enabled, Shopify CLI automatically updates to the latest version once per day. Major version upgrades are skipped and must be done manually.\n\n To disable auto-upgrade, run `shopify config autoupgrade off`.\n", + "description": "Enables automatic upgrades for Shopify CLI.\n\n When auto-upgrade is enabled, Shopify CLI automatically updates to the latest version once per day. Major version upgrades are skipped and must be done manually.\n\n To disable auto-upgrade, run `shopify config autoupgrade off`.\n\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `AutoUpgradeResult` schema.\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"enabled\": {\n \"type\": \"boolean\"\n }\n },\n \"required\": [\n \"enabled\"\n ],\n \"additionalProperties\": false,\n \"title\": \"AutoUpgradeResult\",\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", + "descriptionWithMarkdown": "Enables automatic upgrades for Shopify CLI.\n\n When auto-upgrade is enabled, Shopify CLI automatically updates to the latest version once per day. Major version upgrades are skipped and must be done manually.\n\n To disable auto-upgrade, run `shopify config autoupgrade off`.\n", "enableJsonFlag": false, "flags": { "json": { @@ -6074,15 +6074,15 @@ "pluginName": "@shopify/cli", "pluginType": "core", "strict": true, - "summary": "Enable automatic upgrades for Shopify CLI." + "summary": "Enables automatic upgrades for Shopify CLI." }, "config:autoupgrade:status": { "aliases": [ ], "args": { }, - "description": "Check whether auto-upgrade is enabled, disabled, or not yet configured.\n\n When auto-upgrade is enabled, Shopify CLI automatically updates to the latest version after each command.\n\n Run `shopify config autoupgrade on` or `shopify config autoupgrade off` to configure it.\n\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `AutoUpgradeResult` schema.\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"enabled\": {\n \"type\": \"boolean\"\n }\n },\n \"required\": [\n \"enabled\"\n ],\n \"additionalProperties\": false,\n \"title\": \"AutoUpgradeResult\",\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", - "descriptionWithMarkdown": "Check whether auto-upgrade is enabled, disabled, or not yet configured.\n\n When auto-upgrade is enabled, Shopify CLI automatically updates to the latest version after each command.\n\n Run `shopify config autoupgrade on` or `shopify config autoupgrade off` to configure it.\n", + "description": "Checks whether auto-upgrade is enabled, disabled, or not yet configured.\n\n When auto-upgrade is enabled, Shopify CLI automatically updates to the latest version after each command.\n\n Run `shopify config autoupgrade on` or `shopify config autoupgrade off` to configure it.\n\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `AutoUpgradeResult` schema.\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"enabled\": {\n \"type\": \"boolean\"\n }\n },\n \"required\": [\n \"enabled\"\n ],\n \"additionalProperties\": false,\n \"title\": \"AutoUpgradeResult\",\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", + "descriptionWithMarkdown": "Checks whether auto-upgrade is enabled, disabled, or not yet configured.\n\n When auto-upgrade is enabled, Shopify CLI automatically updates to the latest version after each command.\n\n Run `shopify config autoupgrade on` or `shopify config autoupgrade off` to configure it.\n", "enableJsonFlag": false, "flags": { "json": { @@ -6133,14 +6133,14 @@ "pluginName": "@shopify/cli", "pluginType": "core", "strict": true, - "summary": "Check whether auto-upgrade is enabled, disabled, or not yet configured." + "summary": "Checks whether auto-upgrade is enabled, disabled, or not yet configured." }, "debug:command-flags": { "aliases": [ ], "args": { }, - "description": "View all the available command flags", + "description": "Views all the available command flags", "enableJsonFlag": false, "flags": { "csv": { @@ -6265,15 +6265,15 @@ "pluginName": "@shopify/cli", "pluginType": "core", "strict": true, - "summary": "Watch and prints out changes to an app." + "summary": "Watches and prints out changes to an app." }, "doc:fetch": { "aliases": [ ], "args": { }, - "description": "Download a complete document from shopify.dev. Every page on shopify.dev has a Markdown version, and that is what this tool returns. Use this to pull an entire document verbatim — for example, a set of instructions an agent follows like a centrally-served skill. Pass `--language` for the language of the app you are building so code examples match your stack. For finding the relevant pieces of content across shopify.dev instead, use `doc search`.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `DocFetchResult` schema.\n\n```json\n{\n \"anyOf\": [\n {\n \"type\": \"object\",\n \"properties\": {\n \"document\": {\n \"$ref\": \"#/definitions/Document\"\n }\n },\n \"required\": [\n \"document\"\n ],\n \"additionalProperties\": false\n },\n {\n \"$ref\": \"#/definitions/DocumentFile\"\n }\n ],\n \"title\": \"DocFetchResult\",\n \"definitions\": {\n \"Document\": {\n \"type\": \"object\",\n \"properties\": {\n \"url\": {\n \"type\": \"string\",\n \"format\": \"uri\",\n \"description\": \"The requested shopify.dev document URL.\"\n },\n \"content\": {\n \"type\": \"string\",\n \"description\": \"The document in Markdown, with the requested language filter applied.\"\n }\n },\n \"required\": [\n \"url\",\n \"content\"\n ],\n \"additionalProperties\": false\n },\n \"DocumentFile\": {\n \"type\": \"object\",\n \"properties\": {\n \"path\": {\n \"type\": \"string\",\n \"pattern\": \"^(?:\\\\/|[A-Za-z]:[\\\\\\\\/]|\\\\\\\\\\\\\\\\)\",\n \"description\": \"The absolute native path of the written file.\"\n },\n \"format\": {\n \"type\": \"string\",\n \"const\": \"markdown\",\n \"description\": \"The file contains the original Markdown document, not a JSON wrapper.\"\n }\n },\n \"required\": [\n \"path\",\n \"format\"\n ],\n \"additionalProperties\": false\n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", - "descriptionWithMarkdown": "Download a complete document from shopify.dev. Every page on shopify.dev has a Markdown version, and that is what this tool returns. Use this to pull an entire document verbatim — for example, a set of instructions an agent follows like a centrally-served skill. Pass `--language` for the language of the app you are building so code examples match your stack. For finding the relevant pieces of content across shopify.dev instead, use `doc search`.", + "description": "Downloads a complete document from shopify.dev. Every page on shopify.dev has a Markdown version, and that is what this tool returns. Use this to pull an entire document verbatim — for example, a set of instructions an agent follows like a centrally-served skill. Pass `--language` for the language of the app you are building so code examples match your stack. For finding the relevant pieces of content across shopify.dev instead, use `doc search`.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `DocFetchResult` schema.\n\n```json\n{\n \"anyOf\": [\n {\n \"type\": \"object\",\n \"properties\": {\n \"document\": {\n \"$ref\": \"#/definitions/Document\"\n }\n },\n \"required\": [\n \"document\"\n ],\n \"additionalProperties\": false\n },\n {\n \"$ref\": \"#/definitions/DocumentFile\"\n }\n ],\n \"title\": \"DocFetchResult\",\n \"definitions\": {\n \"Document\": {\n \"type\": \"object\",\n \"properties\": {\n \"url\": {\n \"type\": \"string\",\n \"format\": \"uri\",\n \"description\": \"The requested shopify.dev document URL.\"\n },\n \"content\": {\n \"type\": \"string\",\n \"description\": \"The document in Markdown, with the requested language filter applied.\"\n }\n },\n \"required\": [\n \"url\",\n \"content\"\n ],\n \"additionalProperties\": false\n },\n \"DocumentFile\": {\n \"type\": \"object\",\n \"properties\": {\n \"path\": {\n \"type\": \"string\",\n \"pattern\": \"^(?:\\\\/|[A-Za-z]:[\\\\\\\\/]|\\\\\\\\\\\\\\\\)\",\n \"description\": \"The absolute native path of the written file.\"\n },\n \"format\": {\n \"type\": \"string\",\n \"const\": \"markdown\",\n \"description\": \"The file contains the original Markdown document, not a JSON wrapper.\"\n }\n },\n \"required\": [\n \"path\",\n \"format\"\n ],\n \"additionalProperties\": false\n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", + "descriptionWithMarkdown": "Downloads a complete document from shopify.dev. Every page on shopify.dev has a Markdown version, and that is what this tool returns. Use this to pull an entire document verbatim — for example, a set of instructions an agent follows like a centrally-served skill. Pass `--language` for the language of the app you are building so code examples match your stack. For finding the relevant pieces of content across shopify.dev instead, use `doc search`.", "enableJsonFlag": false, "examples": [ "# fetch the Markdown version of a Shopify.dev page\nshopify doc fetch --url https://shopify.dev/docs/api/shopify-cli", @@ -6373,8 +6373,8 @@ ], "args": { }, - "description": "Query the shopify.dev vector store and print the most relevant documentation chunks as JSON. Best for programmatic discovery — surfacing the relevant pieces of documentation for a topic, rather than retrieving a whole document. To download a full document verbatim, use `doc fetch`.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `DocSearchResult` schema.\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"results\": {\n \"type\": \"array\",\n \"items\": {\n \"$ref\": \"#/definitions/DocumentationSearchEntry\"\n },\n \"description\": \"The top matching chunks from one search request.\"\n },\n \"pageInfo\": {\n \"$ref\": \"#/definitions/PageInfo\"\n }\n },\n \"required\": [\n \"results\",\n \"pageInfo\"\n ],\n \"additionalProperties\": false,\n \"title\": \"DocSearchResult\",\n \"definitions\": {\n \"DocumentationSearchEntry\": {\n \"type\": \"object\",\n \"properties\": {\n \"score\": {\n \"type\": \"number\",\n \"description\": \"The relevance score returned by shopify.dev.\"\n },\n \"content\": {\n \"type\": \"string\",\n \"description\": \"The matching documentation chunk.\"\n },\n \"url\": {\n \"type\": \"string\",\n \"format\": \"uri\",\n \"description\": \"The URL of the matching document.\"\n },\n \"title\": {\n \"type\": \"string\",\n \"description\": \"The title of the matching document.\"\n },\n \"domain\": {\n \"type\": [\n \"string\",\n \"null\"\n ],\n \"description\": \"The documentation domain, or null when unavailable.\"\n }\n },\n \"required\": [\n \"score\",\n \"content\",\n \"url\",\n \"title\",\n \"domain\"\n ],\n \"additionalProperties\": false\n },\n \"PageInfo\": {\n \"type\": \"object\",\n \"properties\": {\n \"hasNextPage\": {\n \"type\": [\n \"boolean\",\n \"null\"\n ],\n \"description\": \"Whether more results are available, or null when unknown.\"\n }\n },\n \"required\": [\n \"hasNextPage\"\n ],\n \"additionalProperties\": false\n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", - "descriptionWithMarkdown": "Query the shopify.dev vector store and print the most relevant documentation chunks as JSON. Best for programmatic discovery — surfacing the relevant pieces of documentation for a topic, rather than retrieving a whole document. To download a full document verbatim, use `doc fetch`.", + "description": "Queries the shopify.dev vector store and prints the most relevant documentation chunks as JSON. Best for programmatic discovery — surfacing the relevant pieces of documentation for a topic, rather than retrieving a whole document. To download a full document verbatim, use `doc fetch`.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `DocSearchResult` schema.\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"results\": {\n \"type\": \"array\",\n \"items\": {\n \"$ref\": \"#/definitions/DocumentationSearchEntry\"\n },\n \"description\": \"The top matching chunks from one search request.\"\n },\n \"pageInfo\": {\n \"$ref\": \"#/definitions/PageInfo\"\n }\n },\n \"required\": [\n \"results\",\n \"pageInfo\"\n ],\n \"additionalProperties\": false,\n \"title\": \"DocSearchResult\",\n \"definitions\": {\n \"DocumentationSearchEntry\": {\n \"type\": \"object\",\n \"properties\": {\n \"score\": {\n \"type\": \"number\",\n \"description\": \"The relevance score returned by shopify.dev.\"\n },\n \"content\": {\n \"type\": \"string\",\n \"description\": \"The matching documentation chunk.\"\n },\n \"url\": {\n \"type\": \"string\",\n \"format\": \"uri\",\n \"description\": \"The URL of the matching document.\"\n },\n \"title\": {\n \"type\": \"string\",\n \"description\": \"The title of the matching document.\"\n },\n \"domain\": {\n \"type\": [\n \"string\",\n \"null\"\n ],\n \"description\": \"The documentation domain, or null when unavailable.\"\n }\n },\n \"required\": [\n \"score\",\n \"content\",\n \"url\",\n \"title\",\n \"domain\"\n ],\n \"additionalProperties\": false\n },\n \"PageInfo\": {\n \"type\": \"object\",\n \"properties\": {\n \"hasNextPage\": {\n \"type\": [\n \"boolean\",\n \"null\"\n ],\n \"description\": \"Whether more results are available, or null when unknown.\"\n }\n },\n \"required\": [\n \"hasNextPage\"\n ],\n \"additionalProperties\": false\n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", + "descriptionWithMarkdown": "Queries the shopify.dev vector store and prints the most relevant documentation chunks as JSON. Best for programmatic discovery — surfacing the relevant pieces of documentation for a topic, rather than retrieving a whole document. To download a full document verbatim, use `doc fetch`.", "enableJsonFlag": false, "examples": [ "# search shopify.dev for a topic\n shopify doc search --query \"subscribe to webhooks\"\n\n # narrow the search to a specific API and version\n shopify doc search --query \"create a product\" --api-name admin --api-version latest", @@ -6460,7 +6460,7 @@ ], "args": { }, - "description": "Generate CLI commands documentation", + "description": "Generates CLI commands documentation", "enableJsonFlag": false, "flags": { "json-schema": { @@ -6486,7 +6486,7 @@ ], "args": { }, - "description": "Run CLI doctor-release tests", + "description": "Runs CLI doctor-release tests", "enableJsonFlag": false, "flags": { "json-schema": { @@ -6512,7 +6512,7 @@ ], "args": { }, - "description": "Run all theme command doctor-release tests", + "description": "Runs all theme command doctor-release tests", "enableJsonFlag": false, "flags": { "environment": { @@ -6603,8 +6603,8 @@ "required": false } }, - "description": "Display help for Shopify CLI\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `HelpResult` schema.\n\n```json\n{\n \"anyOf\": [\n {\n \"type\": \"object\",\n \"properties\": {\n \"kind\": {\n \"type\": \"string\",\n \"const\": \"root\"\n },\n \"commands\": {\n \"type\": \"array\",\n \"items\": {\n \"$ref\": \"#/definitions/HelpCommandSummary\"\n }\n },\n \"topics\": {\n \"type\": \"array\",\n \"items\": {\n \"$ref\": \"#/definitions/HelpTopic\"\n }\n }\n },\n \"required\": [\n \"kind\",\n \"commands\",\n \"topics\"\n ],\n \"additionalProperties\": false\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"kind\": {\n \"type\": \"string\",\n \"const\": \"topic\"\n },\n \"topic\": {\n \"$ref\": \"#/definitions/HelpTopic\"\n },\n \"commands\": {\n \"$ref\": \"#/definitions/HelpResult/anyOf/0/properties/commands\"\n },\n \"topics\": {\n \"$ref\": \"#/definitions/HelpResult/anyOf/0/properties/topics\"\n }\n },\n \"required\": [\n \"kind\",\n \"topic\",\n \"commands\",\n \"topics\"\n ],\n \"additionalProperties\": false\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"kind\": {\n \"type\": \"string\",\n \"const\": \"command\"\n },\n \"command\": {\n \"$ref\": \"#/definitions/HelpCommand\"\n },\n \"commands\": {\n \"$ref\": \"#/definitions/HelpResult/anyOf/0/properties/commands\"\n },\n \"topics\": {\n \"$ref\": \"#/definitions/HelpResult/anyOf/0/properties/topics\"\n }\n },\n \"required\": [\n \"kind\",\n \"command\",\n \"commands\",\n \"topics\"\n ],\n \"additionalProperties\": false\n }\n ],\n \"title\": \"HelpResult\",\n \"definitions\": {\n \"HelpCommandSummary\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"type\": \"string\"\n },\n \"summary\": {\n \"type\": \"string\"\n },\n \"hidden\": {\n \"type\": \"boolean\",\n \"default\": false\n }\n },\n \"required\": [\n \"id\"\n ],\n \"additionalProperties\": false\n },\n \"HelpTopic\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"description\": {\n \"type\": \"string\"\n },\n \"hidden\": {\n \"type\": \"boolean\",\n \"default\": false\n }\n },\n \"required\": [\n \"name\"\n ],\n \"additionalProperties\": false\n },\n \"HelpArgument\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"description\": {\n \"type\": \"string\"\n },\n \"required\": {\n \"type\": \"boolean\",\n \"default\": false\n },\n \"hidden\": {\n \"type\": \"boolean\",\n \"default\": false\n },\n \"options\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n },\n \"default\": {}\n },\n \"required\": [\n \"name\"\n ],\n \"additionalProperties\": false\n },\n \"HelpFlag\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"boolean\",\n \"option\"\n ]\n },\n \"char\": {\n \"type\": \"string\"\n },\n \"summary\": {\n \"type\": \"string\"\n },\n \"description\": {\n \"type\": \"string\"\n },\n \"env\": {\n \"type\": \"string\"\n },\n \"required\": {\n \"type\": \"boolean\",\n \"default\": false\n },\n \"hidden\": {\n \"type\": \"boolean\",\n \"default\": false\n },\n \"options\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n },\n \"default\": {},\n \"multiple\": {\n \"type\": \"boolean\"\n },\n \"allowNo\": {\n \"type\": \"boolean\"\n },\n \"aliases\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n },\n \"dependsOn\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n },\n \"exclusive\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n },\n \"exactlyOne\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n },\n \"required\": [\n \"name\",\n \"type\"\n ],\n \"additionalProperties\": false\n },\n \"HelpCommand\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"$ref\": \"#/definitions/HelpCommandSummary/properties/id\"\n },\n \"summary\": {\n \"$ref\": \"#/definitions/HelpCommandSummary/properties/summary\"\n },\n \"hidden\": {\n \"$ref\": \"#/definitions/HelpCommandSummary/properties/hidden\"\n },\n \"description\": {\n \"type\": \"string\"\n },\n \"aliases\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n },\n \"usage\": {\n \"anyOf\": [\n {\n \"type\": \"string\"\n },\n {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n ]\n },\n \"examples\": {\n \"type\": \"array\",\n \"items\": {\n \"anyOf\": [\n {\n \"type\": \"string\"\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"description\": {\n \"type\": \"string\"\n },\n \"command\": {\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"description\",\n \"command\"\n ],\n \"additionalProperties\": false\n }\n ]\n }\n },\n \"strict\": {\n \"type\": \"boolean\",\n \"default\": true\n },\n \"args\": {\n \"type\": \"object\",\n \"additionalProperties\": {\n \"$ref\": \"#/definitions/HelpArgument\"\n }\n },\n \"flags\": {\n \"type\": \"object\",\n \"additionalProperties\": {\n \"$ref\": \"#/definitions/HelpFlag\"\n }\n }\n },\n \"required\": [\n \"id\",\n \"aliases\",\n \"args\",\n \"flags\"\n ],\n \"additionalProperties\": false\n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", - "descriptionWithMarkdown": "Display help for Shopify CLI", + "description": "Displays help for Shopify CLI\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `HelpResult` schema.\n\n```json\n{\n \"anyOf\": [\n {\n \"type\": \"object\",\n \"properties\": {\n \"kind\": {\n \"type\": \"string\",\n \"const\": \"root\"\n },\n \"commands\": {\n \"type\": \"array\",\n \"items\": {\n \"$ref\": \"#/definitions/HelpCommandSummary\"\n }\n },\n \"topics\": {\n \"type\": \"array\",\n \"items\": {\n \"$ref\": \"#/definitions/HelpTopic\"\n }\n }\n },\n \"required\": [\n \"kind\",\n \"commands\",\n \"topics\"\n ],\n \"additionalProperties\": false\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"kind\": {\n \"type\": \"string\",\n \"const\": \"topic\"\n },\n \"topic\": {\n \"$ref\": \"#/definitions/HelpTopic\"\n },\n \"commands\": {\n \"$ref\": \"#/definitions/HelpResult/anyOf/0/properties/commands\"\n },\n \"topics\": {\n \"$ref\": \"#/definitions/HelpResult/anyOf/0/properties/topics\"\n }\n },\n \"required\": [\n \"kind\",\n \"topic\",\n \"commands\",\n \"topics\"\n ],\n \"additionalProperties\": false\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"kind\": {\n \"type\": \"string\",\n \"const\": \"command\"\n },\n \"command\": {\n \"$ref\": \"#/definitions/HelpCommand\"\n },\n \"commands\": {\n \"$ref\": \"#/definitions/HelpResult/anyOf/0/properties/commands\"\n },\n \"topics\": {\n \"$ref\": \"#/definitions/HelpResult/anyOf/0/properties/topics\"\n }\n },\n \"required\": [\n \"kind\",\n \"command\",\n \"commands\",\n \"topics\"\n ],\n \"additionalProperties\": false\n }\n ],\n \"title\": \"HelpResult\",\n \"definitions\": {\n \"HelpCommandSummary\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"type\": \"string\"\n },\n \"summary\": {\n \"type\": \"string\"\n },\n \"hidden\": {\n \"type\": \"boolean\",\n \"default\": false\n }\n },\n \"required\": [\n \"id\"\n ],\n \"additionalProperties\": false\n },\n \"HelpTopic\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"description\": {\n \"type\": \"string\"\n },\n \"hidden\": {\n \"type\": \"boolean\",\n \"default\": false\n }\n },\n \"required\": [\n \"name\"\n ],\n \"additionalProperties\": false\n },\n \"HelpArgument\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"description\": {\n \"type\": \"string\"\n },\n \"required\": {\n \"type\": \"boolean\",\n \"default\": false\n },\n \"hidden\": {\n \"type\": \"boolean\",\n \"default\": false\n },\n \"options\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n },\n \"default\": {}\n },\n \"required\": [\n \"name\"\n ],\n \"additionalProperties\": false\n },\n \"HelpFlag\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"boolean\",\n \"option\"\n ]\n },\n \"char\": {\n \"type\": \"string\"\n },\n \"summary\": {\n \"type\": \"string\"\n },\n \"description\": {\n \"type\": \"string\"\n },\n \"env\": {\n \"type\": \"string\"\n },\n \"required\": {\n \"type\": \"boolean\",\n \"default\": false\n },\n \"hidden\": {\n \"type\": \"boolean\",\n \"default\": false\n },\n \"options\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n },\n \"default\": {},\n \"multiple\": {\n \"type\": \"boolean\"\n },\n \"allowNo\": {\n \"type\": \"boolean\"\n },\n \"aliases\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n },\n \"dependsOn\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n },\n \"exclusive\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n },\n \"exactlyOne\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n },\n \"required\": [\n \"name\",\n \"type\"\n ],\n \"additionalProperties\": false\n },\n \"HelpCommand\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"$ref\": \"#/definitions/HelpCommandSummary/properties/id\"\n },\n \"summary\": {\n \"$ref\": \"#/definitions/HelpCommandSummary/properties/summary\"\n },\n \"hidden\": {\n \"$ref\": \"#/definitions/HelpCommandSummary/properties/hidden\"\n },\n \"description\": {\n \"type\": \"string\"\n },\n \"aliases\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n },\n \"usage\": {\n \"anyOf\": [\n {\n \"type\": \"string\"\n },\n {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n ]\n },\n \"examples\": {\n \"type\": \"array\",\n \"items\": {\n \"anyOf\": [\n {\n \"type\": \"string\"\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"description\": {\n \"type\": \"string\"\n },\n \"command\": {\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"description\",\n \"command\"\n ],\n \"additionalProperties\": false\n }\n ]\n }\n },\n \"strict\": {\n \"type\": \"boolean\",\n \"default\": true\n },\n \"args\": {\n \"type\": \"object\",\n \"additionalProperties\": {\n \"$ref\": \"#/definitions/HelpArgument\"\n }\n },\n \"flags\": {\n \"type\": \"object\",\n \"additionalProperties\": {\n \"$ref\": \"#/definitions/HelpFlag\"\n }\n }\n },\n \"required\": [\n \"id\",\n \"aliases\",\n \"args\",\n \"flags\"\n ],\n \"additionalProperties\": false\n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", + "descriptionWithMarkdown": "Displays help for Shopify CLI", "enableJsonFlag": false, "flags": { "json": { @@ -8490,7 +8490,7 @@ ], "args": { }, - "description": "View all the available UI kit components", + "description": "Views all the available UI kit components", "enableJsonFlag": false, "flags": { "json-schema": { @@ -8517,7 +8517,7 @@ ], "args": { }, - "description": "View the UI kit components that process async tasks", + "description": "Views the UI kit components that process async tasks", "enableJsonFlag": false, "flags": { "json-schema": { @@ -8543,7 +8543,7 @@ ], "args": { }, - "description": "View the UI kit components prompts", + "description": "Views the UI kit components prompts", "enableJsonFlag": false, "flags": { "json-schema": { @@ -8569,7 +8569,7 @@ ], "args": { }, - "description": "View the UI kit components that display static output", + "description": "Views the UI kit components that display static output", "enableJsonFlag": false, "flags": { "json-schema": { @@ -8595,7 +8595,7 @@ ], "args": { }, - "description": "Generate a notifications.json file for the the CLI, appending a new notification to the current file.", + "description": "Generates a notifications.json file for the the CLI, appending a new notification to the current file.", "enableJsonFlag": false, "flags": { "json-schema": { @@ -8621,7 +8621,7 @@ ], "args": { }, - "description": "List current notifications configured for the CLI.", + "description": "Lists current notifications configured for the CLI.", "enableJsonFlag": false, "flags": { "ignore-errors": { @@ -8716,7 +8716,7 @@ "pluginName": "@shopify/cli", "pluginType": "core", "strict": true, - "summary": "List Shopify organizations you have access to." + "summary": "Lists Shopify organizations you have access to." }, "plugins": { "aliases": [ @@ -9050,8 +9050,8 @@ "name": "query" } }, - "description": "Search shopify.dev for the most relevant content matching a query. Best for discovery — surfacing the relevant pieces of documentation for a topic, rather than retrieving a whole document. To download a full document verbatim, use `doc fetch`.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `SearchResult` schema.\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"url\": {\n \"type\": \"string\",\n \"format\": \"uri\"\n }\n },\n \"required\": [\n \"url\"\n ],\n \"additionalProperties\": false,\n \"title\": \"SearchResult\",\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", - "descriptionWithMarkdown": "Search shopify.dev for the most relevant content matching a query. Best for discovery — surfacing the relevant pieces of documentation for a topic, rather than retrieving a whole document. To download a full document verbatim, use `doc fetch`.", + "description": "Searches shopify.dev for the most relevant content matching a query. Best for discovery — surfacing the relevant pieces of documentation for a topic, rather than retrieving a whole document. To download a full document verbatim, use `doc fetch`.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `SearchResult` schema.\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"url\": {\n \"type\": \"string\",\n \"format\": \"uri\"\n }\n },\n \"required\": [\n \"url\"\n ],\n \"additionalProperties\": false,\n \"title\": \"SearchResult\",\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", + "descriptionWithMarkdown": "Searches shopify.dev for the most relevant content matching a query. Best for discovery — surfacing the relevant pieces of documentation for a topic, rather than retrieving a whole document. To download a full document verbatim, use `doc fetch`.", "enableJsonFlag": false, "examples": [ "# open the search modal on Shopify.dev\n shopify search\n\n # search for a term on Shopify.dev\n shopify search \n\n # search for a phrase on Shopify.dev\n shopify search \"\"\n " @@ -9212,7 +9212,7 @@ "pluginName": "@shopify/cli", "pluginType": "core", "strict": true, - "summary": "Authenticate an app against a store for store commands." + "summary": "Authenticates an app against a store for store commands." }, "store:auth:list": { "aliases": [ @@ -9276,7 +9276,7 @@ "pluginName": "@shopify/cli", "pluginType": "core", "strict": true, - "summary": "List stores authenticated directly with store auth." + "summary": "Lists stores authenticated directly with store auth." }, "store:bulk:cancel": { "aliases": [ @@ -9357,7 +9357,7 @@ "pluginName": "@shopify/cli", "pluginType": "core", "strict": true, - "summary": "Cancel a bulk operation on a store." + "summary": "Cancels a bulk operation on a store." }, "store:bulk:execute": { "aliases": [ @@ -9505,7 +9505,7 @@ "pluginName": "@shopify/cli", "pluginType": "core", "strict": true, - "summary": "Execute bulk operations on a store." + "summary": "Executes bulk operations on a store." }, "store:bulk:status": { "aliases": [ @@ -9513,8 +9513,8 @@ "args": { }, "customPluginName": "@shopify/store", - "description": "Check the status of a specific bulk operation by ID, or list all bulk operations on this store in the last 7 days, using previously stored app authentication.\n\n Run `shopify store auth` first to create stored auth for the store.\n\n Use \"`store bulk execute`\" (https://shopify.dev/docs/api/shopify-cli/store/store-bulk-execute) to start a new bulk operation.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `BulkOperationStatusResult` schema.\n\n```json\n{\n \"anyOf\": [\n {\n \"$ref\": \"#/definitions/GetBulkOperationStatusResult\"\n },\n {\n \"$ref\": \"#/definitions/ListBulkOperationsResult\"\n }\n ],\n \"title\": \"BulkOperationStatusResult\",\n \"definitions\": {\n \"GetBulkOperationStatusResult\": {\n \"type\": \"object\",\n \"properties\": {\n \"storeDomain\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"pattern\": \"^[^.]+\\\\.myshopify\\\\.com$\"\n },\n {\n \"type\": \"null\"\n }\n ]\n },\n \"apiVersion\": {\n \"type\": [\n \"string\",\n \"null\"\n ],\n \"description\": \"The API version selected for the request.\"\n },\n \"operationGid\": {\n \"type\": \"string\",\n \"pattern\": \"^gid:\\\\/\\\\/shopify\\\\/BulkOperation\\\\/[^/]+$\",\n \"description\": \"The Shopify global ID of a bulk operation.\"\n },\n \"operation\": {\n \"anyOf\": [\n {\n \"$ref\": \"#/definitions/BulkOperation\"\n },\n {\n \"type\": \"null\"\n }\n ]\n }\n },\n \"required\": [\n \"storeDomain\",\n \"apiVersion\",\n \"operationGid\",\n \"operation\"\n ],\n \"additionalProperties\": false\n },\n \"ListBulkOperationsResult\": {\n \"type\": \"object\",\n \"properties\": {\n \"storeDomain\": {\n \"$ref\": \"#/definitions/GetBulkOperationStatusResult/properties/storeDomain\"\n },\n \"apiVersion\": {\n \"$ref\": \"#/definitions/GetBulkOperationStatusResult/properties/apiVersion\"\n },\n \"operations\": {\n \"type\": \"array\",\n \"items\": {\n \"$ref\": \"#/definitions/ListedBulkOperation\"\n }\n },\n \"pageInfo\": {\n \"type\": \"object\",\n \"properties\": {\n \"hasNextPage\": {\n \"type\": [\n \"boolean\",\n \"null\"\n ],\n \"description\": \"Unknown when the API result reaches the fetch limit.\"\n }\n },\n \"required\": [\n \"hasNextPage\"\n ],\n \"additionalProperties\": false\n }\n },\n \"required\": [\n \"storeDomain\",\n \"apiVersion\",\n \"operations\",\n \"pageInfo\"\n ],\n \"additionalProperties\": false\n },\n \"BulkOperation\": {\n \"type\": \"object\",\n \"properties\": {\n \"gid\": {\n \"$ref\": \"#/definitions/GetBulkOperationStatusResult/properties/operationGid\"\n },\n \"type\": {\n \"type\": \"string\"\n },\n \"status\": {\n \"type\": \"string\"\n },\n \"errorCode\": {\n \"type\": [\n \"string\",\n \"null\"\n ]\n },\n \"createdAt\": {\n \"type\": \"string\",\n \"format\": \"date-time\",\n \"pattern\": \"^\\\\d{4}-\\\\d{2}-\\\\d{2}T\\\\d{2}:\\\\d{2}:\\\\d{2}Z$\",\n \"description\": \"A UTC ISO 8601 instant with whole seconds and the Z timezone marker.\"\n },\n \"completedAt\": {\n \"anyOf\": [\n {\n \"$ref\": \"#/definitions/BulkOperation/properties/createdAt\"\n },\n {\n \"type\": \"null\"\n }\n ],\n \"description\": \"A UTC ISO 8601 instant with whole seconds and the Z timezone marker.\"\n },\n \"objectCount\": {\n \"type\": \"string\",\n \"pattern\": \"^\\\\d+$\",\n \"description\": \"A nonnegative decimal count, without loss of integer precision.\"\n },\n \"url\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"format\": \"uri\"\n },\n {\n \"type\": \"null\"\n }\n ]\n },\n \"partialDataUrl\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"format\": \"uri\"\n },\n {\n \"type\": \"null\"\n }\n ]\n }\n },\n \"required\": [\n \"gid\",\n \"type\",\n \"status\",\n \"errorCode\",\n \"createdAt\",\n \"completedAt\",\n \"objectCount\",\n \"url\",\n \"partialDataUrl\"\n ],\n \"additionalProperties\": false\n },\n \"ListedBulkOperation\": {\n \"type\": \"object\",\n \"properties\": {\n \"gid\": {\n \"$ref\": \"#/definitions/GetBulkOperationStatusResult/properties/operationGid\"\n },\n \"status\": {\n \"$ref\": \"#/definitions/BulkOperation/properties/status\"\n },\n \"errorCode\": {\n \"$ref\": \"#/definitions/BulkOperation/properties/errorCode\"\n },\n \"createdAt\": {\n \"$ref\": \"#/definitions/BulkOperation/properties/createdAt\"\n },\n \"completedAt\": {\n \"$ref\": \"#/definitions/BulkOperation/properties/completedAt\"\n },\n \"objectCount\": {\n \"$ref\": \"#/definitions/BulkOperation/properties/objectCount\"\n },\n \"url\": {\n \"$ref\": \"#/definitions/BulkOperation/properties/url\"\n },\n \"partialDataUrl\": {\n \"$ref\": \"#/definitions/BulkOperation/properties/partialDataUrl\"\n }\n },\n \"required\": [\n \"gid\",\n \"status\",\n \"errorCode\",\n \"createdAt\",\n \"completedAt\",\n \"objectCount\",\n \"url\",\n \"partialDataUrl\"\n ],\n \"additionalProperties\": false\n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", - "descriptionWithMarkdown": "Check the status of a specific bulk operation by ID, or list all bulk operations on this store in the last 7 days, using previously stored app authentication.\n\n Run `shopify store auth` first to create stored auth for the store.\n\n Use [`store bulk execute`](https://shopify.dev/docs/api/shopify-cli/store/store-bulk-execute) to start a new bulk operation.", + "description": "Checks the status of a specific bulk operation by ID, or lists all bulk operations on this store in the last 7 days, using previously stored app authentication.\n\n Run `shopify store auth` first to create stored auth for the store.\n\n Use \"`store bulk execute`\" (https://shopify.dev/docs/api/shopify-cli/store/store-bulk-execute) to start a new bulk operation.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `BulkOperationStatusResult` schema.\n\n```json\n{\n \"anyOf\": [\n {\n \"$ref\": \"#/definitions/GetBulkOperationStatusResult\"\n },\n {\n \"$ref\": \"#/definitions/ListBulkOperationsResult\"\n }\n ],\n \"title\": \"BulkOperationStatusResult\",\n \"definitions\": {\n \"GetBulkOperationStatusResult\": {\n \"type\": \"object\",\n \"properties\": {\n \"storeDomain\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"pattern\": \"^[^.]+\\\\.myshopify\\\\.com$\"\n },\n {\n \"type\": \"null\"\n }\n ]\n },\n \"apiVersion\": {\n \"type\": [\n \"string\",\n \"null\"\n ],\n \"description\": \"The API version selected for the request.\"\n },\n \"operationGid\": {\n \"type\": \"string\",\n \"pattern\": \"^gid:\\\\/\\\\/shopify\\\\/BulkOperation\\\\/[^/]+$\",\n \"description\": \"The Shopify global ID of a bulk operation.\"\n },\n \"operation\": {\n \"anyOf\": [\n {\n \"$ref\": \"#/definitions/BulkOperation\"\n },\n {\n \"type\": \"null\"\n }\n ]\n }\n },\n \"required\": [\n \"storeDomain\",\n \"apiVersion\",\n \"operationGid\",\n \"operation\"\n ],\n \"additionalProperties\": false\n },\n \"ListBulkOperationsResult\": {\n \"type\": \"object\",\n \"properties\": {\n \"storeDomain\": {\n \"$ref\": \"#/definitions/GetBulkOperationStatusResult/properties/storeDomain\"\n },\n \"apiVersion\": {\n \"$ref\": \"#/definitions/GetBulkOperationStatusResult/properties/apiVersion\"\n },\n \"operations\": {\n \"type\": \"array\",\n \"items\": {\n \"$ref\": \"#/definitions/ListedBulkOperation\"\n }\n },\n \"pageInfo\": {\n \"type\": \"object\",\n \"properties\": {\n \"hasNextPage\": {\n \"type\": [\n \"boolean\",\n \"null\"\n ],\n \"description\": \"Unknown when the API result reaches the fetch limit.\"\n }\n },\n \"required\": [\n \"hasNextPage\"\n ],\n \"additionalProperties\": false\n }\n },\n \"required\": [\n \"storeDomain\",\n \"apiVersion\",\n \"operations\",\n \"pageInfo\"\n ],\n \"additionalProperties\": false\n },\n \"BulkOperation\": {\n \"type\": \"object\",\n \"properties\": {\n \"gid\": {\n \"$ref\": \"#/definitions/GetBulkOperationStatusResult/properties/operationGid\"\n },\n \"type\": {\n \"type\": \"string\"\n },\n \"status\": {\n \"type\": \"string\"\n },\n \"errorCode\": {\n \"type\": [\n \"string\",\n \"null\"\n ]\n },\n \"createdAt\": {\n \"type\": \"string\",\n \"format\": \"date-time\",\n \"pattern\": \"^\\\\d{4}-\\\\d{2}-\\\\d{2}T\\\\d{2}:\\\\d{2}:\\\\d{2}Z$\",\n \"description\": \"A UTC ISO 8601 instant with whole seconds and the Z timezone marker.\"\n },\n \"completedAt\": {\n \"anyOf\": [\n {\n \"$ref\": \"#/definitions/BulkOperation/properties/createdAt\"\n },\n {\n \"type\": \"null\"\n }\n ],\n \"description\": \"A UTC ISO 8601 instant with whole seconds and the Z timezone marker.\"\n },\n \"objectCount\": {\n \"type\": \"string\",\n \"pattern\": \"^\\\\d+$\",\n \"description\": \"A nonnegative decimal count, without loss of integer precision.\"\n },\n \"url\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"format\": \"uri\"\n },\n {\n \"type\": \"null\"\n }\n ]\n },\n \"partialDataUrl\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"format\": \"uri\"\n },\n {\n \"type\": \"null\"\n }\n ]\n }\n },\n \"required\": [\n \"gid\",\n \"type\",\n \"status\",\n \"errorCode\",\n \"createdAt\",\n \"completedAt\",\n \"objectCount\",\n \"url\",\n \"partialDataUrl\"\n ],\n \"additionalProperties\": false\n },\n \"ListedBulkOperation\": {\n \"type\": \"object\",\n \"properties\": {\n \"gid\": {\n \"$ref\": \"#/definitions/GetBulkOperationStatusResult/properties/operationGid\"\n },\n \"status\": {\n \"$ref\": \"#/definitions/BulkOperation/properties/status\"\n },\n \"errorCode\": {\n \"$ref\": \"#/definitions/BulkOperation/properties/errorCode\"\n },\n \"createdAt\": {\n \"$ref\": \"#/definitions/BulkOperation/properties/createdAt\"\n },\n \"completedAt\": {\n \"$ref\": \"#/definitions/BulkOperation/properties/completedAt\"\n },\n \"objectCount\": {\n \"$ref\": \"#/definitions/BulkOperation/properties/objectCount\"\n },\n \"url\": {\n \"$ref\": \"#/definitions/BulkOperation/properties/url\"\n },\n \"partialDataUrl\": {\n \"$ref\": \"#/definitions/BulkOperation/properties/partialDataUrl\"\n }\n },\n \"required\": [\n \"gid\",\n \"status\",\n \"errorCode\",\n \"createdAt\",\n \"completedAt\",\n \"objectCount\",\n \"url\",\n \"partialDataUrl\"\n ],\n \"additionalProperties\": false\n }\n },\n \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```", + "descriptionWithMarkdown": "Checks the status of a specific bulk operation by ID, or lists all bulk operations on this store in the last 7 days, using previously stored app authentication.\n\n Run `shopify store auth` first to create stored auth for the store.\n\n Use [`store bulk execute`](https://shopify.dev/docs/api/shopify-cli/store/store-bulk-execute) to start a new bulk operation.", "examples": [ "<%= config.bin %> <%= command.id %> --store shop.myshopify.com", "<%= config.bin %> <%= command.id %> --store shop.myshopify.com --id 123456789" @@ -9586,7 +9586,7 @@ "pluginName": "@shopify/cli", "pluginType": "core", "strict": true, - "summary": "Check the status of bulk operations on a store." + "summary": "Checks the status of bulk operations on a store." }, "store:create:dev": { "aliases": [ @@ -9706,7 +9706,7 @@ "pluginName": "@shopify/cli", "pluginType": "core", "strict": true, - "summary": "Create a new dev store." + "summary": "Creates a new dev store." }, "store:create:preview": { "aliases": [ @@ -9788,7 +9788,7 @@ "pluginName": "@shopify/cli", "pluginType": "core", "strict": true, - "summary": "Create a preview Shopify store." + "summary": "Creates a preview Shopify store." }, "store:delete": { "aliases": [ @@ -9879,7 +9879,7 @@ "pluginName": "@shopify/cli", "pluginType": "core", "strict": true, - "summary": "Delete a dev store." + "summary": "Deletes a dev store." }, "store:execute": { "aliases": [ @@ -10018,7 +10018,7 @@ "pluginName": "@shopify/cli", "pluginType": "core", "strict": true, - "summary": "Execute GraphQL queries and mutations on a store." + "summary": "Executes GraphQL queries and mutations on a store." }, "store:graphiql": { "aliases": [ @@ -10115,7 +10115,7 @@ "pluginName": "@shopify/cli", "pluginType": "core", "strict": true, - "summary": "Open a local GraphiQL UI for a store." + "summary": "Opens a local GraphiQL UI for a store." }, "store:info": { "aliases": [ @@ -10188,7 +10188,7 @@ "pluginName": "@shopify/cli", "pluginType": "core", "strict": true, - "summary": "Surface metadata about a Shopify store." + "summary": "Surfaces metadata about a Shopify store." }, "store:list": { "aliases": [ @@ -10275,7 +10275,7 @@ "pluginName": "@shopify/cli", "pluginType": "core", "strict": true, - "summary": "List stores in a Shopify organization." + "summary": "Lists stores in a Shopify organization." }, "store:open": { "aliases": [ @@ -10347,7 +10347,7 @@ "pluginName": "@shopify/cli", "pluginType": "core", "strict": true, - "summary": "Open your Shopify store in the default web browser." + "summary": "Opens your Shopify store in the default web browser." }, "store:stripe-auth": { "aliases": [ @@ -10440,7 +10440,7 @@ "pluginName": "@shopify/cli", "pluginType": "core", "strict": true, - "summary": "Authenticate for store commands." + "summary": "Authenticates for store commands." }, "theme:check": { "aliases": [ @@ -10605,7 +10605,7 @@ "pluginName": "@shopify/cli", "pluginType": "core", "strict": true, - "summary": "Validate the theme." + "summary": "Validates the theme." }, "theme:console": { "aliases": [ @@ -10857,7 +10857,7 @@ "pluginName": "@shopify/cli", "pluginType": "core", "strict": true, - "summary": "Delete remote themes from the connected store. This command can't be undone." + "summary": "Deletes remote themes from the connected store. This command can't be undone." }, "theme:dev": { "aliases": [ @@ -11515,7 +11515,7 @@ "pluginName": "@shopify/cli", "pluginType": "core", "strict": true, - "summary": "Start a Language Server Protocol server." + "summary": "Starts a Language Server Protocol server." }, "theme:list": { "aliases": [ @@ -11753,7 +11753,7 @@ "pluginName": "@shopify/cli", "pluginType": "core", "strict": true, - "summary": "Download metafields definitions from your shop into a local file." + "summary": "Downloads metafields definitions from your shop into a local file." }, "theme:open": { "aliases": [ @@ -11950,7 +11950,7 @@ "pluginName": "@shopify/cli", "pluginType": "core", "strict": true, - "summary": "Package your theme into a .zip file, ready to upload to the Online Store." + "summary": "Packages your theme into a .zip file, ready to upload to the Online Store." }, "theme:preview": { "aliases": [ @@ -12094,8 +12094,8 @@ "args": { }, "customPluginName": "@shopify/theme", - "description": "Profile the Shopify Liquid on a given page.\n\n This command will open a web page with the Speedscope profiler detailing the time spent executing Liquid on the given page.", - "descriptionWithMarkdown": "Profile the Shopify Liquid on a given page.\n\n This command will open a web page with the Speedscope profiler detailing the time spent executing Liquid on the given page.", + "description": "Profiles the Shopify Liquid on a given page.\n\n This command will open a web page with the Speedscope profiler detailing the time spent executing Liquid on the given page.", + "descriptionWithMarkdown": "Profiles the Shopify Liquid on a given page.\n\n This command will open a web page with the Speedscope profiler detailing the time spent executing Liquid on the given page.", "enableJsonFlag": false, "flags": { "auth-alias": { @@ -12216,7 +12216,7 @@ "pluginName": "@shopify/cli", "pluginType": "core", "strict": true, - "summary": "Profile the Liquid rendering of a theme page.", + "summary": "Profiles the Liquid rendering of a theme page.", "usage": [ "theme profile", "theme profile --url /products/classic-leather-jacket" @@ -12336,7 +12336,7 @@ "pluginName": "@shopify/cli", "pluginType": "core", "strict": true, - "summary": "Set a remote theme as the live theme." + "summary": "Sets a remote theme as the live theme." }, "theme:pull": { "aliases": [ @@ -12500,7 +12500,7 @@ "pluginName": "@shopify/cli", "pluginType": "core", "strict": true, - "summary": "Download your remote theme files locally." + "summary": "Downloads your remote theme files locally." }, "theme:push": { "aliases": [ diff --git a/packages/cli/src/cli/commands/cache/clear.ts b/packages/cli/src/cli/commands/cache/clear.ts index a16d57d6b2c..bf1a582aede 100644 --- a/packages/cli/src/cli/commands/cache/clear.ts +++ b/packages/cli/src/cli/commands/cache/clear.ts @@ -2,7 +2,7 @@ import Command from '@shopify/cli-kit/node/base-command' import {clearCache} from '@shopify/cli-kit/node/cli' export default class ClearCache extends Command { - static description = 'Clear the CLI cache, used to store some API responses and handle notifications status' + static description = 'Clears the CLI cache, used to store some API responses and handle notifications status' static hidden = true async run(): Promise { diff --git a/packages/cli/src/cli/commands/config/autoupgrade/off.ts b/packages/cli/src/cli/commands/config/autoupgrade/off.ts index 92bdd1355dc..e2d88ad7052 100644 --- a/packages/cli/src/cli/commands/config/autoupgrade/off.ts +++ b/packages/cli/src/cli/commands/config/autoupgrade/off.ts @@ -5,9 +5,9 @@ import Command from '@shopify/cli-kit/node/base-command' import {globalFlags, jsonFlag} from '@shopify/cli-kit/node/cli' export default class AutoupgradeOff extends Command { - static summary = 'Disable automatic upgrades for Shopify CLI.' + static summary = 'Disables automatic upgrades for Shopify CLI.' - static descriptionWithMarkdown = `Disable automatic upgrades for Shopify CLI. + static descriptionWithMarkdown = `Disables automatic upgrades for Shopify CLI. When auto-upgrade is disabled, Shopify CLI won't automatically update. Run \`shopify upgrade\` to update manually. diff --git a/packages/cli/src/cli/commands/config/autoupgrade/on.ts b/packages/cli/src/cli/commands/config/autoupgrade/on.ts index 9189a697e5d..048c8639eb0 100644 --- a/packages/cli/src/cli/commands/config/autoupgrade/on.ts +++ b/packages/cli/src/cli/commands/config/autoupgrade/on.ts @@ -5,9 +5,9 @@ import Command from '@shopify/cli-kit/node/base-command' import {globalFlags, jsonFlag} from '@shopify/cli-kit/node/cli' export default class AutoupgradeOn extends Command { - static summary = 'Enable automatic upgrades for Shopify CLI.' + static summary = 'Enables automatic upgrades for Shopify CLI.' - static descriptionWithMarkdown = `Enable automatic upgrades for Shopify CLI. + static descriptionWithMarkdown = `Enables automatic upgrades for Shopify CLI. When auto-upgrade is enabled, Shopify CLI automatically updates to the latest version once per day. Major version upgrades are skipped and must be done manually. diff --git a/packages/cli/src/cli/commands/config/autoupgrade/status.ts b/packages/cli/src/cli/commands/config/autoupgrade/status.ts index 29a65e3b51d..51d27607210 100644 --- a/packages/cli/src/cli/commands/config/autoupgrade/status.ts +++ b/packages/cli/src/cli/commands/config/autoupgrade/status.ts @@ -5,9 +5,9 @@ import Command from '@shopify/cli-kit/node/base-command' import {globalFlags, jsonFlag} from '@shopify/cli-kit/node/cli' export default class AutoupgradeStatus extends Command { - static summary = 'Check whether auto-upgrade is enabled, disabled, or not yet configured.' + static summary = 'Checks whether auto-upgrade is enabled, disabled, or not yet configured.' - static descriptionWithMarkdown = `Check whether auto-upgrade is enabled, disabled, or not yet configured. + static descriptionWithMarkdown = `Checks whether auto-upgrade is enabled, disabled, or not yet configured. When auto-upgrade is enabled, Shopify CLI automatically updates to the latest version after each command. diff --git a/packages/cli/src/cli/commands/debug/command-flags.ts b/packages/cli/src/cli/commands/debug/command-flags.ts index 1f303c11585..88f8f096b9f 100644 --- a/packages/cli/src/cli/commands/debug/command-flags.ts +++ b/packages/cli/src/cli/commands/debug/command-flags.ts @@ -4,7 +4,7 @@ import {renderTable} from '@shopify/cli-kit/node/ui' import {Flags} from '@oclif/core' export default class CommandFlags extends Command { - static description = 'View all the available command flags' + static description = 'Views all the available command flags' static hidden = true static flags = { diff --git a/packages/cli/src/cli/commands/doc/fetch.ts b/packages/cli/src/cli/commands/doc/fetch.ts index 50e287623b5..c659696f4fc 100644 --- a/packages/cli/src/cli/commands/doc/fetch.ts +++ b/packages/cli/src/cli/commands/doc/fetch.ts @@ -7,7 +7,7 @@ import {Flags} from '@oclif/core' export default class DocFetch extends Command { static descriptionWithMarkdown = - 'Download a complete document from shopify.dev. Every page on shopify.dev has a Markdown version, and that is what this tool returns. Use this to pull an entire document verbatim — for example, a set of instructions an agent follows like a centrally-served skill. Pass `--language` for the language of the app you are building so code examples match your stack. For finding the relevant pieces of content across shopify.dev instead, use `doc search`.' + 'Downloads a complete document from shopify.dev. Every page on shopify.dev has a Markdown version, and that is what this tool returns. Use this to pull an entire document verbatim — for example, a set of instructions an agent follows like a centrally-served skill. Pass `--language` for the language of the app you are building so code examples match your stack. For finding the relevant pieces of content across shopify.dev instead, use `doc search`.' static description = this.descriptionForHelp() diff --git a/packages/cli/src/cli/commands/doc/search.ts b/packages/cli/src/cli/commands/doc/search.ts index 0e5be753ac2..8d948dbc100 100644 --- a/packages/cli/src/cli/commands/doc/search.ts +++ b/packages/cli/src/cli/commands/doc/search.ts @@ -7,7 +7,7 @@ import {Flags} from '@oclif/core' export default class DocSearch extends Command { static descriptionWithMarkdown = - 'Query the shopify.dev vector store and print the most relevant documentation chunks as JSON. Best for programmatic discovery — surfacing the relevant pieces of documentation for a topic, rather than retrieving a whole document. To download a full document verbatim, use `doc fetch`.' + 'Queries the shopify.dev vector store and prints the most relevant documentation chunks as JSON. Best for programmatic discovery — surfacing the relevant pieces of documentation for a topic, rather than retrieving a whole document. To download a full document verbatim, use `doc fetch`.' static description = this.descriptionForHelp() diff --git a/packages/cli/src/cli/commands/docs/generate.ts b/packages/cli/src/cli/commands/docs/generate.ts index b90da1a97d2..e48962a6634 100644 --- a/packages/cli/src/cli/commands/docs/generate.ts +++ b/packages/cli/src/cli/commands/docs/generate.ts @@ -14,7 +14,7 @@ export interface CommandData { } export default class DocsGenerate extends Command { - static description = 'Generate CLI commands documentation' + static description = 'Generates CLI commands documentation' static hidden = true async run(): Promise { diff --git a/packages/cli/src/cli/commands/doctor-release/doctor-release.ts b/packages/cli/src/cli/commands/doctor-release/doctor-release.ts index b7e701877e7..943dfb07d0e 100644 --- a/packages/cli/src/cli/commands/doctor-release/doctor-release.ts +++ b/packages/cli/src/cli/commands/doctor-release/doctor-release.ts @@ -3,7 +3,7 @@ import {canRunDoctorRelease} from '@shopify/cli-kit/node/context/local' import {renderInfo} from '@shopify/cli-kit/node/ui' export default class DoctorRelease extends Command { - static description = 'Run CLI doctor-release tests' + static description = 'Runs CLI doctor-release tests' static hidden = true async run(): Promise { diff --git a/packages/cli/src/cli/commands/doctor-release/theme/index.ts b/packages/cli/src/cli/commands/doctor-release/theme/index.ts index 026a1f0eeab..fa3a3331dee 100644 --- a/packages/cli/src/cli/commands/doctor-release/theme/index.ts +++ b/packages/cli/src/cli/commands/doctor-release/theme/index.ts @@ -6,7 +6,7 @@ import {resolvePath, cwd} from '@shopify/cli-kit/node/path' import {canRunDoctorRelease} from '@shopify/cli-kit/node/context/local' export default class DoctorReleaseTheme extends Command { - static description = 'Run all theme command doctor-release tests' + static description = 'Runs all theme command doctor-release tests' static hidden = true static flags = { diff --git a/packages/cli/src/cli/commands/help.ts b/packages/cli/src/cli/commands/help.ts index 383e6ba6536..e76182412d5 100644 --- a/packages/cli/src/cli/commands/help.ts +++ b/packages/cli/src/cli/commands/help.ts @@ -10,7 +10,7 @@ export default class HelpCommand extends Command { command: Args.string({description: 'Command to show help for.', required: false}), } - static descriptionWithMarkdown = 'Display help for Shopify CLI' + static descriptionWithMarkdown = 'Displays help for Shopify CLI' static description = this.descriptionForHelp() diff --git a/packages/cli/src/cli/commands/kitchen-sink/async.ts b/packages/cli/src/cli/commands/kitchen-sink/async.ts index 5b20360e3b8..f5ac752421a 100644 --- a/packages/cli/src/cli/commands/kitchen-sink/async.ts +++ b/packages/cli/src/cli/commands/kitchen-sink/async.ts @@ -7,7 +7,7 @@ import Command from '@shopify/cli-kit/node/base-command' * and to help update the documentation when they change. */ export default class KitchenSinkAsync extends Command { - static description = 'View the UI kit components that process async tasks' + static description = 'Views the UI kit components that process async tasks' static hidden = true async run(): Promise { diff --git a/packages/cli/src/cli/commands/kitchen-sink/index.ts b/packages/cli/src/cli/commands/kitchen-sink/index.ts index a61e69678b8..46fa72b7116 100644 --- a/packages/cli/src/cli/commands/kitchen-sink/index.ts +++ b/packages/cli/src/cli/commands/kitchen-sink/index.ts @@ -9,7 +9,7 @@ import Command from '@shopify/cli-kit/node/base-command' * and to help update the documentation when they change. */ export default class KitchenSinkAll extends Command { - static description = 'View all the available UI kit components' + static description = 'Views all the available UI kit components' static hiddenAliases = ['kitchen-sink all'] static hidden = true diff --git a/packages/cli/src/cli/commands/kitchen-sink/prompts.ts b/packages/cli/src/cli/commands/kitchen-sink/prompts.ts index 9627f999991..e4b46c8ac4e 100644 --- a/packages/cli/src/cli/commands/kitchen-sink/prompts.ts +++ b/packages/cli/src/cli/commands/kitchen-sink/prompts.ts @@ -7,7 +7,7 @@ import Command from '@shopify/cli-kit/node/base-command' * and to help update the documentation when they change. */ export default class KitchenSinkPrompts extends Command { - static description = 'View the UI kit components prompts' + static description = 'Views the UI kit components prompts' static hidden = true async run(): Promise { diff --git a/packages/cli/src/cli/commands/kitchen-sink/static.ts b/packages/cli/src/cli/commands/kitchen-sink/static.ts index 6b6ebec9bba..095dfd101b6 100644 --- a/packages/cli/src/cli/commands/kitchen-sink/static.ts +++ b/packages/cli/src/cli/commands/kitchen-sink/static.ts @@ -7,7 +7,7 @@ import Command from '@shopify/cli-kit/node/base-command' * and to help update the documentation when they change. */ export default class KitchenSinkStatic extends Command { - static description = 'View the UI kit components that display static output' + static description = 'Views the UI kit components that display static output' static hidden = true async run(): Promise { diff --git a/packages/cli/src/cli/commands/notifications/generate.ts b/packages/cli/src/cli/commands/notifications/generate.ts index 30637c72180..9ad464a1770 100644 --- a/packages/cli/src/cli/commands/notifications/generate.ts +++ b/packages/cli/src/cli/commands/notifications/generate.ts @@ -3,7 +3,7 @@ import Command from '@shopify/cli-kit/node/base-command' export default class Generate extends Command { static description = - 'Generate a notifications.json file for the the CLI, appending a new notification to the current file.' + 'Generates a notifications.json file for the the CLI, appending a new notification to the current file.' static hidden = true diff --git a/packages/cli/src/cli/commands/notifications/list.ts b/packages/cli/src/cli/commands/notifications/list.ts index ef721cb137e..04542885bf7 100644 --- a/packages/cli/src/cli/commands/notifications/list.ts +++ b/packages/cli/src/cli/commands/notifications/list.ts @@ -4,7 +4,7 @@ import Command from '@shopify/cli-kit/node/base-command' import {sendErrorToBugsnag} from '@shopify/cli-kit/node/error-handler' export default class List extends Command { - static description = 'List current notifications configured for the CLI.' + static description = 'Lists current notifications configured for the CLI.' static hidden = true static flags = { diff --git a/packages/cli/src/cli/commands/search.ts b/packages/cli/src/cli/commands/search.ts index 32e15061d1f..c6999984a61 100644 --- a/packages/cli/src/cli/commands/search.ts +++ b/packages/cli/src/cli/commands/search.ts @@ -7,7 +7,7 @@ import {Args} from '@oclif/core' export default class Search extends Command { static descriptionWithMarkdown = - 'Search shopify.dev for the most relevant content matching a query. Best for discovery — surfacing the relevant pieces of documentation for a topic, rather than retrieving a whole document. To download a full document verbatim, use `doc fetch`.' + 'Searches shopify.dev for the most relevant content matching a query. Best for discovery — surfacing the relevant pieces of documentation for a topic, rather than retrieving a whole document. To download a full document verbatim, use `doc fetch`.' static description = this.descriptionForHelp() diff --git a/packages/create-app/oclif.manifest.json b/packages/create-app/oclif.manifest.json index 6d0408e9243..5a829617c39 100644 --- a/packages/create-app/oclif.manifest.json +++ b/packages/create-app/oclif.manifest.json @@ -140,7 +140,7 @@ "pluginName": "@shopify/create-app", "pluginType": "core", "strict": true, - "summary": "Create a new app project" + "summary": "Creates a new app project" } }, "version": "4.9.0" diff --git a/packages/plugin-did-you-mean/src/commands/config/autocorrect/off.ts b/packages/plugin-did-you-mean/src/commands/config/autocorrect/off.ts index b56dbb1fd24..90f9670dd81 100644 --- a/packages/plugin-did-you-mean/src/commands/config/autocorrect/off.ts +++ b/packages/plugin-did-you-mean/src/commands/config/autocorrect/off.ts @@ -4,9 +4,9 @@ import Command from '@shopify/cli-kit/node/base-command' import {renderInfo} from '@shopify/cli-kit/node/ui' export default class AutocorrectOff extends Command { - static summary = 'Disable autocorrect. Off by default.' + static summary = 'Disables autocorrect. Off by default.' - static descriptionWithMarkdown = `Disable autocorrect. Off by default. + static descriptionWithMarkdown = `Disables autocorrect. Off by default. When autocorrection is enabled, Shopify CLI automatically runs a corrected version of your command if a correction is available. diff --git a/packages/plugin-did-you-mean/src/commands/config/autocorrect/on.ts b/packages/plugin-did-you-mean/src/commands/config/autocorrect/on.ts index 98fad9cbee7..ae75303089e 100644 --- a/packages/plugin-did-you-mean/src/commands/config/autocorrect/on.ts +++ b/packages/plugin-did-you-mean/src/commands/config/autocorrect/on.ts @@ -4,9 +4,9 @@ import Command from '@shopify/cli-kit/node/base-command' import {renderInfo} from '@shopify/cli-kit/node/ui' export default class AutocorrectOn extends Command { - static summary = 'Enable autocorrect. Off by default.' + static summary = 'Enables autocorrect. Off by default.' - static descriptionWithMarkdown = `Enable autocorrect. Off by default. + static descriptionWithMarkdown = `Enables autocorrect. Off by default. When autocorrection is enabled, Shopify CLI automatically runs a corrected version of your command if a correction is available. diff --git a/packages/plugin-did-you-mean/src/commands/config/autocorrect/status.ts b/packages/plugin-did-you-mean/src/commands/config/autocorrect/status.ts index 7816df38708..d76b8688260 100644 --- a/packages/plugin-did-you-mean/src/commands/config/autocorrect/status.ts +++ b/packages/plugin-did-you-mean/src/commands/config/autocorrect/status.ts @@ -4,9 +4,9 @@ import Command from '@shopify/cli-kit/node/base-command' import {renderInfo} from '@shopify/cli-kit/node/ui' export default class AutocorrectStatus extends Command { - static summary = 'Check whether autocorrect is enabled or disabled. On by default.' + static summary = 'Checks whether autocorrect is enabled or disabled. On by default.' - static descriptionWithMarkdown = `Check whether autocorrect is enabled or disabled. On by default. + static descriptionWithMarkdown = `Checks whether autocorrect is enabled or disabled. On by default. When autocorrection is enabled, Shopify CLI automatically runs a corrected version of your command if a correction is available. diff --git a/packages/store/src/cli/commands/store/auth.ts b/packages/store/src/cli/commands/store/auth.ts index 1721e1aff1e..f18450a722e 100644 --- a/packages/store/src/cli/commands/store/auth.ts +++ b/packages/store/src/cli/commands/store/auth.ts @@ -7,7 +7,7 @@ import {globalFlags, jsonFlag} from '@shopify/cli-kit/node/cli' import {Flags} from '@oclif/core' export default class StoreAuth extends StoreCommand { - static summary = 'Authenticate an app against a store for store commands.' + static summary = 'Authenticates an app against a store for store commands.' static descriptionWithMarkdown = `Authenticates the app against the specified store for store commands and stores an online access token for later reuse. diff --git a/packages/store/src/cli/commands/store/auth/list.ts b/packages/store/src/cli/commands/store/auth/list.ts index 7185f3ba70c..0ba056f47ee 100644 --- a/packages/store/src/cli/commands/store/auth/list.ts +++ b/packages/store/src/cli/commands/store/auth/list.ts @@ -5,7 +5,7 @@ import Command from '@shopify/cli-kit/node/base-command' import {globalFlags, jsonFlag} from '@shopify/cli-kit/node/cli' export default class StoreAuthList extends Command { - static summary = 'List stores authenticated directly with store auth.' + static summary = 'Lists stores authenticated directly with store auth.' static descriptionWithMarkdown = `Lists stores authenticated directly on this machine with \`shopify store auth\`. diff --git a/packages/store/src/cli/commands/store/bulk/cancel.ts b/packages/store/src/cli/commands/store/bulk/cancel.ts index 864f9953341..98aa4faaf4c 100644 --- a/packages/store/src/cli/commands/store/bulk/cancel.ts +++ b/packages/store/src/cli/commands/store/bulk/cancel.ts @@ -8,7 +8,7 @@ import {requiredBulkOperationIdFlag, storeFlags} from '../../../flags.js' import {globalFlags, jsonFlag} from '@shopify/cli-kit/node/cli' export default class StoreBulkCancel extends StoreCommand { - static summary = 'Cancel a bulk operation on a store.' + static summary = 'Cancels a bulk operation on a store.' static descriptionWithMarkdown = `Cancels a running bulk operation by ID, using previously stored app authentication. diff --git a/packages/store/src/cli/commands/store/bulk/execute.ts b/packages/store/src/cli/commands/store/bulk/execute.ts index 615f48b73fc..443cc3aa6bb 100644 --- a/packages/store/src/cli/commands/store/bulk/execute.ts +++ b/packages/store/src/cli/commands/store/bulk/execute.ts @@ -8,7 +8,7 @@ import {resolveBulkOperationQuery} from '@shopify/cli-kit/node/api/bulk-operatio import {globalFlags, jsonFlag} from '@shopify/cli-kit/node/cli' export default class StoreBulkExecute extends StoreCommand { - static summary = 'Execute bulk operations on a store.' + static summary = 'Executes bulk operations on a store.' static descriptionWithMarkdown = `Executes an Admin API GraphQL query or mutation on the specified store as a bulk operation, using previously stored app authentication. diff --git a/packages/store/src/cli/commands/store/bulk/status.ts b/packages/store/src/cli/commands/store/bulk/status.ts index cf32423d772..c0b11ed07b3 100644 --- a/packages/store/src/cli/commands/store/bulk/status.ts +++ b/packages/store/src/cli/commands/store/bulk/status.ts @@ -8,9 +8,9 @@ import {bulkOperationIdFlag, storeFlags} from '../../../flags.js' import {globalFlags, jsonFlag} from '@shopify/cli-kit/node/cli' export default class StoreBulkStatus extends StoreCommand { - static summary = 'Check the status of bulk operations on a store.' + static summary = 'Checks the status of bulk operations on a store.' - static descriptionWithMarkdown = `Check the status of a specific bulk operation by ID, or list all bulk operations on this store in the last 7 days, using previously stored app authentication. + static descriptionWithMarkdown = `Checks the status of a specific bulk operation by ID, or lists all bulk operations on this store in the last 7 days, using previously stored app authentication. Run \`shopify store auth\` first to create stored auth for the store. diff --git a/packages/store/src/cli/commands/store/create/dev.ts b/packages/store/src/cli/commands/store/create/dev.ts index 1ee307860bc..2f7ea66baf4 100644 --- a/packages/store/src/cli/commands/store/create/dev.ts +++ b/packages/store/src/cli/commands/store/create/dev.ts @@ -11,7 +11,7 @@ import {outputResult} from '@shopify/cli-kit/node/output' import {Flags} from '@oclif/core' export default class StoreCreateDev extends Command { - static summary = 'Create a new dev store.' + static summary = 'Creates a new dev store.' static descriptionWithMarkdown = 'Creates a new dev store in your organization.' diff --git a/packages/store/src/cli/commands/store/create/preview.ts b/packages/store/src/cli/commands/store/create/preview.ts index 8505063399d..09587d289b9 100644 --- a/packages/store/src/cli/commands/store/create/preview.ts +++ b/packages/store/src/cli/commands/store/create/preview.ts @@ -12,7 +12,7 @@ import {renderSingleTask} from '@shopify/cli-kit/node/ui' import {Flags} from '@oclif/core' export default class StoreCreatePreview extends StoreCommand { - static summary = 'Create a preview Shopify store.' + static summary = 'Creates a preview Shopify store.' static descriptionWithMarkdown = `Creates a new Shopify store, with no need for an existing account.` diff --git a/packages/store/src/cli/commands/store/delete.ts b/packages/store/src/cli/commands/store/delete.ts index 91713d3f274..8b67ff6b24e 100644 --- a/packages/store/src/cli/commands/store/delete.ts +++ b/packages/store/src/cli/commands/store/delete.ts @@ -10,7 +10,7 @@ import {isTTY, renderDangerousConfirmationPrompt} from '@shopify/cli-kit/node/ui import {Flags} from '@oclif/core' export default class StoreDelete extends Command { - static summary = 'Delete a dev store.' + static summary = 'Deletes a dev store.' static descriptionWithMarkdown = 'Deletes a dev store from your organization.' diff --git a/packages/store/src/cli/commands/store/execute.ts b/packages/store/src/cli/commands/store/execute.ts index bedb4cf5709..a68c7e6ae32 100644 --- a/packages/store/src/cli/commands/store/execute.ts +++ b/packages/store/src/cli/commands/store/execute.ts @@ -8,7 +8,7 @@ import {resolvePath} from '@shopify/cli-kit/node/path' import {Flags} from '@oclif/core' export default class StoreExecute extends StoreCommand { - static summary = 'Execute GraphQL queries and mutations on a store.' + static summary = 'Executes GraphQL queries and mutations on a store.' static descriptionWithMarkdown = `Executes an Admin API GraphQL query or mutation on the specified store using previously stored app authentication. diff --git a/packages/store/src/cli/commands/store/graphiql.ts b/packages/store/src/cli/commands/store/graphiql.ts index 271baa5497a..be67105290f 100644 --- a/packages/store/src/cli/commands/store/graphiql.ts +++ b/packages/store/src/cli/commands/store/graphiql.ts @@ -5,7 +5,7 @@ import {globalFlags, portFlag} from '@shopify/cli-kit/node/cli' import {Flags} from '@oclif/core' export default class StoreGraphiQL extends StoreCommand { - static summary = 'Open a local GraphiQL UI for a store.' + static summary = 'Opens a local GraphiQL UI for a store.' static descriptionWithMarkdown = `Opens an authenticated Admin API GraphiQL UI for the specified store using previously stored app authentication. diff --git a/packages/store/src/cli/commands/store/info.ts b/packages/store/src/cli/commands/store/info.ts index 8e72f9f53ea..a84740b0994 100644 --- a/packages/store/src/cli/commands/store/info.ts +++ b/packages/store/src/cli/commands/store/info.ts @@ -6,7 +6,7 @@ import {storeFlags} from '../../flags.js' import {globalFlags, jsonFlag} from '@shopify/cli-kit/node/cli' export default class StoreInfo extends StoreCommand { - static summary = 'Surface metadata about a Shopify store.' + static summary = 'Surfaces metadata about a Shopify store.' static descriptionWithMarkdown = `Returns available metadata about a store you have access to, such as its id, display name, subdomain, organization, store owner, type, plan, feature preview, admin URL, and access and save URLs for preview stores. diff --git a/packages/store/src/cli/commands/store/list.ts b/packages/store/src/cli/commands/store/list.ts index 78ae04d5972..1273c6abf58 100644 --- a/packages/store/src/cli/commands/store/list.ts +++ b/packages/store/src/cli/commands/store/list.ts @@ -8,7 +8,7 @@ import {globalFlags, jsonFlag} from '@shopify/cli-kit/node/cli' import {Flags} from '@oclif/core' export default class StoreList extends StoreCommand { - static summary = 'List stores in a Shopify organization.' + static summary = 'Lists stores in a Shopify organization.' static descriptionWithMarkdown = `Lists stores in a Shopify organization available to the current CLI account. diff --git a/packages/store/src/cli/commands/store/open.ts b/packages/store/src/cli/commands/store/open.ts index 9ab17df785c..ebeb4b4b981 100644 --- a/packages/store/src/cli/commands/store/open.ts +++ b/packages/store/src/cli/commands/store/open.ts @@ -6,7 +6,7 @@ import {storeFlags} from '../../flags.js' import {globalFlags, jsonFlag} from '@shopify/cli-kit/node/cli' export default class StoreOpen extends StoreCommand { - static summary = 'Open your Shopify store in the default web browser.' + static summary = 'Opens your Shopify store in the default web browser.' static descriptionWithMarkdown = `Opens the storefront for a store you have access to in your default web browser.` diff --git a/packages/store/src/cli/commands/store/stripe-auth.ts b/packages/store/src/cli/commands/store/stripe-auth.ts index 31907ce93d1..ac684637125 100644 --- a/packages/store/src/cli/commands/store/stripe-auth.ts +++ b/packages/store/src/cli/commands/store/stripe-auth.ts @@ -11,7 +11,7 @@ import {Flags} from '@oclif/core' export default class StoreStripeAuth extends StoreCommand { static hidden = true - static summary = 'Authenticate for store commands.' + static summary = 'Authenticates for store commands.' static descriptionWithMarkdown = `Authenticates to a store then stores an online access token for later reuse. Pass the provided JWT to --signup or stdin.` diff --git a/packages/theme/src/cli/commands/theme/check.ts b/packages/theme/src/cli/commands/theme/check.ts index 5921f6ba370..90b9ffc69d1 100644 --- a/packages/theme/src/cli/commands/theme/check.ts +++ b/packages/theme/src/cli/commands/theme/check.ts @@ -27,7 +27,7 @@ import {AdminSession} from '@shopify/cli-kit/node/session' type CheckFlags = InferredFlags export default class Check extends ThemeCommand { - static summary = 'Validate the theme.' + static summary = 'Validates the theme.' static descriptionWithMarkdown = `Calls and runs [Theme Check](https://shopify.dev/docs/themes/tools/theme-check) to analyze your theme code for errors and to ensure that it follows theme and Liquid best practices. [Learn more about the checks that Theme Check runs.](https://shopify.dev/docs/themes/tools/theme-check/checks)` diff --git a/packages/theme/src/cli/commands/theme/delete.ts b/packages/theme/src/cli/commands/theme/delete.ts index cbf2730178f..faed08556a2 100644 --- a/packages/theme/src/cli/commands/theme/delete.ts +++ b/packages/theme/src/cli/commands/theme/delete.ts @@ -9,7 +9,7 @@ import type {NonTTYFlagRequirement} from '@shopify/cli-kit/node/base-command' type DeleteFlags = OutputFlags export default class Delete extends ThemeCommand { - static summary = "Delete remote themes from the connected store. This command can't be undone." + static summary = "Deletes remote themes from the connected store. This command can't be undone." static descriptionWithMarkdown = `Deletes a theme from your store. diff --git a/packages/theme/src/cli/commands/theme/language-server.ts b/packages/theme/src/cli/commands/theme/language-server.ts index 83d8dad8dfa..c52e70676c7 100644 --- a/packages/theme/src/cli/commands/theme/language-server.ts +++ b/packages/theme/src/cli/commands/theme/language-server.ts @@ -3,7 +3,7 @@ import {globalFlags} from '@shopify/cli-kit/node/cli' import {startServer} from '@shopify/theme-language-server-node' export default class LanguageServer extends ThemeCommand { - static summary = 'Start a Language Server Protocol server.' + static summary = 'Starts a Language Server Protocol server.' static descriptionWithMarkdown = `Starts the [Language Server](https://shopify.dev/docs/themes/tools/cli/language-server).` diff --git a/packages/theme/src/cli/commands/theme/metafields/pull.ts b/packages/theme/src/cli/commands/theme/metafields/pull.ts index ae999118b61..1d17822fd9d 100644 --- a/packages/theme/src/cli/commands/theme/metafields/pull.ts +++ b/packages/theme/src/cli/commands/theme/metafields/pull.ts @@ -8,7 +8,7 @@ import {InferredFlags} from '@oclif/core/interfaces' type MetafieldsFlags = InferredFlags export default class MetafieldsPull extends ThemeCommand { - static summary = 'Download metafields definitions from your shop into a local file.' + static summary = 'Downloads metafields definitions from your shop into a local file.' static descriptionWithMarkdown = `Retrieves metafields from Shopify Admin. diff --git a/packages/theme/src/cli/commands/theme/package.ts b/packages/theme/src/cli/commands/theme/package.ts index 925d13602f4..55030c9be0b 100644 --- a/packages/theme/src/cli/commands/theme/package.ts +++ b/packages/theme/src/cli/commands/theme/package.ts @@ -6,7 +6,7 @@ import {InferredFlags} from '@oclif/core/interfaces' type PackageFlags = InferredFlags export default class Package extends ThemeCommand { - static summary = 'Package your theme into a .zip file, ready to upload to the Online Store.' + static summary = 'Packages your theme into a .zip file, ready to upload to the Online Store.' static descriptionWithMarkdown = `Packages your local theme files into a ZIP file that can be uploaded to Shopify. diff --git a/packages/theme/src/cli/commands/theme/profile.ts b/packages/theme/src/cli/commands/theme/profile.ts index ada34ef65b7..5453004b4fd 100644 --- a/packages/theme/src/cli/commands/theme/profile.ts +++ b/packages/theme/src/cli/commands/theme/profile.ts @@ -11,11 +11,11 @@ import {AdminSession} from '@shopify/cli-kit/node/session' type ProfileFlags = InferredFlags export default class Profile extends ThemeCommand { - static summary = 'Profile the Liquid rendering of a theme page.' + static summary = 'Profiles the Liquid rendering of a theme page.' static usage = ['theme profile', 'theme profile --url /products/classic-leather-jacket'] - static descriptionWithMarkdown = `Profile the Shopify Liquid on a given page. + static descriptionWithMarkdown = `Profiles the Shopify Liquid on a given page. This command will open a web page with the Speedscope profiler detailing the time spent executing Liquid on the given page.` diff --git a/packages/theme/src/cli/commands/theme/publish.ts b/packages/theme/src/cli/commands/theme/publish.ts index 989b68829cd..c1742d909df 100644 --- a/packages/theme/src/cli/commands/theme/publish.ts +++ b/packages/theme/src/cli/commands/theme/publish.ts @@ -9,7 +9,7 @@ import {AdminSession} from '@shopify/cli-kit/node/session' type PublishFlags = OutputFlags export default class Publish extends ThemeCommand { - static summary = 'Set a remote theme as the live theme.' + static summary = 'Sets a remote theme as the live theme.' static descriptionWithMarkdown = `Publishes an unpublished theme from your theme library. diff --git a/packages/theme/src/cli/commands/theme/pull.ts b/packages/theme/src/cli/commands/theme/pull.ts index 605eaaa5dd5..8a35da13e88 100644 --- a/packages/theme/src/cli/commands/theme/pull.ts +++ b/packages/theme/src/cli/commands/theme/pull.ts @@ -12,7 +12,7 @@ import type {NonTTYFlagRequirement} from '@shopify/cli-kit/node/base-command' type PullFlags = InferredFlags export default class Pull extends ThemeCommand { - static summary = 'Download your remote theme files locally.' + static summary = 'Downloads your remote theme files locally.' static descriptionWithMarkdown = `Retrieves theme files from Shopify.