diff --git a/bin/create-doc-pr.js b/bin/create-doc-pr.js index c186ad3d2bb..284af6cc526 100755 --- a/bin/create-doc-pr.js +++ b/bin/create-doc-pr.js @@ -15,7 +15,7 @@ async function createPR() { const generatedDirectory = path.resolve(path.dirname(fileURLToPath(import.meta.url)), "../docs-shopify.dev/generated") - const fileNames = ['generated_category_pages.json', 'generated_docs_data.json', 'generated_static_pages.json'] + const fileNames = ['generated_category_pages.json', 'generated_docs_data.json', 'generated_docs_data_v2.json', 'generated_static_pages.json'] const files = {} for (const fileName of fileNames) { diff --git a/bin/docs/build-dev-docs.sh b/bin/docs/build-dev-docs.sh index 4f60089457e..960754f8bd1 100644 --- a/bin/docs/build-dev-docs.sh +++ b/bin/docs/build-dev-docs.sh @@ -15,3 +15,14 @@ eval $COMPILE_DOCS eval $COMPILE_STATIC_PAGES eval $COMPILE_CATEGORY_PAGES echo "DONE" + +# Copy generated docs to shopify-dev in the world repo if available +WORLD_DEST="$HOME/world/trees/root/src/areas/platforms/shopify-dev/db/data/docs/templated_apis/shopify_cli" +if [ -d "$WORLD_DEST" ]; then + for file in generated_docs_data.json generated_docs_data_v2.json generated_static_pages.json generated_category_pages.json; do + if [ -f "./docs-shopify.dev/generated/$file" ]; then + cp "./docs-shopify.dev/generated/$file" "$WORLD_DEST/$file" + echo "Copied $file to $WORLD_DEST" + fi + done +fi diff --git a/docs-shopify.dev/commands/app-build.doc.ts b/docs-shopify.dev/commands/app-build.doc.ts index ffbf4de20d5..bbd41f19492 100644 --- a/docs-shopify.dev/commands/app-build.doc.ts +++ b/docs-shopify.dev/commands/app-build.doc.ts @@ -3,9 +3,7 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs' const data: ReferenceEntityTemplateSchema = { name: 'app build', - description: `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](/docs/apps/tools/cli/configuration). - - If you're building a [theme app extension](/docs/apps/online-store/theme-app-extensions), then running the \`build\` command runs [Theme Check](/docs/themes/tools/theme-check) against your extension to ensure that it's valid.`, + description: `The following flags are available for the \`app build\` command:`, overviewPreviewDescription: `Build the app, including extensions.`, type: 'command', isVisualComponent: false, diff --git a/docs-shopify.dev/commands/app-bulk-cancel.doc.ts b/docs-shopify.dev/commands/app-bulk-cancel.doc.ts index 184427c825e..c0cac825140 100644 --- a/docs-shopify.dev/commands/app-bulk-cancel.doc.ts +++ b/docs-shopify.dev/commands/app-bulk-cancel.doc.ts @@ -3,7 +3,7 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs' const data: ReferenceEntityTemplateSchema = { name: 'app bulk cancel', - description: `Cancels a running bulk operation by ID.`, + description: `The following flags are available for the \`app bulk cancel\` command:`, overviewPreviewDescription: `Cancel a bulk operation.`, type: 'command', isVisualComponent: false, diff --git a/docs-shopify.dev/commands/app-bulk-execute.doc.ts b/docs-shopify.dev/commands/app-bulk-execute.doc.ts index 0e87c9afa31..6cc4dfc0ec4 100644 --- a/docs-shopify.dev/commands/app-bulk-execute.doc.ts +++ b/docs-shopify.dev/commands/app-bulk-execute.doc.ts @@ -3,11 +3,7 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs' const data: ReferenceEntityTemplateSchema = { name: 'app bulk execute', - description: `Executes an Admin API GraphQL query or mutation on the specified store, as a bulk operation. Mutations are only allowed on dev stores. - - Bulk operations allow you to process large amounts of data asynchronously. Learn more about [bulk query operations](/docs/api/usage/bulk-operations/queries) and [bulk mutation operations](/docs/api/usage/bulk-operations/imports). - - Use [\`bulk status\`](/docs/api/shopify-cli/app/app-bulk-status) to check the status of your bulk operations.`, + description: `The following flags are available for the \`app bulk execute\` command:`, overviewPreviewDescription: `Execute bulk operations.`, type: 'command', isVisualComponent: false, diff --git a/docs-shopify.dev/commands/app-bulk-status.doc.ts b/docs-shopify.dev/commands/app-bulk-status.doc.ts index 410da037721..ab39957ea5a 100644 --- a/docs-shopify.dev/commands/app-bulk-status.doc.ts +++ b/docs-shopify.dev/commands/app-bulk-status.doc.ts @@ -3,11 +3,7 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs' const data: ReferenceEntityTemplateSchema = { name: 'app bulk status', - description: `Check the status of a specific bulk operation by ID, or list all bulk operations 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](/docs/api/usage/bulk-operations/queries) and [bulk mutation operations](/docs/api/usage/bulk-operations/imports). - - Use [\`bulk execute\`](/docs/api/shopify-cli/app/app-bulk-execute) to start a new bulk operation.`, + description: `The following flags are available for the \`app bulk status\` command:`, overviewPreviewDescription: `Check the status of bulk operations.`, type: 'command', isVisualComponent: false, diff --git a/docs-shopify.dev/commands/app-config-link.doc.ts b/docs-shopify.dev/commands/app-config-link.doc.ts index d5aedec9dea..07d6eb6ed70 100644 --- a/docs-shopify.dev/commands/app-config-link.doc.ts +++ b/docs-shopify.dev/commands/app-config-link.doc.ts @@ -3,10 +3,7 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs' const data: ReferenceEntityTemplateSchema = { name: 'app config link', - description: `Pulls app configuration from the Developer Dashboard and creates or overwrites a configuration file. You can create a new app with this command to start with a default configuration file. - - For more information on the format of the created TOML configuration file, refer to the [App configuration](/docs/apps/tools/cli/configuration) page. - `, + description: `The following flags are available for the \`app config link\` command:`, overviewPreviewDescription: `Fetch your app configuration from the Developer Dashboard.`, type: 'command', isVisualComponent: false, diff --git a/docs-shopify.dev/commands/app-config-pull.doc.ts b/docs-shopify.dev/commands/app-config-pull.doc.ts index 9780b60bdb5..f6bee7592e2 100644 --- a/docs-shopify.dev/commands/app-config-pull.doc.ts +++ b/docs-shopify.dev/commands/app-config-pull.doc.ts @@ -3,9 +3,7 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs' const data: ReferenceEntityTemplateSchema = { name: 'app config pull', - description: `Pulls the latest configuration from the already-linked Shopify app and updates the selected configuration file. - -This command reuses the existing linked app and organization and skips all interactive prompts. Use \`--config\` to target a specific configuration file, or omit it to use the default one.`, + description: `The following flags are available for the \`app config pull\` command:`, overviewPreviewDescription: `Refresh an already-linked app configuration without prompts.`, type: 'command', isVisualComponent: false, diff --git a/docs-shopify.dev/commands/app-config-use.doc.ts b/docs-shopify.dev/commands/app-config-use.doc.ts index 2f73c63186f..afa176e14a7 100644 --- a/docs-shopify.dev/commands/app-config-use.doc.ts +++ b/docs-shopify.dev/commands/app-config-use.doc.ts @@ -3,7 +3,7 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs' const data: ReferenceEntityTemplateSchema = { name: 'app config use', - description: `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.`, + description: `The following flags are available for the \`app config use\` command:`, overviewPreviewDescription: `Activate an app configuration.`, type: 'command', isVisualComponent: false, diff --git a/docs-shopify.dev/commands/app-config-validate.doc.ts b/docs-shopify.dev/commands/app-config-validate.doc.ts index cedde571a3e..33831f9edef 100644 --- a/docs-shopify.dev/commands/app-config-validate.doc.ts +++ b/docs-shopify.dev/commands/app-config-validate.doc.ts @@ -3,7 +3,7 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs' const data: ReferenceEntityTemplateSchema = { name: 'app config validate', - description: `Validates the selected app configuration file and all extension configurations against their schemas and reports any errors found.`, + description: `The following flags are available for the \`app config validate\` command:`, overviewPreviewDescription: `Validate your app configuration and extensions.`, type: 'command', isVisualComponent: false, diff --git a/docs-shopify.dev/commands/app-deploy.doc.ts b/docs-shopify.dev/commands/app-deploy.doc.ts index 2542c30fc6d..6eb82bdc12f 100644 --- a/docs-shopify.dev/commands/app-deploy.doc.ts +++ b/docs-shopify.dev/commands/app-deploy.doc.ts @@ -3,12 +3,7 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs' const data: ReferenceEntityTemplateSchema = { name: 'app deploy', - description: `[Builds the app](/docs/api/shopify-cli/app/app-build), then deploys your app configuration and extensions. - - This command creates an app version, which is a snapshot of your app configuration and all extensions. This version is then released to users. - - This command doesn't deploy your [web app](/docs/apps/tools/cli/structure#web-components). You need to [deploy your web app](/docs/apps/deployment/web) to your own hosting solution. - `, + description: `The following flags are available for the \`app deploy\` command:`, overviewPreviewDescription: `Deploy your Shopify app.`, type: 'command', isVisualComponent: false, diff --git a/docs-shopify.dev/commands/app-dev-clean.doc.ts b/docs-shopify.dev/commands/app-dev-clean.doc.ts index 371ff666e26..c560b834781 100644 --- a/docs-shopify.dev/commands/app-dev-clean.doc.ts +++ b/docs-shopify.dev/commands/app-dev-clean.doc.ts @@ -3,10 +3,7 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs' const data: ReferenceEntityTemplateSchema = { name: 'app dev clean', - description: `Stop the dev preview that was started with \`shopify app dev\`. - - It restores the app's active version to the selected development store. - `, + description: `The following flags are available for the \`app dev clean\` command:`, overviewPreviewDescription: `Cleans up the dev preview from the selected store.`, type: 'command', isVisualComponent: false, diff --git a/docs-shopify.dev/commands/app-dev.doc.ts b/docs-shopify.dev/commands/app-dev.doc.ts index 254424cbaf4..03c686cbe49 100644 --- a/docs-shopify.dev/commands/app-dev.doc.ts +++ b/docs-shopify.dev/commands/app-dev.doc.ts @@ -3,7 +3,7 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs' const data: ReferenceEntityTemplateSchema = { name: 'app dev', - description: `Builds and previews your app on a dev store, and watches for changes. [Read more about testing apps locally](/docs/apps/build/cli-for-apps/test-apps-locally).`, + description: `The following flags are available for the \`app dev\` command:`, overviewPreviewDescription: `Run the app.`, type: 'command', isVisualComponent: false, diff --git a/docs-shopify.dev/commands/app-env-pull.doc.ts b/docs-shopify.dev/commands/app-env-pull.doc.ts index 57acedf8771..02133284c84 100644 --- a/docs-shopify.dev/commands/app-env-pull.doc.ts +++ b/docs-shopify.dev/commands/app-env-pull.doc.ts @@ -3,9 +3,7 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs' const data: ReferenceEntityTemplateSchema = { name: 'app env pull', - description: `Creates or updates an \`.env\` files that contains app and app extension environment variables. - - When an existing \`.env\` file is updated, changes to the variables are displayed in the terminal output. Existing variables and commented variables are preserved.`, + description: `The following flags are available for the \`app env pull\` command:`, overviewPreviewDescription: `Pull app and extensions environment variables.`, type: 'command', isVisualComponent: false, diff --git a/docs-shopify.dev/commands/app-env-show.doc.ts b/docs-shopify.dev/commands/app-env-show.doc.ts index 2ea5804a5fb..d3019b50a09 100644 --- a/docs-shopify.dev/commands/app-env-show.doc.ts +++ b/docs-shopify.dev/commands/app-env-show.doc.ts @@ -3,7 +3,7 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs' const data: ReferenceEntityTemplateSchema = { name: 'app env show', - description: `Displays environment variables that can be used to deploy apps and app extensions.`, + description: `The following flags are available for the \`app env show\` command:`, overviewPreviewDescription: `Display app and extensions environment variables.`, type: 'command', isVisualComponent: false, diff --git a/docs-shopify.dev/commands/app-execute.doc.ts b/docs-shopify.dev/commands/app-execute.doc.ts index 78b2334de54..baa95ef344f 100644 --- a/docs-shopify.dev/commands/app-execute.doc.ts +++ b/docs-shopify.dev/commands/app-execute.doc.ts @@ -3,9 +3,7 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs' const data: ReferenceEntityTemplateSchema = { name: 'app execute', - description: `Executes an Admin API GraphQL query or mutation on the specified store. Mutations are only allowed on dev stores. - - For operations that process large amounts of data, use [\`bulk execute\`](/docs/api/shopify-cli/app/app-bulk-execute) instead.`, + description: `The following flags are available for the \`app execute\` command:`, overviewPreviewDescription: `Execute GraphQL queries and mutations.`, type: 'command', isVisualComponent: false, diff --git a/docs-shopify.dev/commands/app-function-build.doc.ts b/docs-shopify.dev/commands/app-function-build.doc.ts index 7e32c8aad1a..13d73f21074 100644 --- a/docs-shopify.dev/commands/app-function-build.doc.ts +++ b/docs-shopify.dev/commands/app-function-build.doc.ts @@ -3,7 +3,7 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs' const data: ReferenceEntityTemplateSchema = { name: 'app function build', - description: `Compiles the function in your current directory to WebAssembly (Wasm) for testing purposes.`, + description: `The following flags are available for the \`app function build\` command:`, overviewPreviewDescription: `Compile a function to wasm.`, type: 'command', isVisualComponent: false, diff --git a/docs-shopify.dev/commands/app-function-info.doc.ts b/docs-shopify.dev/commands/app-function-info.doc.ts index 2f82b630422..cea641a33ec 100644 --- a/docs-shopify.dev/commands/app-function-info.doc.ts +++ b/docs-shopify.dev/commands/app-function-info.doc.ts @@ -3,15 +3,7 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs' const data: ReferenceEntityTemplateSchema = { name: 'app function info', - description: `The information returned includes the following: - - - The function handle - - The function name - - The function API version - - The targeting configuration - - The schema path - - The WASM path - - The function runner path`, + description: `The following flags are available for the \`app function info\` command:`, overviewPreviewDescription: `Print basic information about your function.`, type: 'command', isVisualComponent: false, diff --git a/docs-shopify.dev/commands/app-function-replay.doc.ts b/docs-shopify.dev/commands/app-function-replay.doc.ts index eee47ad890e..da92d3bc122 100644 --- a/docs-shopify.dev/commands/app-function-replay.doc.ts +++ b/docs-shopify.dev/commands/app-function-replay.doc.ts @@ -3,7 +3,7 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs' const data: ReferenceEntityTemplateSchema = { name: 'app function replay', - description: `Runs the function from your current directory for [testing purposes](/docs/apps/functions/testing-and-debugging). To learn how you can monitor and debug functions when errors occur, refer to [Shopify Functions error handling](/docs/api/functions/errors).`, + description: `The following flags are available for the \`app function replay\` command:`, overviewPreviewDescription: `Replays a function run from an app log.`, type: 'command', isVisualComponent: false, diff --git a/docs-shopify.dev/commands/app-function-run.doc.ts b/docs-shopify.dev/commands/app-function-run.doc.ts index c44aba9c475..b824b8befe9 100644 --- a/docs-shopify.dev/commands/app-function-run.doc.ts +++ b/docs-shopify.dev/commands/app-function-run.doc.ts @@ -3,7 +3,7 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs' const data: ReferenceEntityTemplateSchema = { name: 'app function run', - description: `Runs the function from your current directory for [testing purposes](/docs/apps/functions/testing-and-debugging). To learn how you can monitor and debug functions when errors occur, refer to [Shopify Functions error handling](/docs/api/functions/errors).`, + description: `The following flags are available for the \`app function run\` command:`, overviewPreviewDescription: `Run a function locally for testing.`, type: 'command', isVisualComponent: false, diff --git a/docs-shopify.dev/commands/app-function-schema.doc.ts b/docs-shopify.dev/commands/app-function-schema.doc.ts index e48c9f92cdc..7c153384678 100644 --- a/docs-shopify.dev/commands/app-function-schema.doc.ts +++ b/docs-shopify.dev/commands/app-function-schema.doc.ts @@ -3,9 +3,7 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs' const data: ReferenceEntityTemplateSchema = { name: 'app function schema', - description: `Generates the latest [GraphQL schema](/docs/apps/functions/input-output#graphql-schema) for a function in your app. Run this command from the function directory. - - This command uses the API type and version of your function, as defined in your extension TOML file, to generate the latest GraphQL schema. The schema is written to the \`schema.graphql\` file.`, + description: `The following flags are available for the \`app function schema\` command:`, overviewPreviewDescription: `Fetch the latest GraphQL schema for a function.`, type: 'command', isVisualComponent: false, diff --git a/docs-shopify.dev/commands/app-function-typegen.doc.ts b/docs-shopify.dev/commands/app-function-typegen.doc.ts index f5f3770d122..5f83a7a8ce5 100644 --- a/docs-shopify.dev/commands/app-function-typegen.doc.ts +++ b/docs-shopify.dev/commands/app-function-typegen.doc.ts @@ -3,7 +3,7 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs' const data: ReferenceEntityTemplateSchema = { name: 'app function typegen', - description: `Creates GraphQL types based on your [input query](/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.`, + description: `The following flags are available for the \`app function typegen\` command:`, overviewPreviewDescription: `Generate GraphQL types for a function.`, type: 'command', isVisualComponent: false, diff --git a/docs-shopify.dev/commands/app-generate-extension.doc.ts b/docs-shopify.dev/commands/app-generate-extension.doc.ts index 1d1a1cb4a90..1bead9f072d 100644 --- a/docs-shopify.dev/commands/app-generate-extension.doc.ts +++ b/docs-shopify.dev/commands/app-generate-extension.doc.ts @@ -3,10 +3,7 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs' const data: ReferenceEntityTemplateSchema = { name: 'app generate extension', - description: `Generates a new [app extension](/docs/apps/build/app-extensions). For a list of app extensions that you can generate using this command, refer to [Supported extensions](/docs/apps/build/app-extensions/list-of-app-extensions). - - Each new app extension is created in a folder under \`extensions/\`. To learn more about the extensions file structure, refer to [App structure](/docs/apps/build/cli-for-apps/app-structure) and the documentation for your extension. - `, + description: `The following flags are available for the \`app generate extension\` command:`, overviewPreviewDescription: `Generate a new app Extension.`, type: 'command', isVisualComponent: false, diff --git a/docs-shopify.dev/commands/app-import-custom-data-definitions.doc.ts b/docs-shopify.dev/commands/app-import-custom-data-definitions.doc.ts index a1b101a5295..25f454f6788 100644 --- a/docs-shopify.dev/commands/app-import-custom-data-definitions.doc.ts +++ b/docs-shopify.dev/commands/app-import-custom-data-definitions.doc.ts @@ -3,7 +3,7 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs' const data: ReferenceEntityTemplateSchema = { name: 'app import-custom-data-definitions', - description: `Import metafield and metaobject definitions from your development store. [Read more about declarative custom data definitions](/docs/apps/build/custom-data/declarative-custom-data-definitions).`, + description: `The following flags are available for the \`app import-custom-data-definitions\` command:`, overviewPreviewDescription: `Import metafield and metaobject definitions.`, type: 'command', isVisualComponent: false, diff --git a/docs-shopify.dev/commands/app-import-extensions.doc.ts b/docs-shopify.dev/commands/app-import-extensions.doc.ts index a6e83e7934a..6b3d26b18ea 100644 --- a/docs-shopify.dev/commands/app-import-extensions.doc.ts +++ b/docs-shopify.dev/commands/app-import-extensions.doc.ts @@ -3,8 +3,8 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs' const data: ReferenceEntityTemplateSchema = { name: 'app import-extensions', - description: `Import dashboard-managed extensions into your app.`, - overviewPreviewDescription: `Import dashboard-managed extensions into your app.`, + description: `The following flags are available for the \`app import-extensions\` command:`, + overviewPreviewDescription: `The following flags are available for the \`app import-extensions\` command:`, type: 'command', isVisualComponent: false, defaultExample: { diff --git a/docs-shopify.dev/commands/app-info.doc.ts b/docs-shopify.dev/commands/app-info.doc.ts index 22fe4fd1cde..5f4947d8305 100644 --- a/docs-shopify.dev/commands/app-info.doc.ts +++ b/docs-shopify.dev/commands/app-info.doc.ts @@ -3,12 +3,7 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs' const data: ReferenceEntityTemplateSchema = { name: 'app info', - description: `The information returned includes the following: - - - The app and dev store that's used when you run the [dev](/docs/api/shopify-cli/app/app-dev) command. You can reset these configurations using [\`dev --reset\`](/docs/api/shopify-cli/app/app-dev#flags-propertydetail-reset). - - The [structure](/docs/apps/tools/cli/structure) of your app project. - - The [access scopes](/docs/api/usage) your app has requested. - - System information, including the package manager and version of Shopify CLI used in the project.`, + description: `The following flags are available for the \`app info\` command:`, overviewPreviewDescription: `Print basic information about your app and extensions.`, type: 'command', isVisualComponent: false, diff --git a/docs-shopify.dev/commands/app-init.doc.ts b/docs-shopify.dev/commands/app-init.doc.ts index 1d34efb7468..215d777b405 100644 --- a/docs-shopify.dev/commands/app-init.doc.ts +++ b/docs-shopify.dev/commands/app-init.doc.ts @@ -3,7 +3,7 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs' const data: ReferenceEntityTemplateSchema = { name: 'app init', - description: `Create a new app project`, + description: `The following flags are available for the \`app init\` command:`, overviewPreviewDescription: `Create a new app project`, type: 'command', isVisualComponent: false, diff --git a/docs-shopify.dev/commands/app-logs-sources.doc.ts b/docs-shopify.dev/commands/app-logs-sources.doc.ts index c06bb362395..d67f2cfb57a 100644 --- a/docs-shopify.dev/commands/app-logs-sources.doc.ts +++ b/docs-shopify.dev/commands/app-logs-sources.doc.ts @@ -3,7 +3,7 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs' const data: ReferenceEntityTemplateSchema = { name: 'app logs sources', - description: `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.`, + description: `The following flags are available for the \`app logs sources\` command:`, overviewPreviewDescription: `Print out a list of sources that may be used with the logs command.`, type: 'command', isVisualComponent: false, diff --git a/docs-shopify.dev/commands/app-logs.doc.ts b/docs-shopify.dev/commands/app-logs.doc.ts index 6829609ed9e..03537f1a86b 100644 --- a/docs-shopify.dev/commands/app-logs.doc.ts +++ b/docs-shopify.dev/commands/app-logs.doc.ts @@ -3,14 +3,7 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs' const data: ReferenceEntityTemplateSchema = { name: 'app logs', - description: ` - Opens a real-time stream of detailed app logs from the selected app and store. - Use the \`--source\` argument to limit output to a particular log source, such as a specific Shopify Function handle. Use the \`shopify app logs sources\` command to view a list of sources. - Use the \`--status\` argument to filter on status, either \`success\` or \`failure\`. - \`\`\` - shopify app logs --status=success --source=extension.discount-function - \`\`\` - `, + description: `The following flags are available for the \`app logs\` command:`, overviewPreviewDescription: `Stream detailed logs for your Shopify app.`, type: 'command', isVisualComponent: false, diff --git a/docs-shopify.dev/commands/app-release.doc.ts b/docs-shopify.dev/commands/app-release.doc.ts index 8dbdf937e8e..b11ab293e15 100644 --- a/docs-shopify.dev/commands/app-release.doc.ts +++ b/docs-shopify.dev/commands/app-release.doc.ts @@ -3,7 +3,7 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs' const data: ReferenceEntityTemplateSchema = { name: 'app release', - description: `Releases an existing app version. Pass the name of the version that you want to release using the \`--version\` flag.`, + description: `The following flags are available for the \`app release\` command:`, overviewPreviewDescription: `Release an app version.`, type: 'command', isVisualComponent: false, diff --git a/docs-shopify.dev/commands/app-versions-list.doc.ts b/docs-shopify.dev/commands/app-versions-list.doc.ts index 8d598775b21..c3ec225633d 100644 --- a/docs-shopify.dev/commands/app-versions-list.doc.ts +++ b/docs-shopify.dev/commands/app-versions-list.doc.ts @@ -3,7 +3,7 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs' const data: ReferenceEntityTemplateSchema = { name: 'app versions list', - description: `Lists the deployed app versions. An app version is a snapshot of your app extensions.`, + description: `The following flags are available for the \`app versions list\` command:`, overviewPreviewDescription: `List deployed versions of your app.`, type: 'command', isVisualComponent: false, diff --git a/docs-shopify.dev/commands/app-webhook-trigger.doc.ts b/docs-shopify.dev/commands/app-webhook-trigger.doc.ts index f7b9213abdd..536d260d2d4 100644 --- a/docs-shopify.dev/commands/app-webhook-trigger.doc.ts +++ b/docs-shopify.dev/commands/app-webhook-trigger.doc.ts @@ -3,22 +3,7 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs' const data: ReferenceEntityTemplateSchema = { name: 'app webhook trigger', - description: ` - Triggers the delivery of a sample Admin API event topic payload to a designated address. - - You should use this command to experiment with webhooks, to initially test your webhook configuration, or for unit testing. However, to test your webhook configuration from end to end, you should always trigger webhooks by performing the related action in Shopify. - - Because most webhook deliveries use remote endpoints, you can trigger the command from any directory where you can use Shopify CLI, and send the webhook to any of the supported endpoint types. For example, you can run the command from your app's local directory, but send the webhook to a staging environment endpoint. - - To learn more about using webhooks in a Shopify app, refer to [Webhooks overview](/docs/apps/webhooks). - - ### Limitations - - - Webhooks triggered using this method always have the same payload, so they can't be used to test scenarios that differ based on the payload contents. - - Webhooks triggered using this method aren't retried when they fail. - - Trigger requests are rate-limited using the [Partner API rate limit](/docs/api/partner#rate_limits). - - You can't use this method to validate your API webhook subscriptions. - `, + description: `The following flags are available for the \`app webhook trigger\` command:`, overviewPreviewDescription: `Trigger delivery of a sample webhook topic payload to a designated address.`, type: 'command', isVisualComponent: false, diff --git a/docs-shopify.dev/commands/auth-login.doc.ts b/docs-shopify.dev/commands/auth-login.doc.ts index 673b91e0aa5..06a79fe1c67 100644 --- a/docs-shopify.dev/commands/auth-login.doc.ts +++ b/docs-shopify.dev/commands/auth-login.doc.ts @@ -3,8 +3,8 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs' const data: ReferenceEntityTemplateSchema = { name: 'auth login', - description: `Logs you in to your Shopify account.`, - overviewPreviewDescription: `Logs you in to your Shopify account.`, + description: `The following flags are available for the \`auth login\` command:`, + overviewPreviewDescription: `The following flags are available for the \`auth login\` command:`, type: 'command', isVisualComponent: false, defaultExample: { diff --git a/docs-shopify.dev/commands/commands.doc.ts b/docs-shopify.dev/commands/commands.doc.ts index 98653f60bbc..2950bc3313d 100644 --- a/docs-shopify.dev/commands/commands.doc.ts +++ b/docs-shopify.dev/commands/commands.doc.ts @@ -3,8 +3,8 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs' const data: ReferenceEntityTemplateSchema = { name: 'commands', - description: `List all shopify commands.`, - overviewPreviewDescription: `List all shopify commands.`, + description: `The following flags are available for the \`commands\` command:`, + overviewPreviewDescription: `The following flags are available for the \`commands\` command:`, type: 'command', isVisualComponent: false, defaultExample: { diff --git a/docs-shopify.dev/commands/help.doc.ts b/docs-shopify.dev/commands/help.doc.ts index 2b55e498435..dc1dc3dfc2b 100644 --- a/docs-shopify.dev/commands/help.doc.ts +++ b/docs-shopify.dev/commands/help.doc.ts @@ -3,8 +3,8 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs' const data: ReferenceEntityTemplateSchema = { name: 'help', - description: `Display help for Shopify CLI`, - overviewPreviewDescription: `Display help for Shopify CLI`, + description: `The following flags are available for the \`help\` command:`, + overviewPreviewDescription: `The following flags are available for the \`help\` command:`, type: 'command', isVisualComponent: false, defaultExample: { diff --git a/docs-shopify.dev/commands/hydrogen-build.doc.ts b/docs-shopify.dev/commands/hydrogen-build.doc.ts index 7c5699814b7..6b9b64cfaac 100644 --- a/docs-shopify.dev/commands/hydrogen-build.doc.ts +++ b/docs-shopify.dev/commands/hydrogen-build.doc.ts @@ -3,8 +3,8 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs' const data: ReferenceEntityTemplateSchema = { name: 'hydrogen build', - description: `Builds a Hydrogen storefront for production. The client and app worker files are compiled to a \`/dist\` folder in your Hydrogen project directory.`, - overviewPreviewDescription: `Builds a Hydrogen storefront for production. The client and app worker files are compiled to a \`/dist\` folder in your Hydrogen project directory.`, + description: `The following flags are available for the \`hydrogen build\` command:`, + overviewPreviewDescription: `The following flags are available for the \`hydrogen build\` command:`, type: 'command', isVisualComponent: false, defaultExample: { diff --git a/docs-shopify.dev/commands/hydrogen-check.doc.ts b/docs-shopify.dev/commands/hydrogen-check.doc.ts index afd53f9304d..4ece5bccaca 100644 --- a/docs-shopify.dev/commands/hydrogen-check.doc.ts +++ b/docs-shopify.dev/commands/hydrogen-check.doc.ts @@ -3,8 +3,8 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs' const data: ReferenceEntityTemplateSchema = { name: 'hydrogen check', - description: `Checks whether your Hydrogen app includes a set of standard Shopify routes.`, - overviewPreviewDescription: `Checks whether your Hydrogen app includes a set of standard Shopify routes.`, + description: `The following flags are available for the \`hydrogen check\` command:`, + overviewPreviewDescription: `The following flags are available for the \`hydrogen check\` command:`, type: 'command', isVisualComponent: false, defaultExample: { diff --git a/docs-shopify.dev/commands/hydrogen-codegen.doc.ts b/docs-shopify.dev/commands/hydrogen-codegen.doc.ts index 00b9233f8ac..d9274815e50 100644 --- a/docs-shopify.dev/commands/hydrogen-codegen.doc.ts +++ b/docs-shopify.dev/commands/hydrogen-codegen.doc.ts @@ -3,8 +3,8 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs' const data: ReferenceEntityTemplateSchema = { name: 'hydrogen codegen', - description: `Automatically generates GraphQL types for your project’s Storefront API queries.`, - overviewPreviewDescription: `Automatically generates GraphQL types for your project’s Storefront API queries.`, + description: `The following flags are available for the \`hydrogen codegen\` command:`, + overviewPreviewDescription: `The following flags are available for the \`hydrogen codegen\` command:`, type: 'command', isVisualComponent: false, defaultExample: { diff --git a/docs-shopify.dev/commands/hydrogen-customer-account-push.doc.ts b/docs-shopify.dev/commands/hydrogen-customer-account-push.doc.ts index 0a5279d137c..3726d137f0b 100644 --- a/docs-shopify.dev/commands/hydrogen-customer-account-push.doc.ts +++ b/docs-shopify.dev/commands/hydrogen-customer-account-push.doc.ts @@ -3,8 +3,8 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs' const data: ReferenceEntityTemplateSchema = { name: 'hydrogen customer-account-push', - description: `Push project configuration to admin`, - overviewPreviewDescription: `Push project configuration to admin`, + description: `The following flags are available for the \`hydrogen customer-account-push\` command:`, + overviewPreviewDescription: `The following flags are available for the \`hydrogen customer-account-push\` command:`, type: 'command', isVisualComponent: false, defaultExample: { diff --git a/docs-shopify.dev/commands/hydrogen-debug-cpu.doc.ts b/docs-shopify.dev/commands/hydrogen-debug-cpu.doc.ts index 21c9ba36b28..f57446568d8 100644 --- a/docs-shopify.dev/commands/hydrogen-debug-cpu.doc.ts +++ b/docs-shopify.dev/commands/hydrogen-debug-cpu.doc.ts @@ -3,12 +3,8 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs' const data: ReferenceEntityTemplateSchema = { name: 'hydrogen debug cpu', - description: `Builds the app and runs the resulting code to profile the server startup time, watching for changes. This command can be used to [debug slow app startup times](/docs/custom-storefronts/hydrogen/debugging/cpu-startup) that cause failed deployments in Oxygen. - - The profiling results are written to a \`.cpuprofile\` file that can be viewed with certain tools such as [Flame Chart Visualizer for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=ms-vscode.vscode-js-profile-flame).`, - overviewPreviewDescription: `Builds the app and runs the resulting code to profile the server startup time, watching for changes. This command can be used to [debug slow app startup times](/docs/custom-storefronts/hydrogen/debugging/cpu-startup) that cause failed deployments in Oxygen. - - The profiling results are written to a \`.cpuprofile\` file that can be viewed with certain tools such as [Flame Chart Visualizer for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=ms-vscode.vscode-js-profile-flame).`, + description: `The following flags are available for the \`hydrogen debug cpu\` command:`, + overviewPreviewDescription: `The following flags are available for the \`hydrogen debug cpu\` command:`, type: 'command', isVisualComponent: false, defaultExample: { diff --git a/docs-shopify.dev/commands/hydrogen-deploy.doc.ts b/docs-shopify.dev/commands/hydrogen-deploy.doc.ts index 5d014c407fd..05a39eb289f 100644 --- a/docs-shopify.dev/commands/hydrogen-deploy.doc.ts +++ b/docs-shopify.dev/commands/hydrogen-deploy.doc.ts @@ -3,8 +3,8 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs' const data: ReferenceEntityTemplateSchema = { name: 'hydrogen deploy', - description: `Builds and deploys your Hydrogen storefront to Oxygen. Requires an Oxygen deployment token to be set with the \`--token\` flag or an environment variable (\`SHOPIFY_HYDROGEN_DEPLOYMENT_TOKEN\`). If the storefront is [linked](/docs/api/shopify-cli/hydrogen/hydrogen-link) then the Oxygen deployment token for the linked storefront will be used automatically.`, - overviewPreviewDescription: `Builds and deploys your Hydrogen storefront to Oxygen. Requires an Oxygen deployment token to be set with the \`--token\` flag or an environment variable (\`SHOPIFY_HYDROGEN_DEPLOYMENT_TOKEN\`). If the storefront is [linked](/docs/api/shopify-cli/hydrogen/hydrogen-link) then the Oxygen deployment token for the linked storefront will be used automatically.`, + description: `The following flags are available for the \`hydrogen deploy\` command:`, + overviewPreviewDescription: `The following flags are available for the \`hydrogen deploy\` command:`, type: 'command', isVisualComponent: false, defaultExample: { diff --git a/docs-shopify.dev/commands/hydrogen-dev.doc.ts b/docs-shopify.dev/commands/hydrogen-dev.doc.ts index 5d55c8df2c2..7573e7db4e3 100644 --- a/docs-shopify.dev/commands/hydrogen-dev.doc.ts +++ b/docs-shopify.dev/commands/hydrogen-dev.doc.ts @@ -3,12 +3,8 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs' const data: ReferenceEntityTemplateSchema = { name: 'hydrogen dev', - description: `Runs a Hydrogen storefront in a local runtime that emulates an Oxygen worker for development. - - If your project is [linked](/docs/api/shopify-cli/hydrogen/hydrogen-link) to a Hydrogen storefront, then its environment variables will be loaded with the runtime.`, - overviewPreviewDescription: `Runs a Hydrogen storefront in a local runtime that emulates an Oxygen worker for development. - - If your project is [linked](/docs/api/shopify-cli/hydrogen/hydrogen-link) to a Hydrogen storefront, then its environment variables will be loaded with the runtime.`, + description: `The following flags are available for the \`hydrogen dev\` command:`, + overviewPreviewDescription: `The following flags are available for the \`hydrogen dev\` command:`, type: 'command', isVisualComponent: false, defaultExample: { diff --git a/docs-shopify.dev/commands/hydrogen-env-list.doc.ts b/docs-shopify.dev/commands/hydrogen-env-list.doc.ts index 4e8d12af3bf..c715582e43e 100644 --- a/docs-shopify.dev/commands/hydrogen-env-list.doc.ts +++ b/docs-shopify.dev/commands/hydrogen-env-list.doc.ts @@ -3,8 +3,8 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs' const data: ReferenceEntityTemplateSchema = { name: 'hydrogen env list', - description: `Lists all environments available on the linked Hydrogen storefront.`, - overviewPreviewDescription: `Lists all environments available on the linked Hydrogen storefront.`, + description: `The following flags are available for the \`hydrogen env list\` command:`, + overviewPreviewDescription: `The following flags are available for the \`hydrogen env list\` command:`, type: 'command', isVisualComponent: false, defaultExample: { diff --git a/docs-shopify.dev/commands/hydrogen-env-pull.doc.ts b/docs-shopify.dev/commands/hydrogen-env-pull.doc.ts index 195847967bf..29a8c4fc6bd 100644 --- a/docs-shopify.dev/commands/hydrogen-env-pull.doc.ts +++ b/docs-shopify.dev/commands/hydrogen-env-pull.doc.ts @@ -3,8 +3,8 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs' const data: ReferenceEntityTemplateSchema = { name: 'hydrogen env pull', - description: `Pulls environment variables from the linked Hydrogen storefront and writes them to an \`.env\` file.`, - overviewPreviewDescription: `Pulls environment variables from the linked Hydrogen storefront and writes them to an \`.env\` file.`, + description: `The following flags are available for the \`hydrogen env pull\` command:`, + overviewPreviewDescription: `The following flags are available for the \`hydrogen env pull\` command:`, type: 'command', isVisualComponent: false, defaultExample: { diff --git a/docs-shopify.dev/commands/hydrogen-env-push.doc.ts b/docs-shopify.dev/commands/hydrogen-env-push.doc.ts index 29fe7c9eacc..25f82749442 100644 --- a/docs-shopify.dev/commands/hydrogen-env-push.doc.ts +++ b/docs-shopify.dev/commands/hydrogen-env-push.doc.ts @@ -3,8 +3,8 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs' const data: ReferenceEntityTemplateSchema = { name: 'hydrogen env push', - description: `Push environment variables from the local .env file to your linked Hydrogen storefront.`, - overviewPreviewDescription: `Push environment variables from the local .env file to your linked Hydrogen storefront.`, + description: `The following flags are available for the \`hydrogen env push\` command:`, + overviewPreviewDescription: `The following flags are available for the \`hydrogen env push\` command:`, type: 'command', isVisualComponent: false, defaultExample: { diff --git a/docs-shopify.dev/commands/hydrogen-generate-route.doc.ts b/docs-shopify.dev/commands/hydrogen-generate-route.doc.ts index 00c4510a958..37b2b24045b 100644 --- a/docs-shopify.dev/commands/hydrogen-generate-route.doc.ts +++ b/docs-shopify.dev/commands/hydrogen-generate-route.doc.ts @@ -3,8 +3,8 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs' const data: ReferenceEntityTemplateSchema = { name: 'hydrogen generate route', - description: `Generates a set of default routes from the starter template.`, - overviewPreviewDescription: `Generates a set of default routes from the starter template.`, + description: `The following flags are available for the \`hydrogen generate route\` command:`, + overviewPreviewDescription: `The following flags are available for the \`hydrogen generate route\` command:`, type: 'command', isVisualComponent: false, defaultExample: { diff --git a/docs-shopify.dev/commands/hydrogen-generate-routes.doc.ts b/docs-shopify.dev/commands/hydrogen-generate-routes.doc.ts index 4e95d749369..d623d661ea7 100644 --- a/docs-shopify.dev/commands/hydrogen-generate-routes.doc.ts +++ b/docs-shopify.dev/commands/hydrogen-generate-routes.doc.ts @@ -3,8 +3,8 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs' const data: ReferenceEntityTemplateSchema = { name: 'hydrogen generate routes', - description: `Generates all supported standard shopify routes.`, - overviewPreviewDescription: `Generates all supported standard shopify routes.`, + description: `The following flags are available for the \`hydrogen generate routes\` command:`, + overviewPreviewDescription: `The following flags are available for the \`hydrogen generate routes\` command:`, type: 'command', isVisualComponent: false, defaultExample: { diff --git a/docs-shopify.dev/commands/hydrogen-init.doc.ts b/docs-shopify.dev/commands/hydrogen-init.doc.ts index f37e249196a..dc97a105df8 100644 --- a/docs-shopify.dev/commands/hydrogen-init.doc.ts +++ b/docs-shopify.dev/commands/hydrogen-init.doc.ts @@ -3,8 +3,8 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs' const data: ReferenceEntityTemplateSchema = { name: 'hydrogen init', - description: `Creates a new Hydrogen storefront.`, - overviewPreviewDescription: `Creates a new Hydrogen storefront.`, + description: `The following flags are available for the \`hydrogen init\` command:`, + overviewPreviewDescription: `The following flags are available for the \`hydrogen init\` command:`, type: 'command', isVisualComponent: false, defaultExample: { diff --git a/docs-shopify.dev/commands/hydrogen-link.doc.ts b/docs-shopify.dev/commands/hydrogen-link.doc.ts index 3ff4996948f..0d005388133 100644 --- a/docs-shopify.dev/commands/hydrogen-link.doc.ts +++ b/docs-shopify.dev/commands/hydrogen-link.doc.ts @@ -3,16 +3,8 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs' const data: ReferenceEntityTemplateSchema = { name: 'hydrogen link', - description: `Links your local development environment to a remote Hydrogen storefront. You can link an unlimited number of development environments to a single Hydrogen storefront. - - Linking to a Hydrogen storefront enables you to run [dev](/docs/api/shopify-cli/hydrogen/hydrogen-dev) and automatically inject your linked Hydrogen storefront's environment variables directly into the server runtime. - - After you run the \`link\` command, you can access the [env list](/docs/api/shopify-cli/hydrogen/hydrogen-env-list), [env pull](/docs/api/shopify-cli/hydrogen/hydrogen-env-pull), and [unlink](/docs/api/shopify-cli/hydrogen/hydrogen-unlink) commands.`, - overviewPreviewDescription: `Links your local development environment to a remote Hydrogen storefront. You can link an unlimited number of development environments to a single Hydrogen storefront. - - Linking to a Hydrogen storefront enables you to run [dev](/docs/api/shopify-cli/hydrogen/hydrogen-dev) and automatically inject your linked Hydrogen storefront's environment variables directly into the server runtime. - - After you run the \`link\` command, you can access the [env list](/docs/api/shopify-cli/hydrogen/hydrogen-env-list), [env pull](/docs/api/shopify-cli/hydrogen/hydrogen-env-pull), and [unlink](/docs/api/shopify-cli/hydrogen/hydrogen-unlink) commands.`, + description: `The following flags are available for the \`hydrogen link\` command:`, + overviewPreviewDescription: `The following flags are available for the \`hydrogen link\` command:`, type: 'command', isVisualComponent: false, defaultExample: { diff --git a/docs-shopify.dev/commands/hydrogen-list.doc.ts b/docs-shopify.dev/commands/hydrogen-list.doc.ts index f82ee79597a..7477a70b573 100644 --- a/docs-shopify.dev/commands/hydrogen-list.doc.ts +++ b/docs-shopify.dev/commands/hydrogen-list.doc.ts @@ -3,8 +3,8 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs' const data: ReferenceEntityTemplateSchema = { name: 'hydrogen list', - description: `Lists all remote Hydrogen storefronts available to link to your local development environment.`, - overviewPreviewDescription: `Lists all remote Hydrogen storefronts available to link to your local development environment.`, + description: `The following flags are available for the \`hydrogen list\` command:`, + overviewPreviewDescription: `The following flags are available for the \`hydrogen list\` command:`, type: 'command', isVisualComponent: false, defaultExample: { diff --git a/docs-shopify.dev/commands/hydrogen-login.doc.ts b/docs-shopify.dev/commands/hydrogen-login.doc.ts index bd204bff875..62d4dc325fb 100644 --- a/docs-shopify.dev/commands/hydrogen-login.doc.ts +++ b/docs-shopify.dev/commands/hydrogen-login.doc.ts @@ -3,8 +3,8 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs' const data: ReferenceEntityTemplateSchema = { name: 'hydrogen login', - description: `Logs in to the specified shop and saves the shop domain to the project.`, - overviewPreviewDescription: `Logs in to the specified shop and saves the shop domain to the project.`, + description: `The following flags are available for the \`hydrogen login\` command:`, + overviewPreviewDescription: `The following flags are available for the \`hydrogen login\` command:`, type: 'command', isVisualComponent: false, defaultExample: { diff --git a/docs-shopify.dev/commands/hydrogen-logout.doc.ts b/docs-shopify.dev/commands/hydrogen-logout.doc.ts index fc0c866410a..b863b545632 100644 --- a/docs-shopify.dev/commands/hydrogen-logout.doc.ts +++ b/docs-shopify.dev/commands/hydrogen-logout.doc.ts @@ -3,8 +3,8 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs' const data: ReferenceEntityTemplateSchema = { name: 'hydrogen logout', - description: `Log out from the current shop.`, - overviewPreviewDescription: `Log out from the current shop.`, + description: `The following flags are available for the \`hydrogen logout\` command:`, + overviewPreviewDescription: `The following flags are available for the \`hydrogen logout\` command:`, type: 'command', isVisualComponent: false, defaultExample: { diff --git a/docs-shopify.dev/commands/hydrogen-preview.doc.ts b/docs-shopify.dev/commands/hydrogen-preview.doc.ts index e504feaf1e4..31834437ac7 100644 --- a/docs-shopify.dev/commands/hydrogen-preview.doc.ts +++ b/docs-shopify.dev/commands/hydrogen-preview.doc.ts @@ -3,8 +3,8 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs' const data: ReferenceEntityTemplateSchema = { name: 'hydrogen preview', - description: `Runs a server in your local development environment that serves your Hydrogen app's production build. Requires running the [build](/docs/api/shopify-cli/hydrogen/hydrogen-build) command first.`, - overviewPreviewDescription: `Runs a server in your local development environment that serves your Hydrogen app's production build. Requires running the [build](/docs/api/shopify-cli/hydrogen/hydrogen-build) command first.`, + description: `The following flags are available for the \`hydrogen preview\` command:`, + overviewPreviewDescription: `The following flags are available for the \`hydrogen preview\` command:`, type: 'command', isVisualComponent: false, defaultExample: { diff --git a/docs-shopify.dev/commands/hydrogen-setup-css.doc.ts b/docs-shopify.dev/commands/hydrogen-setup-css.doc.ts index fb10471f71d..8e66d6cb434 100644 --- a/docs-shopify.dev/commands/hydrogen-setup-css.doc.ts +++ b/docs-shopify.dev/commands/hydrogen-setup-css.doc.ts @@ -3,8 +3,8 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs' const data: ReferenceEntityTemplateSchema = { name: 'hydrogen setup css', - description: `Adds support for certain CSS strategies to your project.`, - overviewPreviewDescription: `Adds support for certain CSS strategies to your project.`, + description: `The following flags are available for the \`hydrogen setup css\` command:`, + overviewPreviewDescription: `The following flags are available for the \`hydrogen setup css\` command:`, type: 'command', isVisualComponent: false, defaultExample: { diff --git a/docs-shopify.dev/commands/hydrogen-setup-markets.doc.ts b/docs-shopify.dev/commands/hydrogen-setup-markets.doc.ts index 5cf2ec57d8d..bbdf09aaf13 100644 --- a/docs-shopify.dev/commands/hydrogen-setup-markets.doc.ts +++ b/docs-shopify.dev/commands/hydrogen-setup-markets.doc.ts @@ -3,8 +3,8 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs' const data: ReferenceEntityTemplateSchema = { name: 'hydrogen setup markets', - description: `Adds support for multiple [markets](/docs/custom-storefronts/hydrogen/markets) to your project by using the URL structure.`, - overviewPreviewDescription: `Adds support for multiple [markets](/docs/custom-storefronts/hydrogen/markets) to your project by using the URL structure.`, + description: `The following flags are available for the \`hydrogen setup markets\` command:`, + overviewPreviewDescription: `The following flags are available for the \`hydrogen setup markets\` command:`, type: 'command', isVisualComponent: false, defaultExample: { diff --git a/docs-shopify.dev/commands/hydrogen-setup-vite.doc.ts b/docs-shopify.dev/commands/hydrogen-setup-vite.doc.ts index c70a69522dd..b7a542458e3 100644 --- a/docs-shopify.dev/commands/hydrogen-setup-vite.doc.ts +++ b/docs-shopify.dev/commands/hydrogen-setup-vite.doc.ts @@ -3,8 +3,8 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs' const data: ReferenceEntityTemplateSchema = { name: 'hydrogen setup vite', - description: `EXPERIMENTAL: Upgrades the project to use Vite.`, - overviewPreviewDescription: `EXPERIMENTAL: Upgrades the project to use Vite.`, + description: `The following flags are available for the \`hydrogen setup vite\` command:`, + overviewPreviewDescription: `The following flags are available for the \`hydrogen setup vite\` command:`, type: 'command', isVisualComponent: false, defaultExample: { diff --git a/docs-shopify.dev/commands/hydrogen-setup.doc.ts b/docs-shopify.dev/commands/hydrogen-setup.doc.ts index 1b842947999..d8a8ada907e 100644 --- a/docs-shopify.dev/commands/hydrogen-setup.doc.ts +++ b/docs-shopify.dev/commands/hydrogen-setup.doc.ts @@ -3,8 +3,8 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs' const data: ReferenceEntityTemplateSchema = { name: 'hydrogen setup', - description: `Scaffold routes and core functionality.`, - overviewPreviewDescription: `Scaffold routes and core functionality.`, + description: `The following flags are available for the \`hydrogen setup\` command:`, + overviewPreviewDescription: `The following flags are available for the \`hydrogen setup\` command:`, type: 'command', isVisualComponent: false, defaultExample: { diff --git a/docs-shopify.dev/commands/hydrogen-unlink.doc.ts b/docs-shopify.dev/commands/hydrogen-unlink.doc.ts index fb6fadaed58..ae41471e00a 100644 --- a/docs-shopify.dev/commands/hydrogen-unlink.doc.ts +++ b/docs-shopify.dev/commands/hydrogen-unlink.doc.ts @@ -3,8 +3,8 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs' const data: ReferenceEntityTemplateSchema = { name: 'hydrogen unlink', - description: `Unlinks your local development environment from a remote Hydrogen storefront.`, - overviewPreviewDescription: `Unlinks your local development environment from a remote Hydrogen storefront.`, + description: `The following flags are available for the \`hydrogen unlink\` command:`, + overviewPreviewDescription: `The following flags are available for the \`hydrogen unlink\` command:`, type: 'command', isVisualComponent: false, defaultExample: { diff --git a/docs-shopify.dev/commands/hydrogen-upgrade.doc.ts b/docs-shopify.dev/commands/hydrogen-upgrade.doc.ts index ac0609d6ec7..bcf54590daf 100644 --- a/docs-shopify.dev/commands/hydrogen-upgrade.doc.ts +++ b/docs-shopify.dev/commands/hydrogen-upgrade.doc.ts @@ -3,8 +3,8 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs' const data: ReferenceEntityTemplateSchema = { name: 'hydrogen upgrade', - description: `Upgrade Hydrogen project dependencies, preview features, fixes and breaking changes. The command also generates an instruction file for each upgrade.`, - overviewPreviewDescription: `Upgrade Hydrogen project dependencies, preview features, fixes and breaking changes. The command also generates an instruction file for each upgrade.`, + description: `The following flags are available for the \`hydrogen upgrade\` command:`, + overviewPreviewDescription: `The following flags are available for the \`hydrogen upgrade\` command:`, type: 'command', isVisualComponent: false, defaultExample: { diff --git a/docs-shopify.dev/commands/interfaces/app-build.interface.ts b/docs-shopify.dev/commands/interfaces/app-build.interface.ts index b9ad844ccb8..b49ee1cf21c 100644 --- a/docs-shopify.dev/commands/interfaces/app-build.interface.ts +++ b/docs-shopify.dev/commands/interfaces/app-build.interface.ts @@ -1,4 +1,8 @@ // This is an autogenerated file. Don't edit this file manually. +/** + * The following flags are available for the `app build` command: + * @publicDocs + */ export interface appbuild { /** * The Client ID of your app. diff --git a/docs-shopify.dev/commands/interfaces/app-bulk-cancel.interface.ts b/docs-shopify.dev/commands/interfaces/app-bulk-cancel.interface.ts index 5bb81f2b196..35af820689f 100644 --- a/docs-shopify.dev/commands/interfaces/app-bulk-cancel.interface.ts +++ b/docs-shopify.dev/commands/interfaces/app-bulk-cancel.interface.ts @@ -1,4 +1,8 @@ // This is an autogenerated file. Don't edit this file manually. +/** + * The following flags are available for the `app bulk cancel` command: + * @publicDocs + */ export interface appbulkcancel { /** * The Client ID of your app. diff --git a/docs-shopify.dev/commands/interfaces/app-bulk-execute.interface.ts b/docs-shopify.dev/commands/interfaces/app-bulk-execute.interface.ts index 5836d541822..20287c13968 100644 --- a/docs-shopify.dev/commands/interfaces/app-bulk-execute.interface.ts +++ b/docs-shopify.dev/commands/interfaces/app-bulk-execute.interface.ts @@ -1,4 +1,8 @@ // This is an autogenerated file. Don't edit this file manually. +/** + * The following flags are available for the `app bulk execute` command: + * @publicDocs + */ export interface appbulkexecute { /** * The Client ID of your app. diff --git a/docs-shopify.dev/commands/interfaces/app-bulk-status.interface.ts b/docs-shopify.dev/commands/interfaces/app-bulk-status.interface.ts index 1afe74ecc80..51f7be3a0fa 100644 --- a/docs-shopify.dev/commands/interfaces/app-bulk-status.interface.ts +++ b/docs-shopify.dev/commands/interfaces/app-bulk-status.interface.ts @@ -1,4 +1,8 @@ // This is an autogenerated file. Don't edit this file manually. +/** + * The following flags are available for the `app bulk status` command: + * @publicDocs + */ export interface appbulkstatus { /** * The Client ID of your app. diff --git a/docs-shopify.dev/commands/interfaces/app-config-link.interface.ts b/docs-shopify.dev/commands/interfaces/app-config-link.interface.ts index 66f2daca741..61612d1b815 100644 --- a/docs-shopify.dev/commands/interfaces/app-config-link.interface.ts +++ b/docs-shopify.dev/commands/interfaces/app-config-link.interface.ts @@ -1,4 +1,8 @@ // This is an autogenerated file. Don't edit this file manually. +/** + * The following flags are available for the `app config link` command: + * @publicDocs + */ export interface appconfiglink { /** * The Client ID of your app. diff --git a/docs-shopify.dev/commands/interfaces/app-config-pull.interface.ts b/docs-shopify.dev/commands/interfaces/app-config-pull.interface.ts index f41f6817d79..b536b11053b 100644 --- a/docs-shopify.dev/commands/interfaces/app-config-pull.interface.ts +++ b/docs-shopify.dev/commands/interfaces/app-config-pull.interface.ts @@ -1,4 +1,8 @@ // This is an autogenerated file. Don't edit this file manually. +/** + * The following flags are available for the `app config pull` command: + * @publicDocs + */ export interface appconfigpull { /** * The Client ID of your app. diff --git a/docs-shopify.dev/commands/interfaces/app-config-use.interface.ts b/docs-shopify.dev/commands/interfaces/app-config-use.interface.ts index 067b2ec6e0c..baff1d18848 100644 --- a/docs-shopify.dev/commands/interfaces/app-config-use.interface.ts +++ b/docs-shopify.dev/commands/interfaces/app-config-use.interface.ts @@ -1,4 +1,8 @@ // This is an autogenerated file. Don't edit this file manually. +/** + * The following flags are available for the `app config use` command: + * @publicDocs + */ export interface appconfiguse { /** * The Client ID of your app. diff --git a/docs-shopify.dev/commands/interfaces/app-config-validate.interface.ts b/docs-shopify.dev/commands/interfaces/app-config-validate.interface.ts index 89220a7e035..3d8d00ad456 100644 --- a/docs-shopify.dev/commands/interfaces/app-config-validate.interface.ts +++ b/docs-shopify.dev/commands/interfaces/app-config-validate.interface.ts @@ -1,4 +1,8 @@ // This is an autogenerated file. Don't edit this file manually. +/** + * The following flags are available for the `app config validate` command: + * @publicDocs + */ export interface appconfigvalidate { /** * The Client ID of your app. diff --git a/docs-shopify.dev/commands/interfaces/app-deploy.interface.ts b/docs-shopify.dev/commands/interfaces/app-deploy.interface.ts index 528a6733014..6fd04ce3911 100644 --- a/docs-shopify.dev/commands/interfaces/app-deploy.interface.ts +++ b/docs-shopify.dev/commands/interfaces/app-deploy.interface.ts @@ -1,4 +1,8 @@ // This is an autogenerated file. Don't edit this file manually. +/** + * The following flags are available for the `app deploy` command: + * @publicDocs + */ export interface appdeploy { /** * Allows removing extensions and configuration without requiring user confirmation. For CI/CD environments, the recommended flag is --allow-updates. diff --git a/docs-shopify.dev/commands/interfaces/app-dev-clean.interface.ts b/docs-shopify.dev/commands/interfaces/app-dev-clean.interface.ts index 5c4d4b387c8..4f40193eeca 100644 --- a/docs-shopify.dev/commands/interfaces/app-dev-clean.interface.ts +++ b/docs-shopify.dev/commands/interfaces/app-dev-clean.interface.ts @@ -1,4 +1,8 @@ // This is an autogenerated file. Don't edit this file manually. +/** + * The following flags are available for the `app dev clean` command: + * @publicDocs + */ export interface appdevclean { /** * The Client ID of your app. diff --git a/docs-shopify.dev/commands/interfaces/app-dev.interface.ts b/docs-shopify.dev/commands/interfaces/app-dev.interface.ts index bcd7da6cc1f..cabb8f600ef 100644 --- a/docs-shopify.dev/commands/interfaces/app-dev.interface.ts +++ b/docs-shopify.dev/commands/interfaces/app-dev.interface.ts @@ -1,4 +1,8 @@ // This is an autogenerated file. Don't edit this file manually. +/** + * The following flags are available for the `app dev` command: + * @publicDocs + */ export interface appdev { /** * Resource URL for checkout UI extension. Format: "/cart/{productVariantID}:{productQuantity}" diff --git a/docs-shopify.dev/commands/interfaces/app-env-pull.interface.ts b/docs-shopify.dev/commands/interfaces/app-env-pull.interface.ts index e19d2874d04..b1955be10b3 100644 --- a/docs-shopify.dev/commands/interfaces/app-env-pull.interface.ts +++ b/docs-shopify.dev/commands/interfaces/app-env-pull.interface.ts @@ -1,4 +1,8 @@ // This is an autogenerated file. Don't edit this file manually. +/** + * The following flags are available for the `app env pull` command: + * @publicDocs + */ export interface appenvpull { /** * The Client ID of your app. diff --git a/docs-shopify.dev/commands/interfaces/app-env-show.interface.ts b/docs-shopify.dev/commands/interfaces/app-env-show.interface.ts index f425139c38c..22922d457f7 100644 --- a/docs-shopify.dev/commands/interfaces/app-env-show.interface.ts +++ b/docs-shopify.dev/commands/interfaces/app-env-show.interface.ts @@ -1,4 +1,8 @@ // This is an autogenerated file. Don't edit this file manually. +/** + * The following flags are available for the `app env show` command: + * @publicDocs + */ export interface appenvshow { /** * The Client ID of your app. diff --git a/docs-shopify.dev/commands/interfaces/app-execute.interface.ts b/docs-shopify.dev/commands/interfaces/app-execute.interface.ts index ef1e8cb1afd..6579aacae38 100644 --- a/docs-shopify.dev/commands/interfaces/app-execute.interface.ts +++ b/docs-shopify.dev/commands/interfaces/app-execute.interface.ts @@ -1,4 +1,8 @@ // This is an autogenerated file. Don't edit this file manually. +/** + * The following flags are available for the `app execute` command: + * @publicDocs + */ export interface appexecute { /** * The Client ID of your app. diff --git a/docs-shopify.dev/commands/interfaces/app-function-build.interface.ts b/docs-shopify.dev/commands/interfaces/app-function-build.interface.ts index c6795e1e713..48fa548058c 100644 --- a/docs-shopify.dev/commands/interfaces/app-function-build.interface.ts +++ b/docs-shopify.dev/commands/interfaces/app-function-build.interface.ts @@ -1,4 +1,8 @@ // This is an autogenerated file. Don't edit this file manually. +/** + * The following flags are available for the `app function build` command: + * @publicDocs + */ export interface appfunctionbuild { /** * The Client ID of your app. diff --git a/docs-shopify.dev/commands/interfaces/app-function-info.interface.ts b/docs-shopify.dev/commands/interfaces/app-function-info.interface.ts index 5dc3d0ed135..1a63189a074 100644 --- a/docs-shopify.dev/commands/interfaces/app-function-info.interface.ts +++ b/docs-shopify.dev/commands/interfaces/app-function-info.interface.ts @@ -1,4 +1,8 @@ // This is an autogenerated file. Don't edit this file manually. +/** + * The following flags are available for the `app function info` command: + * @publicDocs + */ export interface appfunctioninfo { /** * The Client ID of your app. diff --git a/docs-shopify.dev/commands/interfaces/app-function-replay.interface.ts b/docs-shopify.dev/commands/interfaces/app-function-replay.interface.ts index 70bf6af0125..09917f4c3c5 100644 --- a/docs-shopify.dev/commands/interfaces/app-function-replay.interface.ts +++ b/docs-shopify.dev/commands/interfaces/app-function-replay.interface.ts @@ -1,4 +1,8 @@ // This is an autogenerated file. Don't edit this file manually. +/** + * The following flags are available for the `app function replay` command: + * @publicDocs + */ export interface appfunctionreplay { /** * The Client ID of your app. diff --git a/docs-shopify.dev/commands/interfaces/app-function-run.interface.ts b/docs-shopify.dev/commands/interfaces/app-function-run.interface.ts index a37303ac33e..266a8f4bc56 100644 --- a/docs-shopify.dev/commands/interfaces/app-function-run.interface.ts +++ b/docs-shopify.dev/commands/interfaces/app-function-run.interface.ts @@ -1,4 +1,8 @@ // This is an autogenerated file. Don't edit this file manually. +/** + * The following flags are available for the `app function run` command: + * @publicDocs + */ export interface appfunctionrun { /** * The Client ID of your app. diff --git a/docs-shopify.dev/commands/interfaces/app-function-schema.interface.ts b/docs-shopify.dev/commands/interfaces/app-function-schema.interface.ts index 09e8f37c498..184f8c2dd10 100644 --- a/docs-shopify.dev/commands/interfaces/app-function-schema.interface.ts +++ b/docs-shopify.dev/commands/interfaces/app-function-schema.interface.ts @@ -1,4 +1,8 @@ // This is an autogenerated file. Don't edit this file manually. +/** + * The following flags are available for the `app function schema` command: + * @publicDocs + */ export interface appfunctionschema { /** * The Client ID of your app. diff --git a/docs-shopify.dev/commands/interfaces/app-function-typegen.interface.ts b/docs-shopify.dev/commands/interfaces/app-function-typegen.interface.ts index aae24d3e95e..26e4b821ad3 100644 --- a/docs-shopify.dev/commands/interfaces/app-function-typegen.interface.ts +++ b/docs-shopify.dev/commands/interfaces/app-function-typegen.interface.ts @@ -1,4 +1,8 @@ // This is an autogenerated file. Don't edit this file manually. +/** + * The following flags are available for the `app function typegen` command: + * @publicDocs + */ export interface appfunctiontypegen { /** * The Client ID of your app. diff --git a/docs-shopify.dev/commands/interfaces/app-generate-extension.interface.ts b/docs-shopify.dev/commands/interfaces/app-generate-extension.interface.ts index 1a90e37ea09..f351fd32356 100644 --- a/docs-shopify.dev/commands/interfaces/app-generate-extension.interface.ts +++ b/docs-shopify.dev/commands/interfaces/app-generate-extension.interface.ts @@ -1,4 +1,8 @@ // This is an autogenerated file. Don't edit this file manually. +/** + * The following flags are available for the `app generate extension` command: + * @publicDocs + */ export interface appgenerateextension { /** * The Client ID of your app. diff --git a/docs-shopify.dev/commands/interfaces/app-import-custom-data-definitions.interface.ts b/docs-shopify.dev/commands/interfaces/app-import-custom-data-definitions.interface.ts index bb6c131bef9..eadb26647eb 100644 --- a/docs-shopify.dev/commands/interfaces/app-import-custom-data-definitions.interface.ts +++ b/docs-shopify.dev/commands/interfaces/app-import-custom-data-definitions.interface.ts @@ -1,4 +1,8 @@ // This is an autogenerated file. Don't edit this file manually. +/** + * The following flags are available for the `app import-custom-data-definitions` command: + * @publicDocs + */ export interface appimportcustomdatadefinitions { /** * The Client ID of your app. diff --git a/docs-shopify.dev/commands/interfaces/app-import-extensions.interface.ts b/docs-shopify.dev/commands/interfaces/app-import-extensions.interface.ts index 09132bc64a4..29b7f26fe74 100644 --- a/docs-shopify.dev/commands/interfaces/app-import-extensions.interface.ts +++ b/docs-shopify.dev/commands/interfaces/app-import-extensions.interface.ts @@ -1,4 +1,8 @@ // This is an autogenerated file. Don't edit this file manually. +/** + * The following flags are available for the `app import-extensions` command: + * @publicDocs + */ export interface appimportextensions { /** * The Client ID of your app. diff --git a/docs-shopify.dev/commands/interfaces/app-info.interface.ts b/docs-shopify.dev/commands/interfaces/app-info.interface.ts index 0c66843a421..fe05159c10f 100644 --- a/docs-shopify.dev/commands/interfaces/app-info.interface.ts +++ b/docs-shopify.dev/commands/interfaces/app-info.interface.ts @@ -1,4 +1,8 @@ // This is an autogenerated file. Don't edit this file manually. +/** + * The following flags are available for the `app info` command: + * @publicDocs + */ export interface appinfo { /** * The Client ID of your app. diff --git a/docs-shopify.dev/commands/interfaces/app-init.interface.ts b/docs-shopify.dev/commands/interfaces/app-init.interface.ts index 5c861ed2a42..e05279935c4 100644 --- a/docs-shopify.dev/commands/interfaces/app-init.interface.ts +++ b/docs-shopify.dev/commands/interfaces/app-init.interface.ts @@ -1,4 +1,8 @@ // This is an autogenerated file. Don't edit this file manually. +/** + * The following flags are available for the `app init` command: + * @publicDocs + */ export interface appinit { /** * The Client ID of your app. Use this to automatically link your new project to an existing app. Using this flag avoids the app selection prompt. diff --git a/docs-shopify.dev/commands/interfaces/app-logs-sources.interface.ts b/docs-shopify.dev/commands/interfaces/app-logs-sources.interface.ts index f4279a1301a..1ce5188ffd7 100644 --- a/docs-shopify.dev/commands/interfaces/app-logs-sources.interface.ts +++ b/docs-shopify.dev/commands/interfaces/app-logs-sources.interface.ts @@ -1,4 +1,8 @@ // This is an autogenerated file. Don't edit this file manually. +/** + * The following flags are available for the `app logs sources` command: + * @publicDocs + */ export interface applogssources { /** * The Client ID of your app. diff --git a/docs-shopify.dev/commands/interfaces/app-logs.interface.ts b/docs-shopify.dev/commands/interfaces/app-logs.interface.ts index 2ea79fb89d7..8498e2ac7fb 100644 --- a/docs-shopify.dev/commands/interfaces/app-logs.interface.ts +++ b/docs-shopify.dev/commands/interfaces/app-logs.interface.ts @@ -1,4 +1,8 @@ // This is an autogenerated file. Don't edit this file manually. +/** + * The following flags are available for the `app logs` command: + * @publicDocs + */ export interface applogs { /** * The Client ID of your app. diff --git a/docs-shopify.dev/commands/interfaces/app-release.interface.ts b/docs-shopify.dev/commands/interfaces/app-release.interface.ts index 9c381109438..eb392e1515d 100644 --- a/docs-shopify.dev/commands/interfaces/app-release.interface.ts +++ b/docs-shopify.dev/commands/interfaces/app-release.interface.ts @@ -1,4 +1,8 @@ // This is an autogenerated file. Don't edit this file manually. +/** + * The following flags are available for the `app release` command: + * @publicDocs + */ export interface apprelease { /** * Allows removing extensions and configuration without requiring user confirmation. For CI/CD environments, the recommended flag is --allow-updates. diff --git a/docs-shopify.dev/commands/interfaces/app-versions-list.interface.ts b/docs-shopify.dev/commands/interfaces/app-versions-list.interface.ts index 517f4ee5a34..d4c6ca406cd 100644 --- a/docs-shopify.dev/commands/interfaces/app-versions-list.interface.ts +++ b/docs-shopify.dev/commands/interfaces/app-versions-list.interface.ts @@ -1,4 +1,8 @@ // This is an autogenerated file. Don't edit this file manually. +/** + * The following flags are available for the `app versions list` command: + * @publicDocs + */ export interface appversionslist { /** * The Client ID of your app. diff --git a/docs-shopify.dev/commands/interfaces/app-webhook-trigger.interface.ts b/docs-shopify.dev/commands/interfaces/app-webhook-trigger.interface.ts index 5dc1bba925a..4969520933c 100644 --- a/docs-shopify.dev/commands/interfaces/app-webhook-trigger.interface.ts +++ b/docs-shopify.dev/commands/interfaces/app-webhook-trigger.interface.ts @@ -1,4 +1,8 @@ // This is an autogenerated file. Don't edit this file manually. +/** + * The following flags are available for the `app webhook trigger` command: + * @publicDocs + */ export interface appwebhooktrigger { /** * The URL where the webhook payload should be sent. diff --git a/docs-shopify.dev/commands/interfaces/auth-login.interface.ts b/docs-shopify.dev/commands/interfaces/auth-login.interface.ts index a392b6c8ed2..d6c9bd440ba 100644 --- a/docs-shopify.dev/commands/interfaces/auth-login.interface.ts +++ b/docs-shopify.dev/commands/interfaces/auth-login.interface.ts @@ -1,4 +1,8 @@ // This is an autogenerated file. Don't edit this file manually. +/** + * The following flags are available for the `auth login` command: + * @publicDocs + */ export interface authlogin { /** * Alias of the session you want to login to. diff --git a/docs-shopify.dev/commands/interfaces/auth-logout.interface.ts b/docs-shopify.dev/commands/interfaces/auth-logout.interface.ts index b4a87270a99..188b6a30c60 100644 --- a/docs-shopify.dev/commands/interfaces/auth-logout.interface.ts +++ b/docs-shopify.dev/commands/interfaces/auth-logout.interface.ts @@ -1,4 +1,8 @@ // This is an autogenerated file. Don't edit this file manually. +/** + * + * @publicDocs + */ export interface authlogout { } diff --git a/docs-shopify.dev/commands/interfaces/commands.interface.ts b/docs-shopify.dev/commands/interfaces/commands.interface.ts index 1b5531ef900..ddda337cb85 100644 --- a/docs-shopify.dev/commands/interfaces/commands.interface.ts +++ b/docs-shopify.dev/commands/interfaces/commands.interface.ts @@ -1,4 +1,8 @@ // This is an autogenerated file. Don't edit this file manually. +/** + * The following flags are available for the `commands` command: + * @publicDocs + */ export interface commands { /** * Only show provided columns (comma-separated). diff --git a/docs-shopify.dev/commands/interfaces/config-autocorrect-off.interface.ts b/docs-shopify.dev/commands/interfaces/config-autocorrect-off.interface.ts index f0990f32dd4..26892c49f53 100644 --- a/docs-shopify.dev/commands/interfaces/config-autocorrect-off.interface.ts +++ b/docs-shopify.dev/commands/interfaces/config-autocorrect-off.interface.ts @@ -1,4 +1,8 @@ // This is an autogenerated file. Don't edit this file manually. +/** + * + * @publicDocs + */ export interface configautocorrectoff { } diff --git a/docs-shopify.dev/commands/interfaces/config-autocorrect-on.interface.ts b/docs-shopify.dev/commands/interfaces/config-autocorrect-on.interface.ts index 0d9e7d2a28e..7d8677a57c2 100644 --- a/docs-shopify.dev/commands/interfaces/config-autocorrect-on.interface.ts +++ b/docs-shopify.dev/commands/interfaces/config-autocorrect-on.interface.ts @@ -1,4 +1,8 @@ // This is an autogenerated file. Don't edit this file manually. +/** + * + * @publicDocs + */ export interface configautocorrecton { } diff --git a/docs-shopify.dev/commands/interfaces/config-autocorrect-status.interface.ts b/docs-shopify.dev/commands/interfaces/config-autocorrect-status.interface.ts index 57bd33c1492..1feb5afa14e 100644 --- a/docs-shopify.dev/commands/interfaces/config-autocorrect-status.interface.ts +++ b/docs-shopify.dev/commands/interfaces/config-autocorrect-status.interface.ts @@ -1,4 +1,8 @@ // This is an autogenerated file. Don't edit this file manually. +/** + * + * @publicDocs + */ export interface configautocorrectstatus { } diff --git a/docs-shopify.dev/commands/interfaces/help.interface.ts b/docs-shopify.dev/commands/interfaces/help.interface.ts index 35df0f51b16..afab36201fb 100644 --- a/docs-shopify.dev/commands/interfaces/help.interface.ts +++ b/docs-shopify.dev/commands/interfaces/help.interface.ts @@ -1,4 +1,8 @@ // This is an autogenerated file. Don't edit this file manually. +/** + * The following flags are available for the `help` command: + * @publicDocs + */ export interface help { /** * Include all nested commands in the output. diff --git a/docs-shopify.dev/commands/interfaces/hydrogen-build.interface.ts b/docs-shopify.dev/commands/interfaces/hydrogen-build.interface.ts index 0d7b8cb9b6e..2468bc8aa47 100644 --- a/docs-shopify.dev/commands/interfaces/hydrogen-build.interface.ts +++ b/docs-shopify.dev/commands/interfaces/hydrogen-build.interface.ts @@ -1,4 +1,8 @@ // This is an autogenerated file. Don't edit this file manually. +/** + * The following flags are available for the `hydrogen build` command: + * @publicDocs + */ export interface hydrogenbuild { /** * Show a bundle size summary after building. Defaults to true, use `--no-bundle-stats` to disable. diff --git a/docs-shopify.dev/commands/interfaces/hydrogen-check.interface.ts b/docs-shopify.dev/commands/interfaces/hydrogen-check.interface.ts index b03a555e210..215b394d831 100644 --- a/docs-shopify.dev/commands/interfaces/hydrogen-check.interface.ts +++ b/docs-shopify.dev/commands/interfaces/hydrogen-check.interface.ts @@ -1,4 +1,8 @@ // This is an autogenerated file. Don't edit this file manually. +/** + * The following flags are available for the `hydrogen check` command: + * @publicDocs + */ export interface hydrogencheck { /** * The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run. diff --git a/docs-shopify.dev/commands/interfaces/hydrogen-codegen.interface.ts b/docs-shopify.dev/commands/interfaces/hydrogen-codegen.interface.ts index 5b3d83954df..d5a7ede458f 100644 --- a/docs-shopify.dev/commands/interfaces/hydrogen-codegen.interface.ts +++ b/docs-shopify.dev/commands/interfaces/hydrogen-codegen.interface.ts @@ -1,4 +1,8 @@ // This is an autogenerated file. Don't edit this file manually. +/** + * The following flags are available for the `hydrogen codegen` command: + * @publicDocs + */ export interface hydrogencodegen { /** * Specify a path to a codegen configuration file. Defaults to `/codegen.ts` if it exists. diff --git a/docs-shopify.dev/commands/interfaces/hydrogen-customer-account-push.interface.ts b/docs-shopify.dev/commands/interfaces/hydrogen-customer-account-push.interface.ts index 5f9b4bfb8e6..2ee45a3b69d 100644 --- a/docs-shopify.dev/commands/interfaces/hydrogen-customer-account-push.interface.ts +++ b/docs-shopify.dev/commands/interfaces/hydrogen-customer-account-push.interface.ts @@ -1,4 +1,8 @@ // This is an autogenerated file. Don't edit this file manually. +/** + * The following flags are available for the `hydrogen customer-account-push` command: + * @publicDocs + */ export interface hydrogencustomeraccountpush { /** * The development domain of your application. diff --git a/docs-shopify.dev/commands/interfaces/hydrogen-debug-cpu.interface.ts b/docs-shopify.dev/commands/interfaces/hydrogen-debug-cpu.interface.ts index 7e2b9778fce..d1f5cea39e7 100644 --- a/docs-shopify.dev/commands/interfaces/hydrogen-debug-cpu.interface.ts +++ b/docs-shopify.dev/commands/interfaces/hydrogen-debug-cpu.interface.ts @@ -1,4 +1,8 @@ // This is an autogenerated file. Don't edit this file manually. +/** + * The following flags are available for the `hydrogen debug cpu` command: + * @publicDocs + */ export interface hydrogendebugcpu { /** * Entry file for the worker. Defaults to `./server`. diff --git a/docs-shopify.dev/commands/interfaces/hydrogen-deploy.interface.ts b/docs-shopify.dev/commands/interfaces/hydrogen-deploy.interface.ts index ae2a1b58912..b43c9f25aa0 100644 --- a/docs-shopify.dev/commands/interfaces/hydrogen-deploy.interface.ts +++ b/docs-shopify.dev/commands/interfaces/hydrogen-deploy.interface.ts @@ -1,4 +1,8 @@ // This is an autogenerated file. Don't edit this file manually. +/** + * The following flags are available for the `hydrogen deploy` command: + * @publicDocs + */ export interface hydrogendeploy { /** * Generate an authentication bypass token, which can be used to perform end-to-end tests against the deployment. diff --git a/docs-shopify.dev/commands/interfaces/hydrogen-dev.interface.ts b/docs-shopify.dev/commands/interfaces/hydrogen-dev.interface.ts index c2200b0a1e7..ce17a2ef9a9 100644 --- a/docs-shopify.dev/commands/interfaces/hydrogen-dev.interface.ts +++ b/docs-shopify.dev/commands/interfaces/hydrogen-dev.interface.ts @@ -1,4 +1,8 @@ // This is an autogenerated file. Don't edit this file manually. +/** + * The following flags are available for the `hydrogen dev` command: + * @publicDocs + */ export interface hydrogendev { /** * Automatically generates GraphQL types for your project’s Storefront API queries. diff --git a/docs-shopify.dev/commands/interfaces/hydrogen-env-list.interface.ts b/docs-shopify.dev/commands/interfaces/hydrogen-env-list.interface.ts index 55bf627c510..de896f7f239 100644 --- a/docs-shopify.dev/commands/interfaces/hydrogen-env-list.interface.ts +++ b/docs-shopify.dev/commands/interfaces/hydrogen-env-list.interface.ts @@ -1,4 +1,8 @@ // This is an autogenerated file. Don't edit this file manually. +/** + * The following flags are available for the `hydrogen env list` command: + * @publicDocs + */ export interface hydrogenenvlist { /** * The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run. diff --git a/docs-shopify.dev/commands/interfaces/hydrogen-env-pull.interface.ts b/docs-shopify.dev/commands/interfaces/hydrogen-env-pull.interface.ts index c6f829cb432..57fb69c2be0 100644 --- a/docs-shopify.dev/commands/interfaces/hydrogen-env-pull.interface.ts +++ b/docs-shopify.dev/commands/interfaces/hydrogen-env-pull.interface.ts @@ -1,4 +1,8 @@ // This is an autogenerated file. Don't edit this file manually. +/** + * The following flags are available for the `hydrogen env pull` command: + * @publicDocs + */ export interface hydrogenenvpull { /** * Specifies the environment to perform the operation using its handle. Fetch the handle using the `env list` command. diff --git a/docs-shopify.dev/commands/interfaces/hydrogen-env-push.interface.ts b/docs-shopify.dev/commands/interfaces/hydrogen-env-push.interface.ts index 094d00c1dde..eb9c80c1095 100644 --- a/docs-shopify.dev/commands/interfaces/hydrogen-env-push.interface.ts +++ b/docs-shopify.dev/commands/interfaces/hydrogen-env-push.interface.ts @@ -1,4 +1,8 @@ // This is an autogenerated file. Don't edit this file manually. +/** + * The following flags are available for the `hydrogen env push` command: + * @publicDocs + */ export interface hydrogenenvpush { /** * Specifies the environment to perform the operation using its handle. Fetch the handle using the `env list` command. diff --git a/docs-shopify.dev/commands/interfaces/hydrogen-generate-route.interface.ts b/docs-shopify.dev/commands/interfaces/hydrogen-generate-route.interface.ts index d4618b4c6d9..320cde9b6f1 100644 --- a/docs-shopify.dev/commands/interfaces/hydrogen-generate-route.interface.ts +++ b/docs-shopify.dev/commands/interfaces/hydrogen-generate-route.interface.ts @@ -1,4 +1,8 @@ // This is an autogenerated file. Don't edit this file manually. +/** + * The following flags are available for the `hydrogen generate route` command: + * @publicDocs + */ export interface hydrogengenerateroute { /** * Remix adapter used in the route. The default is `@shopify/remix-oxygen`. diff --git a/docs-shopify.dev/commands/interfaces/hydrogen-generate-routes.interface.ts b/docs-shopify.dev/commands/interfaces/hydrogen-generate-routes.interface.ts index 9b1e7943d75..d30e04f51da 100644 --- a/docs-shopify.dev/commands/interfaces/hydrogen-generate-routes.interface.ts +++ b/docs-shopify.dev/commands/interfaces/hydrogen-generate-routes.interface.ts @@ -1,4 +1,8 @@ // This is an autogenerated file. Don't edit this file manually. +/** + * The following flags are available for the `hydrogen generate routes` command: + * @publicDocs + */ export interface hydrogengenerateroutes { /** * Remix adapter used in the route. The default is `@shopify/remix-oxygen`. diff --git a/docs-shopify.dev/commands/interfaces/hydrogen-init.interface.ts b/docs-shopify.dev/commands/interfaces/hydrogen-init.interface.ts index 34edbc9cfdc..4226e609035 100644 --- a/docs-shopify.dev/commands/interfaces/hydrogen-init.interface.ts +++ b/docs-shopify.dev/commands/interfaces/hydrogen-init.interface.ts @@ -1,4 +1,8 @@ // This is an autogenerated file. Don't edit this file manually. +/** + * The following flags are available for the `hydrogen init` command: + * @publicDocs + */ export interface hydrogeninit { /** * Overwrites the destination directory and files if they already exist. diff --git a/docs-shopify.dev/commands/interfaces/hydrogen-link.interface.ts b/docs-shopify.dev/commands/interfaces/hydrogen-link.interface.ts index c67f1fca366..aea69b1bcc3 100644 --- a/docs-shopify.dev/commands/interfaces/hydrogen-link.interface.ts +++ b/docs-shopify.dev/commands/interfaces/hydrogen-link.interface.ts @@ -1,4 +1,8 @@ // This is an autogenerated file. Don't edit this file manually. +/** + * The following flags are available for the `hydrogen link` command: + * @publicDocs + */ export interface hydrogenlink { /** * Overwrites the destination directory and files if they already exist. diff --git a/docs-shopify.dev/commands/interfaces/hydrogen-list.interface.ts b/docs-shopify.dev/commands/interfaces/hydrogen-list.interface.ts index f8d96d91ec9..f8a211bf9b0 100644 --- a/docs-shopify.dev/commands/interfaces/hydrogen-list.interface.ts +++ b/docs-shopify.dev/commands/interfaces/hydrogen-list.interface.ts @@ -1,4 +1,8 @@ // This is an autogenerated file. Don't edit this file manually. +/** + * The following flags are available for the `hydrogen list` command: + * @publicDocs + */ export interface hydrogenlist { /** * The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run. diff --git a/docs-shopify.dev/commands/interfaces/hydrogen-login.interface.ts b/docs-shopify.dev/commands/interfaces/hydrogen-login.interface.ts index acecbfee999..99cba513f04 100644 --- a/docs-shopify.dev/commands/interfaces/hydrogen-login.interface.ts +++ b/docs-shopify.dev/commands/interfaces/hydrogen-login.interface.ts @@ -1,4 +1,8 @@ // This is an autogenerated file. Don't edit this file manually. +/** + * The following flags are available for the `hydrogen login` command: + * @publicDocs + */ export interface hydrogenlogin { /** * The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run. diff --git a/docs-shopify.dev/commands/interfaces/hydrogen-logout.interface.ts b/docs-shopify.dev/commands/interfaces/hydrogen-logout.interface.ts index e6427e7b543..8e48b80b12f 100644 --- a/docs-shopify.dev/commands/interfaces/hydrogen-logout.interface.ts +++ b/docs-shopify.dev/commands/interfaces/hydrogen-logout.interface.ts @@ -1,4 +1,8 @@ // This is an autogenerated file. Don't edit this file manually. +/** + * The following flags are available for the `hydrogen logout` command: + * @publicDocs + */ export interface hydrogenlogout { /** * The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run. diff --git a/docs-shopify.dev/commands/interfaces/hydrogen-preview.interface.ts b/docs-shopify.dev/commands/interfaces/hydrogen-preview.interface.ts index 01fa2cd2bb5..f3ef485494b 100644 --- a/docs-shopify.dev/commands/interfaces/hydrogen-preview.interface.ts +++ b/docs-shopify.dev/commands/interfaces/hydrogen-preview.interface.ts @@ -1,4 +1,8 @@ // This is an autogenerated file. Don't edit this file manually. +/** + * The following flags are available for the `hydrogen preview` command: + * @publicDocs + */ export interface hydrogenpreview { /** * Builds the app before starting the preview server. diff --git a/docs-shopify.dev/commands/interfaces/hydrogen-setup-css.interface.ts b/docs-shopify.dev/commands/interfaces/hydrogen-setup-css.interface.ts index a953ac1829d..04edbd37548 100644 --- a/docs-shopify.dev/commands/interfaces/hydrogen-setup-css.interface.ts +++ b/docs-shopify.dev/commands/interfaces/hydrogen-setup-css.interface.ts @@ -1,4 +1,8 @@ // This is an autogenerated file. Don't edit this file manually. +/** + * The following flags are available for the `hydrogen setup css` command: + * @publicDocs + */ export interface hydrogensetupcss { /** * Overwrites the destination directory and files if they already exist. diff --git a/docs-shopify.dev/commands/interfaces/hydrogen-setup-markets.interface.ts b/docs-shopify.dev/commands/interfaces/hydrogen-setup-markets.interface.ts index d8c98679437..fad3107502e 100644 --- a/docs-shopify.dev/commands/interfaces/hydrogen-setup-markets.interface.ts +++ b/docs-shopify.dev/commands/interfaces/hydrogen-setup-markets.interface.ts @@ -1,4 +1,8 @@ // This is an autogenerated file. Don't edit this file manually. +/** + * The following flags are available for the `hydrogen setup markets` command: + * @publicDocs + */ export interface hydrogensetupmarkets { /** * The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run. diff --git a/docs-shopify.dev/commands/interfaces/hydrogen-setup-vite.interface.ts b/docs-shopify.dev/commands/interfaces/hydrogen-setup-vite.interface.ts index 138955da0b2..6798b9ed876 100644 --- a/docs-shopify.dev/commands/interfaces/hydrogen-setup-vite.interface.ts +++ b/docs-shopify.dev/commands/interfaces/hydrogen-setup-vite.interface.ts @@ -1,4 +1,8 @@ // This is an autogenerated file. Don't edit this file manually. +/** + * The following flags are available for the `hydrogen setup vite` command: + * @publicDocs + */ export interface hydrogensetupvite { /** * The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run. diff --git a/docs-shopify.dev/commands/interfaces/hydrogen-setup.interface.ts b/docs-shopify.dev/commands/interfaces/hydrogen-setup.interface.ts index f7258f21687..d26b9c1e602 100644 --- a/docs-shopify.dev/commands/interfaces/hydrogen-setup.interface.ts +++ b/docs-shopify.dev/commands/interfaces/hydrogen-setup.interface.ts @@ -1,4 +1,8 @@ // This is an autogenerated file. Don't edit this file manually. +/** + * The following flags are available for the `hydrogen setup` command: + * @publicDocs + */ export interface hydrogensetup { /** * Overwrites the destination directory and files if they already exist. diff --git a/docs-shopify.dev/commands/interfaces/hydrogen-shortcut.interface.ts b/docs-shopify.dev/commands/interfaces/hydrogen-shortcut.interface.ts index 730e5a4d0a6..7ce649a5c47 100644 --- a/docs-shopify.dev/commands/interfaces/hydrogen-shortcut.interface.ts +++ b/docs-shopify.dev/commands/interfaces/hydrogen-shortcut.interface.ts @@ -1,4 +1,8 @@ // This is an autogenerated file. Don't edit this file manually. +/** + * + * @publicDocs + */ export interface hydrogenshortcut { } diff --git a/docs-shopify.dev/commands/interfaces/hydrogen-unlink.interface.ts b/docs-shopify.dev/commands/interfaces/hydrogen-unlink.interface.ts index 193142021a0..605127feb0e 100644 --- a/docs-shopify.dev/commands/interfaces/hydrogen-unlink.interface.ts +++ b/docs-shopify.dev/commands/interfaces/hydrogen-unlink.interface.ts @@ -1,4 +1,8 @@ // This is an autogenerated file. Don't edit this file manually. +/** + * The following flags are available for the `hydrogen unlink` command: + * @publicDocs + */ export interface hydrogenunlink { /** * The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run. diff --git a/docs-shopify.dev/commands/interfaces/hydrogen-upgrade.interface.ts b/docs-shopify.dev/commands/interfaces/hydrogen-upgrade.interface.ts index 55f15684862..bd42eafa30f 100644 --- a/docs-shopify.dev/commands/interfaces/hydrogen-upgrade.interface.ts +++ b/docs-shopify.dev/commands/interfaces/hydrogen-upgrade.interface.ts @@ -1,4 +1,8 @@ // This is an autogenerated file. Don't edit this file manually. +/** + * The following flags are available for the `hydrogen upgrade` command: + * @publicDocs + */ export interface hydrogenupgrade { /** * Ignore warnings and force the upgrade to the target version diff --git a/docs-shopify.dev/commands/interfaces/organization-list.interface.ts b/docs-shopify.dev/commands/interfaces/organization-list.interface.ts index 84ca7073bb4..9fa9df1b83c 100644 --- a/docs-shopify.dev/commands/interfaces/organization-list.interface.ts +++ b/docs-shopify.dev/commands/interfaces/organization-list.interface.ts @@ -1,4 +1,8 @@ // This is an autogenerated file. Don't edit this file manually. +/** + * The following flags are available for the `organization list` command: + * @publicDocs + */ export interface organizationlist { /** * Output the result as JSON. Automatically disables color output. diff --git a/docs-shopify.dev/commands/interfaces/search.interface.ts b/docs-shopify.dev/commands/interfaces/search.interface.ts index f36caccb6b0..929dae7d286 100644 --- a/docs-shopify.dev/commands/interfaces/search.interface.ts +++ b/docs-shopify.dev/commands/interfaces/search.interface.ts @@ -1,4 +1,8 @@ // This is an autogenerated file. Don't edit this file manually. +/** + * + * @publicDocs + */ export interface search { } diff --git a/docs-shopify.dev/commands/interfaces/store-auth.interface.ts b/docs-shopify.dev/commands/interfaces/store-auth.interface.ts index e38a6d147e8..226a322d550 100644 --- a/docs-shopify.dev/commands/interfaces/store-auth.interface.ts +++ b/docs-shopify.dev/commands/interfaces/store-auth.interface.ts @@ -1,4 +1,8 @@ // This is an autogenerated file. Don't edit this file manually. +/** + * The following flags are available for the `store auth` command: + * @publicDocs + */ export interface storeauth { /** * Disable color output. diff --git a/docs-shopify.dev/commands/interfaces/store-execute.interface.ts b/docs-shopify.dev/commands/interfaces/store-execute.interface.ts index 3bff68a8f95..3982066b375 100644 --- a/docs-shopify.dev/commands/interfaces/store-execute.interface.ts +++ b/docs-shopify.dev/commands/interfaces/store-execute.interface.ts @@ -1,4 +1,8 @@ // This is an autogenerated file. Don't edit this file manually. +/** + * The following flags are available for the `store execute` command: + * @publicDocs + */ export interface storeexecute { /** * Allow GraphQL mutations to run against the target store. diff --git a/docs-shopify.dev/commands/interfaces/theme-check.interface.ts b/docs-shopify.dev/commands/interfaces/theme-check.interface.ts index 41a0493b342..905df2bf20e 100644 --- a/docs-shopify.dev/commands/interfaces/theme-check.interface.ts +++ b/docs-shopify.dev/commands/interfaces/theme-check.interface.ts @@ -1,4 +1,8 @@ // This is an autogenerated file. Don't edit this file manually. +/** + * The following flags are available for the `theme check` command: + * @publicDocs + */ export interface themecheck { /** * Automatically fix offenses diff --git a/docs-shopify.dev/commands/interfaces/theme-console.interface.ts b/docs-shopify.dev/commands/interfaces/theme-console.interface.ts index f386c58125b..2bb63673dae 100644 --- a/docs-shopify.dev/commands/interfaces/theme-console.interface.ts +++ b/docs-shopify.dev/commands/interfaces/theme-console.interface.ts @@ -1,4 +1,8 @@ // This is an autogenerated file. Don't edit this file manually. +/** + * The following flags are available for the `theme console` command: + * @publicDocs + */ export interface themeconsole { /** * The environment to apply to the current command. diff --git a/docs-shopify.dev/commands/interfaces/theme-delete.interface.ts b/docs-shopify.dev/commands/interfaces/theme-delete.interface.ts index 44c4ea59d54..16ce3004333 100644 --- a/docs-shopify.dev/commands/interfaces/theme-delete.interface.ts +++ b/docs-shopify.dev/commands/interfaces/theme-delete.interface.ts @@ -1,4 +1,8 @@ // This is an autogenerated file. Don't edit this file manually. +/** + * The following flags are available for the `theme delete` command: + * @publicDocs + */ export interface themedelete { /** * Delete your development theme. diff --git a/docs-shopify.dev/commands/interfaces/theme-dev.interface.ts b/docs-shopify.dev/commands/interfaces/theme-dev.interface.ts index 311f0b9d57f..d1388b0d3a4 100644 --- a/docs-shopify.dev/commands/interfaces/theme-dev.interface.ts +++ b/docs-shopify.dev/commands/interfaces/theme-dev.interface.ts @@ -1,4 +1,8 @@ // This is an autogenerated file. Don't edit this file manually. +/** + * The following flags are available for the `theme dev` command: + * @publicDocs + */ export interface themedev { /** * Allow development on a live theme. diff --git a/docs-shopify.dev/commands/interfaces/theme-duplicate.interface.ts b/docs-shopify.dev/commands/interfaces/theme-duplicate.interface.ts index 33190b1d7be..87cac1ae070 100644 --- a/docs-shopify.dev/commands/interfaces/theme-duplicate.interface.ts +++ b/docs-shopify.dev/commands/interfaces/theme-duplicate.interface.ts @@ -1,4 +1,8 @@ // This is an autogenerated file. Don't edit this file manually. +/** + * The following flags are available for the `theme duplicate` command: + * @publicDocs + */ export interface themeduplicate { /** * The environment to apply to the current command. diff --git a/docs-shopify.dev/commands/interfaces/theme-info.interface.ts b/docs-shopify.dev/commands/interfaces/theme-info.interface.ts index 7fd304c0ba7..13626fc21b1 100644 --- a/docs-shopify.dev/commands/interfaces/theme-info.interface.ts +++ b/docs-shopify.dev/commands/interfaces/theme-info.interface.ts @@ -1,4 +1,8 @@ // This is an autogenerated file. Don't edit this file manually. +/** + * The following flags are available for the `theme info` command: + * @publicDocs + */ export interface themeinfo { /** * Retrieve info from your development theme. diff --git a/docs-shopify.dev/commands/interfaces/theme-init.interface.ts b/docs-shopify.dev/commands/interfaces/theme-init.interface.ts index 05fbe882cd3..3b1d36e131b 100644 --- a/docs-shopify.dev/commands/interfaces/theme-init.interface.ts +++ b/docs-shopify.dev/commands/interfaces/theme-init.interface.ts @@ -1,4 +1,8 @@ // This is an autogenerated file. Don't edit this file manually. +/** + * The following flags are available for the `theme init` command: + * @publicDocs + */ export interface themeinit { /** * The Git URL to clone from. Defaults to Shopify's Skeleton theme. diff --git a/docs-shopify.dev/commands/interfaces/theme-language-server.interface.ts b/docs-shopify.dev/commands/interfaces/theme-language-server.interface.ts index 67ea9e2bb8c..eba537a449e 100644 --- a/docs-shopify.dev/commands/interfaces/theme-language-server.interface.ts +++ b/docs-shopify.dev/commands/interfaces/theme-language-server.interface.ts @@ -1,4 +1,8 @@ // This is an autogenerated file. Don't edit this file manually. +/** + * The following flags are available for the `theme language-server` command: + * @publicDocs + */ export interface themelanguageserver { /** * Disable color output. diff --git a/docs-shopify.dev/commands/interfaces/theme-list.interface.ts b/docs-shopify.dev/commands/interfaces/theme-list.interface.ts index d2880779a01..3915ac72a84 100644 --- a/docs-shopify.dev/commands/interfaces/theme-list.interface.ts +++ b/docs-shopify.dev/commands/interfaces/theme-list.interface.ts @@ -1,4 +1,8 @@ // This is an autogenerated file. Don't edit this file manually. +/** + * The following flags are available for the `theme list` command: + * @publicDocs + */ export interface themelist { /** * The environment to apply to the current command. diff --git a/docs-shopify.dev/commands/interfaces/theme-metafields-pull.interface.ts b/docs-shopify.dev/commands/interfaces/theme-metafields-pull.interface.ts index ee0a3e8ae91..fa2d7ed2443 100644 --- a/docs-shopify.dev/commands/interfaces/theme-metafields-pull.interface.ts +++ b/docs-shopify.dev/commands/interfaces/theme-metafields-pull.interface.ts @@ -1,4 +1,8 @@ // This is an autogenerated file. Don't edit this file manually. +/** + * The following flags are available for the `theme metafields pull` command: + * @publicDocs + */ export interface thememetafieldspull { /** * The environment to apply to the current command. diff --git a/docs-shopify.dev/commands/interfaces/theme-open.interface.ts b/docs-shopify.dev/commands/interfaces/theme-open.interface.ts index 6bad3978a76..ad278be9e01 100644 --- a/docs-shopify.dev/commands/interfaces/theme-open.interface.ts +++ b/docs-shopify.dev/commands/interfaces/theme-open.interface.ts @@ -1,4 +1,8 @@ // This is an autogenerated file. Don't edit this file manually. +/** + * The following flags are available for the `theme open` command: + * @publicDocs + */ export interface themeopen { /** * Open your development theme. diff --git a/docs-shopify.dev/commands/interfaces/theme-package.interface.ts b/docs-shopify.dev/commands/interfaces/theme-package.interface.ts index 7f90468239f..8fa0f536a79 100644 --- a/docs-shopify.dev/commands/interfaces/theme-package.interface.ts +++ b/docs-shopify.dev/commands/interfaces/theme-package.interface.ts @@ -1,4 +1,8 @@ // This is an autogenerated file. Don't edit this file manually. +/** + * The following flags are available for the `theme package` command: + * @publicDocs + */ export interface themepackage { /** * Disable color output. diff --git a/docs-shopify.dev/commands/interfaces/theme-preview.interface.ts b/docs-shopify.dev/commands/interfaces/theme-preview.interface.ts index 5d443d9370e..57f05a11f23 100644 --- a/docs-shopify.dev/commands/interfaces/theme-preview.interface.ts +++ b/docs-shopify.dev/commands/interfaces/theme-preview.interface.ts @@ -1,4 +1,8 @@ // This is an autogenerated file. Don't edit this file manually. +/** + * The following flags are available for the `theme preview` command: + * @publicDocs + */ export interface themepreview { /** * The environment to apply to the current command. diff --git a/docs-shopify.dev/commands/interfaces/theme-profile.interface.ts b/docs-shopify.dev/commands/interfaces/theme-profile.interface.ts index 8eee4acea34..27cc8a0ebd2 100644 --- a/docs-shopify.dev/commands/interfaces/theme-profile.interface.ts +++ b/docs-shopify.dev/commands/interfaces/theme-profile.interface.ts @@ -1,4 +1,8 @@ // This is an autogenerated file. Don't edit this file manually. +/** + * The following flags are available for the `theme profile` command: + * @publicDocs + */ export interface themeprofile { /** * The environment to apply to the current command. diff --git a/docs-shopify.dev/commands/interfaces/theme-publish.interface.ts b/docs-shopify.dev/commands/interfaces/theme-publish.interface.ts index 0d6c12fc0a6..d040efd5a9a 100644 --- a/docs-shopify.dev/commands/interfaces/theme-publish.interface.ts +++ b/docs-shopify.dev/commands/interfaces/theme-publish.interface.ts @@ -1,4 +1,8 @@ // This is an autogenerated file. Don't edit this file manually. +/** + * The following flags are available for the `theme publish` command: + * @publicDocs + */ export interface themepublish { /** * The environment to apply to the current command. diff --git a/docs-shopify.dev/commands/interfaces/theme-pull.interface.ts b/docs-shopify.dev/commands/interfaces/theme-pull.interface.ts index de776d5a0b1..227338fca0a 100644 --- a/docs-shopify.dev/commands/interfaces/theme-pull.interface.ts +++ b/docs-shopify.dev/commands/interfaces/theme-pull.interface.ts @@ -1,4 +1,8 @@ // This is an autogenerated file. Don't edit this file manually. +/** + * The following flags are available for the `theme pull` command: + * @publicDocs + */ export interface themepull { /** * Pull theme files from your remote development theme. diff --git a/docs-shopify.dev/commands/interfaces/theme-push.interface.ts b/docs-shopify.dev/commands/interfaces/theme-push.interface.ts index e9c22e4f71a..3abaa13038d 100644 --- a/docs-shopify.dev/commands/interfaces/theme-push.interface.ts +++ b/docs-shopify.dev/commands/interfaces/theme-push.interface.ts @@ -1,4 +1,8 @@ // This is an autogenerated file. Don't edit this file manually. +/** + * The following flags are available for the `theme push` command: + * @publicDocs + */ export interface themepush { /** * Allow push to a live theme. diff --git a/docs-shopify.dev/commands/interfaces/theme-rename.interface.ts b/docs-shopify.dev/commands/interfaces/theme-rename.interface.ts index e5255d725c3..b1eea93668e 100644 --- a/docs-shopify.dev/commands/interfaces/theme-rename.interface.ts +++ b/docs-shopify.dev/commands/interfaces/theme-rename.interface.ts @@ -1,4 +1,8 @@ // This is an autogenerated file. Don't edit this file manually. +/** + * The following flags are available for the `theme rename` command: + * @publicDocs + */ export interface themerename { /** * Rename your development theme. diff --git a/docs-shopify.dev/commands/interfaces/theme-share.interface.ts b/docs-shopify.dev/commands/interfaces/theme-share.interface.ts index 5e12cfbe30e..468f14844d4 100644 --- a/docs-shopify.dev/commands/interfaces/theme-share.interface.ts +++ b/docs-shopify.dev/commands/interfaces/theme-share.interface.ts @@ -1,4 +1,8 @@ // This is an autogenerated file. Don't edit this file manually. +/** + * The following flags are available for the `theme share` command: + * @publicDocs + */ export interface themeshare { /** * The environment to apply to the current command. diff --git a/docs-shopify.dev/commands/interfaces/upgrade.interface.ts b/docs-shopify.dev/commands/interfaces/upgrade.interface.ts index 7c7d0f0f105..6a271b43338 100644 --- a/docs-shopify.dev/commands/interfaces/upgrade.interface.ts +++ b/docs-shopify.dev/commands/interfaces/upgrade.interface.ts @@ -1,4 +1,8 @@ // This is an autogenerated file. Don't edit this file manually. +/** + * + * @publicDocs + */ export interface upgrade { } diff --git a/docs-shopify.dev/commands/interfaces/version.interface.ts b/docs-shopify.dev/commands/interfaces/version.interface.ts index 7c282657383..be5d9b0df2d 100644 --- a/docs-shopify.dev/commands/interfaces/version.interface.ts +++ b/docs-shopify.dev/commands/interfaces/version.interface.ts @@ -1,4 +1,8 @@ // This is an autogenerated file. Don't edit this file manually. +/** + * + * @publicDocs + */ export interface version { } diff --git a/docs-shopify.dev/commands/organization-list.doc.ts b/docs-shopify.dev/commands/organization-list.doc.ts index 2e80d3dd424..3d5ab9fb19b 100644 --- a/docs-shopify.dev/commands/organization-list.doc.ts +++ b/docs-shopify.dev/commands/organization-list.doc.ts @@ -3,7 +3,7 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs' const data: ReferenceEntityTemplateSchema = { name: 'organization list', - description: `Lists the Shopify organizations that you have access to, along with their organization IDs.`, + description: `The following flags are available for the \`organization list\` command:`, overviewPreviewDescription: `List Shopify organizations you have access to.`, type: 'command', isVisualComponent: false, diff --git a/docs-shopify.dev/commands/store-auth.doc.ts b/docs-shopify.dev/commands/store-auth.doc.ts index 8f06c2b8c9e..d4ea4cf8fe8 100644 --- a/docs-shopify.dev/commands/store-auth.doc.ts +++ b/docs-shopify.dev/commands/store-auth.doc.ts @@ -3,9 +3,7 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs' const data: ReferenceEntityTemplateSchema = { name: 'store auth', - description: `Authenticates the app against the specified store for store commands and stores an online access token for later reuse. - -Re-run this command if the stored token is missing, expires, or no longer has the scopes you need.`, + description: `The following flags are available for the \`store auth\` command:`, overviewPreviewDescription: `Authenticate an app against a store for store commands.`, type: 'command', isVisualComponent: false, diff --git a/docs-shopify.dev/commands/store-execute.doc.ts b/docs-shopify.dev/commands/store-execute.doc.ts index e1707fef3e5..fb24271df83 100644 --- a/docs-shopify.dev/commands/store-execute.doc.ts +++ b/docs-shopify.dev/commands/store-execute.doc.ts @@ -3,11 +3,7 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs' const data: ReferenceEntityTemplateSchema = { name: 'store execute', - description: `Executes an Admin API GraphQL query or mutation on the specified store using previously stored app authentication. - -Run \`shopify store auth\` first to create stored auth for the store. - -Mutations are disabled by default. Re-run with \`--allow-mutations\` if you intend to modify store data.`, + description: `The following flags are available for the \`store execute\` command:`, overviewPreviewDescription: `Execute GraphQL queries and mutations on a store.`, type: 'command', isVisualComponent: false, diff --git a/docs-shopify.dev/commands/theme-check.doc.ts b/docs-shopify.dev/commands/theme-check.doc.ts index baf51103617..a06aa85ad5c 100644 --- a/docs-shopify.dev/commands/theme-check.doc.ts +++ b/docs-shopify.dev/commands/theme-check.doc.ts @@ -3,7 +3,7 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs' const data: ReferenceEntityTemplateSchema = { name: 'theme check', - description: `Calls and runs [Theme Check](/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.](/docs/themes/tools/theme-check/checks)`, + description: `The following flags are available for the \`theme check\` command:`, overviewPreviewDescription: `Validate the theme.`, type: 'command', isVisualComponent: false, diff --git a/docs-shopify.dev/commands/theme-console.doc.ts b/docs-shopify.dev/commands/theme-console.doc.ts index a2eb67dfbce..0a89023ed3b 100644 --- a/docs-shopify.dev/commands/theme-console.doc.ts +++ b/docs-shopify.dev/commands/theme-console.doc.ts @@ -3,9 +3,7 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs' const data: ReferenceEntityTemplateSchema = { name: 'theme console', - description: `Starts the Shopify Liquid REPL (read-eval-print loop) tool. This tool provides an interactive terminal interface for evaluating Liquid code and exploring Liquid objects, filters, and tags using real store data. - - You can also provide context to the console using a URL, as some Liquid objects are context-specific`, + description: `The following flags are available for the \`theme console\` command:`, overviewPreviewDescription: `Shopify Liquid REPL (read-eval-print loop) tool`, type: 'command', isVisualComponent: false, diff --git a/docs-shopify.dev/commands/theme-delete.doc.ts b/docs-shopify.dev/commands/theme-delete.doc.ts index 69cb5755939..7be120b56c2 100644 --- a/docs-shopify.dev/commands/theme-delete.doc.ts +++ b/docs-shopify.dev/commands/theme-delete.doc.ts @@ -3,11 +3,7 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs' const data: ReferenceEntityTemplateSchema = { name: 'theme delete', - description: `Deletes a theme from your store. - - You can specify multiple themes by ID. If no theme is specified, then you're prompted to select the theme that you want to delete from the list of themes in your store. - - You're asked to confirm that you want to delete the specified themes before they are deleted. You can skip this confirmation using the \`--force\` flag.`, + description: `The following flags are available for the \`theme delete\` command:`, overviewPreviewDescription: `Delete remote themes from the connected store. This command can't be undone.`, type: 'command', isVisualComponent: false, diff --git a/docs-shopify.dev/commands/theme-dev.doc.ts b/docs-shopify.dev/commands/theme-dev.doc.ts index 3f6a1c3029a..d41a0e73135 100644 --- a/docs-shopify.dev/commands/theme-dev.doc.ts +++ b/docs-shopify.dev/commands/theme-dev.doc.ts @@ -3,26 +3,7 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs' const data: ReferenceEntityTemplateSchema = { name: 'theme dev', - description: ` - Uploads the current theme as the specified theme, or a [development theme](/docs/themes/tools/cli#development-themes), to a store so you can preview it. - -This command returns the following information: - -- A link to your development theme at http://127.0.0.1:9292. This URL can hot reload local changes to CSS and sections, or refresh the entire page when a file changes, enabling you to preview changes in real time using the store's data. - - You can specify a different network interface and port using \`--host\` and \`--port\`. - -- A link to the [editor](/docs/themes/tools/online-editor) for the theme in the Shopify admin. - -- A [preview link](https://help.shopify.com/manual/online-store/themes/adding-themes#share-a-theme-preview-with-others) that you can share with other developers. - -If you already have a development theme for your current environment, then this command replaces the development theme with your local theme. You can override this using the \`--theme-editor-sync\` flag. - -> Note: You can't preview checkout customizations using http://127.0.0.1:9292. - -Development themes are deleted when you run \`shopify auth logout\`. If you need a preview link that can be used after you log out, then you should [share](/docs/api/shopify-cli/theme/theme-share) your theme or [push](/docs/api/shopify-cli/theme/theme-push) to an unpublished theme on your store. - -You can run this command only in a directory that matches the [default Shopify theme folder structure](/docs/themes/tools/cli#directory-structure).`, + description: `The following flags are available for the \`theme dev\` command:`, overviewPreviewDescription: `Uploads the current theme as a development theme to the connected store, then prints theme editor and preview URLs to your terminal. While running, changes will push to the store in real time.`, type: 'command', isVisualComponent: false, diff --git a/docs-shopify.dev/commands/theme-duplicate.doc.ts b/docs-shopify.dev/commands/theme-duplicate.doc.ts index 722901b7246..8935975b429 100644 --- a/docs-shopify.dev/commands/theme-duplicate.doc.ts +++ b/docs-shopify.dev/commands/theme-duplicate.doc.ts @@ -3,36 +3,7 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs' const data: ReferenceEntityTemplateSchema = { name: 'theme duplicate', - description: `If you want to duplicate your local theme, you need to run \`shopify theme push\` first. - -If no theme ID is specified, you're prompted to select the theme that you want to duplicate from the list of themes in your store. You're asked to confirm that you want to duplicate the specified theme. - -Prompts and confirmations are not shown when duplicate is run in a CI environment or the \`--force\` flag is used, therefore you must specify a theme ID using the \`--theme\` flag. - -You can optionally name the duplicated theme using the \`--name\` flag. - -If you use the \`--json\` flag, then theme information is returned in JSON format, which can be used as a machine-readable input for scripts or continuous integration. - -Sample JSON output: - -\`\`\`json -{ - "theme": { - "id": 108267175958, - "name": "A Duplicated Theme", - "role": "unpublished", - "shop": "mystore.myshopify.com" - } -} -\`\`\` - -\`\`\`json -{ - "message": "The theme 'Summer Edition' could not be duplicated due to errors", - "errors": ["Maximum number of themes reached"], - "requestId": "12345-abcde-67890" -} -\`\`\``, + description: `The following flags are available for the \`theme duplicate\` command:`, overviewPreviewDescription: `Duplicates a theme from your theme library.`, type: 'command', isVisualComponent: false, diff --git a/docs-shopify.dev/commands/theme-info.doc.ts b/docs-shopify.dev/commands/theme-info.doc.ts index b1942001df2..7258671e1db 100644 --- a/docs-shopify.dev/commands/theme-info.doc.ts +++ b/docs-shopify.dev/commands/theme-info.doc.ts @@ -3,8 +3,8 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs' const data: ReferenceEntityTemplateSchema = { name: 'theme info', - description: `Displays information about your theme environment, including your current store. Can also retrieve information about a specific theme.`, - overviewPreviewDescription: `Displays information about your theme environment, including your current store. Can also retrieve information about a specific theme.`, + description: `The following flags are available for the \`theme info\` command:`, + overviewPreviewDescription: `The following flags are available for the \`theme info\` command:`, type: 'command', isVisualComponent: false, defaultExample: { diff --git a/docs-shopify.dev/commands/theme-init.doc.ts b/docs-shopify.dev/commands/theme-init.doc.ts index 80257b39bce..fdcf98fc22c 100644 --- a/docs-shopify.dev/commands/theme-init.doc.ts +++ b/docs-shopify.dev/commands/theme-init.doc.ts @@ -3,12 +3,7 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs' const data: ReferenceEntityTemplateSchema = { name: 'theme init', - description: `Clones a Git repository to your local machine to use as the starting point for building a theme. - - If no Git repository is specified, then this command creates a copy of Shopify's [Skeleton theme](https://github.com/Shopify/skeleton-theme.git), with the specified name in the current folder. If no name is provided, then you're prompted to enter one. - - > Caution: If you're building a theme for the Shopify Theme Store, then you can use our example theme as a starting point. However, the theme that you submit needs to be [substantively different from existing themes](/docs/themes/store/requirements#uniqueness) so that it provides added value for users. - `, + description: `The following flags are available for the \`theme init\` command:`, overviewPreviewDescription: `Clones a Git repository to use as a starting point for building a new theme.`, type: 'command', isVisualComponent: false, diff --git a/docs-shopify.dev/commands/theme-language-server.doc.ts b/docs-shopify.dev/commands/theme-language-server.doc.ts index 5b77ace2b3f..4187f6f4bb4 100644 --- a/docs-shopify.dev/commands/theme-language-server.doc.ts +++ b/docs-shopify.dev/commands/theme-language-server.doc.ts @@ -3,7 +3,7 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs' const data: ReferenceEntityTemplateSchema = { name: 'theme language-server', - description: `Starts the [Language Server](/docs/themes/tools/cli/language-server).`, + description: `The following flags are available for the \`theme language-server\` command:`, overviewPreviewDescription: `Start a Language Server Protocol server.`, type: 'command', isVisualComponent: false, diff --git a/docs-shopify.dev/commands/theme-list.doc.ts b/docs-shopify.dev/commands/theme-list.doc.ts index 10b1a3bfcc9..c456556e752 100644 --- a/docs-shopify.dev/commands/theme-list.doc.ts +++ b/docs-shopify.dev/commands/theme-list.doc.ts @@ -3,8 +3,8 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs' const data: ReferenceEntityTemplateSchema = { name: 'theme list', - description: `Lists the themes in your store, along with their IDs and statuses.`, - overviewPreviewDescription: `Lists the themes in your store, along with their IDs and statuses.`, + description: `The following flags are available for the \`theme list\` command:`, + overviewPreviewDescription: `The following flags are available for the \`theme list\` command:`, type: 'command', isVisualComponent: false, defaultExample: { diff --git a/docs-shopify.dev/commands/theme-metafields-pull.doc.ts b/docs-shopify.dev/commands/theme-metafields-pull.doc.ts index fdaaf381aee..cff1dcbea69 100644 --- a/docs-shopify.dev/commands/theme-metafields-pull.doc.ts +++ b/docs-shopify.dev/commands/theme-metafields-pull.doc.ts @@ -3,9 +3,7 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs' const data: ReferenceEntityTemplateSchema = { name: 'theme metafields pull', - description: `Retrieves metafields from Shopify Admin. - -If the metafields file already exists, it will be overwritten.`, + description: `The following flags are available for the \`theme metafields pull\` command:`, overviewPreviewDescription: `Download metafields definitions from your shop into a local file.`, type: 'command', isVisualComponent: false, diff --git a/docs-shopify.dev/commands/theme-open.doc.ts b/docs-shopify.dev/commands/theme-open.doc.ts index b96adde3cc7..509a9362445 100644 --- a/docs-shopify.dev/commands/theme-open.doc.ts +++ b/docs-shopify.dev/commands/theme-open.doc.ts @@ -3,12 +3,7 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs' const data: ReferenceEntityTemplateSchema = { name: 'theme open', - description: `Returns links that let you preview the specified theme. The following links are returned: - - - A link to the [editor](/docs/themes/tools/online-editor) for the theme in the Shopify admin. - - A [preview link](https://help.shopify.com/manual/online-store/themes/adding-themes#share-a-theme-preview-with-others) that you can share with other developers. - - If you don't specify a theme, then you're prompted to select the theme to open from the list of the themes in your store.`, + description: `The following flags are available for the \`theme open\` command:`, overviewPreviewDescription: `Opens the preview of your remote theme.`, type: 'command', isVisualComponent: false, diff --git a/docs-shopify.dev/commands/theme-package.doc.ts b/docs-shopify.dev/commands/theme-package.doc.ts index 8e46a4a597c..1056a707d68 100644 --- a/docs-shopify.dev/commands/theme-package.doc.ts +++ b/docs-shopify.dev/commands/theme-package.doc.ts @@ -3,13 +3,7 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs' const data: ReferenceEntityTemplateSchema = { name: 'theme package', - description: `Packages your local theme files into a ZIP file that can be uploaded to Shopify. - - Only folders that match the [default Shopify theme folder structure](/docs/storefronts/themes/tools/cli#directory-structure) are included in the package. - - The package includes the \`listings\` directory if present (required for multi-preset themes per [Theme Store requirements](/docs/storefronts/themes/store/requirements#adding-presets-to-your-theme-zip-submission)). - - The ZIP file uses the name \`theme_name-theme_version.zip\`, based on parameters in your [settings_schema.json](/docs/storefronts/themes/architecture/config/settings-schema-json) file.`, + description: `The following flags are available for the \`theme package\` command:`, overviewPreviewDescription: `Package your theme into a .zip file, ready to upload to the Online Store.`, type: 'command', isVisualComponent: false, diff --git a/docs-shopify.dev/commands/theme-preview.doc.ts b/docs-shopify.dev/commands/theme-preview.doc.ts index 30ff73174d5..bdfc2ce98c3 100644 --- a/docs-shopify.dev/commands/theme-preview.doc.ts +++ b/docs-shopify.dev/commands/theme-preview.doc.ts @@ -3,9 +3,7 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs' const data: ReferenceEntityTemplateSchema = { name: 'theme preview', - description: `Applies a JSON overrides file to a theme and creates or updates a preview. This lets you quickly preview changes. - - The command returns a preview URL and a preview identifier. You can reuse the preview identifier with \`--preview-id\` to update an existing preview instead of creating a new one.`, + description: `The following flags are available for the \`theme preview\` command:`, overviewPreviewDescription: `Applies JSON overrides to a theme and returns a preview URL.`, type: 'command', isVisualComponent: false, diff --git a/docs-shopify.dev/commands/theme-profile.doc.ts b/docs-shopify.dev/commands/theme-profile.doc.ts index e4427c67a61..2356ea4e0d7 100644 --- a/docs-shopify.dev/commands/theme-profile.doc.ts +++ b/docs-shopify.dev/commands/theme-profile.doc.ts @@ -3,9 +3,7 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs' const data: ReferenceEntityTemplateSchema = { name: 'theme profile', - description: `Profile 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.`, + description: `The following flags are available for the \`theme profile\` command:`, overviewPreviewDescription: `Profile the Liquid rendering of a theme page.`, type: 'command', isVisualComponent: false, diff --git a/docs-shopify.dev/commands/theme-publish.doc.ts b/docs-shopify.dev/commands/theme-publish.doc.ts index e1df64c2492..9d10d0493c1 100644 --- a/docs-shopify.dev/commands/theme-publish.doc.ts +++ b/docs-shopify.dev/commands/theme-publish.doc.ts @@ -3,13 +3,7 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs' const data: ReferenceEntityTemplateSchema = { name: 'theme publish', - description: `Publishes an unpublished theme from your theme library. - -If no theme ID is specified, then you're prompted to select the theme that you want to publish from the list of themes in your store. - -You can run this command only in a directory that matches the [default Shopify theme folder structure](/docs/themes/tools/cli#directory-structure). - -If you want to publish your local theme, then you need to run \`shopify theme push\` first. You're asked to confirm that you want to publish the specified theme. You can skip this confirmation using the \`--force\` flag.`, + description: `The following flags are available for the \`theme publish\` command:`, overviewPreviewDescription: `Set a remote theme as the live theme.`, type: 'command', isVisualComponent: false, diff --git a/docs-shopify.dev/commands/theme-pull.doc.ts b/docs-shopify.dev/commands/theme-pull.doc.ts index 7c53070de3e..621e8538efd 100644 --- a/docs-shopify.dev/commands/theme-pull.doc.ts +++ b/docs-shopify.dev/commands/theme-pull.doc.ts @@ -3,9 +3,7 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs' const data: ReferenceEntityTemplateSchema = { name: 'theme pull', - description: `Retrieves theme files from Shopify. - -If no theme is specified, then you're prompted to select the theme to pull from the list of the themes in your store.`, + description: `The following flags are available for the \`theme pull\` command:`, overviewPreviewDescription: `Download your remote theme files locally.`, type: 'command', isVisualComponent: false, diff --git a/docs-shopify.dev/commands/theme-push.doc.ts b/docs-shopify.dev/commands/theme-push.doc.ts index 023c5c42edd..56ffd70d7cd 100644 --- a/docs-shopify.dev/commands/theme-push.doc.ts +++ b/docs-shopify.dev/commands/theme-push.doc.ts @@ -3,34 +3,7 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs' const data: ReferenceEntityTemplateSchema = { name: 'theme push', - description: `Uploads your local theme files to Shopify, overwriting the remote version if specified. - - If no theme is specified, then you're prompted to select the theme to overwrite from the list of the themes in your store. - - You can run this command only in a directory that matches the [default Shopify theme folder structure](/docs/themes/tools/cli#directory-structure). - - This command returns the following information: - - - A link to the [editor](/docs/themes/tools/online-editor) for the theme in the Shopify admin. - - A [preview link](https://help.shopify.com/manual/online-store/themes/adding-themes#share-a-theme-preview-with-others) that you can share with others. - - If you use the \`--json\` flag, then theme information is returned in JSON format, which can be used as a machine-readable input for scripts or continuous integration. - - Sample output: - - \`\`\`json - { - "theme": { - "id": 108267175958, - "name": "MyTheme", - "role": "unpublished", - "shop": "mystore.myshopify.com", - "editor_url": "https://mystore.myshopify.com/admin/themes/108267175958/editor", - "preview_url": "https://mystore.myshopify.com/?preview_theme_id=108267175958" - } - } - \`\`\` - `, + description: `The following flags are available for the \`theme push\` command:`, overviewPreviewDescription: `Uploads your local theme files to the connected store, overwriting the remote version if specified.`, type: 'command', isVisualComponent: false, diff --git a/docs-shopify.dev/commands/theme-rename.doc.ts b/docs-shopify.dev/commands/theme-rename.doc.ts index 2425ac9ced1..e3bd5209fa6 100644 --- a/docs-shopify.dev/commands/theme-rename.doc.ts +++ b/docs-shopify.dev/commands/theme-rename.doc.ts @@ -3,10 +3,7 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs' const data: ReferenceEntityTemplateSchema = { name: 'theme rename', - description: `Renames a theme in your store. - - If no theme is specified, then you're prompted to select the theme that you want to rename from the list of themes in your store. - `, + description: `The following flags are available for the \`theme rename\` command:`, overviewPreviewDescription: `Renames an existing theme.`, type: 'command', isVisualComponent: false, diff --git a/docs-shopify.dev/commands/theme-share.doc.ts b/docs-shopify.dev/commands/theme-share.doc.ts index cd7ef590295..7137d55855e 100644 --- a/docs-shopify.dev/commands/theme-share.doc.ts +++ b/docs-shopify.dev/commands/theme-share.doc.ts @@ -3,9 +3,7 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs' const data: ReferenceEntityTemplateSchema = { name: 'theme share', - description: `Uploads your theme as a new, unpublished theme in your theme library. The theme is given a randomized name. - - This command returns a [preview link](https://help.shopify.com/manual/online-store/themes/adding-themes#share-a-theme-preview-with-others) that you can share with others.`, + description: `The following flags are available for the \`theme share\` command:`, overviewPreviewDescription: `Creates a shareable, unpublished, and new theme on your theme library with a randomized name.`, type: 'command', isVisualComponent: false, diff --git a/docs-shopify.dev/generated/generated_docs_data.json b/docs-shopify.dev/generated/generated_docs_data.json index 75162409d11..971f1fdfc8f 100644 --- a/docs-shopify.dev/generated/generated_docs_data.json +++ b/docs-shopify.dev/generated/generated_docs_data.json @@ -1,7 +1,7 @@ [ { "name": "app build", - "description": "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](/docs/apps/tools/cli/configuration).\n\n If you're building a [theme app extension](/docs/apps/online-store/theme-app-extensions), then running the `build` command runs [Theme Check](/docs/themes/tools/theme-check) against your extension to ensure that it's valid.", + "description": "The following flags are available for the `app build` command:", "overviewPreviewDescription": "Build the app, including extensions.", "type": "command", "isVisualComponent": false, @@ -26,7 +26,8 @@ "appbuild": { "filePath": "docs-shopify.dev/commands/interfaces/app-build.interface.ts", "name": "appbuild", - "description": "", + "description": "The following flags are available for the `app build` command:", + "isPublicDocs": true, "members": [ { "filePath": "docs-shopify.dev/commands/interfaces/app-build.interface.ts", @@ -41,7 +42,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/app-build.interface.ts", "syntaxKind": "PropertySignature", "name": "--no-color", - "value": "\"\"", + "value": "''", "description": "Disable color output.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_NO_COLOR" @@ -59,7 +60,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/app-build.interface.ts", "syntaxKind": "PropertySignature", "name": "--reset", - "value": "\"\"", + "value": "''", "description": "Reset all your settings.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_RESET" @@ -68,7 +69,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/app-build.interface.ts", "syntaxKind": "PropertySignature", "name": "--skip-dependencies-installation", - "value": "\"\"", + "value": "''", "description": "Skips the installation of dependencies. Deprecated, use workspaces instead.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_SKIP_DEPENDENCIES_INSTALLATION" @@ -77,7 +78,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/app-build.interface.ts", "syntaxKind": "PropertySignature", "name": "--verbose", - "value": "\"\"", + "value": "''", "description": "Increase the verbosity of the output.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_VERBOSE" @@ -102,7 +103,7 @@ }, { "name": "app bulk cancel", - "description": "Cancels a running bulk operation by ID.", + "description": "The following flags are available for the `app bulk cancel` command:", "overviewPreviewDescription": "Cancel a bulk operation.", "type": "command", "isVisualComponent": false, @@ -127,7 +128,8 @@ "appbulkcancel": { "filePath": "docs-shopify.dev/commands/interfaces/app-bulk-cancel.interface.ts", "name": "appbulkcancel", - "description": "", + "description": "The following flags are available for the `app bulk cancel` command:", + "isPublicDocs": true, "members": [ { "filePath": "docs-shopify.dev/commands/interfaces/app-bulk-cancel.interface.ts", @@ -150,7 +152,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/app-bulk-cancel.interface.ts", "syntaxKind": "PropertySignature", "name": "--no-color", - "value": "\"\"", + "value": "''", "description": "Disable color output.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_NO_COLOR" @@ -168,7 +170,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/app-bulk-cancel.interface.ts", "syntaxKind": "PropertySignature", "name": "--reset", - "value": "\"\"", + "value": "''", "description": "Reset all your settings.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_RESET" @@ -177,7 +179,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/app-bulk-cancel.interface.ts", "syntaxKind": "PropertySignature", "name": "--verbose", - "value": "\"\"", + "value": "''", "description": "Increase the verbosity of the output.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_VERBOSE" @@ -211,7 +213,7 @@ }, { "name": "app bulk execute", - "description": "Executes an Admin API GraphQL query or mutation on the specified store, as a bulk operation. Mutations are only allowed on dev stores.\n\n Bulk operations allow you to process large amounts of data asynchronously. Learn more about [bulk query operations](/docs/api/usage/bulk-operations/queries) and [bulk mutation operations](/docs/api/usage/bulk-operations/imports).\n\n Use [`bulk status`](/docs/api/shopify-cli/app/app-bulk-status) to check the status of your bulk operations.", + "description": "The following flags are available for the `app bulk execute` command:", "overviewPreviewDescription": "Execute bulk operations.", "type": "command", "isVisualComponent": false, @@ -236,7 +238,8 @@ "appbulkexecute": { "filePath": "docs-shopify.dev/commands/interfaces/app-bulk-execute.interface.ts", "name": "appbulkexecute", - "description": "", + "description": "The following flags are available for the `app bulk execute` command:", + "isPublicDocs": true, "members": [ { "filePath": "docs-shopify.dev/commands/interfaces/app-bulk-execute.interface.ts", @@ -251,7 +254,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/app-bulk-execute.interface.ts", "syntaxKind": "PropertySignature", "name": "--no-color", - "value": "\"\"", + "value": "''", "description": "Disable color output.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_NO_COLOR" @@ -287,7 +290,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/app-bulk-execute.interface.ts", "syntaxKind": "PropertySignature", "name": "--reset", - "value": "\"\"", + "value": "''", "description": "Reset all your settings.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_RESET" @@ -305,7 +308,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/app-bulk-execute.interface.ts", "syntaxKind": "PropertySignature", "name": "--verbose", - "value": "\"\"", + "value": "''", "description": "Increase the verbosity of the output.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_VERBOSE" @@ -323,7 +326,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/app-bulk-execute.interface.ts", "syntaxKind": "PropertySignature", "name": "--watch", - "value": "\"\"", + "value": "''", "description": "Wait for bulk operation results before exiting. Defaults to false.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_WATCH" @@ -375,7 +378,7 @@ }, { "name": "app bulk status", - "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](/docs/api/usage/bulk-operations/queries) and [bulk mutation operations](/docs/api/usage/bulk-operations/imports).\n\n Use [`bulk execute`](/docs/api/shopify-cli/app/app-bulk-execute) to start a new bulk operation.", + "description": "The following flags are available for the `app bulk status` command:", "overviewPreviewDescription": "Check the status of bulk operations.", "type": "command", "isVisualComponent": false, @@ -400,7 +403,8 @@ "appbulkstatus": { "filePath": "docs-shopify.dev/commands/interfaces/app-bulk-status.interface.ts", "name": "appbulkstatus", - "description": "", + "description": "The following flags are available for the `app bulk status` command:", + "isPublicDocs": true, "members": [ { "filePath": "docs-shopify.dev/commands/interfaces/app-bulk-status.interface.ts", @@ -424,7 +428,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/app-bulk-status.interface.ts", "syntaxKind": "PropertySignature", "name": "--no-color", - "value": "\"\"", + "value": "''", "description": "Disable color output.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_NO_COLOR" @@ -442,7 +446,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/app-bulk-status.interface.ts", "syntaxKind": "PropertySignature", "name": "--reset", - "value": "\"\"", + "value": "''", "description": "Reset all your settings.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_RESET" @@ -451,7 +455,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/app-bulk-status.interface.ts", "syntaxKind": "PropertySignature", "name": "--verbose", - "value": "\"\"", + "value": "''", "description": "Increase the verbosity of the output.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_VERBOSE" @@ -485,7 +489,7 @@ }, { "name": "app config link", - "description": "Pulls app configuration from the Developer Dashboard and creates or overwrites a configuration file. You can create a new app with this command to start with a default configuration file.\n\n For more information on the format of the created TOML configuration file, refer to the [App configuration](/docs/apps/tools/cli/configuration) page.\n ", + "description": "The following flags are available for the `app config link` command:", "overviewPreviewDescription": "Fetch your app configuration from the Developer Dashboard.", "type": "command", "isVisualComponent": false, @@ -510,7 +514,8 @@ "appconfiglink": { "filePath": "docs-shopify.dev/commands/interfaces/app-config-link.interface.ts", "name": "appconfiglink", - "description": "", + "description": "The following flags are available for the `app config link` command:", + "isPublicDocs": true, "members": [ { "filePath": "docs-shopify.dev/commands/interfaces/app-config-link.interface.ts", @@ -525,7 +530,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/app-config-link.interface.ts", "syntaxKind": "PropertySignature", "name": "--no-color", - "value": "\"\"", + "value": "''", "description": "Disable color output.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_NO_COLOR" @@ -543,7 +548,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/app-config-link.interface.ts", "syntaxKind": "PropertySignature", "name": "--reset", - "value": "\"\"", + "value": "''", "description": "Reset all your settings.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_RESET" @@ -552,7 +557,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/app-config-link.interface.ts", "syntaxKind": "PropertySignature", "name": "--verbose", - "value": "\"\"", + "value": "''", "description": "Increase the verbosity of the output.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_VERBOSE" @@ -577,7 +582,7 @@ }, { "name": "app config pull", - "description": "Pulls the latest configuration from the already-linked Shopify app and updates the selected configuration file.\n\nThis command reuses the existing linked app and organization and skips all interactive prompts. Use `--config` to target a specific configuration file, or omit it to use the default one.", + "description": "The following flags are available for the `app config pull` command:", "overviewPreviewDescription": "Refresh an already-linked app configuration without prompts.", "type": "command", "isVisualComponent": false, @@ -602,7 +607,8 @@ "appconfigpull": { "filePath": "docs-shopify.dev/commands/interfaces/app-config-pull.interface.ts", "name": "appconfigpull", - "description": "", + "description": "The following flags are available for the `app config pull` command:", + "isPublicDocs": true, "members": [ { "filePath": "docs-shopify.dev/commands/interfaces/app-config-pull.interface.ts", @@ -617,7 +623,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/app-config-pull.interface.ts", "syntaxKind": "PropertySignature", "name": "--no-color", - "value": "\"\"", + "value": "''", "description": "Disable color output.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_NO_COLOR" @@ -635,7 +641,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/app-config-pull.interface.ts", "syntaxKind": "PropertySignature", "name": "--reset", - "value": "\"\"", + "value": "''", "description": "Reset all your settings.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_RESET" @@ -644,7 +650,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/app-config-pull.interface.ts", "syntaxKind": "PropertySignature", "name": "--verbose", - "value": "\"\"", + "value": "''", "description": "Increase the verbosity of the output.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_VERBOSE" @@ -669,7 +675,7 @@ }, { "name": "app config use", - "description": "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.", + "description": "The following flags are available for the `app config use` command:", "overviewPreviewDescription": "Activate an app configuration.", "type": "command", "isVisualComponent": false, @@ -694,7 +700,8 @@ "appconfiguse": { "filePath": "docs-shopify.dev/commands/interfaces/app-config-use.interface.ts", "name": "appconfiguse", - "description": "", + "description": "The following flags are available for the `app config use` command:", + "isPublicDocs": true, "members": [ { "filePath": "docs-shopify.dev/commands/interfaces/app-config-use.interface.ts", @@ -709,7 +716,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/app-config-use.interface.ts", "syntaxKind": "PropertySignature", "name": "--no-color", - "value": "\"\"", + "value": "''", "description": "Disable color output.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_NO_COLOR" @@ -727,7 +734,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/app-config-use.interface.ts", "syntaxKind": "PropertySignature", "name": "--reset", - "value": "\"\"", + "value": "''", "description": "Reset all your settings.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_RESET" @@ -736,7 +743,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/app-config-use.interface.ts", "syntaxKind": "PropertySignature", "name": "--verbose", - "value": "\"\"", + "value": "''", "description": "Increase the verbosity of the output.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_VERBOSE" @@ -752,7 +759,7 @@ }, { "name": "app config validate", - "description": "Validates the selected app configuration file and all extension configurations against their schemas and reports any errors found.", + "description": "The following flags are available for the `app config validate` command:", "overviewPreviewDescription": "Validate your app configuration and extensions.", "type": "command", "isVisualComponent": false, @@ -777,7 +784,8 @@ "appconfigvalidate": { "filePath": "docs-shopify.dev/commands/interfaces/app-config-validate.interface.ts", "name": "appconfigvalidate", - "description": "", + "description": "The following flags are available for the `app config validate` command:", + "isPublicDocs": true, "members": [ { "filePath": "docs-shopify.dev/commands/interfaces/app-config-validate.interface.ts", @@ -792,7 +800,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/app-config-validate.interface.ts", "syntaxKind": "PropertySignature", "name": "--no-color", - "value": "\"\"", + "value": "''", "description": "Disable color output.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_NO_COLOR" @@ -810,7 +818,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/app-config-validate.interface.ts", "syntaxKind": "PropertySignature", "name": "--reset", - "value": "\"\"", + "value": "''", "description": "Reset all your settings.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_RESET" @@ -819,7 +827,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/app-config-validate.interface.ts", "syntaxKind": "PropertySignature", "name": "--verbose", - "value": "\"\"", + "value": "''", "description": "Increase the verbosity of the output.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_VERBOSE" @@ -837,7 +845,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/app-config-validate.interface.ts", "syntaxKind": "PropertySignature", "name": "-j, --json", - "value": "\"\"", + "value": "''", "description": "Output the result as JSON. Automatically disables color output.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_JSON" @@ -853,7 +861,7 @@ }, { "name": "app deploy", - "description": "[Builds the app](/docs/api/shopify-cli/app/app-build), then deploys your app configuration and extensions.\n\n This command creates an app version, which is a snapshot of your app configuration and all extensions. This version is then released to users.\n\n This command doesn't deploy your [web app](/docs/apps/tools/cli/structure#web-components). You need to [deploy your web app](/docs/apps/deployment/web) to your own hosting solution.\n ", + "description": "The following flags are available for the `app deploy` command:", "overviewPreviewDescription": "Deploy your Shopify app.", "type": "command", "isVisualComponent": false, @@ -878,13 +886,14 @@ "appdeploy": { "filePath": "docs-shopify.dev/commands/interfaces/app-deploy.interface.ts", "name": "appdeploy", - "description": "", + "description": "The following flags are available for the `app deploy` command:", + "isPublicDocs": true, "members": [ { "filePath": "docs-shopify.dev/commands/interfaces/app-deploy.interface.ts", "syntaxKind": "PropertySignature", "name": "--allow-deletes", - "value": "\"\"", + "value": "''", "description": "Allows removing extensions and configuration without requiring user confirmation. For CI/CD environments, the recommended flag is --allow-updates.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_ALLOW_DELETES" @@ -893,7 +902,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/app-deploy.interface.ts", "syntaxKind": "PropertySignature", "name": "--allow-updates", - "value": "\"\"", + "value": "''", "description": "Allows adding and updating extensions and configuration without requiring user confirmation. Recommended option for CI/CD environments.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_ALLOW_UPDATES" @@ -920,7 +929,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/app-deploy.interface.ts", "syntaxKind": "PropertySignature", "name": "--no-build", - "value": "\"\"", + "value": "''", "description": "Use with caution: Skips building any elements of the app that require building. You should ensure your app has been prepared in advance, such as by running `shopify app build` or by caching build artifacts.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_NO_BUILD" @@ -929,7 +938,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/app-deploy.interface.ts", "syntaxKind": "PropertySignature", "name": "--no-color", - "value": "\"\"", + "value": "''", "description": "Disable color output.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_NO_COLOR" @@ -938,7 +947,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/app-deploy.interface.ts", "syntaxKind": "PropertySignature", "name": "--no-release", - "value": "\"\"", + "value": "''", "description": "Creates a version but doesn't release it - it's not made available to merchants. With this flag, a user confirmation is not required.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_NO_RELEASE" @@ -956,7 +965,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/app-deploy.interface.ts", "syntaxKind": "PropertySignature", "name": "--reset", - "value": "\"\"", + "value": "''", "description": "Reset all your settings.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_RESET" @@ -974,7 +983,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/app-deploy.interface.ts", "syntaxKind": "PropertySignature", "name": "--verbose", - "value": "\"\"", + "value": "''", "description": "Increase the verbosity of the output.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_VERBOSE" @@ -1001,7 +1010,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/app-deploy.interface.ts", "syntaxKind": "PropertySignature", "name": "-f, --force", - "value": "\"\"", + "value": "''", "description": "[Deprecated] Deploy without asking for confirmation. Equivalent to --allow-updates --allow-deletes. Use --allow-updates for CI/CD environments instead.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_FORCE" @@ -1017,7 +1026,7 @@ }, { "name": "app dev clean", - "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 ", + "description": "The following flags are available for the `app dev clean` command:", "overviewPreviewDescription": "Cleans up the dev preview from the selected store.", "type": "command", "isVisualComponent": false, @@ -1042,7 +1051,8 @@ "appdevclean": { "filePath": "docs-shopify.dev/commands/interfaces/app-dev-clean.interface.ts", "name": "appdevclean", - "description": "", + "description": "The following flags are available for the `app dev clean` command:", + "isPublicDocs": true, "members": [ { "filePath": "docs-shopify.dev/commands/interfaces/app-dev-clean.interface.ts", @@ -1057,7 +1067,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/app-dev-clean.interface.ts", "syntaxKind": "PropertySignature", "name": "--no-color", - "value": "\"\"", + "value": "''", "description": "Disable color output.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_NO_COLOR" @@ -1075,7 +1085,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/app-dev-clean.interface.ts", "syntaxKind": "PropertySignature", "name": "--reset", - "value": "\"\"", + "value": "''", "description": "Reset all your settings.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_RESET" @@ -1084,7 +1094,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/app-dev-clean.interface.ts", "syntaxKind": "PropertySignature", "name": "--verbose", - "value": "\"\"", + "value": "''", "description": "Increase the verbosity of the output.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_VERBOSE" @@ -1118,7 +1128,7 @@ }, { "name": "app dev", - "description": "Builds and previews your app on a dev store, and watches for changes. [Read more about testing apps locally](/docs/apps/build/cli-for-apps/test-apps-locally).", + "description": "The following flags are available for the `app dev` command:", "overviewPreviewDescription": "Run the app.", "type": "command", "isVisualComponent": false, @@ -1143,7 +1153,8 @@ "appdev": { "filePath": "docs-shopify.dev/commands/interfaces/app-dev.interface.ts", "name": "appdev", - "description": "", + "description": "The following flags are available for the `app dev` command:", + "isPublicDocs": true, "members": [ { "filePath": "docs-shopify.dev/commands/interfaces/app-dev.interface.ts", @@ -1176,7 +1187,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/app-dev.interface.ts", "syntaxKind": "PropertySignature", "name": "--no-color", - "value": "\"\"", + "value": "''", "description": "Disable color output.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_NO_COLOR" @@ -1185,7 +1196,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/app-dev.interface.ts", "syntaxKind": "PropertySignature", "name": "--no-update", - "value": "\"\"", + "value": "''", "description": "Uses the app URL from the toml file instead an autogenerated URL for dev.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_NO_UPDATE" @@ -1212,7 +1223,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/app-dev.interface.ts", "syntaxKind": "PropertySignature", "name": "--reset", - "value": "\"\"", + "value": "''", "description": "Reset all your settings.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_RESET" @@ -1221,7 +1232,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/app-dev.interface.ts", "syntaxKind": "PropertySignature", "name": "--skip-dependencies-installation", - "value": "\"\"", + "value": "''", "description": "Skips the installation of dependencies. Deprecated, use workspaces instead.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_SKIP_DEPENDENCIES_INSTALLATION" @@ -1257,7 +1268,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/app-dev.interface.ts", "syntaxKind": "PropertySignature", "name": "--use-localhost", - "value": "\"\"", + "value": "''", "description": "Service entry point will listen to localhost. A tunnel won't be used. Will work for testing many app features, but not those that directly invoke your app (E.g: Webhooks)", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_USE_LOCALHOST" @@ -1266,7 +1277,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/app-dev.interface.ts", "syntaxKind": "PropertySignature", "name": "--verbose", - "value": "\"\"", + "value": "''", "description": "Increase the verbosity of the output.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_VERBOSE" @@ -1309,7 +1320,7 @@ }, { "name": "app env pull", - "description": "Creates or updates an `.env` files that contains app and app extension environment variables.\n\n When an existing `.env` file is updated, changes to the variables are displayed in the terminal output. Existing variables and commented variables are preserved.", + "description": "The following flags are available for the `app env pull` command:", "overviewPreviewDescription": "Pull app and extensions environment variables.", "type": "command", "isVisualComponent": false, @@ -1334,7 +1345,8 @@ "appenvpull": { "filePath": "docs-shopify.dev/commands/interfaces/app-env-pull.interface.ts", "name": "appenvpull", - "description": "", + "description": "The following flags are available for the `app env pull` command:", + "isPublicDocs": true, "members": [ { "filePath": "docs-shopify.dev/commands/interfaces/app-env-pull.interface.ts", @@ -1358,7 +1370,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/app-env-pull.interface.ts", "syntaxKind": "PropertySignature", "name": "--no-color", - "value": "\"\"", + "value": "''", "description": "Disable color output.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_NO_COLOR" @@ -1376,7 +1388,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/app-env-pull.interface.ts", "syntaxKind": "PropertySignature", "name": "--reset", - "value": "\"\"", + "value": "''", "description": "Reset all your settings.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_RESET" @@ -1385,7 +1397,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/app-env-pull.interface.ts", "syntaxKind": "PropertySignature", "name": "--verbose", - "value": "\"\"", + "value": "''", "description": "Increase the verbosity of the output.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_VERBOSE" @@ -1410,7 +1422,7 @@ }, { "name": "app env show", - "description": "Displays environment variables that can be used to deploy apps and app extensions.", + "description": "The following flags are available for the `app env show` command:", "overviewPreviewDescription": "Display app and extensions environment variables.", "type": "command", "isVisualComponent": false, @@ -1435,7 +1447,8 @@ "appenvshow": { "filePath": "docs-shopify.dev/commands/interfaces/app-env-show.interface.ts", "name": "appenvshow", - "description": "", + "description": "The following flags are available for the `app env show` command:", + "isPublicDocs": true, "members": [ { "filePath": "docs-shopify.dev/commands/interfaces/app-env-show.interface.ts", @@ -1450,7 +1463,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/app-env-show.interface.ts", "syntaxKind": "PropertySignature", "name": "--no-color", - "value": "\"\"", + "value": "''", "description": "Disable color output.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_NO_COLOR" @@ -1468,7 +1481,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/app-env-show.interface.ts", "syntaxKind": "PropertySignature", "name": "--reset", - "value": "\"\"", + "value": "''", "description": "Reset all your settings.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_RESET" @@ -1477,7 +1490,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/app-env-show.interface.ts", "syntaxKind": "PropertySignature", "name": "--verbose", - "value": "\"\"", + "value": "''", "description": "Increase the verbosity of the output.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_VERBOSE" @@ -1502,7 +1515,7 @@ }, { "name": "app execute", - "description": "Executes an Admin API GraphQL query or mutation on the specified store. Mutations are only allowed on dev stores.\n\n For operations that process large amounts of data, use [`bulk execute`](/docs/api/shopify-cli/app/app-bulk-execute) instead.", + "description": "The following flags are available for the `app execute` command:", "overviewPreviewDescription": "Execute GraphQL queries and mutations.", "type": "command", "isVisualComponent": false, @@ -1527,7 +1540,8 @@ "appexecute": { "filePath": "docs-shopify.dev/commands/interfaces/app-execute.interface.ts", "name": "appexecute", - "description": "", + "description": "The following flags are available for the `app execute` command:", + "isPublicDocs": true, "members": [ { "filePath": "docs-shopify.dev/commands/interfaces/app-execute.interface.ts", @@ -1542,7 +1556,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/app-execute.interface.ts", "syntaxKind": "PropertySignature", "name": "--no-color", - "value": "\"\"", + "value": "''", "description": "Disable color output.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_NO_COLOR" @@ -1578,7 +1592,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/app-execute.interface.ts", "syntaxKind": "PropertySignature", "name": "--reset", - "value": "\"\"", + "value": "''", "description": "Reset all your settings.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_RESET" @@ -1596,7 +1610,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/app-execute.interface.ts", "syntaxKind": "PropertySignature", "name": "--verbose", - "value": "\"\"", + "value": "''", "description": "Increase the verbosity of the output.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_VERBOSE" @@ -1657,7 +1671,7 @@ }, { "name": "app function build", - "description": "Compiles the function in your current directory to WebAssembly (Wasm) for testing purposes.", + "description": "The following flags are available for the `app function build` command:", "overviewPreviewDescription": "Compile a function to wasm.", "type": "command", "isVisualComponent": false, @@ -1682,7 +1696,8 @@ "appfunctionbuild": { "filePath": "docs-shopify.dev/commands/interfaces/app-function-build.interface.ts", "name": "appfunctionbuild", - "description": "", + "description": "The following flags are available for the `app function build` command:", + "isPublicDocs": true, "members": [ { "filePath": "docs-shopify.dev/commands/interfaces/app-function-build.interface.ts", @@ -1697,7 +1712,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/app-function-build.interface.ts", "syntaxKind": "PropertySignature", "name": "--no-color", - "value": "\"\"", + "value": "''", "description": "Disable color output.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_NO_COLOR" @@ -1715,7 +1730,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/app-function-build.interface.ts", "syntaxKind": "PropertySignature", "name": "--reset", - "value": "\"\"", + "value": "''", "description": "Reset all your settings.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_RESET" @@ -1724,7 +1739,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/app-function-build.interface.ts", "syntaxKind": "PropertySignature", "name": "--verbose", - "value": "\"\"", + "value": "''", "description": "Increase the verbosity of the output.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_VERBOSE" @@ -1749,7 +1764,7 @@ }, { "name": "app function info", - "description": "The information returned includes the following:\n\n - The function handle\n - The function name\n - The function API version\n - The targeting configuration\n - The schema path\n - The WASM path\n - The function runner path", + "description": "The following flags are available for the `app function info` command:", "overviewPreviewDescription": "Print basic information about your function.", "type": "command", "isVisualComponent": false, @@ -1774,7 +1789,8 @@ "appfunctioninfo": { "filePath": "docs-shopify.dev/commands/interfaces/app-function-info.interface.ts", "name": "appfunctioninfo", - "description": "", + "description": "The following flags are available for the `app function info` command:", + "isPublicDocs": true, "members": [ { "filePath": "docs-shopify.dev/commands/interfaces/app-function-info.interface.ts", @@ -1789,7 +1805,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/app-function-info.interface.ts", "syntaxKind": "PropertySignature", "name": "--no-color", - "value": "\"\"", + "value": "''", "description": "Disable color output.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_NO_COLOR" @@ -1807,7 +1823,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/app-function-info.interface.ts", "syntaxKind": "PropertySignature", "name": "--reset", - "value": "\"\"", + "value": "''", "description": "Reset all your settings.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_RESET" @@ -1816,7 +1832,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/app-function-info.interface.ts", "syntaxKind": "PropertySignature", "name": "--verbose", - "value": "\"\"", + "value": "''", "description": "Increase the verbosity of the output.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_VERBOSE" @@ -1834,7 +1850,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/app-function-info.interface.ts", "syntaxKind": "PropertySignature", "name": "-j, --json", - "value": "\"\"", + "value": "''", "description": "Output the result as JSON. Automatically disables color output.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_JSON" @@ -1850,7 +1866,7 @@ }, { "name": "app function replay", - "description": "Runs the function from your current directory for [testing purposes](/docs/apps/functions/testing-and-debugging). To learn how you can monitor and debug functions when errors occur, refer to [Shopify Functions error handling](/docs/api/functions/errors).", + "description": "The following flags are available for the `app function replay` command:", "overviewPreviewDescription": "Replays a function run from an app log.", "type": "command", "isVisualComponent": false, @@ -1875,7 +1891,8 @@ "appfunctionreplay": { "filePath": "docs-shopify.dev/commands/interfaces/app-function-replay.interface.ts", "name": "appfunctionreplay", - "description": "", + "description": "The following flags are available for the `app function replay` command:", + "isPublicDocs": true, "members": [ { "filePath": "docs-shopify.dev/commands/interfaces/app-function-replay.interface.ts", @@ -1890,7 +1907,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/app-function-replay.interface.ts", "syntaxKind": "PropertySignature", "name": "--no-color", - "value": "\"\"", + "value": "''", "description": "Disable color output.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_NO_COLOR" @@ -1908,7 +1925,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/app-function-replay.interface.ts", "syntaxKind": "PropertySignature", "name": "--reset", - "value": "\"\"", + "value": "''", "description": "Reset all your settings.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_RESET" @@ -1917,7 +1934,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/app-function-replay.interface.ts", "syntaxKind": "PropertySignature", "name": "--verbose", - "value": "\"\"", + "value": "''", "description": "Increase the verbosity of the output.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_VERBOSE" @@ -1935,7 +1952,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/app-function-replay.interface.ts", "syntaxKind": "PropertySignature", "name": "-j, --json", - "value": "\"\"", + "value": "''", "description": "Output the result as JSON. Automatically disables color output.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_JSON" @@ -1953,7 +1970,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/app-function-replay.interface.ts", "syntaxKind": "PropertySignature", "name": "-w, --watch", - "value": "\"\"", + "value": "''", "description": "Re-run the function when the source code changes.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_WATCH" @@ -1969,7 +1986,7 @@ }, { "name": "app function run", - "description": "Runs the function from your current directory for [testing purposes](/docs/apps/functions/testing-and-debugging). To learn how you can monitor and debug functions when errors occur, refer to [Shopify Functions error handling](/docs/api/functions/errors).", + "description": "The following flags are available for the `app function run` command:", "overviewPreviewDescription": "Run a function locally for testing.", "type": "command", "isVisualComponent": false, @@ -1994,7 +2011,8 @@ "appfunctionrun": { "filePath": "docs-shopify.dev/commands/interfaces/app-function-run.interface.ts", "name": "appfunctionrun", - "description": "", + "description": "The following flags are available for the `app function run` command:", + "isPublicDocs": true, "members": [ { "filePath": "docs-shopify.dev/commands/interfaces/app-function-run.interface.ts", @@ -2009,7 +2027,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/app-function-run.interface.ts", "syntaxKind": "PropertySignature", "name": "--no-color", - "value": "\"\"", + "value": "''", "description": "Disable color output.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_NO_COLOR" @@ -2027,7 +2045,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/app-function-run.interface.ts", "syntaxKind": "PropertySignature", "name": "--reset", - "value": "\"\"", + "value": "''", "description": "Reset all your settings.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_RESET" @@ -2036,7 +2054,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/app-function-run.interface.ts", "syntaxKind": "PropertySignature", "name": "--verbose", - "value": "\"\"", + "value": "''", "description": "Increase the verbosity of the output.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_VERBOSE" @@ -2072,7 +2090,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/app-function-run.interface.ts", "syntaxKind": "PropertySignature", "name": "-j, --json", - "value": "\"\"", + "value": "''", "description": "Output the result as JSON. Automatically disables color output.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_JSON" @@ -2088,7 +2106,7 @@ }, { "name": "app function schema", - "description": "Generates the latest [GraphQL schema](/docs/apps/functions/input-output#graphql-schema) for a function in your app. Run this command from the function directory.\n\n This command uses the API type and version of your function, as defined in your extension TOML file, to generate the latest GraphQL schema. The schema is written to the `schema.graphql` file.", + "description": "The following flags are available for the `app function schema` command:", "overviewPreviewDescription": "Fetch the latest GraphQL schema for a function.", "type": "command", "isVisualComponent": false, @@ -2113,7 +2131,8 @@ "appfunctionschema": { "filePath": "docs-shopify.dev/commands/interfaces/app-function-schema.interface.ts", "name": "appfunctionschema", - "description": "", + "description": "The following flags are available for the `app function schema` command:", + "isPublicDocs": true, "members": [ { "filePath": "docs-shopify.dev/commands/interfaces/app-function-schema.interface.ts", @@ -2128,7 +2147,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/app-function-schema.interface.ts", "syntaxKind": "PropertySignature", "name": "--no-color", - "value": "\"\"", + "value": "''", "description": "Disable color output.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_NO_COLOR" @@ -2146,7 +2165,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/app-function-schema.interface.ts", "syntaxKind": "PropertySignature", "name": "--reset", - "value": "\"\"", + "value": "''", "description": "Reset all your settings.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_RESET" @@ -2155,7 +2174,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/app-function-schema.interface.ts", "syntaxKind": "PropertySignature", "name": "--stdout", - "value": "\"\"", + "value": "''", "description": "Output the schema to stdout instead of writing to a file.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_STDOUT" @@ -2164,7 +2183,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/app-function-schema.interface.ts", "syntaxKind": "PropertySignature", "name": "--verbose", - "value": "\"\"", + "value": "''", "description": "Increase the verbosity of the output.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_VERBOSE" @@ -2189,7 +2208,7 @@ }, { "name": "app function typegen", - "description": "Creates GraphQL types based on your [input query](/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.", + "description": "The following flags are available for the `app function typegen` command:", "overviewPreviewDescription": "Generate GraphQL types for a function.", "type": "command", "isVisualComponent": false, @@ -2214,7 +2233,8 @@ "appfunctiontypegen": { "filePath": "docs-shopify.dev/commands/interfaces/app-function-typegen.interface.ts", "name": "appfunctiontypegen", - "description": "", + "description": "The following flags are available for the `app function typegen` command:", + "isPublicDocs": true, "members": [ { "filePath": "docs-shopify.dev/commands/interfaces/app-function-typegen.interface.ts", @@ -2229,7 +2249,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/app-function-typegen.interface.ts", "syntaxKind": "PropertySignature", "name": "--no-color", - "value": "\"\"", + "value": "''", "description": "Disable color output.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_NO_COLOR" @@ -2247,7 +2267,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/app-function-typegen.interface.ts", "syntaxKind": "PropertySignature", "name": "--reset", - "value": "\"\"", + "value": "''", "description": "Reset all your settings.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_RESET" @@ -2256,7 +2276,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/app-function-typegen.interface.ts", "syntaxKind": "PropertySignature", "name": "--verbose", - "value": "\"\"", + "value": "''", "description": "Increase the verbosity of the output.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_VERBOSE" @@ -2281,7 +2301,7 @@ }, { "name": "app generate extension", - "description": "Generates a new [app extension](/docs/apps/build/app-extensions). For a list of app extensions that you can generate using this command, refer to [Supported extensions](/docs/apps/build/app-extensions/list-of-app-extensions).\n\n Each new app extension is created in a folder under `extensions/`. To learn more about the extensions file structure, refer to [App structure](/docs/apps/build/cli-for-apps/app-structure) and the documentation for your extension.\n ", + "description": "The following flags are available for the `app generate extension` command:", "overviewPreviewDescription": "Generate a new app Extension.", "type": "command", "isVisualComponent": false, @@ -2306,7 +2326,8 @@ "appgenerateextension": { "filePath": "docs-shopify.dev/commands/interfaces/app-generate-extension.interface.ts", "name": "appgenerateextension", - "description": "", + "description": "The following flags are available for the `app generate extension` command:", + "isPublicDocs": true, "members": [ { "filePath": "docs-shopify.dev/commands/interfaces/app-generate-extension.interface.ts", @@ -2330,7 +2351,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/app-generate-extension.interface.ts", "syntaxKind": "PropertySignature", "name": "--no-color", - "value": "\"\"", + "value": "''", "description": "Disable color output.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_NO_COLOR" @@ -2348,7 +2369,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/app-generate-extension.interface.ts", "syntaxKind": "PropertySignature", "name": "--reset", - "value": "\"\"", + "value": "''", "description": "Reset all your settings.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_RESET" @@ -2357,7 +2378,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/app-generate-extension.interface.ts", "syntaxKind": "PropertySignature", "name": "--verbose", - "value": "\"\"", + "value": "''", "description": "Increase the verbosity of the output.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_VERBOSE" @@ -2409,7 +2430,7 @@ }, { "name": "app import-custom-data-definitions", - "description": "Import metafield and metaobject definitions from your development store. [Read more about declarative custom data definitions](/docs/apps/build/custom-data/declarative-custom-data-definitions).", + "description": "The following flags are available for the `app import-custom-data-definitions` command:", "overviewPreviewDescription": "Import metafield and metaobject definitions.", "type": "command", "isVisualComponent": false, @@ -2434,7 +2455,8 @@ "appimportcustomdatadefinitions": { "filePath": "docs-shopify.dev/commands/interfaces/app-import-custom-data-definitions.interface.ts", "name": "appimportcustomdatadefinitions", - "description": "", + "description": "The following flags are available for the `app import-custom-data-definitions` command:", + "isPublicDocs": true, "members": [ { "filePath": "docs-shopify.dev/commands/interfaces/app-import-custom-data-definitions.interface.ts", @@ -2449,7 +2471,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/app-import-custom-data-definitions.interface.ts", "syntaxKind": "PropertySignature", "name": "--include-existing", - "value": "\"\"", + "value": "''", "description": "Include existing declared definitions in the output.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_INCLUDE_EXISTING" @@ -2458,7 +2480,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/app-import-custom-data-definitions.interface.ts", "syntaxKind": "PropertySignature", "name": "--no-color", - "value": "\"\"", + "value": "''", "description": "Disable color output.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_NO_COLOR" @@ -2476,7 +2498,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/app-import-custom-data-definitions.interface.ts", "syntaxKind": "PropertySignature", "name": "--reset", - "value": "\"\"", + "value": "''", "description": "Reset all your settings.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_RESET" @@ -2485,7 +2507,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/app-import-custom-data-definitions.interface.ts", "syntaxKind": "PropertySignature", "name": "--verbose", - "value": "\"\"", + "value": "''", "description": "Increase the verbosity of the output.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_VERBOSE" @@ -2519,8 +2541,8 @@ }, { "name": "app import-extensions", - "description": "Import dashboard-managed extensions into your app.", - "overviewPreviewDescription": "Import dashboard-managed extensions into your app.", + "description": "The following flags are available for the `app import-extensions` command:", + "overviewPreviewDescription": "The following flags are available for the `app import-extensions` command:", "type": "command", "isVisualComponent": false, "defaultExample": { @@ -2544,7 +2566,8 @@ "appimportextensions": { "filePath": "docs-shopify.dev/commands/interfaces/app-import-extensions.interface.ts", "name": "appimportextensions", - "description": "", + "description": "The following flags are available for the `app import-extensions` command:", + "isPublicDocs": true, "members": [ { "filePath": "docs-shopify.dev/commands/interfaces/app-import-extensions.interface.ts", @@ -2559,7 +2582,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/app-import-extensions.interface.ts", "syntaxKind": "PropertySignature", "name": "--no-color", - "value": "\"\"", + "value": "''", "description": "Disable color output.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_NO_COLOR" @@ -2577,7 +2600,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/app-import-extensions.interface.ts", "syntaxKind": "PropertySignature", "name": "--reset", - "value": "\"\"", + "value": "''", "description": "Reset all your settings.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_RESET" @@ -2586,7 +2609,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/app-import-extensions.interface.ts", "syntaxKind": "PropertySignature", "name": "--verbose", - "value": "\"\"", + "value": "''", "description": "Increase the verbosity of the output.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_VERBOSE" @@ -2611,7 +2634,7 @@ }, { "name": "app info", - "description": "The information returned includes the following:\n\n - The app and dev store that's used when you run the [dev](/docs/api/shopify-cli/app/app-dev) command. You can reset these configurations using [`dev --reset`](/docs/api/shopify-cli/app/app-dev#flags-propertydetail-reset).\n - The [structure](/docs/apps/tools/cli/structure) of your app project.\n - The [access scopes](/docs/api/usage) your app has requested.\n - System information, including the package manager and version of Shopify CLI used in the project.", + "description": "The following flags are available for the `app info` command:", "overviewPreviewDescription": "Print basic information about your app and extensions.", "type": "command", "isVisualComponent": false, @@ -2636,7 +2659,8 @@ "appinfo": { "filePath": "docs-shopify.dev/commands/interfaces/app-info.interface.ts", "name": "appinfo", - "description": "", + "description": "The following flags are available for the `app info` command:", + "isPublicDocs": true, "members": [ { "filePath": "docs-shopify.dev/commands/interfaces/app-info.interface.ts", @@ -2651,7 +2675,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/app-info.interface.ts", "syntaxKind": "PropertySignature", "name": "--no-color", - "value": "\"\"", + "value": "''", "description": "Disable color output.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_NO_COLOR" @@ -2669,7 +2693,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/app-info.interface.ts", "syntaxKind": "PropertySignature", "name": "--reset", - "value": "\"\"", + "value": "''", "description": "Reset all your settings.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_RESET" @@ -2678,7 +2702,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/app-info.interface.ts", "syntaxKind": "PropertySignature", "name": "--verbose", - "value": "\"\"", + "value": "''", "description": "Increase the verbosity of the output.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_VERBOSE" @@ -2687,7 +2711,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/app-info.interface.ts", "syntaxKind": "PropertySignature", "name": "--web-env", - "value": "\"\"", + "value": "''", "description": "Outputs environment variables necessary for running and deploying web/.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_OUTPUT_WEB_ENV" @@ -2705,7 +2729,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/app-info.interface.ts", "syntaxKind": "PropertySignature", "name": "-j, --json", - "value": "\"\"", + "value": "''", "description": "Output the result as JSON. Automatically disables color output.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_JSON" @@ -2721,7 +2745,7 @@ }, { "name": "app init", - "description": "Create a new app project", + "description": "The following flags are available for the `app init` command:", "overviewPreviewDescription": "Create a new app project", "type": "command", "isVisualComponent": false, @@ -2746,7 +2770,8 @@ "appinit": { "filePath": "docs-shopify.dev/commands/interfaces/app-init.interface.ts", "name": "appinit", - "description": "", + "description": "The following flags are available for the `app init` command:", + "isPublicDocs": true, "members": [ { "filePath": "docs-shopify.dev/commands/interfaces/app-init.interface.ts", @@ -2770,7 +2795,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/app-init.interface.ts", "syntaxKind": "PropertySignature", "name": "--no-color", - "value": "\"\"", + "value": "''", "description": "Disable color output.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_NO_COLOR" @@ -2797,7 +2822,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/app-init.interface.ts", "syntaxKind": "PropertySignature", "name": "--verbose", - "value": "\"\"", + "value": "''", "description": "Increase the verbosity of the output.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_VERBOSE" @@ -2840,7 +2865,7 @@ }, { "name": "app logs sources", - "description": "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.", + "description": "The following flags are available for the `app logs sources` command:", "overviewPreviewDescription": "Print out a list of sources that may be used with the logs command.", "type": "command", "isVisualComponent": false, @@ -2865,7 +2890,8 @@ "applogssources": { "filePath": "docs-shopify.dev/commands/interfaces/app-logs-sources.interface.ts", "name": "applogssources", - "description": "", + "description": "The following flags are available for the `app logs sources` command:", + "isPublicDocs": true, "members": [ { "filePath": "docs-shopify.dev/commands/interfaces/app-logs-sources.interface.ts", @@ -2880,7 +2906,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/app-logs-sources.interface.ts", "syntaxKind": "PropertySignature", "name": "--no-color", - "value": "\"\"", + "value": "''", "description": "Disable color output.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_NO_COLOR" @@ -2898,7 +2924,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/app-logs-sources.interface.ts", "syntaxKind": "PropertySignature", "name": "--reset", - "value": "\"\"", + "value": "''", "description": "Reset all your settings.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_RESET" @@ -2907,7 +2933,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/app-logs-sources.interface.ts", "syntaxKind": "PropertySignature", "name": "--verbose", - "value": "\"\"", + "value": "''", "description": "Increase the verbosity of the output.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_VERBOSE" @@ -2932,7 +2958,7 @@ }, { "name": "app logs", - "description": "\n Opens a real-time stream of detailed app logs from the selected app and store.\n Use the `--source` argument to limit output to a particular log source, such as a specific Shopify Function handle. Use the `shopify app logs sources` command to view a list of sources.\n Use the `--status` argument to filter on status, either `success` or `failure`.\n ```\n shopify app logs --status=success --source=extension.discount-function\n ```\n ", + "description": "The following flags are available for the `app logs` command:", "overviewPreviewDescription": "Stream detailed logs for your Shopify app.", "type": "command", "isVisualComponent": false, @@ -2957,7 +2983,8 @@ "applogs": { "filePath": "docs-shopify.dev/commands/interfaces/app-logs.interface.ts", "name": "applogs", - "description": "", + "description": "The following flags are available for the `app logs` command:", + "isPublicDocs": true, "members": [ { "filePath": "docs-shopify.dev/commands/interfaces/app-logs.interface.ts", @@ -2972,7 +2999,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/app-logs.interface.ts", "syntaxKind": "PropertySignature", "name": "--no-color", - "value": "\"\"", + "value": "''", "description": "Disable color output.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_NO_COLOR" @@ -2990,7 +3017,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/app-logs.interface.ts", "syntaxKind": "PropertySignature", "name": "--reset", - "value": "\"\"", + "value": "''", "description": "Reset all your settings.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_RESET" @@ -3017,7 +3044,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/app-logs.interface.ts", "syntaxKind": "PropertySignature", "name": "--verbose", - "value": "\"\"", + "value": "''", "description": "Increase the verbosity of the output.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_VERBOSE" @@ -3035,7 +3062,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/app-logs.interface.ts", "syntaxKind": "PropertySignature", "name": "-j, --json", - "value": "\"\"", + "value": "''", "description": "Output the result as JSON. Automatically disables color output.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_JSON" @@ -3060,7 +3087,7 @@ }, { "name": "app release", - "description": "Releases an existing app version. Pass the name of the version that you want to release using the `--version` flag.", + "description": "The following flags are available for the `app release` command:", "overviewPreviewDescription": "Release an app version.", "type": "command", "isVisualComponent": false, @@ -3085,13 +3112,14 @@ "apprelease": { "filePath": "docs-shopify.dev/commands/interfaces/app-release.interface.ts", "name": "apprelease", - "description": "", + "description": "The following flags are available for the `app release` command:", + "isPublicDocs": true, "members": [ { "filePath": "docs-shopify.dev/commands/interfaces/app-release.interface.ts", "syntaxKind": "PropertySignature", "name": "--allow-deletes", - "value": "\"\"", + "value": "''", "description": "Allows removing extensions and configuration without requiring user confirmation. For CI/CD environments, the recommended flag is --allow-updates.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_ALLOW_DELETES" @@ -3100,7 +3128,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/app-release.interface.ts", "syntaxKind": "PropertySignature", "name": "--allow-updates", - "value": "\"\"", + "value": "''", "description": "Allows adding and updating extensions and configuration without requiring user confirmation. Recommended option for CI/CD environments.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_ALLOW_UPDATES" @@ -3118,7 +3146,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/app-release.interface.ts", "syntaxKind": "PropertySignature", "name": "--no-color", - "value": "\"\"", + "value": "''", "description": "Disable color output.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_NO_COLOR" @@ -3136,7 +3164,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/app-release.interface.ts", "syntaxKind": "PropertySignature", "name": "--reset", - "value": "\"\"", + "value": "''", "description": "Reset all your settings.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_RESET" @@ -3145,7 +3173,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/app-release.interface.ts", "syntaxKind": "PropertySignature", "name": "--verbose", - "value": "\"\"", + "value": "''", "description": "Increase the verbosity of the output.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_VERBOSE" @@ -3171,7 +3199,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/app-release.interface.ts", "syntaxKind": "PropertySignature", "name": "-f, --force", - "value": "\"\"", + "value": "''", "description": "[Deprecated] Release without asking for confirmation. Equivalent to --allow-updates --allow-deletes. Use --allow-updates for CI/CD environments instead.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_FORCE" @@ -3187,7 +3215,7 @@ }, { "name": "app versions list", - "description": "Lists the deployed app versions. An app version is a snapshot of your app extensions.", + "description": "The following flags are available for the `app versions list` command:", "overviewPreviewDescription": "List deployed versions of your app.", "type": "command", "isVisualComponent": false, @@ -3212,7 +3240,8 @@ "appversionslist": { "filePath": "docs-shopify.dev/commands/interfaces/app-versions-list.interface.ts", "name": "appversionslist", - "description": "", + "description": "The following flags are available for the `app versions list` command:", + "isPublicDocs": true, "members": [ { "filePath": "docs-shopify.dev/commands/interfaces/app-versions-list.interface.ts", @@ -3227,7 +3256,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/app-versions-list.interface.ts", "syntaxKind": "PropertySignature", "name": "--no-color", - "value": "\"\"", + "value": "''", "description": "Disable color output.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_NO_COLOR" @@ -3245,7 +3274,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/app-versions-list.interface.ts", "syntaxKind": "PropertySignature", "name": "--reset", - "value": "\"\"", + "value": "''", "description": "Reset all your settings.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_RESET" @@ -3254,7 +3283,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/app-versions-list.interface.ts", "syntaxKind": "PropertySignature", "name": "--verbose", - "value": "\"\"", + "value": "''", "description": "Increase the verbosity of the output.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_VERBOSE" @@ -3272,7 +3301,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/app-versions-list.interface.ts", "syntaxKind": "PropertySignature", "name": "-j, --json", - "value": "\"\"", + "value": "''", "description": "Output the result as JSON. Automatically disables color output.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_JSON" @@ -3288,7 +3317,7 @@ }, { "name": "app webhook trigger", - "description": "\n Triggers the delivery of a sample Admin API event topic payload to a designated address.\n\n You should use this command to experiment with webhooks, to initially test your webhook configuration, or for unit testing. However, to test your webhook configuration from end to end, you should always trigger webhooks by performing the related action in Shopify.\n\n Because most webhook deliveries use remote endpoints, you can trigger the command from any directory where you can use Shopify CLI, and send the webhook to any of the supported endpoint types. For example, you can run the command from your app's local directory, but send the webhook to a staging environment endpoint.\n\n To learn more about using webhooks in a Shopify app, refer to [Webhooks overview](/docs/apps/webhooks).\n\n ### Limitations\n\n - Webhooks triggered using this method always have the same payload, so they can't be used to test scenarios that differ based on the payload contents.\n - Webhooks triggered using this method aren't retried when they fail.\n - Trigger requests are rate-limited using the [Partner API rate limit](/docs/api/partner#rate_limits).\n - You can't use this method to validate your API webhook subscriptions.\n ", + "description": "The following flags are available for the `app webhook trigger` command:", "overviewPreviewDescription": "Trigger delivery of a sample webhook topic payload to a designated address.", "type": "command", "isVisualComponent": false, @@ -3313,7 +3342,8 @@ "appwebhooktrigger": { "filePath": "docs-shopify.dev/commands/interfaces/app-webhook-trigger.interface.ts", "name": "appwebhooktrigger", - "description": "", + "description": "The following flags are available for the `app webhook trigger` command:", + "isPublicDocs": true, "members": [ { "filePath": "docs-shopify.dev/commands/interfaces/app-webhook-trigger.interface.ts", @@ -3364,7 +3394,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/app-webhook-trigger.interface.ts", "syntaxKind": "PropertySignature", "name": "--help", - "value": "\"\"", + "value": "''", "description": "This help. When you run the trigger command the CLI will prompt you for any information that isn't passed using flags.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_HELP" @@ -3382,7 +3412,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/app-webhook-trigger.interface.ts", "syntaxKind": "PropertySignature", "name": "--reset", - "value": "\"\"", + "value": "''", "description": "Reset all your settings.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_RESET" @@ -3425,8 +3455,8 @@ }, { "name": "auth login", - "description": "Logs you in to your Shopify account.", - "overviewPreviewDescription": "Logs you in to your Shopify account.", + "description": "The following flags are available for the `auth login` command:", + "overviewPreviewDescription": "The following flags are available for the `auth login` command:", "type": "command", "isVisualComponent": false, "defaultExample": { @@ -3450,7 +3480,8 @@ "authlogin": { "filePath": "docs-shopify.dev/commands/interfaces/auth-login.interface.ts", "name": "authlogin", - "description": "", + "description": "The following flags are available for the `auth login` command:", + "isPublicDocs": true, "members": [ { "filePath": "docs-shopify.dev/commands/interfaces/auth-login.interface.ts", @@ -3494,8 +3525,8 @@ }, { "name": "commands", - "description": "List all shopify commands.", - "overviewPreviewDescription": "List all shopify commands.", + "description": "The following flags are available for the `commands` command:", + "overviewPreviewDescription": "The following flags are available for the `commands` command:", "type": "command", "isVisualComponent": false, "defaultExample": { @@ -3519,13 +3550,14 @@ "commands": { "filePath": "docs-shopify.dev/commands/interfaces/commands.interface.ts", "name": "commands", - "description": "", + "description": "The following flags are available for the `commands` command:", + "isPublicDocs": true, "members": [ { "filePath": "docs-shopify.dev/commands/interfaces/commands.interface.ts", "syntaxKind": "PropertySignature", "name": "--deprecated", - "value": "\"\"", + "value": "''", "description": "Show deprecated commands.", "isOptional": true }, @@ -3533,7 +3565,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/commands.interface.ts", "syntaxKind": "PropertySignature", "name": "--hidden", - "value": "\"\"", + "value": "''", "description": "Show hidden commands.", "isOptional": true }, @@ -3541,7 +3573,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/commands.interface.ts", "syntaxKind": "PropertySignature", "name": "--json", - "value": "\"\"", + "value": "''", "description": "Format output as json.", "isOptional": true }, @@ -3549,7 +3581,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/commands.interface.ts", "syntaxKind": "PropertySignature", "name": "--no-truncate", - "value": "\"\"", + "value": "''", "description": "Do not truncate output.", "isOptional": true }, @@ -3565,7 +3597,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/commands.interface.ts", "syntaxKind": "PropertySignature", "name": "--tree", - "value": "\"\"", + "value": "''", "description": "Show tree of commands.", "isOptional": true }, @@ -3581,7 +3613,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/commands.interface.ts", "syntaxKind": "PropertySignature", "name": "-x, --extended", - "value": "\"\"", + "value": "''", "description": "Show extra columns.", "isOptional": true } @@ -3662,8 +3694,8 @@ }, { "name": "help", - "description": "Display help for Shopify CLI", - "overviewPreviewDescription": "Display help for Shopify CLI", + "description": "The following flags are available for the `help` command:", + "overviewPreviewDescription": "The following flags are available for the `help` command:", "type": "command", "isVisualComponent": false, "defaultExample": { @@ -3687,13 +3719,14 @@ "help": { "filePath": "docs-shopify.dev/commands/interfaces/help.interface.ts", "name": "help", - "description": "", + "description": "The following flags are available for the `help` command:", + "isPublicDocs": true, "members": [ { "filePath": "docs-shopify.dev/commands/interfaces/help.interface.ts", "syntaxKind": "PropertySignature", "name": "-n, --nested-commands", - "value": "\"\"", + "value": "''", "description": "Include all nested commands in the output.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_CLI_NESTED_COMMANDS" @@ -3709,8 +3742,8 @@ }, { "name": "hydrogen build", - "description": "Builds a Hydrogen storefront for production. The client and app worker files are compiled to a `/dist` folder in your Hydrogen project directory.", - "overviewPreviewDescription": "Builds a Hydrogen storefront for production. The client and app worker files are compiled to a `/dist` folder in your Hydrogen project directory.", + "description": "The following flags are available for the `hydrogen build` command:", + "overviewPreviewDescription": "The following flags are available for the `hydrogen build` command:", "type": "command", "isVisualComponent": false, "defaultExample": { @@ -3734,13 +3767,14 @@ "hydrogenbuild": { "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-build.interface.ts", "name": "hydrogenbuild", - "description": "", + "description": "The following flags are available for the `hydrogen build` command:", + "isPublicDocs": true, "members": [ { "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-build.interface.ts", "syntaxKind": "PropertySignature", "name": "--bundle-stats", - "value": "\"\"", + "value": "''", "description": "Show a bundle size summary after building. Defaults to true, use `--no-bundle-stats` to disable.", "isOptional": true }, @@ -3748,7 +3782,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-build.interface.ts", "syntaxKind": "PropertySignature", "name": "--codegen", - "value": "\"\"", + "value": "''", "description": "Automatically generates GraphQL types for your project’s Storefront API queries.", "isOptional": true }, @@ -3764,7 +3798,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-build.interface.ts", "syntaxKind": "PropertySignature", "name": "--disable-route-warning", - "value": "\"\"", + "value": "''", "description": "Disables any warnings about missing standard routes.", "isOptional": true, "environmentValue": "SHOPIFY_HYDROGEN_FLAG_DISABLE_ROUTE_WARNING" @@ -3782,7 +3816,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-build.interface.ts", "syntaxKind": "PropertySignature", "name": "--force-client-sourcemap", - "value": "\"\"", + "value": "''", "description": "Client sourcemapping is avoided by default because it makes backend code visible in the browser. Use this flag to force enabling it.", "isOptional": true, "environmentValue": "SHOPIFY_HYDROGEN_FLAG_FORCE_CLIENT_SOURCEMAP" @@ -3791,7 +3825,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-build.interface.ts", "syntaxKind": "PropertySignature", "name": "--lockfile-check", - "value": "\"\"", + "value": "''", "description": "Checks that there is exactly one valid lockfile in the project. Defaults to `true`. Deactivate with `--no-lockfile-check`.", "isOptional": true, "environmentValue": "SHOPIFY_HYDROGEN_FLAG_LOCKFILE_CHECK" @@ -3809,7 +3843,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-build.interface.ts", "syntaxKind": "PropertySignature", "name": "--sourcemap", - "value": "\"\"", + "value": "''", "description": "Controls whether server sourcemaps are generated. Default to `true`. Deactivate `--no-sourcemaps`.", "isOptional": true, "environmentValue": "SHOPIFY_HYDROGEN_FLAG_SOURCEMAP" @@ -3818,7 +3852,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-build.interface.ts", "syntaxKind": "PropertySignature", "name": "--watch", - "value": "\"\"", + "value": "''", "description": "Watches for changes and rebuilds the project writing output to disk.", "isOptional": true, "environmentValue": "SHOPIFY_HYDROGEN_FLAG_WATCH" @@ -3834,8 +3868,8 @@ }, { "name": "hydrogen check", - "description": "Checks whether your Hydrogen app includes a set of standard Shopify routes.", - "overviewPreviewDescription": "Checks whether your Hydrogen app includes a set of standard Shopify routes.", + "description": "The following flags are available for the `hydrogen check` command:", + "overviewPreviewDescription": "The following flags are available for the `hydrogen check` command:", "type": "command", "isVisualComponent": false, "defaultExample": { @@ -3859,7 +3893,8 @@ "hydrogencheck": { "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-check.interface.ts", "name": "hydrogencheck", - "description": "", + "description": "The following flags are available for the `hydrogen check` command:", + "isPublicDocs": true, "members": [ { "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-check.interface.ts", @@ -3881,8 +3916,8 @@ }, { "name": "hydrogen codegen", - "description": "Automatically generates GraphQL types for your project’s Storefront API queries.", - "overviewPreviewDescription": "Automatically generates GraphQL types for your project’s Storefront API queries.", + "description": "The following flags are available for the `hydrogen codegen` command:", + "overviewPreviewDescription": "The following flags are available for the `hydrogen codegen` command:", "type": "command", "isVisualComponent": false, "defaultExample": { @@ -3906,7 +3941,8 @@ "hydrogencodegen": { "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-codegen.interface.ts", "name": "hydrogencodegen", - "description": "", + "description": "The following flags are available for the `hydrogen codegen` command:", + "isPublicDocs": true, "members": [ { "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-codegen.interface.ts", @@ -3929,7 +3965,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-codegen.interface.ts", "syntaxKind": "PropertySignature", "name": "--watch", - "value": "\"\"", + "value": "''", "description": "Watch the project for changes to update types on file save.", "isOptional": true } @@ -3944,8 +3980,8 @@ }, { "name": "hydrogen customer-account-push", - "description": "Push project configuration to admin", - "overviewPreviewDescription": "Push project configuration to admin", + "description": "The following flags are available for the `hydrogen customer-account-push` command:", + "overviewPreviewDescription": "The following flags are available for the `hydrogen customer-account-push` command:", "type": "command", "isVisualComponent": false, "defaultExample": { @@ -3969,7 +4005,8 @@ "hydrogencustomeraccountpush": { "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-customer-account-push.interface.ts", "name": "hydrogencustomeraccountpush", - "description": "", + "description": "The following flags are available for the `hydrogen customer-account-push` command:", + "isPublicDocs": true, "members": [ { "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-customer-account-push.interface.ts", @@ -4022,8 +4059,8 @@ }, { "name": "hydrogen debug cpu", - "description": "Builds the app and runs the resulting code to profile the server startup time, watching for changes. This command can be used to [debug slow app startup times](/docs/custom-storefronts/hydrogen/debugging/cpu-startup) that cause failed deployments in Oxygen.\n\n The profiling results are written to a `.cpuprofile` file that can be viewed with certain tools such as [Flame Chart Visualizer for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=ms-vscode.vscode-js-profile-flame).", - "overviewPreviewDescription": "Builds the app and runs the resulting code to profile the server startup time, watching for changes. This command can be used to [debug slow app startup times](/docs/custom-storefronts/hydrogen/debugging/cpu-startup) that cause failed deployments in Oxygen.\n\n The profiling results are written to a `.cpuprofile` file that can be viewed with certain tools such as [Flame Chart Visualizer for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=ms-vscode.vscode-js-profile-flame).", + "description": "The following flags are available for the `hydrogen debug cpu` command:", + "overviewPreviewDescription": "The following flags are available for the `hydrogen debug cpu` command:", "type": "command", "isVisualComponent": false, "defaultExample": { @@ -4047,7 +4084,8 @@ "hydrogendebugcpu": { "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-debug-cpu.interface.ts", "name": "hydrogendebugcpu", - "description": "", + "description": "The following flags are available for the `hydrogen debug cpu` command:", + "isPublicDocs": true, "members": [ { "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-debug-cpu.interface.ts", @@ -4086,8 +4124,8 @@ }, { "name": "hydrogen deploy", - "description": "Builds and deploys your Hydrogen storefront to Oxygen. Requires an Oxygen deployment token to be set with the `--token` flag or an environment variable (`SHOPIFY_HYDROGEN_DEPLOYMENT_TOKEN`). If the storefront is [linked](/docs/api/shopify-cli/hydrogen/hydrogen-link) then the Oxygen deployment token for the linked storefront will be used automatically.", - "overviewPreviewDescription": "Builds and deploys your Hydrogen storefront to Oxygen. Requires an Oxygen deployment token to be set with the `--token` flag or an environment variable (`SHOPIFY_HYDROGEN_DEPLOYMENT_TOKEN`). If the storefront is [linked](/docs/api/shopify-cli/hydrogen/hydrogen-link) then the Oxygen deployment token for the linked storefront will be used automatically.", + "description": "The following flags are available for the `hydrogen deploy` command:", + "overviewPreviewDescription": "The following flags are available for the `hydrogen deploy` command:", "type": "command", "isVisualComponent": false, "defaultExample": { @@ -4111,13 +4149,14 @@ "hydrogendeploy": { "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-deploy.interface.ts", "name": "hydrogendeploy", - "description": "", + "description": "The following flags are available for the `hydrogen deploy` command:", + "isPublicDocs": true, "members": [ { "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-deploy.interface.ts", "syntaxKind": "PropertySignature", "name": "--auth-bypass-token", - "value": "\"\"", + "value": "''", "description": "Generate an authentication bypass token, which can be used to perform end-to-end tests against the deployment.", "isOptional": true, "environmentValue": "AUTH_BYPASS_TOKEN" @@ -4177,7 +4216,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-deploy.interface.ts", "syntaxKind": "PropertySignature", "name": "--force-client-sourcemap", - "value": "\"\"", + "value": "''", "description": "Client sourcemapping is avoided by default because it makes backend code visible in the browser. Use this flag to force enabling it.", "isOptional": true, "environmentValue": "SHOPIFY_HYDROGEN_FLAG_FORCE_CLIENT_SOURCEMAP" @@ -4186,7 +4225,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-deploy.interface.ts", "syntaxKind": "PropertySignature", "name": "--json-output", - "value": "\"\"", + "value": "''", "description": "Create a JSON file containing the deployment details in CI environments. Defaults to true, use `--no-json-output` to disable.", "isOptional": true }, @@ -4194,7 +4233,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-deploy.interface.ts", "syntaxKind": "PropertySignature", "name": "--lockfile-check", - "value": "\"\"", + "value": "''", "description": "Checks that there is exactly one valid lockfile in the project. Defaults to `true`. Deactivate with `--no-lockfile-check`.", "isOptional": true, "environmentValue": "SHOPIFY_HYDROGEN_FLAG_LOCKFILE_CHECK" @@ -4221,7 +4260,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-deploy.interface.ts", "syntaxKind": "PropertySignature", "name": "--no-verify", - "value": "\"\"", + "value": "''", "description": "Skip the routability verification step after deployment.", "isOptional": true }, @@ -4238,7 +4277,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-deploy.interface.ts", "syntaxKind": "PropertySignature", "name": "--preview", - "value": "\"\"", + "value": "''", "description": "Deploys to the Preview environment.", "isOptional": true }, @@ -4246,7 +4285,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-deploy.interface.ts", "syntaxKind": "PropertySignature", "name": "-f, --force", - "value": "\"\"", + "value": "''", "description": "Forces a deployment to proceed if there are uncommited changes in its Git repository.", "isOptional": true, "environmentValue": "SHOPIFY_HYDROGEN_FLAG_FORCE" @@ -4280,8 +4319,8 @@ }, { "name": "hydrogen dev", - "description": "Runs a Hydrogen storefront in a local runtime that emulates an Oxygen worker for development.\n\n If your project is [linked](/docs/api/shopify-cli/hydrogen/hydrogen-link) to a Hydrogen storefront, then its environment variables will be loaded with the runtime.", - "overviewPreviewDescription": "Runs a Hydrogen storefront in a local runtime that emulates an Oxygen worker for development.\n\n If your project is [linked](/docs/api/shopify-cli/hydrogen/hydrogen-link) to a Hydrogen storefront, then its environment variables will be loaded with the runtime.", + "description": "The following flags are available for the `hydrogen dev` command:", + "overviewPreviewDescription": "The following flags are available for the `hydrogen dev` command:", "type": "command", "isVisualComponent": false, "defaultExample": { @@ -4305,13 +4344,14 @@ "hydrogendev": { "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-dev.interface.ts", "name": "hydrogendev", - "description": "", + "description": "The following flags are available for the `hydrogen dev` command:", + "isPublicDocs": true, "members": [ { "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-dev.interface.ts", "syntaxKind": "PropertySignature", "name": "--codegen", - "value": "\"\"", + "value": "''", "description": "Automatically generates GraphQL types for your project’s Storefront API queries.", "isOptional": true }, @@ -4327,7 +4367,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-dev.interface.ts", "syntaxKind": "PropertySignature", "name": "--customer-account-push", - "value": "\"\"", + "value": "''", "description": "Use tunneling for local development and push the tunneling domain to admin. Required to use Customer Account API's OAuth flow", "isOptional": true, "environmentValue": "SHOPIFY_HYDROGEN_FLAG_CUSTOMER_ACCOUNT_PUSH" @@ -4336,7 +4376,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-dev.interface.ts", "syntaxKind": "PropertySignature", "name": "--debug", - "value": "\"\"", + "value": "''", "description": "Enables inspector connections to the server with a debugger such as Visual Studio Code or Chrome DevTools.", "isOptional": true, "environmentValue": "SHOPIFY_HYDROGEN_FLAG_DEBUG" @@ -4345,7 +4385,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-dev.interface.ts", "syntaxKind": "PropertySignature", "name": "--disable-deps-optimizer", - "value": "\"\"", + "value": "''", "description": "Disable adding dependencies to Vite's `ssr.optimizeDeps.include` automatically", "isOptional": true, "environmentValue": "SHOPIFY_HYDROGEN_FLAG_DISABLE_DEPS_OPTIMIZER" @@ -4354,7 +4394,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-dev.interface.ts", "syntaxKind": "PropertySignature", "name": "--disable-version-check", - "value": "\"\"", + "value": "''", "description": "Skip the version check when running `hydrogen dev`", "isOptional": true }, @@ -4362,7 +4402,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-dev.interface.ts", "syntaxKind": "PropertySignature", "name": "--disable-virtual-routes", - "value": "\"\"", + "value": "''", "description": "Disable rendering fallback routes when a route file doesn't exist.", "isOptional": true, "environmentValue": "SHOPIFY_HYDROGEN_FLAG_DISABLE_VIRTUAL_ROUTES" @@ -4405,7 +4445,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-dev.interface.ts", "syntaxKind": "PropertySignature", "name": "--host", - "value": "\"\"", + "value": "''", "description": "Expose the server to the local network", "isOptional": true }, @@ -4440,7 +4480,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-dev.interface.ts", "syntaxKind": "PropertySignature", "name": "--verbose", - "value": "\"\"", + "value": "''", "description": "Outputs more information about the command's execution.", "isOptional": true, "environmentValue": "SHOPIFY_HYDROGEN_FLAG_VERBOSE" @@ -4456,8 +4496,8 @@ }, { "name": "hydrogen env list", - "description": "Lists all environments available on the linked Hydrogen storefront.", - "overviewPreviewDescription": "Lists all environments available on the linked Hydrogen storefront.", + "description": "The following flags are available for the `hydrogen env list` command:", + "overviewPreviewDescription": "The following flags are available for the `hydrogen env list` command:", "type": "command", "isVisualComponent": false, "defaultExample": { @@ -4481,7 +4521,8 @@ "hydrogenenvlist": { "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-env-list.interface.ts", "name": "hydrogenenvlist", - "description": "", + "description": "The following flags are available for the `hydrogen env list` command:", + "isPublicDocs": true, "members": [ { "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-env-list.interface.ts", @@ -4503,8 +4544,8 @@ }, { "name": "hydrogen env pull", - "description": "Pulls environment variables from the linked Hydrogen storefront and writes them to an `.env` file.", - "overviewPreviewDescription": "Pulls environment variables from the linked Hydrogen storefront and writes them to an `.env` file.", + "description": "The following flags are available for the `hydrogen env pull` command:", + "overviewPreviewDescription": "The following flags are available for the `hydrogen env pull` command:", "type": "command", "isVisualComponent": false, "defaultExample": { @@ -4528,7 +4569,8 @@ "hydrogenenvpull": { "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-env-pull.interface.ts", "name": "hydrogenenvpull", - "description": "", + "description": "The following flags are available for the `hydrogen env pull` command:", + "isPublicDocs": true, "members": [ { "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-env-pull.interface.ts", @@ -4568,7 +4610,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-env-pull.interface.ts", "syntaxKind": "PropertySignature", "name": "-f, --force", - "value": "\"\"", + "value": "''", "description": "Overwrites the destination directory and files if they already exist.", "isOptional": true, "environmentValue": "SHOPIFY_HYDROGEN_FLAG_FORCE" @@ -4584,8 +4626,8 @@ }, { "name": "hydrogen env push", - "description": "Push environment variables from the local .env file to your linked Hydrogen storefront.", - "overviewPreviewDescription": "Push environment variables from the local .env file to your linked Hydrogen storefront.", + "description": "The following flags are available for the `hydrogen env push` command:", + "overviewPreviewDescription": "The following flags are available for the `hydrogen env push` command:", "type": "command", "isVisualComponent": false, "defaultExample": { @@ -4609,7 +4651,8 @@ "hydrogenenvpush": { "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-env-push.interface.ts", "name": "hydrogenenvpush", - "description": "", + "description": "The following flags are available for the `hydrogen env push` command:", + "isPublicDocs": true, "members": [ { "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-env-push.interface.ts", @@ -4647,8 +4690,8 @@ }, { "name": "hydrogen generate route", - "description": "Generates a set of default routes from the starter template.", - "overviewPreviewDescription": "Generates a set of default routes from the starter template.", + "description": "The following flags are available for the `hydrogen generate route` command:", + "overviewPreviewDescription": "The following flags are available for the `hydrogen generate route` command:", "type": "command", "isVisualComponent": false, "defaultExample": { @@ -4672,7 +4715,8 @@ "hydrogengenerateroute": { "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-generate-route.interface.ts", "name": "hydrogengenerateroute", - "description": "", + "description": "The following flags are available for the `hydrogen generate route` command:", + "isPublicDocs": true, "members": [ { "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-generate-route.interface.ts", @@ -4705,7 +4749,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-generate-route.interface.ts", "syntaxKind": "PropertySignature", "name": "--typescript", - "value": "\"\"", + "value": "''", "description": "Generate TypeScript files", "isOptional": true, "environmentValue": "SHOPIFY_HYDROGEN_FLAG_TYPESCRIPT" @@ -4714,7 +4758,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-generate-route.interface.ts", "syntaxKind": "PropertySignature", "name": "-f, --force", - "value": "\"\"", + "value": "''", "description": "Overwrites the destination directory and files if they already exist.", "isOptional": true, "environmentValue": "SHOPIFY_HYDROGEN_FLAG_FORCE" @@ -4730,8 +4774,8 @@ }, { "name": "hydrogen generate routes", - "description": "Generates all supported standard shopify routes.", - "overviewPreviewDescription": "Generates all supported standard shopify routes.", + "description": "The following flags are available for the `hydrogen generate routes` command:", + "overviewPreviewDescription": "The following flags are available for the `hydrogen generate routes` command:", "type": "command", "isVisualComponent": false, "defaultExample": { @@ -4755,7 +4799,8 @@ "hydrogengenerateroutes": { "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-generate-routes.interface.ts", "name": "hydrogengenerateroutes", - "description": "", + "description": "The following flags are available for the `hydrogen generate routes` command:", + "isPublicDocs": true, "members": [ { "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-generate-routes.interface.ts", @@ -4788,7 +4833,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-generate-routes.interface.ts", "syntaxKind": "PropertySignature", "name": "--typescript", - "value": "\"\"", + "value": "''", "description": "Generate TypeScript files", "isOptional": true, "environmentValue": "SHOPIFY_HYDROGEN_FLAG_TYPESCRIPT" @@ -4797,7 +4842,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-generate-routes.interface.ts", "syntaxKind": "PropertySignature", "name": "-f, --force", - "value": "\"\"", + "value": "''", "description": "Overwrites the destination directory and files if they already exist.", "isOptional": true, "environmentValue": "SHOPIFY_HYDROGEN_FLAG_FORCE" @@ -4813,8 +4858,8 @@ }, { "name": "hydrogen init", - "description": "Creates a new Hydrogen storefront.", - "overviewPreviewDescription": "Creates a new Hydrogen storefront.", + "description": "The following flags are available for the `hydrogen init` command:", + "overviewPreviewDescription": "The following flags are available for the `hydrogen init` command:", "type": "command", "isVisualComponent": false, "defaultExample": { @@ -4838,13 +4883,14 @@ "hydrogeninit": { "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-init.interface.ts", "name": "hydrogeninit", - "description": "", + "description": "The following flags are available for the `hydrogen init` command:", + "isPublicDocs": true, "members": [ { "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-init.interface.ts", "syntaxKind": "PropertySignature", "name": "--git", - "value": "\"\"", + "value": "''", "description": "Init Git and create initial commits.", "isOptional": true, "environmentValue": "SHOPIFY_HYDROGEN_FLAG_GIT" @@ -4853,7 +4899,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-init.interface.ts", "syntaxKind": "PropertySignature", "name": "--install-deps", - "value": "\"\"", + "value": "''", "description": "Auto installs dependencies using the active package manager.", "isOptional": true, "environmentValue": "SHOPIFY_HYDROGEN_FLAG_INSTALL_DEPS" @@ -4880,7 +4926,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-init.interface.ts", "syntaxKind": "PropertySignature", "name": "--mock-shop", - "value": "\"\"", + "value": "''", "description": "Use mock.shop as the data source for the storefront.", "isOptional": true, "environmentValue": "SHOPIFY_HYDROGEN_FLAG_MOCK_DATA" @@ -4898,7 +4944,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-init.interface.ts", "syntaxKind": "PropertySignature", "name": "--quickstart", - "value": "\"\"", + "value": "''", "description": "Scaffolds a new Hydrogen project with a set of sensible defaults. Equivalent to `shopify hydrogen init --path hydrogen-quickstart --mock-shop --language js --shortcut --markets none`", "isOptional": true, "environmentValue": "SHOPIFY_HYDROGEN_FLAG_QUICKSTART" @@ -4907,7 +4953,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-init.interface.ts", "syntaxKind": "PropertySignature", "name": "--shortcut", - "value": "\"\"", + "value": "''", "description": "Creates a global h2 shortcut for Shopify CLI using shell aliases. Deactivate with `--no-shortcut`.", "isOptional": true, "environmentValue": "SHOPIFY_HYDROGEN_FLAG_SHORTCUT" @@ -4934,7 +4980,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-init.interface.ts", "syntaxKind": "PropertySignature", "name": "-f, --force", - "value": "\"\"", + "value": "''", "description": "Overwrites the destination directory and files if they already exist.", "isOptional": true, "environmentValue": "SHOPIFY_HYDROGEN_FLAG_FORCE" @@ -4950,8 +4996,8 @@ }, { "name": "hydrogen link", - "description": "Links your local development environment to a remote Hydrogen storefront. You can link an unlimited number of development environments to a single Hydrogen storefront.\n\n Linking to a Hydrogen storefront enables you to run [dev](/docs/api/shopify-cli/hydrogen/hydrogen-dev) and automatically inject your linked Hydrogen storefront's environment variables directly into the server runtime.\n\n After you run the `link` command, you can access the [env list](/docs/api/shopify-cli/hydrogen/hydrogen-env-list), [env pull](/docs/api/shopify-cli/hydrogen/hydrogen-env-pull), and [unlink](/docs/api/shopify-cli/hydrogen/hydrogen-unlink) commands.", - "overviewPreviewDescription": "Links your local development environment to a remote Hydrogen storefront. You can link an unlimited number of development environments to a single Hydrogen storefront.\n\n Linking to a Hydrogen storefront enables you to run [dev](/docs/api/shopify-cli/hydrogen/hydrogen-dev) and automatically inject your linked Hydrogen storefront's environment variables directly into the server runtime.\n\n After you run the `link` command, you can access the [env list](/docs/api/shopify-cli/hydrogen/hydrogen-env-list), [env pull](/docs/api/shopify-cli/hydrogen/hydrogen-env-pull), and [unlink](/docs/api/shopify-cli/hydrogen/hydrogen-unlink) commands.", + "description": "The following flags are available for the `hydrogen link` command:", + "overviewPreviewDescription": "The following flags are available for the `hydrogen link` command:", "type": "command", "isVisualComponent": false, "defaultExample": { @@ -4975,7 +5021,8 @@ "hydrogenlink": { "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-link.interface.ts", "name": "hydrogenlink", - "description": "", + "description": "The following flags are available for the `hydrogen link` command:", + "isPublicDocs": true, "members": [ { "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-link.interface.ts", @@ -4999,7 +5046,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-link.interface.ts", "syntaxKind": "PropertySignature", "name": "-f, --force", - "value": "\"\"", + "value": "''", "description": "Overwrites the destination directory and files if they already exist.", "isOptional": true, "environmentValue": "SHOPIFY_HYDROGEN_FLAG_FORCE" @@ -5015,8 +5062,8 @@ }, { "name": "hydrogen list", - "description": "Lists all remote Hydrogen storefronts available to link to your local development environment.", - "overviewPreviewDescription": "Lists all remote Hydrogen storefronts available to link to your local development environment.", + "description": "The following flags are available for the `hydrogen list` command:", + "overviewPreviewDescription": "The following flags are available for the `hydrogen list` command:", "type": "command", "isVisualComponent": false, "defaultExample": { @@ -5040,7 +5087,8 @@ "hydrogenlist": { "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-list.interface.ts", "name": "hydrogenlist", - "description": "", + "description": "The following flags are available for the `hydrogen list` command:", + "isPublicDocs": true, "members": [ { "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-list.interface.ts", @@ -5062,8 +5110,8 @@ }, { "name": "hydrogen login", - "description": "Logs in to the specified shop and saves the shop domain to the project.", - "overviewPreviewDescription": "Logs in to the specified shop and saves the shop domain to the project.", + "description": "The following flags are available for the `hydrogen login` command:", + "overviewPreviewDescription": "The following flags are available for the `hydrogen login` command:", "type": "command", "isVisualComponent": false, "defaultExample": { @@ -5087,7 +5135,8 @@ "hydrogenlogin": { "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-login.interface.ts", "name": "hydrogenlogin", - "description": "", + "description": "The following flags are available for the `hydrogen login` command:", + "isPublicDocs": true, "members": [ { "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-login.interface.ts", @@ -5118,8 +5167,8 @@ }, { "name": "hydrogen logout", - "description": "Log out from the current shop.", - "overviewPreviewDescription": "Log out from the current shop.", + "description": "The following flags are available for the `hydrogen logout` command:", + "overviewPreviewDescription": "The following flags are available for the `hydrogen logout` command:", "type": "command", "isVisualComponent": false, "defaultExample": { @@ -5143,7 +5192,8 @@ "hydrogenlogout": { "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-logout.interface.ts", "name": "hydrogenlogout", - "description": "", + "description": "The following flags are available for the `hydrogen logout` command:", + "isPublicDocs": true, "members": [ { "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-logout.interface.ts", @@ -5165,8 +5215,8 @@ }, { "name": "hydrogen preview", - "description": "Runs a server in your local development environment that serves your Hydrogen app's production build. Requires running the [build](/docs/api/shopify-cli/hydrogen/hydrogen-build) command first.", - "overviewPreviewDescription": "Runs a server in your local development environment that serves your Hydrogen app's production build. Requires running the [build](/docs/api/shopify-cli/hydrogen/hydrogen-build) command first.", + "description": "The following flags are available for the `hydrogen preview` command:", + "overviewPreviewDescription": "The following flags are available for the `hydrogen preview` command:", "type": "command", "isVisualComponent": false, "defaultExample": { @@ -5190,13 +5240,14 @@ "hydrogenpreview": { "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-preview.interface.ts", "name": "hydrogenpreview", - "description": "", + "description": "The following flags are available for the `hydrogen preview` command:", + "isPublicDocs": true, "members": [ { "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-preview.interface.ts", "syntaxKind": "PropertySignature", "name": "--build", - "value": "\"\"", + "value": "''", "description": "Builds the app before starting the preview server.", "isOptional": true }, @@ -5204,7 +5255,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-preview.interface.ts", "syntaxKind": "PropertySignature", "name": "--codegen", - "value": "\"\"", + "value": "''", "description": "Automatically generates GraphQL types for your project’s Storefront API queries.", "isOptional": true }, @@ -5220,7 +5271,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-preview.interface.ts", "syntaxKind": "PropertySignature", "name": "--debug", - "value": "\"\"", + "value": "''", "description": "Enables inspector connections to the server with a debugger such as Visual Studio Code or Chrome DevTools.", "isOptional": true, "environmentValue": "SHOPIFY_HYDROGEN_FLAG_DEBUG" @@ -5290,7 +5341,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-preview.interface.ts", "syntaxKind": "PropertySignature", "name": "--verbose", - "value": "\"\"", + "value": "''", "description": "Outputs more information about the command's execution.", "isOptional": true, "environmentValue": "SHOPIFY_HYDROGEN_FLAG_VERBOSE" @@ -5299,7 +5350,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-preview.interface.ts", "syntaxKind": "PropertySignature", "name": "--watch", - "value": "\"\"", + "value": "''", "description": "Watches for changes and rebuilds the project.", "isOptional": true } @@ -5314,8 +5365,8 @@ }, { "name": "hydrogen setup css", - "description": "Adds support for certain CSS strategies to your project.", - "overviewPreviewDescription": "Adds support for certain CSS strategies to your project.", + "description": "The following flags are available for the `hydrogen setup css` command:", + "overviewPreviewDescription": "The following flags are available for the `hydrogen setup css` command:", "type": "command", "isVisualComponent": false, "defaultExample": { @@ -5339,13 +5390,14 @@ "hydrogensetupcss": { "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-setup-css.interface.ts", "name": "hydrogensetupcss", - "description": "", + "description": "The following flags are available for the `hydrogen setup css` command:", + "isPublicDocs": true, "members": [ { "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-setup-css.interface.ts", "syntaxKind": "PropertySignature", "name": "--install-deps", - "value": "\"\"", + "value": "''", "description": "Auto installs dependencies using the active package manager.", "isOptional": true, "environmentValue": "SHOPIFY_HYDROGEN_FLAG_INSTALL_DEPS" @@ -5363,7 +5415,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-setup-css.interface.ts", "syntaxKind": "PropertySignature", "name": "-f, --force", - "value": "\"\"", + "value": "''", "description": "Overwrites the destination directory and files if they already exist.", "isOptional": true, "environmentValue": "SHOPIFY_HYDROGEN_FLAG_FORCE" @@ -5379,8 +5431,8 @@ }, { "name": "hydrogen setup markets", - "description": "Adds support for multiple [markets](/docs/custom-storefronts/hydrogen/markets) to your project by using the URL structure.", - "overviewPreviewDescription": "Adds support for multiple [markets](/docs/custom-storefronts/hydrogen/markets) to your project by using the URL structure.", + "description": "The following flags are available for the `hydrogen setup markets` command:", + "overviewPreviewDescription": "The following flags are available for the `hydrogen setup markets` command:", "type": "command", "isVisualComponent": false, "defaultExample": { @@ -5404,7 +5456,8 @@ "hydrogensetupmarkets": { "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-setup-markets.interface.ts", "name": "hydrogensetupmarkets", - "description": "", + "description": "The following flags are available for the `hydrogen setup markets` command:", + "isPublicDocs": true, "members": [ { "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-setup-markets.interface.ts", @@ -5426,8 +5479,8 @@ }, { "name": "hydrogen setup vite", - "description": "EXPERIMENTAL: Upgrades the project to use Vite.", - "overviewPreviewDescription": "EXPERIMENTAL: Upgrades the project to use Vite.", + "description": "The following flags are available for the `hydrogen setup vite` command:", + "overviewPreviewDescription": "The following flags are available for the `hydrogen setup vite` command:", "type": "command", "isVisualComponent": false, "defaultExample": { @@ -5451,7 +5504,8 @@ "hydrogensetupvite": { "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-setup-vite.interface.ts", "name": "hydrogensetupvite", - "description": "", + "description": "The following flags are available for the `hydrogen setup vite` command:", + "isPublicDocs": true, "members": [ { "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-setup-vite.interface.ts", @@ -5473,8 +5527,8 @@ }, { "name": "hydrogen setup", - "description": "Scaffold routes and core functionality.", - "overviewPreviewDescription": "Scaffold routes and core functionality.", + "description": "The following flags are available for the `hydrogen setup` command:", + "overviewPreviewDescription": "The following flags are available for the `hydrogen setup` command:", "type": "command", "isVisualComponent": false, "defaultExample": { @@ -5498,13 +5552,14 @@ "hydrogensetup": { "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-setup.interface.ts", "name": "hydrogensetup", - "description": "", + "description": "The following flags are available for the `hydrogen setup` command:", + "isPublicDocs": true, "members": [ { "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-setup.interface.ts", "syntaxKind": "PropertySignature", "name": "--install-deps", - "value": "\"\"", + "value": "''", "description": "Auto installs dependencies using the active package manager.", "isOptional": true, "environmentValue": "SHOPIFY_HYDROGEN_FLAG_INSTALL_DEPS" @@ -5531,7 +5586,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-setup.interface.ts", "syntaxKind": "PropertySignature", "name": "--shortcut", - "value": "\"\"", + "value": "''", "description": "Creates a global h2 shortcut for Shopify CLI using shell aliases. Deactivate with `--no-shortcut`.", "isOptional": true, "environmentValue": "SHOPIFY_HYDROGEN_FLAG_SHORTCUT" @@ -5540,7 +5595,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-setup.interface.ts", "syntaxKind": "PropertySignature", "name": "-f, --force", - "value": "\"\"", + "value": "''", "description": "Overwrites the destination directory and files if they already exist.", "isOptional": true, "environmentValue": "SHOPIFY_HYDROGEN_FLAG_FORCE" @@ -5578,8 +5633,8 @@ }, { "name": "hydrogen unlink", - "description": "Unlinks your local development environment from a remote Hydrogen storefront.", - "overviewPreviewDescription": "Unlinks your local development environment from a remote Hydrogen storefront.", + "description": "The following flags are available for the `hydrogen unlink` command:", + "overviewPreviewDescription": "The following flags are available for the `hydrogen unlink` command:", "type": "command", "isVisualComponent": false, "defaultExample": { @@ -5603,7 +5658,8 @@ "hydrogenunlink": { "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-unlink.interface.ts", "name": "hydrogenunlink", - "description": "", + "description": "The following flags are available for the `hydrogen unlink` command:", + "isPublicDocs": true, "members": [ { "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-unlink.interface.ts", @@ -5625,8 +5681,8 @@ }, { "name": "hydrogen upgrade", - "description": "Upgrade Hydrogen project dependencies, preview features, fixes and breaking changes. The command also generates an instruction file for each upgrade.", - "overviewPreviewDescription": "Upgrade Hydrogen project dependencies, preview features, fixes and breaking changes. The command also generates an instruction file for each upgrade.", + "description": "The following flags are available for the `hydrogen upgrade` command:", + "overviewPreviewDescription": "The following flags are available for the `hydrogen upgrade` command:", "type": "command", "isVisualComponent": false, "defaultExample": { @@ -5650,7 +5706,8 @@ "hydrogenupgrade": { "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-upgrade.interface.ts", "name": "hydrogenupgrade", - "description": "", + "description": "The following flags are available for the `hydrogen upgrade` command:", + "isPublicDocs": true, "members": [ { "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-upgrade.interface.ts", @@ -5665,7 +5722,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-upgrade.interface.ts", "syntaxKind": "PropertySignature", "name": "-f, --force", - "value": "\"\"", + "value": "''", "description": "Ignore warnings and force the upgrade to the target version", "isOptional": true, "environmentValue": "SHOPIFY_HYDROGEN_FLAG_FORCE" @@ -5689,7 +5746,7 @@ }, { "name": "organization list", - "description": "Lists the Shopify organizations that you have access to, along with their organization IDs.", + "description": "The following flags are available for the `organization list` command:", "overviewPreviewDescription": "List Shopify organizations you have access to.", "type": "command", "isVisualComponent": false, @@ -5714,13 +5771,14 @@ "organizationlist": { "filePath": "docs-shopify.dev/commands/interfaces/organization-list.interface.ts", "name": "organizationlist", - "description": "", + "description": "The following flags are available for the `organization list` command:", + "isPublicDocs": true, "members": [ { "filePath": "docs-shopify.dev/commands/interfaces/organization-list.interface.ts", "syntaxKind": "PropertySignature", "name": "--no-color", - "value": "\"\"", + "value": "''", "description": "Disable color output.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_NO_COLOR" @@ -5729,7 +5787,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/organization-list.interface.ts", "syntaxKind": "PropertySignature", "name": "--verbose", - "value": "\"\"", + "value": "''", "description": "Increase the verbosity of the output.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_VERBOSE" @@ -5738,7 +5796,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/organization-list.interface.ts", "syntaxKind": "PropertySignature", "name": "-j, --json", - "value": "\"\"", + "value": "''", "description": "Output the result as JSON. Automatically disables color output.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_JSON" @@ -5776,7 +5834,7 @@ }, { "name": "store auth", - "description": "Authenticates the app against the specified store for store commands and stores an online access token for later reuse.\n\nRe-run this command if the stored token is missing, expires, or no longer has the scopes you need.", + "description": "The following flags are available for the `store auth` command:", "overviewPreviewDescription": "Authenticate an app against a store for store commands.", "type": "command", "isVisualComponent": false, @@ -5801,13 +5859,14 @@ "storeauth": { "filePath": "docs-shopify.dev/commands/interfaces/store-auth.interface.ts", "name": "storeauth", - "description": "", + "description": "The following flags are available for the `store auth` command:", + "isPublicDocs": true, "members": [ { "filePath": "docs-shopify.dev/commands/interfaces/store-auth.interface.ts", "syntaxKind": "PropertySignature", "name": "--no-color", - "value": "\"\"", + "value": "''", "description": "Disable color output.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_NO_COLOR" @@ -5824,7 +5883,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/store-auth.interface.ts", "syntaxKind": "PropertySignature", "name": "--verbose", - "value": "\"\"", + "value": "''", "description": "Increase the verbosity of the output.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_VERBOSE" @@ -5848,7 +5907,7 @@ }, { "name": "store execute", - "description": "Executes an Admin API GraphQL query or mutation on the specified store using previously stored app authentication.\n\nRun `shopify store auth` first to create stored auth for the store.\n\nMutations are disabled by default. Re-run with `--allow-mutations` if you intend to modify store data.", + "description": "The following flags are available for the `store execute` command:", "overviewPreviewDescription": "Execute GraphQL queries and mutations on a store.", "type": "command", "isVisualComponent": false, @@ -5873,13 +5932,14 @@ "storeexecute": { "filePath": "docs-shopify.dev/commands/interfaces/store-execute.interface.ts", "name": "storeexecute", - "description": "", + "description": "The following flags are available for the `store execute` command:", + "isPublicDocs": true, "members": [ { "filePath": "docs-shopify.dev/commands/interfaces/store-execute.interface.ts", "syntaxKind": "PropertySignature", "name": "--allow-mutations", - "value": "\"\"", + "value": "''", "description": "Allow GraphQL mutations to run against the target store.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_ALLOW_MUTATIONS" @@ -5888,7 +5948,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/store-execute.interface.ts", "syntaxKind": "PropertySignature", "name": "--no-color", - "value": "\"\"", + "value": "''", "description": "Disable color output.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_NO_COLOR" @@ -5924,7 +5984,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/store-execute.interface.ts", "syntaxKind": "PropertySignature", "name": "--verbose", - "value": "\"\"", + "value": "''", "description": "Increase the verbosity of the output.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_VERBOSE" @@ -5975,7 +6035,7 @@ }, { "name": "theme check", - "description": "Calls and runs [Theme Check](/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.](/docs/themes/tools/theme-check/checks)", + "description": "The following flags are available for the `theme check` command:", "overviewPreviewDescription": "Validate the theme.", "type": "command", "isVisualComponent": false, @@ -6000,7 +6060,8 @@ "themecheck": { "filePath": "docs-shopify.dev/commands/interfaces/theme-check.interface.ts", "name": "themecheck", - "description": "", + "description": "The following flags are available for the `theme check` command:", + "isPublicDocs": true, "members": [ { "filePath": "docs-shopify.dev/commands/interfaces/theme-check.interface.ts", @@ -6015,7 +6076,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/theme-check.interface.ts", "syntaxKind": "PropertySignature", "name": "--init", - "value": "\"\"", + "value": "''", "description": "Generate a .theme-check.yml file", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_INIT" @@ -6024,7 +6085,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/theme-check.interface.ts", "syntaxKind": "PropertySignature", "name": "--list", - "value": "\"\"", + "value": "''", "description": "List enabled checks", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_LIST" @@ -6033,7 +6094,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/theme-check.interface.ts", "syntaxKind": "PropertySignature", "name": "--no-color", - "value": "\"\"", + "value": "''", "description": "Disable color output.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_NO_COLOR" @@ -6051,7 +6112,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/theme-check.interface.ts", "syntaxKind": "PropertySignature", "name": "--print", - "value": "\"\"", + "value": "''", "description": "Output active config to STDOUT", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_PRINT" @@ -6060,7 +6121,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/theme-check.interface.ts", "syntaxKind": "PropertySignature", "name": "--verbose", - "value": "\"\"", + "value": "''", "description": "Increase the verbosity of the output.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_VERBOSE" @@ -6069,7 +6130,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/theme-check.interface.ts", "syntaxKind": "PropertySignature", "name": "-a, --auto-correct", - "value": "\"\"", + "value": "''", "description": "Automatically fix offenses", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_AUTO_CORRECT" @@ -6105,7 +6166,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/theme-check.interface.ts", "syntaxKind": "PropertySignature", "name": "-v, --version", - "value": "\"\"", + "value": "''", "description": "Print Theme Check version", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_VERSION" @@ -6121,7 +6182,7 @@ }, { "name": "theme console", - "description": "Starts the Shopify Liquid REPL (read-eval-print loop) tool. This tool provides an interactive terminal interface for evaluating Liquid code and exploring Liquid objects, filters, and tags using real store data.\n\n You can also provide context to the console using a URL, as some Liquid objects are context-specific", + "description": "The following flags are available for the `theme console` command:", "overviewPreviewDescription": "Shopify Liquid REPL (read-eval-print loop) tool", "type": "command", "isVisualComponent": false, @@ -6146,13 +6207,14 @@ "themeconsole": { "filePath": "docs-shopify.dev/commands/interfaces/theme-console.interface.ts", "name": "themeconsole", - "description": "", + "description": "The following flags are available for the `theme console` command:", + "isPublicDocs": true, "members": [ { "filePath": "docs-shopify.dev/commands/interfaces/theme-console.interface.ts", "syntaxKind": "PropertySignature", "name": "--no-color", - "value": "\"\"", + "value": "''", "description": "Disable color output.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_NO_COLOR" @@ -6197,7 +6259,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/theme-console.interface.ts", "syntaxKind": "PropertySignature", "name": "--verbose", - "value": "\"\"", + "value": "''", "description": "Increase the verbosity of the output.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_VERBOSE" @@ -6231,7 +6293,7 @@ }, { "name": "theme delete", - "description": "Deletes a theme from your store.\n\n You can specify multiple themes by ID. If no theme is specified, then you're prompted to select the theme that you want to delete from the list of themes in your store.\n\n You're asked to confirm that you want to delete the specified themes before they are deleted. You can skip this confirmation using the `--force` flag.", + "description": "The following flags are available for the `theme delete` command:", "overviewPreviewDescription": "Delete remote themes from the connected store. This command can't be undone.", "type": "command", "isVisualComponent": false, @@ -6256,13 +6318,14 @@ "themedelete": { "filePath": "docs-shopify.dev/commands/interfaces/theme-delete.interface.ts", "name": "themedelete", - "description": "", + "description": "The following flags are available for the `theme delete` command:", + "isPublicDocs": true, "members": [ { "filePath": "docs-shopify.dev/commands/interfaces/theme-delete.interface.ts", "syntaxKind": "PropertySignature", "name": "--no-color", - "value": "\"\"", + "value": "''", "description": "Disable color output.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_NO_COLOR" @@ -6289,7 +6352,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/theme-delete.interface.ts", "syntaxKind": "PropertySignature", "name": "--verbose", - "value": "\"\"", + "value": "''", "description": "Increase the verbosity of the output.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_VERBOSE" @@ -6298,7 +6361,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/theme-delete.interface.ts", "syntaxKind": "PropertySignature", "name": "-a, --show-all", - "value": "\"\"", + "value": "''", "description": "Include others development themes in theme list.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_SHOW_ALL" @@ -6307,7 +6370,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/theme-delete.interface.ts", "syntaxKind": "PropertySignature", "name": "-d, --development", - "value": "\"\"", + "value": "''", "description": "Delete your development theme.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_DEVELOPMENT" @@ -6325,7 +6388,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/theme-delete.interface.ts", "syntaxKind": "PropertySignature", "name": "-f, --force", - "value": "\"\"", + "value": "''", "description": "Skip confirmation.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_FORCE" @@ -6359,7 +6422,7 @@ }, { "name": "theme dev", - "description": "\n Uploads the current theme as the specified theme, or a [development theme](/docs/themes/tools/cli#development-themes), to a store so you can preview it.\n\nThis command returns the following information:\n\n- A link to your development theme at http://127.0.0.1:9292. This URL can hot reload local changes to CSS and sections, or refresh the entire page when a file changes, enabling you to preview changes in real time using the store's data.\n\n You can specify a different network interface and port using `--host` and `--port`.\n\n- A link to the [editor](/docs/themes/tools/online-editor) for the theme in the Shopify admin.\n\n- A [preview link](https://help.shopify.com/manual/online-store/themes/adding-themes#share-a-theme-preview-with-others) that you can share with other developers.\n\nIf you already have a development theme for your current environment, then this command replaces the development theme with your local theme. You can override this using the `--theme-editor-sync` flag.\n\n> Note: You can't preview checkout customizations using http://127.0.0.1:9292.\n\nDevelopment themes are deleted when you run `shopify auth logout`. If you need a preview link that can be used after you log out, then you should [share](/docs/api/shopify-cli/theme/theme-share) your theme or [push](/docs/api/shopify-cli/theme/theme-push) to an unpublished theme on your store.\n\nYou can run this command only in a directory that matches the [default Shopify theme folder structure](/docs/themes/tools/cli#directory-structure).", + "description": "The following flags are available for the `theme dev` command:", "overviewPreviewDescription": "Uploads the current theme as a development theme to the connected store, then prints theme editor and preview URLs to your terminal. While running, changes will push to the store in real time.", "type": "command", "isVisualComponent": false, @@ -6384,14 +6447,15 @@ "themedev": { "filePath": "docs-shopify.dev/commands/interfaces/theme-dev.interface.ts", "name": "themedev", - "description": "", + "description": "The following flags are available for the `theme dev` command:", + "isPublicDocs": true, "members": [ { "filePath": "docs-shopify.dev/commands/interfaces/theme-dev.interface.ts", "syntaxKind": "PropertySignature", "name": "--error-overlay ", "value": "string", - "description": "Controls the visibility of the error overlay when an theme asset upload fails: - silent Prevents the error overlay from appearing. - default Displays the error overlay.", + "description": "Controls the visibility of the error overlay when an theme asset upload fails:\n- silent Prevents the error overlay from appearing.\n- default Displays the error overlay.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_ERROR_OVERLAY" }, @@ -6418,7 +6482,7 @@ "syntaxKind": "PropertySignature", "name": "--live-reload ", "value": "string", - "description": "The live reload mode switches the server behavior when a file is modified: - hot-reload Hot reloads local changes to CSS and sections (default) - full-page Always refreshes the entire page - off Deactivate live reload", + "description": "The live reload mode switches the server behavior when a file is modified:\n- hot-reload Hot reloads local changes to CSS and sections (default)\n- full-page Always refreshes the entire page\n- off Deactivate live reload", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_LIVE_RELOAD" }, @@ -6426,7 +6490,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/theme-dev.interface.ts", "syntaxKind": "PropertySignature", "name": "--no-color", - "value": "\"\"", + "value": "''", "description": "Disable color output.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_NO_COLOR" @@ -6444,7 +6508,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/theme-dev.interface.ts", "syntaxKind": "PropertySignature", "name": "--open", - "value": "\"\"", + "value": "''", "description": "Automatically launch the theme preview in your default web browser.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_OPEN" @@ -6489,7 +6553,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/theme-dev.interface.ts", "syntaxKind": "PropertySignature", "name": "--theme-editor-sync", - "value": "\"\"", + "value": "''", "description": "Synchronize Theme Editor updates in the local theme files.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_THEME_EDITOR_SYNC" @@ -6498,7 +6562,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/theme-dev.interface.ts", "syntaxKind": "PropertySignature", "name": "--verbose", - "value": "\"\"", + "value": "''", "description": "Increase the verbosity of the output.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_VERBOSE" @@ -6507,7 +6571,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/theme-dev.interface.ts", "syntaxKind": "PropertySignature", "name": "-a, --allow-live", - "value": "\"\"", + "value": "''", "description": "Allow development on a live theme.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_ALLOW_LIVE" @@ -6525,7 +6589,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/theme-dev.interface.ts", "syntaxKind": "PropertySignature", "name": "-n, --nodelete", - "value": "\"\"", + "value": "''", "description": "Prevents files from being deleted in the remote theme when a file has been deleted locally. This applies to files that are deleted while the command is running, and files that have been deleted locally before the command is run.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_NODELETE" @@ -6577,7 +6641,7 @@ }, { "name": "theme duplicate", - "description": "If you want to duplicate your local theme, you need to run `shopify theme push` first.\n\nIf no theme ID is specified, you're prompted to select the theme that you want to duplicate from the list of themes in your store. You're asked to confirm that you want to duplicate the specified theme.\n\nPrompts and confirmations are not shown when duplicate is run in a CI environment or the `--force` flag is used, therefore you must specify a theme ID using the `--theme` flag.\n\nYou can optionally name the duplicated theme using the `--name` flag.\n\nIf you use the `--json` flag, then theme information is returned in JSON format, which can be used as a machine-readable input for scripts or continuous integration.\n\nSample JSON output:\n\n```json\n{\n \"theme\": {\n \"id\": 108267175958,\n \"name\": \"A Duplicated Theme\",\n \"role\": \"unpublished\",\n \"shop\": \"mystore.myshopify.com\"\n }\n}\n```\n\n```json\n{\n \"message\": \"The theme 'Summer Edition' could not be duplicated due to errors\",\n \"errors\": [\"Maximum number of themes reached\"],\n \"requestId\": \"12345-abcde-67890\"\n}\n```", + "description": "The following flags are available for the `theme duplicate` command:", "overviewPreviewDescription": "Duplicates a theme from your theme library.", "type": "command", "isVisualComponent": false, @@ -6602,13 +6666,14 @@ "themeduplicate": { "filePath": "docs-shopify.dev/commands/interfaces/theme-duplicate.interface.ts", "name": "themeduplicate", - "description": "", + "description": "The following flags are available for the `theme duplicate` command:", + "isPublicDocs": true, "members": [ { "filePath": "docs-shopify.dev/commands/interfaces/theme-duplicate.interface.ts", "syntaxKind": "PropertySignature", "name": "--no-color", - "value": "\"\"", + "value": "''", "description": "Disable color output.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_NO_COLOR" @@ -6626,7 +6691,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/theme-duplicate.interface.ts", "syntaxKind": "PropertySignature", "name": "--verbose", - "value": "\"\"", + "value": "''", "description": "Increase the verbosity of the output.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_VERBOSE" @@ -6644,7 +6709,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/theme-duplicate.interface.ts", "syntaxKind": "PropertySignature", "name": "-f, --force", - "value": "\"\"", + "value": "''", "description": "Force the duplicate operation to run without prompts or confirmations.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_FORCE" @@ -6653,7 +6718,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/theme-duplicate.interface.ts", "syntaxKind": "PropertySignature", "name": "-j, --json", - "value": "\"\"", + "value": "''", "description": "Output the result as JSON. Automatically disables color output.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_JSON" @@ -6696,8 +6761,8 @@ }, { "name": "theme info", - "description": "Displays information about your theme environment, including your current store. Can also retrieve information about a specific theme.", - "overviewPreviewDescription": "Displays information about your theme environment, including your current store. Can also retrieve information about a specific theme.", + "description": "The following flags are available for the `theme info` command:", + "overviewPreviewDescription": "The following flags are available for the `theme info` command:", "type": "command", "isVisualComponent": false, "defaultExample": { @@ -6721,13 +6786,14 @@ "themeinfo": { "filePath": "docs-shopify.dev/commands/interfaces/theme-info.interface.ts", "name": "themeinfo", - "description": "", + "description": "The following flags are available for the `theme info` command:", + "isPublicDocs": true, "members": [ { "filePath": "docs-shopify.dev/commands/interfaces/theme-info.interface.ts", "syntaxKind": "PropertySignature", "name": "--no-color", - "value": "\"\"", + "value": "''", "description": "Disable color output.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_NO_COLOR" @@ -6754,7 +6820,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/theme-info.interface.ts", "syntaxKind": "PropertySignature", "name": "--verbose", - "value": "\"\"", + "value": "''", "description": "Increase the verbosity of the output.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_VERBOSE" @@ -6763,7 +6829,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/theme-info.interface.ts", "syntaxKind": "PropertySignature", "name": "-d, --development", - "value": "\"\"", + "value": "''", "description": "Retrieve info from your development theme.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_DEVELOPMENT" @@ -6781,7 +6847,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/theme-info.interface.ts", "syntaxKind": "PropertySignature", "name": "-j, --json", - "value": "\"\"", + "value": "''", "description": "Output the result as JSON. Automatically disables color output.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_JSON" @@ -6815,7 +6881,7 @@ }, { "name": "theme init", - "description": "Clones a Git repository to your local machine to use as the starting point for building a theme.\n\n If no Git repository is specified, then this command creates a copy of Shopify's [Skeleton theme](https://github.com/Shopify/skeleton-theme.git), with the specified name in the current folder. If no name is provided, then you're prompted to enter one.\n\n > Caution: If you're building a theme for the Shopify Theme Store, then you can use our example theme as a starting point. However, the theme that you submit needs to be [substantively different from existing themes](/docs/themes/store/requirements#uniqueness) so that it provides added value for users.\n ", + "description": "The following flags are available for the `theme init` command:", "overviewPreviewDescription": "Clones a Git repository to use as a starting point for building a new theme.", "type": "command", "isVisualComponent": false, @@ -6840,13 +6906,14 @@ "themeinit": { "filePath": "docs-shopify.dev/commands/interfaces/theme-init.interface.ts", "name": "themeinit", - "description": "", + "description": "The following flags are available for the `theme init` command:", + "isPublicDocs": true, "members": [ { "filePath": "docs-shopify.dev/commands/interfaces/theme-init.interface.ts", "syntaxKind": "PropertySignature", "name": "--no-color", - "value": "\"\"", + "value": "''", "description": "Disable color output.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_NO_COLOR" @@ -6864,7 +6931,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/theme-init.interface.ts", "syntaxKind": "PropertySignature", "name": "--verbose", - "value": "\"\"", + "value": "''", "description": "Increase the verbosity of the output.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_VERBOSE" @@ -6873,7 +6940,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/theme-init.interface.ts", "syntaxKind": "PropertySignature", "name": "-l, --latest", - "value": "\"\"", + "value": "''", "description": "Downloads the latest release of the `clone-url`", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_LATEST" @@ -6898,7 +6965,7 @@ }, { "name": "theme language-server", - "description": "Starts the [Language Server](/docs/themes/tools/cli/language-server).", + "description": "The following flags are available for the `theme language-server` command:", "overviewPreviewDescription": "Start a Language Server Protocol server.", "type": "command", "isVisualComponent": false, @@ -6923,13 +6990,14 @@ "themelanguageserver": { "filePath": "docs-shopify.dev/commands/interfaces/theme-language-server.interface.ts", "name": "themelanguageserver", - "description": "", + "description": "The following flags are available for the `theme language-server` command:", + "isPublicDocs": true, "members": [ { "filePath": "docs-shopify.dev/commands/interfaces/theme-language-server.interface.ts", "syntaxKind": "PropertySignature", "name": "--no-color", - "value": "\"\"", + "value": "''", "description": "Disable color output.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_NO_COLOR" @@ -6938,7 +7006,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/theme-language-server.interface.ts", "syntaxKind": "PropertySignature", "name": "--verbose", - "value": "\"\"", + "value": "''", "description": "Increase the verbosity of the output.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_VERBOSE" @@ -6954,8 +7022,8 @@ }, { "name": "theme list", - "description": "Lists the themes in your store, along with their IDs and statuses.", - "overviewPreviewDescription": "Lists the themes in your store, along with their IDs and statuses.", + "description": "The following flags are available for the `theme list` command:", + "overviewPreviewDescription": "The following flags are available for the `theme list` command:", "type": "command", "isVisualComponent": false, "defaultExample": { @@ -6979,7 +7047,8 @@ "themelist": { "filePath": "docs-shopify.dev/commands/interfaces/theme-list.interface.ts", "name": "themelist", - "description": "", + "description": "The following flags are available for the `theme list` command:", + "isPublicDocs": true, "members": [ { "filePath": "docs-shopify.dev/commands/interfaces/theme-list.interface.ts", @@ -7003,7 +7072,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/theme-list.interface.ts", "syntaxKind": "PropertySignature", "name": "--no-color", - "value": "\"\"", + "value": "''", "description": "Disable color output.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_NO_COLOR" @@ -7039,7 +7108,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/theme-list.interface.ts", "syntaxKind": "PropertySignature", "name": "--verbose", - "value": "\"\"", + "value": "''", "description": "Increase the verbosity of the output.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_VERBOSE" @@ -7057,7 +7126,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/theme-list.interface.ts", "syntaxKind": "PropertySignature", "name": "-j, --json", - "value": "\"\"", + "value": "''", "description": "Output the result as JSON. Automatically disables color output.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_JSON" @@ -7082,7 +7151,7 @@ }, { "name": "theme metafields pull", - "description": "Retrieves metafields from Shopify Admin.\n\nIf the metafields file already exists, it will be overwritten.", + "description": "The following flags are available for the `theme metafields pull` command:", "overviewPreviewDescription": "Download metafields definitions from your shop into a local file.", "type": "command", "isVisualComponent": false, @@ -7107,13 +7176,14 @@ "thememetafieldspull": { "filePath": "docs-shopify.dev/commands/interfaces/theme-metafields-pull.interface.ts", "name": "thememetafieldspull", - "description": "", + "description": "The following flags are available for the `theme metafields pull` command:", + "isPublicDocs": true, "members": [ { "filePath": "docs-shopify.dev/commands/interfaces/theme-metafields-pull.interface.ts", "syntaxKind": "PropertySignature", "name": "--no-color", - "value": "\"\"", + "value": "''", "description": "Disable color output.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_NO_COLOR" @@ -7140,7 +7210,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/theme-metafields-pull.interface.ts", "syntaxKind": "PropertySignature", "name": "--verbose", - "value": "\"\"", + "value": "''", "description": "Increase the verbosity of the output.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_VERBOSE" @@ -7174,7 +7244,7 @@ }, { "name": "theme open", - "description": "Returns links that let you preview the specified theme. The following links are returned:\n\n - A link to the [editor](/docs/themes/tools/online-editor) for the theme in the Shopify admin.\n - A [preview link](https://help.shopify.com/manual/online-store/themes/adding-themes#share-a-theme-preview-with-others) that you can share with other developers.\n\n If you don't specify a theme, then you're prompted to select the theme to open from the list of the themes in your store.", + "description": "The following flags are available for the `theme open` command:", "overviewPreviewDescription": "Opens the preview of your remote theme.", "type": "command", "isVisualComponent": false, @@ -7199,13 +7269,14 @@ "themeopen": { "filePath": "docs-shopify.dev/commands/interfaces/theme-open.interface.ts", "name": "themeopen", - "description": "", + "description": "The following flags are available for the `theme open` command:", + "isPublicDocs": true, "members": [ { "filePath": "docs-shopify.dev/commands/interfaces/theme-open.interface.ts", "syntaxKind": "PropertySignature", "name": "--no-color", - "value": "\"\"", + "value": "''", "description": "Disable color output.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_NO_COLOR" @@ -7232,7 +7303,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/theme-open.interface.ts", "syntaxKind": "PropertySignature", "name": "--verbose", - "value": "\"\"", + "value": "''", "description": "Increase the verbosity of the output.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_VERBOSE" @@ -7241,7 +7312,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/theme-open.interface.ts", "syntaxKind": "PropertySignature", "name": "-d, --development", - "value": "\"\"", + "value": "''", "description": "Open your development theme.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_DEVELOPMENT" @@ -7250,7 +7321,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/theme-open.interface.ts", "syntaxKind": "PropertySignature", "name": "-E, --editor", - "value": "\"\"", + "value": "''", "description": "Open the theme editor for the specified theme in the browser.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_EDITOR" @@ -7268,7 +7339,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/theme-open.interface.ts", "syntaxKind": "PropertySignature", "name": "-l, --live", - "value": "\"\"", + "value": "''", "description": "Open your live (published) theme.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_LIVE" @@ -7302,7 +7373,7 @@ }, { "name": "theme package", - "description": "Packages your local theme files into a ZIP file that can be uploaded to Shopify.\n\n Only folders that match the [default Shopify theme folder structure](/docs/storefronts/themes/tools/cli#directory-structure) are included in the package.\n\n The package includes the `listings` directory if present (required for multi-preset themes per [Theme Store requirements](/docs/storefronts/themes/store/requirements#adding-presets-to-your-theme-zip-submission)).\n\n The ZIP file uses the name `theme_name-theme_version.zip`, based on parameters in your [settings_schema.json](/docs/storefronts/themes/architecture/config/settings-schema-json) file.", + "description": "The following flags are available for the `theme package` command:", "overviewPreviewDescription": "Package your theme into a .zip file, ready to upload to the Online Store.", "type": "command", "isVisualComponent": false, @@ -7327,13 +7398,14 @@ "themepackage": { "filePath": "docs-shopify.dev/commands/interfaces/theme-package.interface.ts", "name": "themepackage", - "description": "", + "description": "The following flags are available for the `theme package` command:", + "isPublicDocs": true, "members": [ { "filePath": "docs-shopify.dev/commands/interfaces/theme-package.interface.ts", "syntaxKind": "PropertySignature", "name": "--no-color", - "value": "\"\"", + "value": "''", "description": "Disable color output.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_NO_COLOR" @@ -7351,7 +7423,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/theme-package.interface.ts", "syntaxKind": "PropertySignature", "name": "--verbose", - "value": "\"\"", + "value": "''", "description": "Increase the verbosity of the output.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_VERBOSE" @@ -7367,7 +7439,7 @@ }, { "name": "theme preview", - "description": "Applies a JSON overrides file to a theme and creates or updates a preview. This lets you quickly preview changes.\n\n The command returns a preview URL and a preview identifier. You can reuse the preview identifier with `--preview-id` to update an existing preview instead of creating a new one.", + "description": "The following flags are available for the `theme preview` command:", "overviewPreviewDescription": "Applies JSON overrides to a theme and returns a preview URL.", "type": "command", "isVisualComponent": false, @@ -7392,13 +7464,14 @@ "themepreview": { "filePath": "docs-shopify.dev/commands/interfaces/theme-preview.interface.ts", "name": "themepreview", - "description": "", + "description": "The following flags are available for the `theme preview` command:", + "isPublicDocs": true, "members": [ { "filePath": "docs-shopify.dev/commands/interfaces/theme-preview.interface.ts", "syntaxKind": "PropertySignature", "name": "--json", - "value": "\"\"", + "value": "''", "description": "Output the preview URL and identifier as JSON.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_JSON" @@ -7407,7 +7480,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/theme-preview.interface.ts", "syntaxKind": "PropertySignature", "name": "--no-color", - "value": "\"\"", + "value": "''", "description": "Disable color output.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_NO_COLOR" @@ -7416,7 +7489,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/theme-preview.interface.ts", "syntaxKind": "PropertySignature", "name": "--open", - "value": "\"\"", + "value": "''", "description": "Automatically launch the theme preview in your default web browser.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_OPEN" @@ -7460,7 +7533,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/theme-preview.interface.ts", "syntaxKind": "PropertySignature", "name": "--verbose", - "value": "\"\"", + "value": "''", "description": "Increase the verbosity of the output.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_VERBOSE" @@ -7502,7 +7575,7 @@ }, { "name": "theme profile", - "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.", + "description": "The following flags are available for the `theme profile` command:", "overviewPreviewDescription": "Profile the Liquid rendering of a theme page.", "type": "command", "isVisualComponent": false, @@ -7527,13 +7600,14 @@ "themeprofile": { "filePath": "docs-shopify.dev/commands/interfaces/theme-profile.interface.ts", "name": "themeprofile", - "description": "", + "description": "The following flags are available for the `theme profile` command:", + "isPublicDocs": true, "members": [ { "filePath": "docs-shopify.dev/commands/interfaces/theme-profile.interface.ts", "syntaxKind": "PropertySignature", "name": "--no-color", - "value": "\"\"", + "value": "''", "description": "Disable color output.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_NO_COLOR" @@ -7578,7 +7652,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/theme-profile.interface.ts", "syntaxKind": "PropertySignature", "name": "--verbose", - "value": "\"\"", + "value": "''", "description": "Increase the verbosity of the output.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_VERBOSE" @@ -7596,7 +7670,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/theme-profile.interface.ts", "syntaxKind": "PropertySignature", "name": "-j, --json", - "value": "\"\"", + "value": "''", "description": "Output the result as JSON. Automatically disables color output.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_JSON" @@ -7630,7 +7704,7 @@ }, { "name": "theme publish", - "description": "Publishes an unpublished theme from your theme library.\n\nIf no theme ID is specified, then you're prompted to select the theme that you want to publish from the list of themes in your store.\n\nYou can run this command only in a directory that matches the [default Shopify theme folder structure](/docs/themes/tools/cli#directory-structure).\n\nIf you want to publish your local theme, then you need to run `shopify theme push` first. You're asked to confirm that you want to publish the specified theme. You can skip this confirmation using the `--force` flag.", + "description": "The following flags are available for the `theme publish` command:", "overviewPreviewDescription": "Set a remote theme as the live theme.", "type": "command", "isVisualComponent": false, @@ -7655,13 +7729,14 @@ "themepublish": { "filePath": "docs-shopify.dev/commands/interfaces/theme-publish.interface.ts", "name": "themepublish", - "description": "", + "description": "The following flags are available for the `theme publish` command:", + "isPublicDocs": true, "members": [ { "filePath": "docs-shopify.dev/commands/interfaces/theme-publish.interface.ts", "syntaxKind": "PropertySignature", "name": "--no-color", - "value": "\"\"", + "value": "''", "description": "Disable color output.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_NO_COLOR" @@ -7688,7 +7763,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/theme-publish.interface.ts", "syntaxKind": "PropertySignature", "name": "--verbose", - "value": "\"\"", + "value": "''", "description": "Increase the verbosity of the output.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_VERBOSE" @@ -7706,7 +7781,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/theme-publish.interface.ts", "syntaxKind": "PropertySignature", "name": "-f, --force", - "value": "\"\"", + "value": "''", "description": "Skip confirmation.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_FORCE" @@ -7740,7 +7815,7 @@ }, { "name": "theme pull", - "description": "Retrieves theme files from Shopify.\n\nIf no theme is specified, then you're prompted to select the theme to pull from the list of the themes in your store.", + "description": "The following flags are available for the `theme pull` command:", "overviewPreviewDescription": "Download your remote theme files locally.", "type": "command", "isVisualComponent": false, @@ -7765,13 +7840,14 @@ "themepull": { "filePath": "docs-shopify.dev/commands/interfaces/theme-pull.interface.ts", "name": "themepull", - "description": "", + "description": "The following flags are available for the `theme pull` command:", + "isPublicDocs": true, "members": [ { "filePath": "docs-shopify.dev/commands/interfaces/theme-pull.interface.ts", "syntaxKind": "PropertySignature", "name": "--no-color", - "value": "\"\"", + "value": "''", "description": "Disable color output.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_NO_COLOR" @@ -7798,7 +7874,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/theme-pull.interface.ts", "syntaxKind": "PropertySignature", "name": "--verbose", - "value": "\"\"", + "value": "''", "description": "Increase the verbosity of the output.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_VERBOSE" @@ -7807,7 +7883,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/theme-pull.interface.ts", "syntaxKind": "PropertySignature", "name": "-d, --development", - "value": "\"\"", + "value": "''", "description": "Pull theme files from your remote development theme.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_DEVELOPMENT" @@ -7825,7 +7901,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/theme-pull.interface.ts", "syntaxKind": "PropertySignature", "name": "-l, --live", - "value": "\"\"", + "value": "''", "description": "Pull theme files from your remote live theme.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_LIVE" @@ -7834,7 +7910,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/theme-pull.interface.ts", "syntaxKind": "PropertySignature", "name": "-n, --nodelete", - "value": "\"\"", + "value": "''", "description": "Prevent deleting local files that don't exist remotely.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_NODELETE" @@ -7886,7 +7962,7 @@ }, { "name": "theme push", - "description": "Uploads your local theme files to Shopify, overwriting the remote version if specified.\n\n If no theme is specified, then you're prompted to select the theme to overwrite from the list of the themes in your store.\n\n You can run this command only in a directory that matches the [default Shopify theme folder structure](/docs/themes/tools/cli#directory-structure).\n\n This command returns the following information:\n\n - A link to the [editor](/docs/themes/tools/online-editor) for the theme in the Shopify admin.\n - A [preview link](https://help.shopify.com/manual/online-store/themes/adding-themes#share-a-theme-preview-with-others) that you can share with others.\n\n If you use the `--json` flag, then theme information is returned in JSON format, which can be used as a machine-readable input for scripts or continuous integration.\n\n Sample output:\n\n ```json\n {\n \"theme\": {\n \"id\": 108267175958,\n \"name\": \"MyTheme\",\n \"role\": \"unpublished\",\n \"shop\": \"mystore.myshopify.com\",\n \"editor_url\": \"https://mystore.myshopify.com/admin/themes/108267175958/editor\",\n \"preview_url\": \"https://mystore.myshopify.com/?preview_theme_id=108267175958\"\n }\n }\n ```\n ", + "description": "The following flags are available for the `theme push` command:", "overviewPreviewDescription": "Uploads your local theme files to the connected store, overwriting the remote version if specified.", "type": "command", "isVisualComponent": false, @@ -7911,7 +7987,8 @@ "themepush": { "filePath": "docs-shopify.dev/commands/interfaces/theme-push.interface.ts", "name": "themepush", - "description": "", + "description": "The following flags are available for the `theme push` command:", + "isPublicDocs": true, "members": [ { "filePath": "docs-shopify.dev/commands/interfaces/theme-push.interface.ts", @@ -7926,7 +8003,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/theme-push.interface.ts", "syntaxKind": "PropertySignature", "name": "--no-color", - "value": "\"\"", + "value": "''", "description": "Disable color output.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_NO_COLOR" @@ -7953,7 +8030,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/theme-push.interface.ts", "syntaxKind": "PropertySignature", "name": "--strict", - "value": "\"\"", + "value": "''", "description": "Require theme check to pass without errors before pushing. Warnings are allowed.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_STRICT_PUSH" @@ -7962,7 +8039,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/theme-push.interface.ts", "syntaxKind": "PropertySignature", "name": "--verbose", - "value": "\"\"", + "value": "''", "description": "Increase the verbosity of the output.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_VERBOSE" @@ -7971,7 +8048,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/theme-push.interface.ts", "syntaxKind": "PropertySignature", "name": "-a, --allow-live", - "value": "\"\"", + "value": "''", "description": "Allow push to a live theme.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_ALLOW_LIVE" @@ -7989,7 +8066,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/theme-push.interface.ts", "syntaxKind": "PropertySignature", "name": "-d, --development", - "value": "\"\"", + "value": "''", "description": "Push theme files from your remote development theme.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_DEVELOPMENT" @@ -8007,7 +8084,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/theme-push.interface.ts", "syntaxKind": "PropertySignature", "name": "-j, --json", - "value": "\"\"", + "value": "''", "description": "Output the result as JSON. Automatically disables color output.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_JSON" @@ -8016,7 +8093,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/theme-push.interface.ts", "syntaxKind": "PropertySignature", "name": "-l, --live", - "value": "\"\"", + "value": "''", "description": "Push theme files from your remote live theme.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_LIVE" @@ -8025,7 +8102,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/theme-push.interface.ts", "syntaxKind": "PropertySignature", "name": "-n, --nodelete", - "value": "\"\"", + "value": "''", "description": "Prevent deleting remote files that don't exist locally.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_NODELETE" @@ -8043,7 +8120,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/theme-push.interface.ts", "syntaxKind": "PropertySignature", "name": "-p, --publish", - "value": "\"\"", + "value": "''", "description": "Publish as the live theme after uploading.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_PUBLISH" @@ -8070,7 +8147,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/theme-push.interface.ts", "syntaxKind": "PropertySignature", "name": "-u, --unpublished", - "value": "\"\"", + "value": "''", "description": "Create a new unpublished theme and push to it.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_UNPUBLISHED" @@ -8095,7 +8172,7 @@ }, { "name": "theme rename", - "description": "Renames a theme in your store.\n\n If no theme is specified, then you're prompted to select the theme that you want to rename from the list of themes in your store.\n ", + "description": "The following flags are available for the `theme rename` command:", "overviewPreviewDescription": "Renames an existing theme.", "type": "command", "isVisualComponent": false, @@ -8120,13 +8197,14 @@ "themerename": { "filePath": "docs-shopify.dev/commands/interfaces/theme-rename.interface.ts", "name": "themerename", - "description": "", + "description": "The following flags are available for the `theme rename` command:", + "isPublicDocs": true, "members": [ { "filePath": "docs-shopify.dev/commands/interfaces/theme-rename.interface.ts", "syntaxKind": "PropertySignature", "name": "--no-color", - "value": "\"\"", + "value": "''", "description": "Disable color output.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_NO_COLOR" @@ -8153,7 +8231,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/theme-rename.interface.ts", "syntaxKind": "PropertySignature", "name": "--verbose", - "value": "\"\"", + "value": "''", "description": "Increase the verbosity of the output.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_VERBOSE" @@ -8162,7 +8240,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/theme-rename.interface.ts", "syntaxKind": "PropertySignature", "name": "-d, --development", - "value": "\"\"", + "value": "''", "description": "Rename your development theme.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_DEVELOPMENT" @@ -8180,7 +8258,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/theme-rename.interface.ts", "syntaxKind": "PropertySignature", "name": "-l, --live", - "value": "\"\"", + "value": "''", "description": "Rename your remote live theme.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_LIVE" @@ -8223,7 +8301,7 @@ }, { "name": "theme share", - "description": "Uploads your theme as a new, unpublished theme in your theme library. The theme is given a randomized name.\n\n This command returns a [preview link](https://help.shopify.com/manual/online-store/themes/adding-themes#share-a-theme-preview-with-others) that you can share with others.", + "description": "The following flags are available for the `theme share` command:", "overviewPreviewDescription": "Creates a shareable, unpublished, and new theme on your theme library with a randomized name.", "type": "command", "isVisualComponent": false, @@ -8248,7 +8326,8 @@ "themeshare": { "filePath": "docs-shopify.dev/commands/interfaces/theme-share.interface.ts", "name": "themeshare", - "description": "", + "description": "The following flags are available for the `theme share` command:", + "isPublicDocs": true, "members": [ { "filePath": "docs-shopify.dev/commands/interfaces/theme-share.interface.ts", @@ -8263,7 +8342,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/theme-share.interface.ts", "syntaxKind": "PropertySignature", "name": "--no-color", - "value": "\"\"", + "value": "''", "description": "Disable color output.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_NO_COLOR" @@ -8290,7 +8369,7 @@ "filePath": "docs-shopify.dev/commands/interfaces/theme-share.interface.ts", "syntaxKind": "PropertySignature", "name": "--verbose", - "value": "\"\"", + "value": "''", "description": "Increase the verbosity of the output.", "isOptional": true, "environmentValue": "SHOPIFY_FLAG_VERBOSE" diff --git a/docs-shopify.dev/generated/generated_docs_data_v2.json b/docs-shopify.dev/generated/generated_docs_data_v2.json new file mode 100644 index 00000000000..b8b0801e5cb --- /dev/null +++ b/docs-shopify.dev/generated/generated_docs_data_v2.json @@ -0,0 +1,6149 @@ +{ + "DataGeneratedType": { + "docs-shopify.dev/commands/app-build.doc.ts": { + "filePath": "docs-shopify.dev/commands/app-build.doc.ts", + "name": "DataGeneratedType", + "description": "Template schema for reference entity documentation pages.", + "isPublicDocs": true, + "value": "data: ReferenceEntityTemplateSchema = {\n name: 'app build',\n description: `The following flags are available for the \\`app build\\` command:`,\n overviewPreviewDescription: `Build the app, including extensions.`,\n type: 'command',\n isVisualComponent: false,\n defaultExample: {\n codeblock: {\n tabs: [\n {\n title: 'app build',\n code: './examples/app-build.example.sh',\n language: 'bash',\n },\n ],\n title: 'app build',\n },\n },\n definitions: [\n {\n title: 'Flags',\n description: 'The following flags are available for the `app build` command:',\n type: 'appbuild',\n },\n ],\n category: 'app',\n related: [\n ],\n}" + } + }, + "appbuild": { + "docs-shopify.dev/commands/interfaces/app-build.interface.ts": { + "filePath": "docs-shopify.dev/commands/interfaces/app-build.interface.ts", + "name": "appbuild", + "description": "The following flags are available for the `app build` command:", + "isPublicDocs": true, + "members": [ + { + "filePath": "docs-shopify.dev/commands/interfaces/app-build.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--client-id ", + "value": "string", + "description": "The Client ID of your app.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_CLIENT_ID" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-build.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--no-color", + "value": "''", + "description": "Disable color output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_NO_COLOR" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-build.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--path ", + "value": "string", + "description": "The path to your app directory.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_PATH" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-build.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--reset", + "value": "''", + "description": "Reset all your settings.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_RESET" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-build.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--skip-dependencies-installation", + "value": "''", + "description": "Skips the installation of dependencies. Deprecated, use workspaces instead.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_SKIP_DEPENDENCIES_INSTALLATION" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-build.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--verbose", + "value": "''", + "description": "Increase the verbosity of the output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_VERBOSE" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-build.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-c, --config ", + "value": "string", + "description": "The name of the app configuration.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_APP_CONFIG" + } + ], + "value": "export interface appbuild {\n /**\n * The Client ID of your app.\n * @environment SHOPIFY_FLAG_CLIENT_ID\n */\n '--client-id '?: string\n\n /**\n * The name of the app configuration.\n * @environment SHOPIFY_FLAG_APP_CONFIG\n */\n '-c, --config '?: string\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * The path to your app directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Reset all your settings.\n * @environment SHOPIFY_FLAG_RESET\n */\n '--reset'?: ''\n\n /**\n * Skips the installation of dependencies. Deprecated, use workspaces instead.\n * @environment SHOPIFY_FLAG_SKIP_DEPENDENCIES_INSTALLATION\n */\n '--skip-dependencies-installation'?: ''\n\n /**\n * Increase the verbosity of the output.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" + } + }, + "appbulkcancel": { + "docs-shopify.dev/commands/interfaces/app-bulk-cancel.interface.ts": { + "filePath": "docs-shopify.dev/commands/interfaces/app-bulk-cancel.interface.ts", + "name": "appbulkcancel", + "description": "The following flags are available for the `app bulk cancel` command:", + "isPublicDocs": true, + "members": [ + { + "filePath": "docs-shopify.dev/commands/interfaces/app-bulk-cancel.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--client-id ", + "value": "string", + "description": "The Client ID of your app.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_CLIENT_ID" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-bulk-cancel.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--id ", + "value": "string", + "description": "The bulk operation ID to cancel (numeric ID or full GID).", + "environmentValue": "SHOPIFY_FLAG_ID" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-bulk-cancel.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--no-color", + "value": "''", + "description": "Disable color output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_NO_COLOR" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-bulk-cancel.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--path ", + "value": "string", + "description": "The path to your app directory.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_PATH" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-bulk-cancel.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--reset", + "value": "''", + "description": "Reset all your settings.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_RESET" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-bulk-cancel.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--verbose", + "value": "''", + "description": "Increase the verbosity of the output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_VERBOSE" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-bulk-cancel.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-c, --config ", + "value": "string", + "description": "The name of the app configuration.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_APP_CONFIG" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-bulk-cancel.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-s, --store ", + "value": "string", + "description": "The store domain. Must be an existing dev store.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_STORE" + } + ], + "value": "export interface appbulkcancel {\n /**\n * The Client ID of your app.\n * @environment SHOPIFY_FLAG_CLIENT_ID\n */\n '--client-id '?: string\n\n /**\n * The name of the app configuration.\n * @environment SHOPIFY_FLAG_APP_CONFIG\n */\n '-c, --config '?: string\n\n /**\n * The bulk operation ID to cancel (numeric ID or full GID).\n * @environment SHOPIFY_FLAG_ID\n */\n '--id ': string\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * The path to your app directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Reset all your settings.\n * @environment SHOPIFY_FLAG_RESET\n */\n '--reset'?: ''\n\n /**\n * The store domain. Must be an existing dev store.\n * @environment SHOPIFY_FLAG_STORE\n */\n '-s, --store '?: string\n\n /**\n * Increase the verbosity of the output.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" + } + }, + "appbulkexecute": { + "docs-shopify.dev/commands/interfaces/app-bulk-execute.interface.ts": { + "filePath": "docs-shopify.dev/commands/interfaces/app-bulk-execute.interface.ts", + "name": "appbulkexecute", + "description": "The following flags are available for the `app bulk execute` command:", + "isPublicDocs": true, + "members": [ + { + "filePath": "docs-shopify.dev/commands/interfaces/app-bulk-execute.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--client-id ", + "value": "string", + "description": "The Client ID of your app.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_CLIENT_ID" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-bulk-execute.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--no-color", + "value": "''", + "description": "Disable color output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_NO_COLOR" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-bulk-execute.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--output-file ", + "value": "string", + "description": "The file path where results should be written if --watch is specified. If not specified, results will be written to STDOUT.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_OUTPUT_FILE" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-bulk-execute.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--path ", + "value": "string", + "description": "The path to your app directory.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_PATH" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-bulk-execute.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--query-file ", + "value": "string", + "description": "Path to a file containing the GraphQL query or mutation. Can't be used with --query.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_QUERY_FILE" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-bulk-execute.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--reset", + "value": "''", + "description": "Reset all your settings.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_RESET" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-bulk-execute.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--variable-file ", + "value": "string", + "description": "Path to a file containing GraphQL variables in JSONL format (one JSON object per line). Can't be used with --variables.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_VARIABLE_FILE" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-bulk-execute.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--verbose", + "value": "''", + "description": "Increase the verbosity of the output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_VERBOSE" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-bulk-execute.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--version ", + "value": "string", + "description": "The API version to use for the bulk operation. If not specified, uses the latest stable version.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_VERSION" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-bulk-execute.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--watch", + "value": "''", + "description": "Wait for bulk operation results before exiting. Defaults to false.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_WATCH" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-bulk-execute.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-c, --config ", + "value": "string", + "description": "The name of the app configuration.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_APP_CONFIG" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-bulk-execute.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-q, --query ", + "value": "string", + "description": "The GraphQL query or mutation to run as a bulk operation.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_QUERY" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-bulk-execute.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-s, --store ", + "value": "string", + "description": "The store domain. Must be an existing dev store.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_STORE" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-bulk-execute.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-v, --variables ", + "value": "string", + "description": "The values for any GraphQL variables in your mutation, in JSON format. Can be specified multiple times.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_VARIABLES" + } + ], + "value": "export interface appbulkexecute {\n /**\n * The Client ID of your app.\n * @environment SHOPIFY_FLAG_CLIENT_ID\n */\n '--client-id '?: string\n\n /**\n * The name of the app configuration.\n * @environment SHOPIFY_FLAG_APP_CONFIG\n */\n '-c, --config '?: string\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * The file path where results should be written if --watch is specified. If not specified, results will be written to STDOUT.\n * @environment SHOPIFY_FLAG_OUTPUT_FILE\n */\n '--output-file '?: string\n\n /**\n * The path to your app directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * The GraphQL query or mutation to run as a bulk operation.\n * @environment SHOPIFY_FLAG_QUERY\n */\n '-q, --query '?: string\n\n /**\n * Path to a file containing the GraphQL query or mutation. Can't be used with --query.\n * @environment SHOPIFY_FLAG_QUERY_FILE\n */\n '--query-file '?: string\n\n /**\n * Reset all your settings.\n * @environment SHOPIFY_FLAG_RESET\n */\n '--reset'?: ''\n\n /**\n * The store domain. Must be an existing dev store.\n * @environment SHOPIFY_FLAG_STORE\n */\n '-s, --store '?: string\n\n /**\n * Path to a file containing GraphQL variables in JSONL format (one JSON object per line). Can't be used with --variables.\n * @environment SHOPIFY_FLAG_VARIABLE_FILE\n */\n '--variable-file '?: string\n\n /**\n * The values for any GraphQL variables in your mutation, in JSON format. Can be specified multiple times.\n * @environment SHOPIFY_FLAG_VARIABLES\n */\n '-v, --variables '?: string\n\n /**\n * Increase the verbosity of the output.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n\n /**\n * The API version to use for the bulk operation. If not specified, uses the latest stable version.\n * @environment SHOPIFY_FLAG_VERSION\n */\n '--version '?: string\n\n /**\n * Wait for bulk operation results before exiting. Defaults to false.\n * @environment SHOPIFY_FLAG_WATCH\n */\n '--watch'?: ''\n}" + } + }, + "appbulkstatus": { + "docs-shopify.dev/commands/interfaces/app-bulk-status.interface.ts": { + "filePath": "docs-shopify.dev/commands/interfaces/app-bulk-status.interface.ts", + "name": "appbulkstatus", + "description": "The following flags are available for the `app bulk status` command:", + "isPublicDocs": true, + "members": [ + { + "filePath": "docs-shopify.dev/commands/interfaces/app-bulk-status.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--client-id ", + "value": "string", + "description": "The Client ID of your app.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_CLIENT_ID" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-bulk-status.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--id ", + "value": "string", + "description": "The bulk operation ID (numeric ID or full GID). If not provided, lists all bulk operations belonging to this app on this store in the last 7 days.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_ID" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-bulk-status.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--no-color", + "value": "''", + "description": "Disable color output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_NO_COLOR" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-bulk-status.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--path ", + "value": "string", + "description": "The path to your app directory.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_PATH" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-bulk-status.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--reset", + "value": "''", + "description": "Reset all your settings.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_RESET" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-bulk-status.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--verbose", + "value": "''", + "description": "Increase the verbosity of the output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_VERBOSE" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-bulk-status.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-c, --config ", + "value": "string", + "description": "The name of the app configuration.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_APP_CONFIG" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-bulk-status.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-s, --store ", + "value": "string", + "description": "The store domain. Must be an existing dev store.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_STORE" + } + ], + "value": "export interface appbulkstatus {\n /**\n * The Client ID of your app.\n * @environment SHOPIFY_FLAG_CLIENT_ID\n */\n '--client-id '?: string\n\n /**\n * The name of the app configuration.\n * @environment SHOPIFY_FLAG_APP_CONFIG\n */\n '-c, --config '?: string\n\n /**\n * The bulk operation ID (numeric ID or full GID). If not provided, lists all bulk operations belonging to this app on this store in the last 7 days.\n * @environment SHOPIFY_FLAG_ID\n */\n '--id '?: string\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * The path to your app directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Reset all your settings.\n * @environment SHOPIFY_FLAG_RESET\n */\n '--reset'?: ''\n\n /**\n * The store domain. Must be an existing dev store.\n * @environment SHOPIFY_FLAG_STORE\n */\n '-s, --store '?: string\n\n /**\n * Increase the verbosity of the output.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" + } + }, + "appconfiglink": { + "docs-shopify.dev/commands/interfaces/app-config-link.interface.ts": { + "filePath": "docs-shopify.dev/commands/interfaces/app-config-link.interface.ts", + "name": "appconfiglink", + "description": "The following flags are available for the `app config link` command:", + "isPublicDocs": true, + "members": [ + { + "filePath": "docs-shopify.dev/commands/interfaces/app-config-link.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--client-id ", + "value": "string", + "description": "The Client ID of your app.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_CLIENT_ID" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-config-link.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--no-color", + "value": "''", + "description": "Disable color output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_NO_COLOR" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-config-link.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--path ", + "value": "string", + "description": "The path to your app directory.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_PATH" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-config-link.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--reset", + "value": "''", + "description": "Reset all your settings.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_RESET" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-config-link.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--verbose", + "value": "''", + "description": "Increase the verbosity of the output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_VERBOSE" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-config-link.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-c, --config ", + "value": "string", + "description": "The name of the app configuration.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_APP_CONFIG" + } + ], + "value": "export interface appconfiglink {\n /**\n * The Client ID of your app.\n * @environment SHOPIFY_FLAG_CLIENT_ID\n */\n '--client-id '?: string\n\n /**\n * The name of the app configuration.\n * @environment SHOPIFY_FLAG_APP_CONFIG\n */\n '-c, --config '?: string\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * The path to your app directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Reset all your settings.\n * @environment SHOPIFY_FLAG_RESET\n */\n '--reset'?: ''\n\n /**\n * Increase the verbosity of the output.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" + } + }, + "appconfigpull": { + "docs-shopify.dev/commands/interfaces/app-config-pull.interface.ts": { + "filePath": "docs-shopify.dev/commands/interfaces/app-config-pull.interface.ts", + "name": "appconfigpull", + "description": "The following flags are available for the `app config pull` command:", + "isPublicDocs": true, + "members": [ + { + "filePath": "docs-shopify.dev/commands/interfaces/app-config-pull.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--client-id ", + "value": "string", + "description": "The Client ID of your app.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_CLIENT_ID" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-config-pull.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--no-color", + "value": "''", + "description": "Disable color output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_NO_COLOR" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-config-pull.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--path ", + "value": "string", + "description": "The path to your app directory.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_PATH" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-config-pull.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--reset", + "value": "''", + "description": "Reset all your settings.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_RESET" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-config-pull.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--verbose", + "value": "''", + "description": "Increase the verbosity of the output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_VERBOSE" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-config-pull.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-c, --config ", + "value": "string", + "description": "The name of the app configuration.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_APP_CONFIG" + } + ], + "value": "export interface appconfigpull {\n /**\n * The Client ID of your app.\n * @environment SHOPIFY_FLAG_CLIENT_ID\n */\n '--client-id '?: string\n\n /**\n * The name of the app configuration.\n * @environment SHOPIFY_FLAG_APP_CONFIG\n */\n '-c, --config '?: string\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * The path to your app directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Reset all your settings.\n * @environment SHOPIFY_FLAG_RESET\n */\n '--reset'?: ''\n\n /**\n * Increase the verbosity of the output.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" + } + }, + "appconfiguse": { + "docs-shopify.dev/commands/interfaces/app-config-use.interface.ts": { + "filePath": "docs-shopify.dev/commands/interfaces/app-config-use.interface.ts", + "name": "appconfiguse", + "description": "The following flags are available for the `app config use` command:", + "isPublicDocs": true, + "members": [ + { + "filePath": "docs-shopify.dev/commands/interfaces/app-config-use.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--client-id ", + "value": "string", + "description": "The Client ID of your app.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_CLIENT_ID" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-config-use.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--no-color", + "value": "''", + "description": "Disable color output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_NO_COLOR" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-config-use.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--path ", + "value": "string", + "description": "The path to your app directory.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_PATH" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-config-use.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--reset", + "value": "''", + "description": "Reset all your settings.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_RESET" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-config-use.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--verbose", + "value": "''", + "description": "Increase the verbosity of the output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_VERBOSE" + } + ], + "value": "export interface appconfiguse {\n /**\n * The Client ID of your app.\n * @environment SHOPIFY_FLAG_CLIENT_ID\n */\n '--client-id '?: string\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * The path to your app directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Reset all your settings.\n * @environment SHOPIFY_FLAG_RESET\n */\n '--reset'?: ''\n\n /**\n * Increase the verbosity of the output.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" + } + }, + "appconfigvalidate": { + "docs-shopify.dev/commands/interfaces/app-config-validate.interface.ts": { + "filePath": "docs-shopify.dev/commands/interfaces/app-config-validate.interface.ts", + "name": "appconfigvalidate", + "description": "The following flags are available for the `app config validate` command:", + "isPublicDocs": true, + "members": [ + { + "filePath": "docs-shopify.dev/commands/interfaces/app-config-validate.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--client-id ", + "value": "string", + "description": "The Client ID of your app.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_CLIENT_ID" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-config-validate.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--no-color", + "value": "''", + "description": "Disable color output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_NO_COLOR" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-config-validate.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--path ", + "value": "string", + "description": "The path to your app directory.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_PATH" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-config-validate.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--reset", + "value": "''", + "description": "Reset all your settings.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_RESET" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-config-validate.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--verbose", + "value": "''", + "description": "Increase the verbosity of the output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_VERBOSE" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-config-validate.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-c, --config ", + "value": "string", + "description": "The name of the app configuration.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_APP_CONFIG" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-config-validate.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-j, --json", + "value": "''", + "description": "Output the result as JSON. Automatically disables color output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON" + } + ], + "value": "export interface appconfigvalidate {\n /**\n * The Client ID of your app.\n * @environment SHOPIFY_FLAG_CLIENT_ID\n */\n '--client-id '?: string\n\n /**\n * The name of the app configuration.\n * @environment SHOPIFY_FLAG_APP_CONFIG\n */\n '-c, --config '?: string\n\n /**\n * Output the result as JSON. Automatically disables color output.\n * @environment SHOPIFY_FLAG_JSON\n */\n '-j, --json'?: ''\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * The path to your app directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Reset all your settings.\n * @environment SHOPIFY_FLAG_RESET\n */\n '--reset'?: ''\n\n /**\n * Increase the verbosity of the output.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" + } + }, + "appdeploy": { + "docs-shopify.dev/commands/interfaces/app-deploy.interface.ts": { + "filePath": "docs-shopify.dev/commands/interfaces/app-deploy.interface.ts", + "name": "appdeploy", + "description": "The following flags are available for the `app deploy` command:", + "isPublicDocs": true, + "members": [ + { + "filePath": "docs-shopify.dev/commands/interfaces/app-deploy.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--allow-deletes", + "value": "''", + "description": "Allows removing extensions and configuration without requiring user confirmation. For CI/CD environments, the recommended flag is --allow-updates.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_ALLOW_DELETES" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-deploy.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--allow-updates", + "value": "''", + "description": "Allows adding and updating extensions and configuration without requiring user confirmation. Recommended option for CI/CD environments.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_ALLOW_UPDATES" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-deploy.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--client-id ", + "value": "string", + "description": "The Client ID of your app.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_CLIENT_ID" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-deploy.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--message ", + "value": "string", + "description": "Optional message that will be associated with this version. This is for internal use only and won't be available externally.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_MESSAGE" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-deploy.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--no-build", + "value": "''", + "description": "Use with caution: Skips building any elements of the app that require building. You should ensure your app has been prepared in advance, such as by running `shopify app build` or by caching build artifacts.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_NO_BUILD" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-deploy.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--no-color", + "value": "''", + "description": "Disable color output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_NO_COLOR" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-deploy.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--no-release", + "value": "''", + "description": "Creates a version but doesn't release it - it's not made available to merchants. With this flag, a user confirmation is not required.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_NO_RELEASE" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-deploy.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--path ", + "value": "string", + "description": "The path to your app directory.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_PATH" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-deploy.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--reset", + "value": "''", + "description": "Reset all your settings.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_RESET" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-deploy.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--source-control-url ", + "value": "string", + "description": "URL associated with the new app version.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_SOURCE_CONTROL_URL" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-deploy.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--verbose", + "value": "''", + "description": "Increase the verbosity of the output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_VERBOSE" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-deploy.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--version ", + "value": "string", + "description": "Optional version tag that will be associated with this app version. If not provided, an auto-generated identifier will be generated for this app version.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_VERSION" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-deploy.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-c, --config ", + "value": "string", + "description": "The name of the app configuration.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_APP_CONFIG" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-deploy.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-f, --force", + "value": "''", + "description": "[Deprecated] Deploy without asking for confirmation. Equivalent to --allow-updates --allow-deletes. Use --allow-updates for CI/CD environments instead.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_FORCE" + } + ], + "value": "export interface appdeploy {\n /**\n * Allows removing extensions and configuration without requiring user confirmation. For CI/CD environments, the recommended flag is --allow-updates.\n * @environment SHOPIFY_FLAG_ALLOW_DELETES\n */\n '--allow-deletes'?: ''\n\n /**\n * Allows adding and updating extensions and configuration without requiring user confirmation. Recommended option for CI/CD environments.\n * @environment SHOPIFY_FLAG_ALLOW_UPDATES\n */\n '--allow-updates'?: ''\n\n /**\n * The Client ID of your app.\n * @environment SHOPIFY_FLAG_CLIENT_ID\n */\n '--client-id '?: string\n\n /**\n * The name of the app configuration.\n * @environment SHOPIFY_FLAG_APP_CONFIG\n */\n '-c, --config '?: string\n\n /**\n * [Deprecated] Deploy without asking for confirmation. Equivalent to --allow-updates --allow-deletes. Use --allow-updates for CI/CD environments instead.\n * @environment SHOPIFY_FLAG_FORCE\n */\n '-f, --force'?: ''\n\n /**\n * Optional message that will be associated with this version. This is for internal use only and won't be available externally.\n * @environment SHOPIFY_FLAG_MESSAGE\n */\n '--message '?: string\n\n /**\n * Use with caution: Skips building any elements of the app that require building. You should ensure your app has been prepared in advance, such as by running `shopify app build` or by caching build artifacts.\n * @environment SHOPIFY_FLAG_NO_BUILD\n */\n '--no-build'?: ''\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * Creates a version but doesn't release it - it's not made available to merchants. With this flag, a user confirmation is not required.\n * @environment SHOPIFY_FLAG_NO_RELEASE\n */\n '--no-release'?: ''\n\n /**\n * The path to your app directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Reset all your settings.\n * @environment SHOPIFY_FLAG_RESET\n */\n '--reset'?: ''\n\n /**\n * URL associated with the new app version.\n * @environment SHOPIFY_FLAG_SOURCE_CONTROL_URL\n */\n '--source-control-url '?: string\n\n /**\n * Increase the verbosity of the output.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n\n /**\n * Optional version tag that will be associated with this app version. If not provided, an auto-generated identifier will be generated for this app version.\n * @environment SHOPIFY_FLAG_VERSION\n */\n '--version '?: string\n}" + } + }, + "appdevclean": { + "docs-shopify.dev/commands/interfaces/app-dev-clean.interface.ts": { + "filePath": "docs-shopify.dev/commands/interfaces/app-dev-clean.interface.ts", + "name": "appdevclean", + "description": "The following flags are available for the `app dev clean` command:", + "isPublicDocs": true, + "members": [ + { + "filePath": "docs-shopify.dev/commands/interfaces/app-dev-clean.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--client-id ", + "value": "string", + "description": "The Client ID of your app.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_CLIENT_ID" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-dev-clean.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--no-color", + "value": "''", + "description": "Disable color output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_NO_COLOR" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-dev-clean.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--path ", + "value": "string", + "description": "The path to your app directory.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_PATH" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-dev-clean.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--reset", + "value": "''", + "description": "Reset all your settings.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_RESET" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-dev-clean.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--verbose", + "value": "''", + "description": "Increase the verbosity of the output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_VERBOSE" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-dev-clean.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-c, --config ", + "value": "string", + "description": "The name of the app configuration.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_APP_CONFIG" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-dev-clean.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-s, --store ", + "value": "string", + "description": "Store URL. Must be an existing development store.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_STORE" + } + ], + "value": "export interface appdevclean {\n /**\n * The Client ID of your app.\n * @environment SHOPIFY_FLAG_CLIENT_ID\n */\n '--client-id '?: string\n\n /**\n * The name of the app configuration.\n * @environment SHOPIFY_FLAG_APP_CONFIG\n */\n '-c, --config '?: string\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * The path to your app directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Reset all your settings.\n * @environment SHOPIFY_FLAG_RESET\n */\n '--reset'?: ''\n\n /**\n * Store URL. Must be an existing development store.\n * @environment SHOPIFY_FLAG_STORE\n */\n '-s, --store '?: string\n\n /**\n * Increase the verbosity of the output.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" + } + }, + "appdev": { + "docs-shopify.dev/commands/interfaces/app-dev.interface.ts": { + "filePath": "docs-shopify.dev/commands/interfaces/app-dev.interface.ts", + "name": "appdev", + "description": "The following flags are available for the `app dev` command:", + "isPublicDocs": true, + "members": [ + { + "filePath": "docs-shopify.dev/commands/interfaces/app-dev.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--checkout-cart-url ", + "value": "string", + "description": "Resource URL for checkout UI extension. Format: \"/cart/{productVariantID}:{productQuantity}\"", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_CHECKOUT_CART_URL" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-dev.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--client-id ", + "value": "string", + "description": "The Client ID of your app.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_CLIENT_ID" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-dev.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--localhost-port ", + "value": "string", + "description": "Port to use for localhost.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_LOCALHOST_PORT" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-dev.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--no-color", + "value": "''", + "description": "Disable color output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_NO_COLOR" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-dev.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--no-update", + "value": "''", + "description": "Uses the app URL from the toml file instead an autogenerated URL for dev.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_NO_UPDATE" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-dev.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--notify ", + "value": "string", + "description": "The file path or URL. The file path is to a file that you want updated on idle. The URL path is where you want a webhook posted to report on file changes.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_NOTIFY" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-dev.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--path ", + "value": "string", + "description": "The path to your app directory.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_PATH" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-dev.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--reset", + "value": "''", + "description": "Reset all your settings.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_RESET" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-dev.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--skip-dependencies-installation", + "value": "''", + "description": "Skips the installation of dependencies. Deprecated, use workspaces instead.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_SKIP_DEPENDENCIES_INSTALLATION" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-dev.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--subscription-product-url ", + "value": "string", + "description": "Resource URL for subscription UI extension. Format: \"/products/{productId}\"", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_SUBSCRIPTION_PRODUCT_URL" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-dev.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--theme-app-extension-port ", + "value": "string", + "description": "Local port of the theme app extension development server.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_THEME_APP_EXTENSION_PORT" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-dev.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--tunnel-url ", + "value": "string", + "description": "Use a custom tunnel, it must be running before executing dev. Format: \"https://my-tunnel-url:port\".", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_TUNNEL_URL" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-dev.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--use-localhost", + "value": "''", + "description": "Service entry point will listen to localhost. A tunnel won't be used. Will work for testing many app features, but not those that directly invoke your app (E.g: Webhooks)", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_USE_LOCALHOST" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-dev.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--verbose", + "value": "''", + "description": "Increase the verbosity of the output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_VERBOSE" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-dev.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-c, --config ", + "value": "string", + "description": "The name of the app configuration.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_APP_CONFIG" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-dev.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-s, --store ", + "value": "string", + "description": "Store URL. Must be an existing development or Shopify Plus sandbox store.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_STORE" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-dev.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-t, --theme ", + "value": "string", + "description": "Theme ID or name of the theme app extension host theme.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_THEME" + } + ], + "value": "export interface appdev {\n /**\n * Resource URL for checkout UI extension. Format: \"/cart/{productVariantID}:{productQuantity}\"\n * @environment SHOPIFY_FLAG_CHECKOUT_CART_URL\n */\n '--checkout-cart-url '?: string\n\n /**\n * The Client ID of your app.\n * @environment SHOPIFY_FLAG_CLIENT_ID\n */\n '--client-id '?: string\n\n /**\n * The name of the app configuration.\n * @environment SHOPIFY_FLAG_APP_CONFIG\n */\n '-c, --config '?: string\n\n /**\n * Port to use for localhost.\n * @environment SHOPIFY_FLAG_LOCALHOST_PORT\n */\n '--localhost-port '?: string\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * Uses the app URL from the toml file instead an autogenerated URL for dev.\n * @environment SHOPIFY_FLAG_NO_UPDATE\n */\n '--no-update'?: ''\n\n /**\n * The file path or URL. The file path is to a file that you want updated on idle. The URL path is where you want a webhook posted to report on file changes.\n * @environment SHOPIFY_FLAG_NOTIFY\n */\n '--notify '?: string\n\n /**\n * The path to your app directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Reset all your settings.\n * @environment SHOPIFY_FLAG_RESET\n */\n '--reset'?: ''\n\n /**\n * Skips the installation of dependencies. Deprecated, use workspaces instead.\n * @environment SHOPIFY_FLAG_SKIP_DEPENDENCIES_INSTALLATION\n */\n '--skip-dependencies-installation'?: ''\n\n /**\n * Store URL. Must be an existing development or Shopify Plus sandbox store.\n * @environment SHOPIFY_FLAG_STORE\n */\n '-s, --store '?: string\n\n /**\n * Resource URL for subscription UI extension. Format: \"/products/{productId}\"\n * @environment SHOPIFY_FLAG_SUBSCRIPTION_PRODUCT_URL\n */\n '--subscription-product-url '?: string\n\n /**\n * Theme ID or name of the theme app extension host theme.\n * @environment SHOPIFY_FLAG_THEME\n */\n '-t, --theme '?: string\n\n /**\n * Local port of the theme app extension development server.\n * @environment SHOPIFY_FLAG_THEME_APP_EXTENSION_PORT\n */\n '--theme-app-extension-port '?: string\n\n /**\n * Use a custom tunnel, it must be running before executing dev. Format: \"https://my-tunnel-url:port\".\n * @environment SHOPIFY_FLAG_TUNNEL_URL\n */\n '--tunnel-url '?: string\n\n /**\n * Service entry point will listen to localhost. A tunnel won't be used. Will work for testing many app features, but not those that directly invoke your app (E.g: Webhooks)\n * @environment SHOPIFY_FLAG_USE_LOCALHOST\n */\n '--use-localhost'?: ''\n\n /**\n * Increase the verbosity of the output.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" + } + }, + "appenvpull": { + "docs-shopify.dev/commands/interfaces/app-env-pull.interface.ts": { + "filePath": "docs-shopify.dev/commands/interfaces/app-env-pull.interface.ts", + "name": "appenvpull", + "description": "The following flags are available for the `app env pull` command:", + "isPublicDocs": true, + "members": [ + { + "filePath": "docs-shopify.dev/commands/interfaces/app-env-pull.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--client-id ", + "value": "string", + "description": "The Client ID of your app.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_CLIENT_ID" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-env-pull.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--env-file ", + "value": "string", + "description": "Specify an environment file to update if the update flag is set", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_ENV_FILE" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-env-pull.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--no-color", + "value": "''", + "description": "Disable color output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_NO_COLOR" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-env-pull.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--path ", + "value": "string", + "description": "The path to your app directory.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_PATH" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-env-pull.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--reset", + "value": "''", + "description": "Reset all your settings.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_RESET" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-env-pull.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--verbose", + "value": "''", + "description": "Increase the verbosity of the output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_VERBOSE" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-env-pull.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-c, --config ", + "value": "string", + "description": "The name of the app configuration.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_APP_CONFIG" + } + ], + "value": "export interface appenvpull {\n /**\n * The Client ID of your app.\n * @environment SHOPIFY_FLAG_CLIENT_ID\n */\n '--client-id '?: string\n\n /**\n * The name of the app configuration.\n * @environment SHOPIFY_FLAG_APP_CONFIG\n */\n '-c, --config '?: string\n\n /**\n * Specify an environment file to update if the update flag is set\n * @environment SHOPIFY_FLAG_ENV_FILE\n */\n '--env-file '?: string\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * The path to your app directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Reset all your settings.\n * @environment SHOPIFY_FLAG_RESET\n */\n '--reset'?: ''\n\n /**\n * Increase the verbosity of the output.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" + } + }, + "appenvshow": { + "docs-shopify.dev/commands/interfaces/app-env-show.interface.ts": { + "filePath": "docs-shopify.dev/commands/interfaces/app-env-show.interface.ts", + "name": "appenvshow", + "description": "The following flags are available for the `app env show` command:", + "isPublicDocs": true, + "members": [ + { + "filePath": "docs-shopify.dev/commands/interfaces/app-env-show.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--client-id ", + "value": "string", + "description": "The Client ID of your app.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_CLIENT_ID" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-env-show.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--no-color", + "value": "''", + "description": "Disable color output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_NO_COLOR" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-env-show.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--path ", + "value": "string", + "description": "The path to your app directory.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_PATH" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-env-show.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--reset", + "value": "''", + "description": "Reset all your settings.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_RESET" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-env-show.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--verbose", + "value": "''", + "description": "Increase the verbosity of the output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_VERBOSE" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-env-show.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-c, --config ", + "value": "string", + "description": "The name of the app configuration.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_APP_CONFIG" + } + ], + "value": "export interface appenvshow {\n /**\n * The Client ID of your app.\n * @environment SHOPIFY_FLAG_CLIENT_ID\n */\n '--client-id '?: string\n\n /**\n * The name of the app configuration.\n * @environment SHOPIFY_FLAG_APP_CONFIG\n */\n '-c, --config '?: string\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * The path to your app directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Reset all your settings.\n * @environment SHOPIFY_FLAG_RESET\n */\n '--reset'?: ''\n\n /**\n * Increase the verbosity of the output.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" + } + }, + "appexecute": { + "docs-shopify.dev/commands/interfaces/app-execute.interface.ts": { + "filePath": "docs-shopify.dev/commands/interfaces/app-execute.interface.ts", + "name": "appexecute", + "description": "The following flags are available for the `app execute` command:", + "isPublicDocs": true, + "members": [ + { + "filePath": "docs-shopify.dev/commands/interfaces/app-execute.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--client-id ", + "value": "string", + "description": "The Client ID of your app.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_CLIENT_ID" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-execute.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--no-color", + "value": "''", + "description": "Disable color output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_NO_COLOR" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-execute.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--output-file ", + "value": "string", + "description": "The file name where results should be written, instead of STDOUT.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_OUTPUT_FILE" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-execute.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--path ", + "value": "string", + "description": "The path to your app directory.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_PATH" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-execute.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--query-file ", + "value": "string", + "description": "Path to a file containing the GraphQL query or mutation. Can't be used with --query.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_QUERY_FILE" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-execute.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--reset", + "value": "''", + "description": "Reset all your settings.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_RESET" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-execute.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--variable-file ", + "value": "string", + "description": "Path to a file containing GraphQL variables in JSON format. Can't be used with --variables.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_VARIABLE_FILE" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-execute.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--verbose", + "value": "''", + "description": "Increase the verbosity of the output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_VERBOSE" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-execute.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--version ", + "value": "string", + "description": "The API version to use for the query or mutation. Defaults to the latest stable version.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_VERSION" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-execute.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-c, --config ", + "value": "string", + "description": "The name of the app configuration.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_APP_CONFIG" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-execute.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-q, --query ", + "value": "string", + "description": "The GraphQL query or mutation, as a string.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_QUERY" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-execute.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-s, --store ", + "value": "string", + "description": "The myshopify.com domain of the store to execute against. The app must be installed on the store. If not specified, you will be prompted to select a store.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_STORE" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-execute.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-v, --variables ", + "value": "string", + "description": "The values for any GraphQL variables in your query or mutation, in JSON format.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_VARIABLES" + } + ], + "value": "export interface appexecute {\n /**\n * The Client ID of your app.\n * @environment SHOPIFY_FLAG_CLIENT_ID\n */\n '--client-id '?: string\n\n /**\n * The name of the app configuration.\n * @environment SHOPIFY_FLAG_APP_CONFIG\n */\n '-c, --config '?: string\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * The file name where results should be written, instead of STDOUT.\n * @environment SHOPIFY_FLAG_OUTPUT_FILE\n */\n '--output-file '?: string\n\n /**\n * The path to your app directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * The GraphQL query or mutation, as a string.\n * @environment SHOPIFY_FLAG_QUERY\n */\n '-q, --query '?: string\n\n /**\n * Path to a file containing the GraphQL query or mutation. Can't be used with --query.\n * @environment SHOPIFY_FLAG_QUERY_FILE\n */\n '--query-file '?: string\n\n /**\n * Reset all your settings.\n * @environment SHOPIFY_FLAG_RESET\n */\n '--reset'?: ''\n\n /**\n * The myshopify.com domain of the store to execute against. The app must be installed on the store. If not specified, you will be prompted to select a store.\n * @environment SHOPIFY_FLAG_STORE\n */\n '-s, --store '?: string\n\n /**\n * Path to a file containing GraphQL variables in JSON format. Can't be used with --variables.\n * @environment SHOPIFY_FLAG_VARIABLE_FILE\n */\n '--variable-file '?: string\n\n /**\n * The values for any GraphQL variables in your query or mutation, in JSON format.\n * @environment SHOPIFY_FLAG_VARIABLES\n */\n '-v, --variables '?: string\n\n /**\n * Increase the verbosity of the output.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n\n /**\n * The API version to use for the query or mutation. Defaults to the latest stable version.\n * @environment SHOPIFY_FLAG_VERSION\n */\n '--version '?: string\n}" + } + }, + "appfunctionbuild": { + "docs-shopify.dev/commands/interfaces/app-function-build.interface.ts": { + "filePath": "docs-shopify.dev/commands/interfaces/app-function-build.interface.ts", + "name": "appfunctionbuild", + "description": "The following flags are available for the `app function build` command:", + "isPublicDocs": true, + "members": [ + { + "filePath": "docs-shopify.dev/commands/interfaces/app-function-build.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--client-id ", + "value": "string", + "description": "The Client ID of your app.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_CLIENT_ID" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-function-build.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--no-color", + "value": "''", + "description": "Disable color output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_NO_COLOR" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-function-build.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--path ", + "value": "string", + "description": "The path to your function directory.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_PATH" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-function-build.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--reset", + "value": "''", + "description": "Reset all your settings.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_RESET" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-function-build.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--verbose", + "value": "''", + "description": "Increase the verbosity of the output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_VERBOSE" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-function-build.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-c, --config ", + "value": "string", + "description": "The name of the app configuration.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_APP_CONFIG" + } + ], + "value": "export interface appfunctionbuild {\n /**\n * The Client ID of your app.\n * @environment SHOPIFY_FLAG_CLIENT_ID\n */\n '--client-id '?: string\n\n /**\n * The name of the app configuration.\n * @environment SHOPIFY_FLAG_APP_CONFIG\n */\n '-c, --config '?: string\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * The path to your function directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Reset all your settings.\n * @environment SHOPIFY_FLAG_RESET\n */\n '--reset'?: ''\n\n /**\n * Increase the verbosity of the output.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" + } + }, + "appfunctioninfo": { + "docs-shopify.dev/commands/interfaces/app-function-info.interface.ts": { + "filePath": "docs-shopify.dev/commands/interfaces/app-function-info.interface.ts", + "name": "appfunctioninfo", + "description": "The following flags are available for the `app function info` command:", + "isPublicDocs": true, + "members": [ + { + "filePath": "docs-shopify.dev/commands/interfaces/app-function-info.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--client-id ", + "value": "string", + "description": "The Client ID of your app.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_CLIENT_ID" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-function-info.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--no-color", + "value": "''", + "description": "Disable color output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_NO_COLOR" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-function-info.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--path ", + "value": "string", + "description": "The path to your function directory.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_PATH" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-function-info.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--reset", + "value": "''", + "description": "Reset all your settings.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_RESET" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-function-info.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--verbose", + "value": "''", + "description": "Increase the verbosity of the output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_VERBOSE" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-function-info.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-c, --config ", + "value": "string", + "description": "The name of the app configuration.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_APP_CONFIG" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-function-info.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-j, --json", + "value": "''", + "description": "Output the result as JSON. Automatically disables color output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON" + } + ], + "value": "export interface appfunctioninfo {\n /**\n * The Client ID of your app.\n * @environment SHOPIFY_FLAG_CLIENT_ID\n */\n '--client-id '?: string\n\n /**\n * The name of the app configuration.\n * @environment SHOPIFY_FLAG_APP_CONFIG\n */\n '-c, --config '?: string\n\n /**\n * Output the result as JSON. Automatically disables color output.\n * @environment SHOPIFY_FLAG_JSON\n */\n '-j, --json'?: ''\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * The path to your function directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Reset all your settings.\n * @environment SHOPIFY_FLAG_RESET\n */\n '--reset'?: ''\n\n /**\n * Increase the verbosity of the output.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" + } + }, + "appfunctionreplay": { + "docs-shopify.dev/commands/interfaces/app-function-replay.interface.ts": { + "filePath": "docs-shopify.dev/commands/interfaces/app-function-replay.interface.ts", + "name": "appfunctionreplay", + "description": "The following flags are available for the `app function replay` command:", + "isPublicDocs": true, + "members": [ + { + "filePath": "docs-shopify.dev/commands/interfaces/app-function-replay.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--client-id ", + "value": "string", + "description": "The Client ID of your app.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_CLIENT_ID" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-function-replay.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--no-color", + "value": "''", + "description": "Disable color output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_NO_COLOR" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-function-replay.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--path ", + "value": "string", + "description": "The path to your function directory.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_PATH" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-function-replay.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--reset", + "value": "''", + "description": "Reset all your settings.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_RESET" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-function-replay.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--verbose", + "value": "''", + "description": "Increase the verbosity of the output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_VERBOSE" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-function-replay.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-c, --config ", + "value": "string", + "description": "The name of the app configuration.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_APP_CONFIG" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-function-replay.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-j, --json", + "value": "''", + "description": "Output the result as JSON. Automatically disables color output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-function-replay.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-l, --log ", + "value": "string", + "description": "Specifies a log identifier to replay instead of selecting from a list. The identifier is provided in the output of `shopify app dev` and is the suffix of the log file name.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_LOG" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-function-replay.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-w, --watch", + "value": "''", + "description": "Re-run the function when the source code changes.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_WATCH" + } + ], + "value": "export interface appfunctionreplay {\n /**\n * The Client ID of your app.\n * @environment SHOPIFY_FLAG_CLIENT_ID\n */\n '--client-id '?: string\n\n /**\n * The name of the app configuration.\n * @environment SHOPIFY_FLAG_APP_CONFIG\n */\n '-c, --config '?: string\n\n /**\n * Output the result as JSON. Automatically disables color output.\n * @environment SHOPIFY_FLAG_JSON\n */\n '-j, --json'?: ''\n\n /**\n * Specifies a log identifier to replay instead of selecting from a list. The identifier is provided in the output of `shopify app dev` and is the suffix of the log file name.\n * @environment SHOPIFY_FLAG_LOG\n */\n '-l, --log '?: string\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * The path to your function directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Reset all your settings.\n * @environment SHOPIFY_FLAG_RESET\n */\n '--reset'?: ''\n\n /**\n * Increase the verbosity of the output.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n\n /**\n * Re-run the function when the source code changes.\n * @environment SHOPIFY_FLAG_WATCH\n */\n '-w, --watch'?: ''\n}" + } + }, + "appfunctionrun": { + "docs-shopify.dev/commands/interfaces/app-function-run.interface.ts": { + "filePath": "docs-shopify.dev/commands/interfaces/app-function-run.interface.ts", + "name": "appfunctionrun", + "description": "The following flags are available for the `app function run` command:", + "isPublicDocs": true, + "members": [ + { + "filePath": "docs-shopify.dev/commands/interfaces/app-function-run.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--client-id ", + "value": "string", + "description": "The Client ID of your app.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_CLIENT_ID" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-function-run.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--no-color", + "value": "''", + "description": "Disable color output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_NO_COLOR" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-function-run.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--path ", + "value": "string", + "description": "The path to your function directory.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_PATH" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-function-run.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--reset", + "value": "''", + "description": "Reset all your settings.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_RESET" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-function-run.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--verbose", + "value": "''", + "description": "Increase the verbosity of the output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_VERBOSE" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-function-run.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-c, --config ", + "value": "string", + "description": "The name of the app configuration.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_APP_CONFIG" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-function-run.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-e, --export ", + "value": "string", + "description": "Name of the WebAssembly export to invoke.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_EXPORT" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-function-run.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-i, --input ", + "value": "string", + "description": "The input JSON to pass to the function. If omitted, standard input is used.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_INPUT" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-function-run.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-j, --json", + "value": "''", + "description": "Output the result as JSON. Automatically disables color output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON" + } + ], + "value": "export interface appfunctionrun {\n /**\n * The Client ID of your app.\n * @environment SHOPIFY_FLAG_CLIENT_ID\n */\n '--client-id '?: string\n\n /**\n * The name of the app configuration.\n * @environment SHOPIFY_FLAG_APP_CONFIG\n */\n '-c, --config '?: string\n\n /**\n * Name of the WebAssembly export to invoke.\n * @environment SHOPIFY_FLAG_EXPORT\n */\n '-e, --export '?: string\n\n /**\n * The input JSON to pass to the function. If omitted, standard input is used.\n * @environment SHOPIFY_FLAG_INPUT\n */\n '-i, --input '?: string\n\n /**\n * Output the result as JSON. Automatically disables color output.\n * @environment SHOPIFY_FLAG_JSON\n */\n '-j, --json'?: ''\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * The path to your function directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Reset all your settings.\n * @environment SHOPIFY_FLAG_RESET\n */\n '--reset'?: ''\n\n /**\n * Increase the verbosity of the output.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" + } + }, + "appfunctionschema": { + "docs-shopify.dev/commands/interfaces/app-function-schema.interface.ts": { + "filePath": "docs-shopify.dev/commands/interfaces/app-function-schema.interface.ts", + "name": "appfunctionschema", + "description": "The following flags are available for the `app function schema` command:", + "isPublicDocs": true, + "members": [ + { + "filePath": "docs-shopify.dev/commands/interfaces/app-function-schema.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--client-id ", + "value": "string", + "description": "The Client ID of your app.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_CLIENT_ID" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-function-schema.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--no-color", + "value": "''", + "description": "Disable color output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_NO_COLOR" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-function-schema.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--path ", + "value": "string", + "description": "The path to your function directory.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_PATH" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-function-schema.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--reset", + "value": "''", + "description": "Reset all your settings.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_RESET" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-function-schema.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--stdout", + "value": "''", + "description": "Output the schema to stdout instead of writing to a file.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_STDOUT" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-function-schema.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--verbose", + "value": "''", + "description": "Increase the verbosity of the output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_VERBOSE" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-function-schema.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-c, --config ", + "value": "string", + "description": "The name of the app configuration.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_APP_CONFIG" + } + ], + "value": "export interface appfunctionschema {\n /**\n * The Client ID of your app.\n * @environment SHOPIFY_FLAG_CLIENT_ID\n */\n '--client-id '?: string\n\n /**\n * The name of the app configuration.\n * @environment SHOPIFY_FLAG_APP_CONFIG\n */\n '-c, --config '?: string\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * The path to your function directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Reset all your settings.\n * @environment SHOPIFY_FLAG_RESET\n */\n '--reset'?: ''\n\n /**\n * Output the schema to stdout instead of writing to a file.\n * @environment SHOPIFY_FLAG_STDOUT\n */\n '--stdout'?: ''\n\n /**\n * Increase the verbosity of the output.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" + } + }, + "appfunctiontypegen": { + "docs-shopify.dev/commands/interfaces/app-function-typegen.interface.ts": { + "filePath": "docs-shopify.dev/commands/interfaces/app-function-typegen.interface.ts", + "name": "appfunctiontypegen", + "description": "The following flags are available for the `app function typegen` command:", + "isPublicDocs": true, + "members": [ + { + "filePath": "docs-shopify.dev/commands/interfaces/app-function-typegen.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--client-id ", + "value": "string", + "description": "The Client ID of your app.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_CLIENT_ID" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-function-typegen.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--no-color", + "value": "''", + "description": "Disable color output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_NO_COLOR" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-function-typegen.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--path ", + "value": "string", + "description": "The path to your function directory.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_PATH" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-function-typegen.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--reset", + "value": "''", + "description": "Reset all your settings.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_RESET" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-function-typegen.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--verbose", + "value": "''", + "description": "Increase the verbosity of the output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_VERBOSE" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-function-typegen.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-c, --config ", + "value": "string", + "description": "The name of the app configuration.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_APP_CONFIG" + } + ], + "value": "export interface appfunctiontypegen {\n /**\n * The Client ID of your app.\n * @environment SHOPIFY_FLAG_CLIENT_ID\n */\n '--client-id '?: string\n\n /**\n * The name of the app configuration.\n * @environment SHOPIFY_FLAG_APP_CONFIG\n */\n '-c, --config '?: string\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * The path to your function directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Reset all your settings.\n * @environment SHOPIFY_FLAG_RESET\n */\n '--reset'?: ''\n\n /**\n * Increase the verbosity of the output.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" + } + }, + "appgenerateextension": { + "docs-shopify.dev/commands/interfaces/app-generate-extension.interface.ts": { + "filePath": "docs-shopify.dev/commands/interfaces/app-generate-extension.interface.ts", + "name": "appgenerateextension", + "description": "The following flags are available for the `app generate extension` command:", + "isPublicDocs": true, + "members": [ + { + "filePath": "docs-shopify.dev/commands/interfaces/app-generate-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--client-id ", + "value": "string", + "description": "The Client ID of your app.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_CLIENT_ID" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-generate-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--flavor ", + "value": "string", + "description": "Choose a starting template for your extension, where applicable", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_FLAVOR" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-generate-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--no-color", + "value": "''", + "description": "Disable color output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_NO_COLOR" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-generate-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--path ", + "value": "string", + "description": "The path to your app directory.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_PATH" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-generate-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--reset", + "value": "''", + "description": "Reset all your settings.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_RESET" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-generate-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--verbose", + "value": "''", + "description": "Increase the verbosity of the output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_VERBOSE" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-generate-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-c, --config ", + "value": "string", + "description": "The name of the app configuration.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_APP_CONFIG" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-generate-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-n, --name ", + "value": "string", + "description": "name of your Extension", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_NAME" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-generate-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-t, --template ", + "value": "string", + "description": "Extension template", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_EXTENSION_TEMPLATE" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-generate-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-t, --type ", + "value": "string", + "description": "Deprecated. Please use --template", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_EXTENSION_TYPE" + } + ], + "value": "export interface appgenerateextension {\n /**\n * The Client ID of your app.\n * @environment SHOPIFY_FLAG_CLIENT_ID\n */\n '--client-id '?: string\n\n /**\n * The name of the app configuration.\n * @environment SHOPIFY_FLAG_APP_CONFIG\n */\n '-c, --config '?: string\n\n /**\n * Choose a starting template for your extension, where applicable\n * @environment SHOPIFY_FLAG_FLAVOR\n */\n '--flavor '?: string\n\n /**\n * name of your Extension\n * @environment SHOPIFY_FLAG_NAME\n */\n '-n, --name '?: string\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * The path to your app directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Reset all your settings.\n * @environment SHOPIFY_FLAG_RESET\n */\n '--reset'?: ''\n\n /**\n * Extension template\n * @environment SHOPIFY_FLAG_EXTENSION_TEMPLATE\n */\n '-t, --template '?: string\n\n /**\n * Deprecated. Please use --template\n * @environment SHOPIFY_FLAG_EXTENSION_TYPE\n */\n '-t, --type '?: string\n\n /**\n * Increase the verbosity of the output.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" + } + }, + "appimportcustomdatadefinitions": { + "docs-shopify.dev/commands/interfaces/app-import-custom-data-definitions.interface.ts": { + "filePath": "docs-shopify.dev/commands/interfaces/app-import-custom-data-definitions.interface.ts", + "name": "appimportcustomdatadefinitions", + "description": "The following flags are available for the `app import-custom-data-definitions` command:", + "isPublicDocs": true, + "members": [ + { + "filePath": "docs-shopify.dev/commands/interfaces/app-import-custom-data-definitions.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--client-id ", + "value": "string", + "description": "The Client ID of your app.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_CLIENT_ID" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-import-custom-data-definitions.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--include-existing", + "value": "''", + "description": "Include existing declared definitions in the output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_INCLUDE_EXISTING" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-import-custom-data-definitions.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--no-color", + "value": "''", + "description": "Disable color output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_NO_COLOR" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-import-custom-data-definitions.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--path ", + "value": "string", + "description": "The path to your app directory.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_PATH" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-import-custom-data-definitions.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--reset", + "value": "''", + "description": "Reset all your settings.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_RESET" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-import-custom-data-definitions.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--verbose", + "value": "''", + "description": "Increase the verbosity of the output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_VERBOSE" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-import-custom-data-definitions.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-c, --config ", + "value": "string", + "description": "The name of the app configuration.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_APP_CONFIG" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-import-custom-data-definitions.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-s, --store ", + "value": "string", + "description": "Store URL. Must be an existing development or Shopify Plus sandbox store.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_STORE" + } + ], + "value": "export interface appimportcustomdatadefinitions {\n /**\n * The Client ID of your app.\n * @environment SHOPIFY_FLAG_CLIENT_ID\n */\n '--client-id '?: string\n\n /**\n * The name of the app configuration.\n * @environment SHOPIFY_FLAG_APP_CONFIG\n */\n '-c, --config '?: string\n\n /**\n * Include existing declared definitions in the output.\n * @environment SHOPIFY_FLAG_INCLUDE_EXISTING\n */\n '--include-existing'?: ''\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * The path to your app directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Reset all your settings.\n * @environment SHOPIFY_FLAG_RESET\n */\n '--reset'?: ''\n\n /**\n * Store URL. Must be an existing development or Shopify Plus sandbox store.\n * @environment SHOPIFY_FLAG_STORE\n */\n '-s, --store '?: string\n\n /**\n * Increase the verbosity of the output.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" + } + }, + "appimportextensions": { + "docs-shopify.dev/commands/interfaces/app-import-extensions.interface.ts": { + "filePath": "docs-shopify.dev/commands/interfaces/app-import-extensions.interface.ts", + "name": "appimportextensions", + "description": "The following flags are available for the `app import-extensions` command:", + "isPublicDocs": true, + "members": [ + { + "filePath": "docs-shopify.dev/commands/interfaces/app-import-extensions.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--client-id ", + "value": "string", + "description": "The Client ID of your app.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_CLIENT_ID" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-import-extensions.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--no-color", + "value": "''", + "description": "Disable color output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_NO_COLOR" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-import-extensions.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--path ", + "value": "string", + "description": "The path to your app directory.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_PATH" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-import-extensions.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--reset", + "value": "''", + "description": "Reset all your settings.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_RESET" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-import-extensions.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--verbose", + "value": "''", + "description": "Increase the verbosity of the output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_VERBOSE" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-import-extensions.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-c, --config ", + "value": "string", + "description": "The name of the app configuration.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_APP_CONFIG" + } + ], + "value": "export interface appimportextensions {\n /**\n * The Client ID of your app.\n * @environment SHOPIFY_FLAG_CLIENT_ID\n */\n '--client-id '?: string\n\n /**\n * The name of the app configuration.\n * @environment SHOPIFY_FLAG_APP_CONFIG\n */\n '-c, --config '?: string\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * The path to your app directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Reset all your settings.\n * @environment SHOPIFY_FLAG_RESET\n */\n '--reset'?: ''\n\n /**\n * Increase the verbosity of the output.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" + } + }, + "appinfo": { + "docs-shopify.dev/commands/interfaces/app-info.interface.ts": { + "filePath": "docs-shopify.dev/commands/interfaces/app-info.interface.ts", + "name": "appinfo", + "description": "The following flags are available for the `app info` command:", + "isPublicDocs": true, + "members": [ + { + "filePath": "docs-shopify.dev/commands/interfaces/app-info.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--client-id ", + "value": "string", + "description": "The Client ID of your app.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_CLIENT_ID" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-info.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--no-color", + "value": "''", + "description": "Disable color output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_NO_COLOR" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-info.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--path ", + "value": "string", + "description": "The path to your app directory.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_PATH" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-info.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--reset", + "value": "''", + "description": "Reset all your settings.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_RESET" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-info.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--verbose", + "value": "''", + "description": "Increase the verbosity of the output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_VERBOSE" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-info.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--web-env", + "value": "''", + "description": "Outputs environment variables necessary for running and deploying web/.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_OUTPUT_WEB_ENV" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-info.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-c, --config ", + "value": "string", + "description": "The name of the app configuration.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_APP_CONFIG" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-info.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-j, --json", + "value": "''", + "description": "Output the result as JSON. Automatically disables color output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON" + } + ], + "value": "export interface appinfo {\n /**\n * The Client ID of your app.\n * @environment SHOPIFY_FLAG_CLIENT_ID\n */\n '--client-id '?: string\n\n /**\n * The name of the app configuration.\n * @environment SHOPIFY_FLAG_APP_CONFIG\n */\n '-c, --config '?: string\n\n /**\n * Output the result as JSON. Automatically disables color output.\n * @environment SHOPIFY_FLAG_JSON\n */\n '-j, --json'?: ''\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * The path to your app directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Reset all your settings.\n * @environment SHOPIFY_FLAG_RESET\n */\n '--reset'?: ''\n\n /**\n * Increase the verbosity of the output.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n\n /**\n * Outputs environment variables necessary for running and deploying web/.\n * @environment SHOPIFY_FLAG_OUTPUT_WEB_ENV\n */\n '--web-env'?: ''\n}" + } + }, + "appinit": { + "docs-shopify.dev/commands/interfaces/app-init.interface.ts": { + "filePath": "docs-shopify.dev/commands/interfaces/app-init.interface.ts", + "name": "appinit", + "description": "The following flags are available for the `app init` command:", + "isPublicDocs": true, + "members": [ + { + "filePath": "docs-shopify.dev/commands/interfaces/app-init.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--client-id ", + "value": "string", + "description": "The Client ID of your app. Use this to automatically link your new project to an existing app. Using this flag avoids the app selection prompt.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_CLIENT_ID" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-init.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--flavor ", + "value": "string", + "description": "Which flavor of the given template to use.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_TEMPLATE_FLAVOR" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-init.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--no-color", + "value": "''", + "description": "Disable color output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_NO_COLOR" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-init.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--organization-id ", + "value": "string", + "description": "The organization ID. Your organization ID can be found in your Dev Dashboard URL: https://dev.shopify.com/dashboard/", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_ORGANIZATION_ID" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-init.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--template ", + "value": "string", + "description": "The app template. Accepts one of the following: - \n - Any GitHub repo with optional branch and subpath, e.g., https://github.com/Shopify//[subpath]#[branch]", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_TEMPLATE" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-init.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--verbose", + "value": "''", + "description": "Increase the verbosity of the output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_VERBOSE" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-init.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-d, --package-manager ", + "value": "string", + "description": "", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_PACKAGE_MANAGER" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-init.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-n, --name ", + "value": "string", + "description": "The name for the new app. When provided, skips the app selection prompt and creates a new app with this name.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_NAME" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-init.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-p, --path ", + "value": "string", + "description": "", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_PATH" + } + ], + "value": "export interface appinit {\n /**\n * The Client ID of your app. Use this to automatically link your new project to an existing app. Using this flag avoids the app selection prompt.\n * @environment SHOPIFY_FLAG_CLIENT_ID\n */\n '--client-id '?: string\n\n /**\n * Which flavor of the given template to use.\n * @environment SHOPIFY_FLAG_TEMPLATE_FLAVOR\n */\n '--flavor '?: string\n\n /**\n * The name for the new app. When provided, skips the app selection prompt and creates a new app with this name.\n * @environment SHOPIFY_FLAG_NAME\n */\n '-n, --name '?: string\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * The organization ID. Your organization ID can be found in your Dev Dashboard URL: https://dev.shopify.com/dashboard/\n * @environment SHOPIFY_FLAG_ORGANIZATION_ID\n */\n '--organization-id '?: string\n\n /**\n * \n * @environment SHOPIFY_FLAG_PACKAGE_MANAGER\n */\n '-d, --package-manager '?: string\n\n /**\n * \n * @environment SHOPIFY_FLAG_PATH\n */\n '-p, --path '?: string\n\n /**\n * The app template. Accepts one of the following:\n - \n - Any GitHub repo with optional branch and subpath, e.g., https://github.com/Shopify//[subpath]#[branch]\n * @environment SHOPIFY_FLAG_TEMPLATE\n */\n '--template '?: string\n\n /**\n * Increase the verbosity of the output.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" + } + }, + "applogssources": { + "docs-shopify.dev/commands/interfaces/app-logs-sources.interface.ts": { + "filePath": "docs-shopify.dev/commands/interfaces/app-logs-sources.interface.ts", + "name": "applogssources", + "description": "The following flags are available for the `app logs sources` command:", + "isPublicDocs": true, + "members": [ + { + "filePath": "docs-shopify.dev/commands/interfaces/app-logs-sources.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--client-id ", + "value": "string", + "description": "The Client ID of your app.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_CLIENT_ID" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-logs-sources.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--no-color", + "value": "''", + "description": "Disable color output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_NO_COLOR" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-logs-sources.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--path ", + "value": "string", + "description": "The path to your app directory.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_PATH" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-logs-sources.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--reset", + "value": "''", + "description": "Reset all your settings.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_RESET" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-logs-sources.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--verbose", + "value": "''", + "description": "Increase the verbosity of the output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_VERBOSE" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-logs-sources.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-c, --config ", + "value": "string", + "description": "The name of the app configuration.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_APP_CONFIG" + } + ], + "value": "export interface applogssources {\n /**\n * The Client ID of your app.\n * @environment SHOPIFY_FLAG_CLIENT_ID\n */\n '--client-id '?: string\n\n /**\n * The name of the app configuration.\n * @environment SHOPIFY_FLAG_APP_CONFIG\n */\n '-c, --config '?: string\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * The path to your app directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Reset all your settings.\n * @environment SHOPIFY_FLAG_RESET\n */\n '--reset'?: ''\n\n /**\n * Increase the verbosity of the output.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" + } + }, + "applogs": { + "docs-shopify.dev/commands/interfaces/app-logs.interface.ts": { + "filePath": "docs-shopify.dev/commands/interfaces/app-logs.interface.ts", + "name": "applogs", + "description": "The following flags are available for the `app logs` command:", + "isPublicDocs": true, + "members": [ + { + "filePath": "docs-shopify.dev/commands/interfaces/app-logs.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--client-id ", + "value": "string", + "description": "The Client ID of your app.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_CLIENT_ID" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-logs.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--no-color", + "value": "''", + "description": "Disable color output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_NO_COLOR" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-logs.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--path ", + "value": "string", + "description": "The path to your app directory.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_PATH" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-logs.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--reset", + "value": "''", + "description": "Reset all your settings.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_RESET" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-logs.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--source ", + "value": "string", + "description": "Filters output to the specified log source.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_SOURCE" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-logs.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--status ", + "value": "string", + "description": "Filters output to the specified status (success or failure).", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_STATUS" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-logs.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--verbose", + "value": "''", + "description": "Increase the verbosity of the output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_VERBOSE" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-logs.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-c, --config ", + "value": "string", + "description": "The name of the app configuration.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_APP_CONFIG" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-logs.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-j, --json", + "value": "''", + "description": "Output the result as JSON. Automatically disables color output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-logs.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-s, --store ", + "value": "string", + "description": "Store URL. Must be an existing development or Shopify Plus sandbox store.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_STORE" + } + ], + "value": "export interface applogs {\n /**\n * The Client ID of your app.\n * @environment SHOPIFY_FLAG_CLIENT_ID\n */\n '--client-id '?: string\n\n /**\n * The name of the app configuration.\n * @environment SHOPIFY_FLAG_APP_CONFIG\n */\n '-c, --config '?: string\n\n /**\n * Output the result as JSON. Automatically disables color output.\n * @environment SHOPIFY_FLAG_JSON\n */\n '-j, --json'?: ''\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * The path to your app directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Reset all your settings.\n * @environment SHOPIFY_FLAG_RESET\n */\n '--reset'?: ''\n\n /**\n * Filters output to the specified log source.\n * @environment SHOPIFY_FLAG_SOURCE\n */\n '--source '?: string\n\n /**\n * Filters output to the specified status (success or failure).\n * @environment SHOPIFY_FLAG_STATUS\n */\n '--status '?: string\n\n /**\n * Store URL. Must be an existing development or Shopify Plus sandbox store.\n * @environment SHOPIFY_FLAG_STORE\n */\n '-s, --store '?: string\n\n /**\n * Increase the verbosity of the output.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" + } + }, + "apprelease": { + "docs-shopify.dev/commands/interfaces/app-release.interface.ts": { + "filePath": "docs-shopify.dev/commands/interfaces/app-release.interface.ts", + "name": "apprelease", + "description": "The following flags are available for the `app release` command:", + "isPublicDocs": true, + "members": [ + { + "filePath": "docs-shopify.dev/commands/interfaces/app-release.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--allow-deletes", + "value": "''", + "description": "Allows removing extensions and configuration without requiring user confirmation. For CI/CD environments, the recommended flag is --allow-updates.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_ALLOW_DELETES" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-release.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--allow-updates", + "value": "''", + "description": "Allows adding and updating extensions and configuration without requiring user confirmation. Recommended option for CI/CD environments.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_ALLOW_UPDATES" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-release.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--client-id ", + "value": "string", + "description": "The Client ID of your app.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_CLIENT_ID" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-release.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--no-color", + "value": "''", + "description": "Disable color output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_NO_COLOR" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-release.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--path ", + "value": "string", + "description": "The path to your app directory.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_PATH" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-release.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--reset", + "value": "''", + "description": "Reset all your settings.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_RESET" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-release.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--verbose", + "value": "''", + "description": "Increase the verbosity of the output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_VERBOSE" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-release.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--version ", + "value": "string", + "description": "The name of the app version to release.", + "environmentValue": "SHOPIFY_FLAG_VERSION" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-release.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-c, --config ", + "value": "string", + "description": "The name of the app configuration.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_APP_CONFIG" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-release.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-f, --force", + "value": "''", + "description": "[Deprecated] Release without asking for confirmation. Equivalent to --allow-updates --allow-deletes. Use --allow-updates for CI/CD environments instead.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_FORCE" + } + ], + "value": "export interface apprelease {\n /**\n * Allows removing extensions and configuration without requiring user confirmation. For CI/CD environments, the recommended flag is --allow-updates.\n * @environment SHOPIFY_FLAG_ALLOW_DELETES\n */\n '--allow-deletes'?: ''\n\n /**\n * Allows adding and updating extensions and configuration without requiring user confirmation. Recommended option for CI/CD environments.\n * @environment SHOPIFY_FLAG_ALLOW_UPDATES\n */\n '--allow-updates'?: ''\n\n /**\n * The Client ID of your app.\n * @environment SHOPIFY_FLAG_CLIENT_ID\n */\n '--client-id '?: string\n\n /**\n * The name of the app configuration.\n * @environment SHOPIFY_FLAG_APP_CONFIG\n */\n '-c, --config '?: string\n\n /**\n * [Deprecated] Release without asking for confirmation. Equivalent to --allow-updates --allow-deletes. Use --allow-updates for CI/CD environments instead.\n * @environment SHOPIFY_FLAG_FORCE\n */\n '-f, --force'?: ''\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * The path to your app directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Reset all your settings.\n * @environment SHOPIFY_FLAG_RESET\n */\n '--reset'?: ''\n\n /**\n * Increase the verbosity of the output.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n\n /**\n * The name of the app version to release.\n * @environment SHOPIFY_FLAG_VERSION\n */\n '--version ': string\n}" + } + }, + "appversionslist": { + "docs-shopify.dev/commands/interfaces/app-versions-list.interface.ts": { + "filePath": "docs-shopify.dev/commands/interfaces/app-versions-list.interface.ts", + "name": "appversionslist", + "description": "The following flags are available for the `app versions list` command:", + "isPublicDocs": true, + "members": [ + { + "filePath": "docs-shopify.dev/commands/interfaces/app-versions-list.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--client-id ", + "value": "string", + "description": "The Client ID of your app.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_CLIENT_ID" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-versions-list.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--no-color", + "value": "''", + "description": "Disable color output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_NO_COLOR" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-versions-list.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--path ", + "value": "string", + "description": "The path to your app directory.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_PATH" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-versions-list.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--reset", + "value": "''", + "description": "Reset all your settings.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_RESET" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-versions-list.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--verbose", + "value": "''", + "description": "Increase the verbosity of the output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_VERBOSE" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-versions-list.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-c, --config ", + "value": "string", + "description": "The name of the app configuration.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_APP_CONFIG" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-versions-list.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-j, --json", + "value": "''", + "description": "Output the result as JSON. Automatically disables color output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON" + } + ], + "value": "export interface appversionslist {\n /**\n * The Client ID of your app.\n * @environment SHOPIFY_FLAG_CLIENT_ID\n */\n '--client-id '?: string\n\n /**\n * The name of the app configuration.\n * @environment SHOPIFY_FLAG_APP_CONFIG\n */\n '-c, --config '?: string\n\n /**\n * Output the result as JSON. Automatically disables color output.\n * @environment SHOPIFY_FLAG_JSON\n */\n '-j, --json'?: ''\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * The path to your app directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Reset all your settings.\n * @environment SHOPIFY_FLAG_RESET\n */\n '--reset'?: ''\n\n /**\n * Increase the verbosity of the output.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" + } + }, + "appwebhooktrigger": { + "docs-shopify.dev/commands/interfaces/app-webhook-trigger.interface.ts": { + "filePath": "docs-shopify.dev/commands/interfaces/app-webhook-trigger.interface.ts", + "name": "appwebhooktrigger", + "description": "The following flags are available for the `app webhook trigger` command:", + "isPublicDocs": true, + "members": [ + { + "filePath": "docs-shopify.dev/commands/interfaces/app-webhook-trigger.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--address ", + "value": "string", + "description": "The URL where the webhook payload should be sent. You will need a different address type for each delivery-method:\n · For remote HTTP testing, use a URL that starts with https://\n · For local HTTP testing, use http://localhost:{port}/{url-path}\n · For Google Pub/Sub, use pubsub://{project-id}:{topic-id}\n · For Amazon EventBridge, use an Amazon Resource Name (ARN) starting with arn:aws:events:", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_ADDRESS" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-webhook-trigger.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--api-version ", + "value": "string", + "description": "The API Version of the webhook topic.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_API_VERSION" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-webhook-trigger.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--client-id ", + "value": "string", + "description": "The Client ID of your app.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_CLIENT_ID" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-webhook-trigger.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--client-secret ", + "value": "string", + "description": "Your app's client secret. This secret allows us to return the X-Shopify-Hmac-SHA256 header that lets you validate the origin of the response that you receive.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_CLIENT_SECRET" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-webhook-trigger.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--delivery-method ", + "value": "string", + "description": "Method chosen to deliver the topic payload. If not passed, it's inferred from the address.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_DELIVERY_METHOD" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-webhook-trigger.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--help", + "value": "''", + "description": "This help. When you run the trigger command the CLI will prompt you for any information that isn't passed using flags.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_HELP" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-webhook-trigger.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--path ", + "value": "string", + "description": "The path to your app directory.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_PATH" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-webhook-trigger.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--reset", + "value": "''", + "description": "Reset all your settings.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_RESET" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-webhook-trigger.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--shared-secret ", + "value": "string", + "description": "Deprecated. Please use client-secret.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_SHARED_SECRET" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-webhook-trigger.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--topic ", + "value": "string", + "description": "The requested webhook topic.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_TOPIC" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/app-webhook-trigger.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-c, --config ", + "value": "string", + "description": "The name of the app configuration.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_APP_CONFIG" + } + ], + "value": "export interface appwebhooktrigger {\n /**\n * The URL where the webhook payload should be sent.\n You will need a different address type for each delivery-method:\n · For remote HTTP testing, use a URL that starts with https://\n · For local HTTP testing, use http://localhost:{port}/{url-path}\n · For Google Pub/Sub, use pubsub://{project-id}:{topic-id}\n · For Amazon EventBridge, use an Amazon Resource Name (ARN) starting with arn:aws:events:\n * @environment SHOPIFY_FLAG_ADDRESS\n */\n '--address '?: string\n\n /**\n * The API Version of the webhook topic.\n * @environment SHOPIFY_FLAG_API_VERSION\n */\n '--api-version '?: string\n\n /**\n * The Client ID of your app.\n * @environment SHOPIFY_FLAG_CLIENT_ID\n */\n '--client-id '?: string\n\n /**\n * Your app's client secret. This secret allows us to return the X-Shopify-Hmac-SHA256 header that lets you validate the origin of the response that you receive.\n * @environment SHOPIFY_FLAG_CLIENT_SECRET\n */\n '--client-secret '?: string\n\n /**\n * The name of the app configuration.\n * @environment SHOPIFY_FLAG_APP_CONFIG\n */\n '-c, --config '?: string\n\n /**\n * Method chosen to deliver the topic payload. If not passed, it's inferred from the address.\n * @environment SHOPIFY_FLAG_DELIVERY_METHOD\n */\n '--delivery-method '?: string\n\n /**\n * This help. When you run the trigger command the CLI will prompt you for any information that isn't passed using flags.\n * @environment SHOPIFY_FLAG_HELP\n */\n '--help'?: ''\n\n /**\n * The path to your app directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Reset all your settings.\n * @environment SHOPIFY_FLAG_RESET\n */\n '--reset'?: ''\n\n /**\n * Deprecated. Please use client-secret.\n * @environment SHOPIFY_FLAG_SHARED_SECRET\n */\n '--shared-secret '?: string\n\n /**\n * The requested webhook topic.\n * @environment SHOPIFY_FLAG_TOPIC\n */\n '--topic '?: string\n}" + } + }, + "authlogin": { + "docs-shopify.dev/commands/interfaces/auth-login.interface.ts": { + "filePath": "docs-shopify.dev/commands/interfaces/auth-login.interface.ts", + "name": "authlogin", + "description": "The following flags are available for the `auth login` command:", + "isPublicDocs": true, + "members": [ + { + "filePath": "docs-shopify.dev/commands/interfaces/auth-login.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--alias ", + "value": "string", + "description": "Alias of the session you want to login to.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_AUTH_ALIAS" + } + ], + "value": "export interface authlogin {\n /**\n * Alias of the session you want to login to.\n * @environment SHOPIFY_FLAG_AUTH_ALIAS\n */\n '--alias '?: string\n}" + } + }, + "authlogout": { + "docs-shopify.dev/commands/interfaces/auth-logout.interface.ts": { + "filePath": "docs-shopify.dev/commands/interfaces/auth-logout.interface.ts", + "name": "authlogout", + "description": "", + "isPublicDocs": true, + "members": [], + "value": "export interface authlogout {\n\n}" + } + }, + "commands": { + "docs-shopify.dev/commands/interfaces/commands.interface.ts": { + "filePath": "docs-shopify.dev/commands/interfaces/commands.interface.ts", + "name": "commands", + "description": "The following flags are available for the `commands` command:", + "isPublicDocs": true, + "members": [ + { + "filePath": "docs-shopify.dev/commands/interfaces/commands.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--deprecated", + "value": "''", + "description": "Show deprecated commands.", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/commands.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--hidden", + "value": "''", + "description": "Show hidden commands.", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/commands.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--json", + "value": "''", + "description": "Format output as json.", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/commands.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--no-truncate", + "value": "''", + "description": "Do not truncate output.", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/commands.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--sort ", + "value": "string", + "description": "Property to sort by.", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/commands.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--tree", + "value": "''", + "description": "Show tree of commands.", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/commands.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-c, --columns ", + "value": "string", + "description": "Only show provided columns (comma-separated).", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/commands.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-x, --extended", + "value": "''", + "description": "Show extra columns.", + "isOptional": true + } + ], + "value": "export interface commands {\n /**\n * Only show provided columns (comma-separated).\n *\n */\n '-c, --columns '?: string\n\n /**\n * Show deprecated commands.\n *\n */\n '--deprecated'?: ''\n\n /**\n * Show extra columns.\n *\n */\n '-x, --extended'?: ''\n\n /**\n * Show hidden commands.\n *\n */\n '--hidden'?: ''\n\n /**\n * Format output as json.\n *\n */\n '--json'?: ''\n\n /**\n * Do not truncate output.\n *\n */\n '--no-truncate'?: ''\n\n /**\n * Property to sort by.\n *\n */\n '--sort '?: string\n\n /**\n * Show tree of commands.\n *\n */\n '--tree'?: ''\n}" + } + }, + "configautocorrectoff": { + "docs-shopify.dev/commands/interfaces/config-autocorrect-off.interface.ts": { + "filePath": "docs-shopify.dev/commands/interfaces/config-autocorrect-off.interface.ts", + "name": "configautocorrectoff", + "description": "", + "isPublicDocs": true, + "members": [], + "value": "export interface configautocorrectoff {\n\n}" + } + }, + "configautocorrecton": { + "docs-shopify.dev/commands/interfaces/config-autocorrect-on.interface.ts": { + "filePath": "docs-shopify.dev/commands/interfaces/config-autocorrect-on.interface.ts", + "name": "configautocorrecton", + "description": "", + "isPublicDocs": true, + "members": [], + "value": "export interface configautocorrecton {\n\n}" + } + }, + "configautocorrectstatus": { + "docs-shopify.dev/commands/interfaces/config-autocorrect-status.interface.ts": { + "filePath": "docs-shopify.dev/commands/interfaces/config-autocorrect-status.interface.ts", + "name": "configautocorrectstatus", + "description": "", + "isPublicDocs": true, + "members": [], + "value": "export interface configautocorrectstatus {\n\n}" + } + }, + "help": { + "docs-shopify.dev/commands/interfaces/help.interface.ts": { + "filePath": "docs-shopify.dev/commands/interfaces/help.interface.ts", + "name": "help", + "description": "The following flags are available for the `help` command:", + "isPublicDocs": true, + "members": [ + { + "filePath": "docs-shopify.dev/commands/interfaces/help.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-n, --nested-commands", + "value": "''", + "description": "Include all nested commands in the output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_CLI_NESTED_COMMANDS" + } + ], + "value": "export interface help {\n /**\n * Include all nested commands in the output.\n * @environment SHOPIFY_FLAG_CLI_NESTED_COMMANDS\n */\n '-n, --nested-commands'?: ''\n}" + } + }, + "hydrogenbuild": { + "docs-shopify.dev/commands/interfaces/hydrogen-build.interface.ts": { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-build.interface.ts", + "name": "hydrogenbuild", + "description": "The following flags are available for the `hydrogen build` command:", + "isPublicDocs": true, + "members": [ + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-build.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--bundle-stats", + "value": "''", + "description": "Show a bundle size summary after building. Defaults to true, use `--no-bundle-stats` to disable.", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-build.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--codegen", + "value": "''", + "description": "Automatically generates GraphQL types for your project’s Storefront API queries.", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-build.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--codegen-config-path ", + "value": "string", + "description": "Specifies a path to a codegen configuration file. Defaults to `/codegen.ts` if this file exists.", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-build.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--disable-route-warning", + "value": "''", + "description": "Disables any warnings about missing standard routes.", + "isOptional": true, + "environmentValue": "SHOPIFY_HYDROGEN_FLAG_DISABLE_ROUTE_WARNING" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-build.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--entry ", + "value": "string", + "description": "Entry file for the worker. Defaults to `./server`.", + "isOptional": true, + "environmentValue": "SHOPIFY_HYDROGEN_FLAG_ENTRY" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-build.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--force-client-sourcemap", + "value": "''", + "description": "Client sourcemapping is avoided by default because it makes backend code visible in the browser. Use this flag to force enabling it.", + "isOptional": true, + "environmentValue": "SHOPIFY_HYDROGEN_FLAG_FORCE_CLIENT_SOURCEMAP" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-build.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--lockfile-check", + "value": "''", + "description": "Checks that there is exactly one valid lockfile in the project. Defaults to `true`. Deactivate with `--no-lockfile-check`.", + "isOptional": true, + "environmentValue": "SHOPIFY_HYDROGEN_FLAG_LOCKFILE_CHECK" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-build.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--path ", + "value": "string", + "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.", + "isOptional": true, + "environmentValue": "SHOPIFY_HYDROGEN_FLAG_PATH" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-build.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--sourcemap", + "value": "''", + "description": "Controls whether server sourcemaps are generated. Default to `true`. Deactivate `--no-sourcemaps`.", + "isOptional": true, + "environmentValue": "SHOPIFY_HYDROGEN_FLAG_SOURCEMAP" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-build.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--watch", + "value": "''", + "description": "Watches for changes and rebuilds the project writing output to disk.", + "isOptional": true, + "environmentValue": "SHOPIFY_HYDROGEN_FLAG_WATCH" + } + ], + "value": "export interface hydrogenbuild {\n /**\n * Show a bundle size summary after building. Defaults to true, use `--no-bundle-stats` to disable.\n *\n */\n '--bundle-stats'?: ''\n\n /**\n * Automatically generates GraphQL types for your project’s Storefront API queries.\n *\n */\n '--codegen'?: ''\n\n /**\n * Specifies a path to a codegen configuration file. Defaults to `/codegen.ts` if this file exists.\n *\n */\n '--codegen-config-path '?: string\n\n /**\n * Disables any warnings about missing standard routes.\n * @environment SHOPIFY_HYDROGEN_FLAG_DISABLE_ROUTE_WARNING\n */\n '--disable-route-warning'?: ''\n\n /**\n * Entry file for the worker. Defaults to `./server`.\n * @environment SHOPIFY_HYDROGEN_FLAG_ENTRY\n */\n '--entry '?: string\n\n /**\n * Client sourcemapping is avoided by default because it makes backend code visible in the browser. Use this flag to force enabling it.\n * @environment SHOPIFY_HYDROGEN_FLAG_FORCE_CLIENT_SOURCEMAP\n */\n '--force-client-sourcemap'?: ''\n\n /**\n * Checks that there is exactly one valid lockfile in the project. Defaults to `true`. Deactivate with `--no-lockfile-check`.\n * @environment SHOPIFY_HYDROGEN_FLAG_LOCKFILE_CHECK\n */\n '--lockfile-check'?: ''\n\n /**\n * The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.\n * @environment SHOPIFY_HYDROGEN_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Controls whether server sourcemaps are generated. Default to `true`. Deactivate `--no-sourcemaps`.\n * @environment SHOPIFY_HYDROGEN_FLAG_SOURCEMAP\n */\n '--sourcemap'?: ''\n\n /**\n * Watches for changes and rebuilds the project writing output to disk.\n * @environment SHOPIFY_HYDROGEN_FLAG_WATCH\n */\n '--watch'?: ''\n}" + } + }, + "hydrogencheck": { + "docs-shopify.dev/commands/interfaces/hydrogen-check.interface.ts": { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-check.interface.ts", + "name": "hydrogencheck", + "description": "The following flags are available for the `hydrogen check` command:", + "isPublicDocs": true, + "members": [ + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-check.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--path ", + "value": "string", + "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.", + "isOptional": true, + "environmentValue": "SHOPIFY_HYDROGEN_FLAG_PATH" + } + ], + "value": "export interface hydrogencheck {\n /**\n * The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.\n * @environment SHOPIFY_HYDROGEN_FLAG_PATH\n */\n '--path '?: string\n}" + } + }, + "hydrogencodegen": { + "docs-shopify.dev/commands/interfaces/hydrogen-codegen.interface.ts": { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-codegen.interface.ts", + "name": "hydrogencodegen", + "description": "The following flags are available for the `hydrogen codegen` command:", + "isPublicDocs": true, + "members": [ + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-codegen.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--codegen-config-path ", + "value": "string", + "description": "Specify a path to a codegen configuration file. Defaults to `/codegen.ts` if it exists.", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-codegen.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--path ", + "value": "string", + "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.", + "isOptional": true, + "environmentValue": "SHOPIFY_HYDROGEN_FLAG_PATH" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-codegen.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--watch", + "value": "''", + "description": "Watch the project for changes to update types on file save.", + "isOptional": true + } + ], + "value": "export interface hydrogencodegen {\n /**\n * Specify a path to a codegen configuration file. Defaults to `/codegen.ts` if it exists.\n *\n */\n '--codegen-config-path '?: string\n\n /**\n * The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.\n * @environment SHOPIFY_HYDROGEN_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Watch the project for changes to update types on file save.\n *\n */\n '--watch'?: ''\n}" + } + }, + "hydrogencustomeraccountpush": { + "docs-shopify.dev/commands/interfaces/hydrogen-customer-account-push.interface.ts": { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-customer-account-push.interface.ts", + "name": "hydrogencustomeraccountpush", + "description": "The following flags are available for the `hydrogen customer-account-push` command:", + "isPublicDocs": true, + "members": [ + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-customer-account-push.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--dev-origin ", + "value": "string", + "description": "The development domain of your application." + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-customer-account-push.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--path ", + "value": "string", + "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.", + "isOptional": true, + "environmentValue": "SHOPIFY_HYDROGEN_FLAG_PATH" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-customer-account-push.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--relative-logout-uri ", + "value": "string", + "description": "The relative url of allowed url that will be redirected to post-logout for Customer Account API OAuth flow. Default to nothing.", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-customer-account-push.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--relative-redirect-uri ", + "value": "string", + "description": "The relative url of allowed callback url for Customer Account API OAuth flow. Default is '/account/authorize'", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-customer-account-push.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--storefront-id ", + "value": "string", + "description": "The id of the storefront the configuration should be pushed to. Must start with 'gid://shopify/HydrogenStorefront/'", + "isOptional": true + } + ], + "value": "export interface hydrogencustomeraccountpush {\n /**\n * The development domain of your application.\n *\n */\n '--dev-origin ': string\n\n /**\n * The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.\n * @environment SHOPIFY_HYDROGEN_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * The relative url of allowed url that will be redirected to post-logout for Customer Account API OAuth flow. Default to nothing.\n *\n */\n '--relative-logout-uri '?: string\n\n /**\n * The relative url of allowed callback url for Customer Account API OAuth flow. Default is '/account/authorize'\n *\n */\n '--relative-redirect-uri '?: string\n\n /**\n * The id of the storefront the configuration should be pushed to. Must start with 'gid://shopify/HydrogenStorefront/'\n *\n */\n '--storefront-id '?: string\n}" + } + }, + "hydrogendebugcpu": { + "docs-shopify.dev/commands/interfaces/hydrogen-debug-cpu.interface.ts": { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-debug-cpu.interface.ts", + "name": "hydrogendebugcpu", + "description": "The following flags are available for the `hydrogen debug cpu` command:", + "isPublicDocs": true, + "members": [ + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-debug-cpu.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--entry ", + "value": "string", + "description": "Entry file for the worker. Defaults to `./server`.", + "isOptional": true, + "environmentValue": "SHOPIFY_HYDROGEN_FLAG_ENTRY" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-debug-cpu.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--output ", + "value": "string", + "description": "Specify a path to generate the profile file. Defaults to \"startup.cpuprofile\".", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-debug-cpu.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--path ", + "value": "string", + "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.", + "isOptional": true, + "environmentValue": "SHOPIFY_HYDROGEN_FLAG_PATH" + } + ], + "value": "export interface hydrogendebugcpu {\n /**\n * Entry file for the worker. Defaults to `./server`.\n * @environment SHOPIFY_HYDROGEN_FLAG_ENTRY\n */\n '--entry '?: string\n\n /**\n * Specify a path to generate the profile file. Defaults to \"startup.cpuprofile\".\n *\n */\n '--output '?: string\n\n /**\n * The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.\n * @environment SHOPIFY_HYDROGEN_FLAG_PATH\n */\n '--path '?: string\n}" + } + }, + "hydrogendeploy": { + "docs-shopify.dev/commands/interfaces/hydrogen-deploy.interface.ts": { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-deploy.interface.ts", + "name": "hydrogendeploy", + "description": "The following flags are available for the `hydrogen deploy` command:", + "isPublicDocs": true, + "members": [ + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-deploy.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--auth-bypass-token", + "value": "''", + "description": "Generate an authentication bypass token, which can be used to perform end-to-end tests against the deployment.", + "isOptional": true, + "environmentValue": "AUTH_BYPASS_TOKEN" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-deploy.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--auth-bypass-token-duration ", + "value": "string", + "description": "Specify the duration (in hours) up to 12 hours for the authentication bypass token. Defaults to `2`", + "isOptional": true, + "environmentValue": "AUTH_BYPASS_TOKEN_DURATION" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-deploy.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--build-command ", + "value": "string", + "description": "Specify a build command to run before deploying. If not specified, `shopify hydrogen build` will be used.", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-deploy.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--entry ", + "value": "string", + "description": "Entry file for the worker. Defaults to `./server`.", + "isOptional": true, + "environmentValue": "SHOPIFY_HYDROGEN_FLAG_ENTRY" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-deploy.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--env ", + "value": "string", + "description": "Specifies the environment to perform the operation using its handle. Fetch the handle using the `env list` command.", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-deploy.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--env-branch ", + "value": "string", + "description": "Specifies the environment to perform the operation using its Git branch name.", + "isOptional": true, + "environmentValue": "SHOPIFY_HYDROGEN_ENVIRONMENT_BRANCH" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-deploy.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--env-file ", + "value": "string", + "description": "Path to an environment file to override existing environment variables for the deployment.", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-deploy.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--force-client-sourcemap", + "value": "''", + "description": "Client sourcemapping is avoided by default because it makes backend code visible in the browser. Use this flag to force enabling it.", + "isOptional": true, + "environmentValue": "SHOPIFY_HYDROGEN_FLAG_FORCE_CLIENT_SOURCEMAP" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-deploy.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--json-output", + "value": "''", + "description": "Create a JSON file containing the deployment details in CI environments. Defaults to true, use `--no-json-output` to disable.", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-deploy.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--lockfile-check", + "value": "''", + "description": "Checks that there is exactly one valid lockfile in the project. Defaults to `true`. Deactivate with `--no-lockfile-check`.", + "isOptional": true, + "environmentValue": "SHOPIFY_HYDROGEN_FLAG_LOCKFILE_CHECK" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-deploy.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--metadata-description ", + "value": "string", + "description": "Description of the changes in the deployment. Defaults to the commit message of the latest commit if there are no uncommited changes.", + "isOptional": true, + "environmentValue": "SHOPIFY_HYDROGEN_FLAG_METADATA_DESCRIPTION" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-deploy.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--metadata-user ", + "value": "string", + "description": "User that initiated the deployment. Will be saved and displayed in the Shopify admin", + "isOptional": true, + "environmentValue": "SHOPIFY_HYDROGEN_FLAG_METADATA_USER" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-deploy.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--no-verify", + "value": "''", + "description": "Skip the routability verification step after deployment.", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-deploy.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--path ", + "value": "string", + "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.", + "isOptional": true, + "environmentValue": "SHOPIFY_HYDROGEN_FLAG_PATH" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-deploy.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--preview", + "value": "''", + "description": "Deploys to the Preview environment.", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-deploy.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-f, --force", + "value": "''", + "description": "Forces a deployment to proceed if there are uncommited changes in its Git repository.", + "isOptional": true, + "environmentValue": "SHOPIFY_HYDROGEN_FLAG_FORCE" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-deploy.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-s, --shop ", + "value": "string", + "description": "Shop URL. It can be the shop prefix (janes-apparel) or the full myshopify.com URL (janes-apparel.myshopify.com, https://janes-apparel.myshopify.com).", + "isOptional": true, + "environmentValue": "SHOPIFY_SHOP" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-deploy.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-t, --token ", + "value": "string", + "description": "Oxygen deployment token. Defaults to the linked storefront's token if available.", + "isOptional": true, + "environmentValue": "SHOPIFY_HYDROGEN_DEPLOYMENT_TOKEN" + } + ], + "value": "export interface hydrogendeploy {\n /**\n * Generate an authentication bypass token, which can be used to perform end-to-end tests against the deployment.\n * @environment AUTH_BYPASS_TOKEN\n */\n '--auth-bypass-token'?: ''\n\n /**\n * Specify the duration (in hours) up to 12 hours for the authentication bypass token. Defaults to `2`\n * @environment AUTH_BYPASS_TOKEN_DURATION\n */\n '--auth-bypass-token-duration '?: string\n\n /**\n * Specify a build command to run before deploying. If not specified, `shopify hydrogen build` will be used.\n *\n */\n '--build-command '?: string\n\n /**\n * Entry file for the worker. Defaults to `./server`.\n * @environment SHOPIFY_HYDROGEN_FLAG_ENTRY\n */\n '--entry '?: string\n\n /**\n * Specifies the environment to perform the operation using its handle. Fetch the handle using the `env list` command.\n *\n */\n '--env '?: string\n\n /**\n * Specifies the environment to perform the operation using its Git branch name.\n * @environment SHOPIFY_HYDROGEN_ENVIRONMENT_BRANCH\n */\n '--env-branch '?: string\n\n /**\n * Path to an environment file to override existing environment variables for the deployment.\n *\n */\n '--env-file '?: string\n\n /**\n * Forces a deployment to proceed if there are uncommited changes in its Git repository.\n * @environment SHOPIFY_HYDROGEN_FLAG_FORCE\n */\n '-f, --force'?: ''\n\n /**\n * Client sourcemapping is avoided by default because it makes backend code visible in the browser. Use this flag to force enabling it.\n * @environment SHOPIFY_HYDROGEN_FLAG_FORCE_CLIENT_SOURCEMAP\n */\n '--force-client-sourcemap'?: ''\n\n /**\n * Create a JSON file containing the deployment details in CI environments. Defaults to true, use `--no-json-output` to disable.\n *\n */\n '--json-output'?: ''\n\n /**\n * Checks that there is exactly one valid lockfile in the project. Defaults to `true`. Deactivate with `--no-lockfile-check`.\n * @environment SHOPIFY_HYDROGEN_FLAG_LOCKFILE_CHECK\n */\n '--lockfile-check'?: ''\n\n /**\n * Description of the changes in the deployment. Defaults to the commit message of the latest commit if there are no uncommited changes.\n * @environment SHOPIFY_HYDROGEN_FLAG_METADATA_DESCRIPTION\n */\n '--metadata-description '?: string\n\n /**\n * User that initiated the deployment. Will be saved and displayed in the Shopify admin\n * @environment SHOPIFY_HYDROGEN_FLAG_METADATA_USER\n */\n '--metadata-user '?: string\n\n /**\n * Skip the routability verification step after deployment.\n *\n */\n '--no-verify'?: ''\n\n /**\n * The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.\n * @environment SHOPIFY_HYDROGEN_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Deploys to the Preview environment.\n *\n */\n '--preview'?: ''\n\n /**\n * Shop URL. It can be the shop prefix (janes-apparel) or the full myshopify.com URL (janes-apparel.myshopify.com, https://janes-apparel.myshopify.com).\n * @environment SHOPIFY_SHOP\n */\n '-s, --shop '?: string\n\n /**\n * Oxygen deployment token. Defaults to the linked storefront's token if available.\n * @environment SHOPIFY_HYDROGEN_DEPLOYMENT_TOKEN\n */\n '-t, --token '?: string\n}" + } + }, + "hydrogendev": { + "docs-shopify.dev/commands/interfaces/hydrogen-dev.interface.ts": { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-dev.interface.ts", + "name": "hydrogendev", + "description": "The following flags are available for the `hydrogen dev` command:", + "isPublicDocs": true, + "members": [ + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-dev.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--codegen", + "value": "''", + "description": "Automatically generates GraphQL types for your project’s Storefront API queries.", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-dev.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--codegen-config-path ", + "value": "string", + "description": "Specifies a path to a codegen configuration file. Defaults to `/codegen.ts` if this file exists.", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-dev.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--customer-account-push", + "value": "''", + "description": "Use tunneling for local development and push the tunneling domain to admin. Required to use Customer Account API's OAuth flow", + "isOptional": true, + "environmentValue": "SHOPIFY_HYDROGEN_FLAG_CUSTOMER_ACCOUNT_PUSH" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-dev.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--debug", + "value": "''", + "description": "Enables inspector connections to the server with a debugger such as Visual Studio Code or Chrome DevTools.", + "isOptional": true, + "environmentValue": "SHOPIFY_HYDROGEN_FLAG_DEBUG" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-dev.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--disable-deps-optimizer", + "value": "''", + "description": "Disable adding dependencies to Vite's `ssr.optimizeDeps.include` automatically", + "isOptional": true, + "environmentValue": "SHOPIFY_HYDROGEN_FLAG_DISABLE_DEPS_OPTIMIZER" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-dev.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--disable-version-check", + "value": "''", + "description": "Skip the version check when running `hydrogen dev`", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-dev.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--disable-virtual-routes", + "value": "''", + "description": "Disable rendering fallback routes when a route file doesn't exist.", + "isOptional": true, + "environmentValue": "SHOPIFY_HYDROGEN_FLAG_DISABLE_VIRTUAL_ROUTES" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-dev.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--entry ", + "value": "string", + "description": "Entry file for the worker. Defaults to `./server`.", + "isOptional": true, + "environmentValue": "SHOPIFY_HYDROGEN_FLAG_ENTRY" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-dev.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--env ", + "value": "string", + "description": "Specifies the environment to perform the operation using its handle. Fetch the handle using the `env list` command.", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-dev.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--env-branch ", + "value": "string", + "description": "Specifies the environment to perform the operation using its Git branch name.", + "isOptional": true, + "environmentValue": "SHOPIFY_HYDROGEN_ENVIRONMENT_BRANCH" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-dev.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--env-file ", + "value": "string", + "description": "Path to an environment file to override existing environment variables. Defaults to the '.env' located in your project path `--path`.", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-dev.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--host", + "value": "''", + "description": "Expose the server to the local network", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-dev.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--inspector-port ", + "value": "string", + "description": "The port where the inspector is available. Defaults to 9229.", + "isOptional": true, + "environmentValue": "SHOPIFY_HYDROGEN_FLAG_INSPECTOR_PORT" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-dev.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--path ", + "value": "string", + "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.", + "isOptional": true, + "environmentValue": "SHOPIFY_HYDROGEN_FLAG_PATH" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-dev.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--port ", + "value": "string", + "description": "The port to run the server on. Defaults to 3000.", + "isOptional": true, + "environmentValue": "SHOPIFY_HYDROGEN_FLAG_PORT" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-dev.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--verbose", + "value": "''", + "description": "Outputs more information about the command's execution.", + "isOptional": true, + "environmentValue": "SHOPIFY_HYDROGEN_FLAG_VERBOSE" + } + ], + "value": "export interface hydrogendev {\n /**\n * Automatically generates GraphQL types for your project’s Storefront API queries.\n *\n */\n '--codegen'?: ''\n\n /**\n * Specifies a path to a codegen configuration file. Defaults to `/codegen.ts` if this file exists.\n *\n */\n '--codegen-config-path '?: string\n\n /**\n * Use tunneling for local development and push the tunneling domain to admin. Required to use Customer Account API's OAuth flow\n * @environment SHOPIFY_HYDROGEN_FLAG_CUSTOMER_ACCOUNT_PUSH\n */\n '--customer-account-push'?: ''\n\n /**\n * Enables inspector connections to the server with a debugger such as Visual Studio Code or Chrome DevTools.\n * @environment SHOPIFY_HYDROGEN_FLAG_DEBUG\n */\n '--debug'?: ''\n\n /**\n * Disable adding dependencies to Vite's `ssr.optimizeDeps.include` automatically\n * @environment SHOPIFY_HYDROGEN_FLAG_DISABLE_DEPS_OPTIMIZER\n */\n '--disable-deps-optimizer'?: ''\n\n /**\n * Skip the version check when running `hydrogen dev`\n *\n */\n '--disable-version-check'?: ''\n\n /**\n * Disable rendering fallback routes when a route file doesn't exist.\n * @environment SHOPIFY_HYDROGEN_FLAG_DISABLE_VIRTUAL_ROUTES\n */\n '--disable-virtual-routes'?: ''\n\n /**\n * Entry file for the worker. Defaults to `./server`.\n * @environment SHOPIFY_HYDROGEN_FLAG_ENTRY\n */\n '--entry '?: string\n\n /**\n * Specifies the environment to perform the operation using its handle. Fetch the handle using the `env list` command.\n *\n */\n '--env '?: string\n\n /**\n * Specifies the environment to perform the operation using its Git branch name.\n * @environment SHOPIFY_HYDROGEN_ENVIRONMENT_BRANCH\n */\n '--env-branch '?: string\n\n /**\n * Path to an environment file to override existing environment variables. Defaults to the '.env' located in your project path `--path`.\n *\n */\n '--env-file '?: string\n\n /**\n * Expose the server to the local network\n *\n */\n '--host'?: ''\n\n /**\n * The port where the inspector is available. Defaults to 9229.\n * @environment SHOPIFY_HYDROGEN_FLAG_INSPECTOR_PORT\n */\n '--inspector-port '?: string\n\n /**\n * The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.\n * @environment SHOPIFY_HYDROGEN_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * The port to run the server on. Defaults to 3000.\n * @environment SHOPIFY_HYDROGEN_FLAG_PORT\n */\n '--port '?: string\n\n /**\n * Outputs more information about the command's execution.\n * @environment SHOPIFY_HYDROGEN_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" + } + }, + "hydrogenenvlist": { + "docs-shopify.dev/commands/interfaces/hydrogen-env-list.interface.ts": { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-env-list.interface.ts", + "name": "hydrogenenvlist", + "description": "The following flags are available for the `hydrogen env list` command:", + "isPublicDocs": true, + "members": [ + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-env-list.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--path ", + "value": "string", + "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.", + "isOptional": true, + "environmentValue": "SHOPIFY_HYDROGEN_FLAG_PATH" + } + ], + "value": "export interface hydrogenenvlist {\n /**\n * The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.\n * @environment SHOPIFY_HYDROGEN_FLAG_PATH\n */\n '--path '?: string\n}" + } + }, + "hydrogenenvpull": { + "docs-shopify.dev/commands/interfaces/hydrogen-env-pull.interface.ts": { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-env-pull.interface.ts", + "name": "hydrogenenvpull", + "description": "The following flags are available for the `hydrogen env pull` command:", + "isPublicDocs": true, + "members": [ + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-env-pull.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--env ", + "value": "string", + "description": "Specifies the environment to perform the operation using its handle. Fetch the handle using the `env list` command.", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-env-pull.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--env-branch ", + "value": "string", + "description": "Specifies the environment to perform the operation using its Git branch name.", + "isOptional": true, + "environmentValue": "SHOPIFY_HYDROGEN_ENVIRONMENT_BRANCH" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-env-pull.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--env-file ", + "value": "string", + "description": "Path to an environment file to override existing environment variables. Defaults to the '.env' located in your project path `--path`.", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-env-pull.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--path ", + "value": "string", + "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.", + "isOptional": true, + "environmentValue": "SHOPIFY_HYDROGEN_FLAG_PATH" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-env-pull.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-f, --force", + "value": "''", + "description": "Overwrites the destination directory and files if they already exist.", + "isOptional": true, + "environmentValue": "SHOPIFY_HYDROGEN_FLAG_FORCE" + } + ], + "value": "export interface hydrogenenvpull {\n /**\n * Specifies the environment to perform the operation using its handle. Fetch the handle using the `env list` command.\n *\n */\n '--env '?: string\n\n /**\n * Specifies the environment to perform the operation using its Git branch name.\n * @environment SHOPIFY_HYDROGEN_ENVIRONMENT_BRANCH\n */\n '--env-branch '?: string\n\n /**\n * Path to an environment file to override existing environment variables. Defaults to the '.env' located in your project path `--path`.\n *\n */\n '--env-file '?: string\n\n /**\n * Overwrites the destination directory and files if they already exist.\n * @environment SHOPIFY_HYDROGEN_FLAG_FORCE\n */\n '-f, --force'?: ''\n\n /**\n * The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.\n * @environment SHOPIFY_HYDROGEN_FLAG_PATH\n */\n '--path '?: string\n}" + } + }, + "hydrogenenvpush": { + "docs-shopify.dev/commands/interfaces/hydrogen-env-push.interface.ts": { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-env-push.interface.ts", + "name": "hydrogenenvpush", + "description": "The following flags are available for the `hydrogen env push` command:", + "isPublicDocs": true, + "members": [ + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-env-push.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--env ", + "value": "string", + "description": "Specifies the environment to perform the operation using its handle. Fetch the handle using the `env list` command.", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-env-push.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--env-file ", + "value": "string", + "description": "Path to an environment file to override existing environment variables. Defaults to the '.env' located in your project path `--path`.", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-env-push.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--path ", + "value": "string", + "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.", + "isOptional": true, + "environmentValue": "SHOPIFY_HYDROGEN_FLAG_PATH" + } + ], + "value": "export interface hydrogenenvpush {\n /**\n * Specifies the environment to perform the operation using its handle. Fetch the handle using the `env list` command.\n *\n */\n '--env '?: string\n\n /**\n * Path to an environment file to override existing environment variables. Defaults to the '.env' located in your project path `--path`.\n *\n */\n '--env-file '?: string\n\n /**\n * The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.\n * @environment SHOPIFY_HYDROGEN_FLAG_PATH\n */\n '--path '?: string\n}" + } + }, + "hydrogengenerateroute": { + "docs-shopify.dev/commands/interfaces/hydrogen-generate-route.interface.ts": { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-generate-route.interface.ts", + "name": "hydrogengenerateroute", + "description": "The following flags are available for the `hydrogen generate route` command:", + "isPublicDocs": true, + "members": [ + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-generate-route.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--adapter ", + "value": "string", + "description": "Remix adapter used in the route. The default is `@shopify/remix-oxygen`.", + "isOptional": true, + "environmentValue": "SHOPIFY_HYDROGEN_FLAG_ADAPTER" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-generate-route.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--locale-param ", + "value": "string", + "description": "The param name in Remix routes for the i18n locale, if any. Example: `locale` becomes ($locale).", + "isOptional": true, + "environmentValue": "SHOPIFY_HYDROGEN_FLAG_ADAPTER" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-generate-route.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--path ", + "value": "string", + "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.", + "isOptional": true, + "environmentValue": "SHOPIFY_HYDROGEN_FLAG_PATH" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-generate-route.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--typescript", + "value": "''", + "description": "Generate TypeScript files", + "isOptional": true, + "environmentValue": "SHOPIFY_HYDROGEN_FLAG_TYPESCRIPT" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-generate-route.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-f, --force", + "value": "''", + "description": "Overwrites the destination directory and files if they already exist.", + "isOptional": true, + "environmentValue": "SHOPIFY_HYDROGEN_FLAG_FORCE" + } + ], + "value": "export interface hydrogengenerateroute {\n /**\n * Remix adapter used in the route. The default is `@shopify/remix-oxygen`.\n * @environment SHOPIFY_HYDROGEN_FLAG_ADAPTER\n */\n '--adapter '?: string\n\n /**\n * Overwrites the destination directory and files if they already exist.\n * @environment SHOPIFY_HYDROGEN_FLAG_FORCE\n */\n '-f, --force'?: ''\n\n /**\n * The param name in Remix routes for the i18n locale, if any. Example: `locale` becomes ($locale).\n * @environment SHOPIFY_HYDROGEN_FLAG_ADAPTER\n */\n '--locale-param '?: string\n\n /**\n * The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.\n * @environment SHOPIFY_HYDROGEN_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Generate TypeScript files\n * @environment SHOPIFY_HYDROGEN_FLAG_TYPESCRIPT\n */\n '--typescript'?: ''\n}" + } + }, + "hydrogengenerateroutes": { + "docs-shopify.dev/commands/interfaces/hydrogen-generate-routes.interface.ts": { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-generate-routes.interface.ts", + "name": "hydrogengenerateroutes", + "description": "The following flags are available for the `hydrogen generate routes` command:", + "isPublicDocs": true, + "members": [ + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-generate-routes.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--adapter ", + "value": "string", + "description": "Remix adapter used in the route. The default is `@shopify/remix-oxygen`.", + "isOptional": true, + "environmentValue": "SHOPIFY_HYDROGEN_FLAG_ADAPTER" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-generate-routes.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--locale-param ", + "value": "string", + "description": "The param name in Remix routes for the i18n locale, if any. Example: `locale` becomes ($locale).", + "isOptional": true, + "environmentValue": "SHOPIFY_HYDROGEN_FLAG_ADAPTER" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-generate-routes.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--path ", + "value": "string", + "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.", + "isOptional": true, + "environmentValue": "SHOPIFY_HYDROGEN_FLAG_PATH" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-generate-routes.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--typescript", + "value": "''", + "description": "Generate TypeScript files", + "isOptional": true, + "environmentValue": "SHOPIFY_HYDROGEN_FLAG_TYPESCRIPT" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-generate-routes.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-f, --force", + "value": "''", + "description": "Overwrites the destination directory and files if they already exist.", + "isOptional": true, + "environmentValue": "SHOPIFY_HYDROGEN_FLAG_FORCE" + } + ], + "value": "export interface hydrogengenerateroutes {\n /**\n * Remix adapter used in the route. The default is `@shopify/remix-oxygen`.\n * @environment SHOPIFY_HYDROGEN_FLAG_ADAPTER\n */\n '--adapter '?: string\n\n /**\n * Overwrites the destination directory and files if they already exist.\n * @environment SHOPIFY_HYDROGEN_FLAG_FORCE\n */\n '-f, --force'?: ''\n\n /**\n * The param name in Remix routes for the i18n locale, if any. Example: `locale` becomes ($locale).\n * @environment SHOPIFY_HYDROGEN_FLAG_ADAPTER\n */\n '--locale-param '?: string\n\n /**\n * The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.\n * @environment SHOPIFY_HYDROGEN_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Generate TypeScript files\n * @environment SHOPIFY_HYDROGEN_FLAG_TYPESCRIPT\n */\n '--typescript'?: ''\n}" + } + }, + "hydrogeninit": { + "docs-shopify.dev/commands/interfaces/hydrogen-init.interface.ts": { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-init.interface.ts", + "name": "hydrogeninit", + "description": "The following flags are available for the `hydrogen init` command:", + "isPublicDocs": true, + "members": [ + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-init.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--git", + "value": "''", + "description": "Init Git and create initial commits.", + "isOptional": true, + "environmentValue": "SHOPIFY_HYDROGEN_FLAG_GIT" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-init.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--install-deps", + "value": "''", + "description": "Auto installs dependencies using the active package manager.", + "isOptional": true, + "environmentValue": "SHOPIFY_HYDROGEN_FLAG_INSTALL_DEPS" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-init.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--language ", + "value": "string", + "description": "Sets the template language to use. One of `js` or `ts`.", + "isOptional": true, + "environmentValue": "SHOPIFY_HYDROGEN_FLAG_LANGUAGE" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-init.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--markets ", + "value": "string", + "description": "Sets the URL structure to support multiple markets. Must be one of: `subfolders`, `domains`, `subdomains`, `none`. Example: `--markets subfolders`.", + "isOptional": true, + "environmentValue": "SHOPIFY_HYDROGEN_FLAG_I18N" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-init.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--mock-shop", + "value": "''", + "description": "Use mock.shop as the data source for the storefront.", + "isOptional": true, + "environmentValue": "SHOPIFY_HYDROGEN_FLAG_MOCK_DATA" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-init.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--path ", + "value": "string", + "description": "The path to the directory of the new Hydrogen storefront.", + "isOptional": true, + "environmentValue": "SHOPIFY_HYDROGEN_FLAG_PATH" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-init.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--quickstart", + "value": "''", + "description": "Scaffolds a new Hydrogen project with a set of sensible defaults. Equivalent to `shopify hydrogen init --path hydrogen-quickstart --mock-shop --language js --shortcut --markets none`", + "isOptional": true, + "environmentValue": "SHOPIFY_HYDROGEN_FLAG_QUICKSTART" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-init.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--shortcut", + "value": "''", + "description": "Creates a global h2 shortcut for Shopify CLI using shell aliases. Deactivate with `--no-shortcut`.", + "isOptional": true, + "environmentValue": "SHOPIFY_HYDROGEN_FLAG_SHORTCUT" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-init.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--styling ", + "value": "string", + "description": "Sets the styling strategy to use. One of `tailwind`, `vanilla-extract`, `css-modules`, `postcss`, `none`.", + "isOptional": true, + "environmentValue": "SHOPIFY_HYDROGEN_FLAG_STYLING" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-init.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--template ", + "value": "string", + "description": "Scaffolds project based on an existing template or example from the Hydrogen repository.", + "isOptional": true, + "environmentValue": "SHOPIFY_HYDROGEN_FLAG_TEMPLATE" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-init.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-f, --force", + "value": "''", + "description": "Overwrites the destination directory and files if they already exist.", + "isOptional": true, + "environmentValue": "SHOPIFY_HYDROGEN_FLAG_FORCE" + } + ], + "value": "export interface hydrogeninit {\n /**\n * Overwrites the destination directory and files if they already exist.\n * @environment SHOPIFY_HYDROGEN_FLAG_FORCE\n */\n '-f, --force'?: ''\n\n /**\n * Init Git and create initial commits.\n * @environment SHOPIFY_HYDROGEN_FLAG_GIT\n */\n '--git'?: ''\n\n /**\n * Auto installs dependencies using the active package manager.\n * @environment SHOPIFY_HYDROGEN_FLAG_INSTALL_DEPS\n */\n '--install-deps'?: ''\n\n /**\n * Sets the template language to use. One of `js` or `ts`.\n * @environment SHOPIFY_HYDROGEN_FLAG_LANGUAGE\n */\n '--language '?: string\n\n /**\n * Sets the URL structure to support multiple markets. Must be one of: `subfolders`, `domains`, `subdomains`, `none`. Example: `--markets subfolders`.\n * @environment SHOPIFY_HYDROGEN_FLAG_I18N\n */\n '--markets '?: string\n\n /**\n * Use mock.shop as the data source for the storefront.\n * @environment SHOPIFY_HYDROGEN_FLAG_MOCK_DATA\n */\n '--mock-shop'?: ''\n\n /**\n * The path to the directory of the new Hydrogen storefront.\n * @environment SHOPIFY_HYDROGEN_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Scaffolds a new Hydrogen project with a set of sensible defaults. Equivalent to `shopify hydrogen init --path hydrogen-quickstart --mock-shop --language js --shortcut --markets none`\n * @environment SHOPIFY_HYDROGEN_FLAG_QUICKSTART\n */\n '--quickstart'?: ''\n\n /**\n * Creates a global h2 shortcut for Shopify CLI using shell aliases. Deactivate with `--no-shortcut`.\n * @environment SHOPIFY_HYDROGEN_FLAG_SHORTCUT\n */\n '--shortcut'?: ''\n\n /**\n * Sets the styling strategy to use. One of `tailwind`, `vanilla-extract`, `css-modules`, `postcss`, `none`.\n * @environment SHOPIFY_HYDROGEN_FLAG_STYLING\n */\n '--styling '?: string\n\n /**\n * Scaffolds project based on an existing template or example from the Hydrogen repository.\n * @environment SHOPIFY_HYDROGEN_FLAG_TEMPLATE\n */\n '--template '?: string\n}" + } + }, + "hydrogenlink": { + "docs-shopify.dev/commands/interfaces/hydrogen-link.interface.ts": { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-link.interface.ts", + "name": "hydrogenlink", + "description": "The following flags are available for the `hydrogen link` command:", + "isPublicDocs": true, + "members": [ + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-link.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--path ", + "value": "string", + "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.", + "isOptional": true, + "environmentValue": "SHOPIFY_HYDROGEN_FLAG_PATH" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-link.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--storefront ", + "value": "string", + "description": "The name of a Hydrogen Storefront (e.g. \"Jane's Apparel\")", + "isOptional": true, + "environmentValue": "SHOPIFY_HYDROGEN_STOREFRONT" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-link.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-f, --force", + "value": "''", + "description": "Overwrites the destination directory and files if they already exist.", + "isOptional": true, + "environmentValue": "SHOPIFY_HYDROGEN_FLAG_FORCE" + } + ], + "value": "export interface hydrogenlink {\n /**\n * Overwrites the destination directory and files if they already exist.\n * @environment SHOPIFY_HYDROGEN_FLAG_FORCE\n */\n '-f, --force'?: ''\n\n /**\n * The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.\n * @environment SHOPIFY_HYDROGEN_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * The name of a Hydrogen Storefront (e.g. \"Jane's Apparel\")\n * @environment SHOPIFY_HYDROGEN_STOREFRONT\n */\n '--storefront '?: string\n}" + } + }, + "hydrogenlist": { + "docs-shopify.dev/commands/interfaces/hydrogen-list.interface.ts": { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-list.interface.ts", + "name": "hydrogenlist", + "description": "The following flags are available for the `hydrogen list` command:", + "isPublicDocs": true, + "members": [ + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-list.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--path ", + "value": "string", + "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.", + "isOptional": true, + "environmentValue": "SHOPIFY_HYDROGEN_FLAG_PATH" + } + ], + "value": "export interface hydrogenlist {\n /**\n * The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.\n * @environment SHOPIFY_HYDROGEN_FLAG_PATH\n */\n '--path '?: string\n}" + } + }, + "hydrogenlogin": { + "docs-shopify.dev/commands/interfaces/hydrogen-login.interface.ts": { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-login.interface.ts", + "name": "hydrogenlogin", + "description": "The following flags are available for the `hydrogen login` command:", + "isPublicDocs": true, + "members": [ + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-login.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--path ", + "value": "string", + "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.", + "isOptional": true, + "environmentValue": "SHOPIFY_HYDROGEN_FLAG_PATH" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-login.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-s, --shop ", + "value": "string", + "description": "Shop URL. It can be the shop prefix (janes-apparel) or the full myshopify.com URL (janes-apparel.myshopify.com, https://janes-apparel.myshopify.com).", + "isOptional": true, + "environmentValue": "SHOPIFY_SHOP" + } + ], + "value": "export interface hydrogenlogin {\n /**\n * The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.\n * @environment SHOPIFY_HYDROGEN_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Shop URL. It can be the shop prefix (janes-apparel) or the full myshopify.com URL (janes-apparel.myshopify.com, https://janes-apparel.myshopify.com).\n * @environment SHOPIFY_SHOP\n */\n '-s, --shop '?: string\n}" + } + }, + "hydrogenlogout": { + "docs-shopify.dev/commands/interfaces/hydrogen-logout.interface.ts": { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-logout.interface.ts", + "name": "hydrogenlogout", + "description": "The following flags are available for the `hydrogen logout` command:", + "isPublicDocs": true, + "members": [ + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-logout.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--path ", + "value": "string", + "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.", + "isOptional": true, + "environmentValue": "SHOPIFY_HYDROGEN_FLAG_PATH" + } + ], + "value": "export interface hydrogenlogout {\n /**\n * The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.\n * @environment SHOPIFY_HYDROGEN_FLAG_PATH\n */\n '--path '?: string\n}" + } + }, + "hydrogenpreview": { + "docs-shopify.dev/commands/interfaces/hydrogen-preview.interface.ts": { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-preview.interface.ts", + "name": "hydrogenpreview", + "description": "The following flags are available for the `hydrogen preview` command:", + "isPublicDocs": true, + "members": [ + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-preview.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--build", + "value": "''", + "description": "Builds the app before starting the preview server.", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-preview.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--codegen", + "value": "''", + "description": "Automatically generates GraphQL types for your project’s Storefront API queries.", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-preview.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--codegen-config-path ", + "value": "string", + "description": "Specifies a path to a codegen configuration file. Defaults to `/codegen.ts` if this file exists.", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-preview.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--debug", + "value": "''", + "description": "Enables inspector connections to the server with a debugger such as Visual Studio Code or Chrome DevTools.", + "isOptional": true, + "environmentValue": "SHOPIFY_HYDROGEN_FLAG_DEBUG" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-preview.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--entry ", + "value": "string", + "description": "Entry file for the worker. Defaults to `./server`.", + "isOptional": true, + "environmentValue": "SHOPIFY_HYDROGEN_FLAG_ENTRY" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-preview.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--env ", + "value": "string", + "description": "Specifies the environment to perform the operation using its handle. Fetch the handle using the `env list` command.", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-preview.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--env-branch ", + "value": "string", + "description": "Specifies the environment to perform the operation using its Git branch name.", + "isOptional": true, + "environmentValue": "SHOPIFY_HYDROGEN_ENVIRONMENT_BRANCH" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-preview.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--env-file ", + "value": "string", + "description": "Path to an environment file to override existing environment variables. Defaults to the '.env' located in your project path `--path`.", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-preview.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--inspector-port ", + "value": "string", + "description": "The port where the inspector is available. Defaults to 9229.", + "isOptional": true, + "environmentValue": "SHOPIFY_HYDROGEN_FLAG_INSPECTOR_PORT" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-preview.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--path ", + "value": "string", + "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.", + "isOptional": true, + "environmentValue": "SHOPIFY_HYDROGEN_FLAG_PATH" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-preview.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--port ", + "value": "string", + "description": "The port to run the server on. Defaults to 3000.", + "isOptional": true, + "environmentValue": "SHOPIFY_HYDROGEN_FLAG_PORT" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-preview.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--verbose", + "value": "''", + "description": "Outputs more information about the command's execution.", + "isOptional": true, + "environmentValue": "SHOPIFY_HYDROGEN_FLAG_VERBOSE" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-preview.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--watch", + "value": "''", + "description": "Watches for changes and rebuilds the project.", + "isOptional": true + } + ], + "value": "export interface hydrogenpreview {\n /**\n * Builds the app before starting the preview server.\n *\n */\n '--build'?: ''\n\n /**\n * Automatically generates GraphQL types for your project’s Storefront API queries.\n *\n */\n '--codegen'?: ''\n\n /**\n * Specifies a path to a codegen configuration file. Defaults to `/codegen.ts` if this file exists.\n *\n */\n '--codegen-config-path '?: string\n\n /**\n * Enables inspector connections to the server with a debugger such as Visual Studio Code or Chrome DevTools.\n * @environment SHOPIFY_HYDROGEN_FLAG_DEBUG\n */\n '--debug'?: ''\n\n /**\n * Entry file for the worker. Defaults to `./server`.\n * @environment SHOPIFY_HYDROGEN_FLAG_ENTRY\n */\n '--entry '?: string\n\n /**\n * Specifies the environment to perform the operation using its handle. Fetch the handle using the `env list` command.\n *\n */\n '--env '?: string\n\n /**\n * Specifies the environment to perform the operation using its Git branch name.\n * @environment SHOPIFY_HYDROGEN_ENVIRONMENT_BRANCH\n */\n '--env-branch '?: string\n\n /**\n * Path to an environment file to override existing environment variables. Defaults to the '.env' located in your project path `--path`.\n *\n */\n '--env-file '?: string\n\n /**\n * The port where the inspector is available. Defaults to 9229.\n * @environment SHOPIFY_HYDROGEN_FLAG_INSPECTOR_PORT\n */\n '--inspector-port '?: string\n\n /**\n * The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.\n * @environment SHOPIFY_HYDROGEN_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * The port to run the server on. Defaults to 3000.\n * @environment SHOPIFY_HYDROGEN_FLAG_PORT\n */\n '--port '?: string\n\n /**\n * Outputs more information about the command's execution.\n * @environment SHOPIFY_HYDROGEN_FLAG_VERBOSE\n */\n '--verbose'?: ''\n\n /**\n * Watches for changes and rebuilds the project.\n *\n */\n '--watch'?: ''\n}" + } + }, + "hydrogensetupcss": { + "docs-shopify.dev/commands/interfaces/hydrogen-setup-css.interface.ts": { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-setup-css.interface.ts", + "name": "hydrogensetupcss", + "description": "The following flags are available for the `hydrogen setup css` command:", + "isPublicDocs": true, + "members": [ + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-setup-css.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--install-deps", + "value": "''", + "description": "Auto installs dependencies using the active package manager.", + "isOptional": true, + "environmentValue": "SHOPIFY_HYDROGEN_FLAG_INSTALL_DEPS" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-setup-css.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--path ", + "value": "string", + "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.", + "isOptional": true, + "environmentValue": "SHOPIFY_HYDROGEN_FLAG_PATH" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-setup-css.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-f, --force", + "value": "''", + "description": "Overwrites the destination directory and files if they already exist.", + "isOptional": true, + "environmentValue": "SHOPIFY_HYDROGEN_FLAG_FORCE" + } + ], + "value": "export interface hydrogensetupcss {\n /**\n * Overwrites the destination directory and files if they already exist.\n * @environment SHOPIFY_HYDROGEN_FLAG_FORCE\n */\n '-f, --force'?: ''\n\n /**\n * Auto installs dependencies using the active package manager.\n * @environment SHOPIFY_HYDROGEN_FLAG_INSTALL_DEPS\n */\n '--install-deps'?: ''\n\n /**\n * The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.\n * @environment SHOPIFY_HYDROGEN_FLAG_PATH\n */\n '--path '?: string\n}" + } + }, + "hydrogensetupmarkets": { + "docs-shopify.dev/commands/interfaces/hydrogen-setup-markets.interface.ts": { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-setup-markets.interface.ts", + "name": "hydrogensetupmarkets", + "description": "The following flags are available for the `hydrogen setup markets` command:", + "isPublicDocs": true, + "members": [ + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-setup-markets.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--path ", + "value": "string", + "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.", + "isOptional": true, + "environmentValue": "SHOPIFY_HYDROGEN_FLAG_PATH" + } + ], + "value": "export interface hydrogensetupmarkets {\n /**\n * The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.\n * @environment SHOPIFY_HYDROGEN_FLAG_PATH\n */\n '--path '?: string\n}" + } + }, + "hydrogensetupvite": { + "docs-shopify.dev/commands/interfaces/hydrogen-setup-vite.interface.ts": { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-setup-vite.interface.ts", + "name": "hydrogensetupvite", + "description": "The following flags are available for the `hydrogen setup vite` command:", + "isPublicDocs": true, + "members": [ + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-setup-vite.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--path ", + "value": "string", + "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.", + "isOptional": true, + "environmentValue": "SHOPIFY_HYDROGEN_FLAG_PATH" + } + ], + "value": "export interface hydrogensetupvite {\n /**\n * The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.\n * @environment SHOPIFY_HYDROGEN_FLAG_PATH\n */\n '--path '?: string\n}" + } + }, + "hydrogensetup": { + "docs-shopify.dev/commands/interfaces/hydrogen-setup.interface.ts": { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-setup.interface.ts", + "name": "hydrogensetup", + "description": "The following flags are available for the `hydrogen setup` command:", + "isPublicDocs": true, + "members": [ + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-setup.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--install-deps", + "value": "''", + "description": "Auto installs dependencies using the active package manager.", + "isOptional": true, + "environmentValue": "SHOPIFY_HYDROGEN_FLAG_INSTALL_DEPS" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-setup.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--markets ", + "value": "string", + "description": "Sets the URL structure to support multiple markets. Must be one of: `subfolders`, `domains`, `subdomains`, `none`. Example: `--markets subfolders`.", + "isOptional": true, + "environmentValue": "SHOPIFY_HYDROGEN_FLAG_I18N" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-setup.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--path ", + "value": "string", + "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.", + "isOptional": true, + "environmentValue": "SHOPIFY_HYDROGEN_FLAG_PATH" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-setup.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--shortcut", + "value": "''", + "description": "Creates a global h2 shortcut for Shopify CLI using shell aliases. Deactivate with `--no-shortcut`.", + "isOptional": true, + "environmentValue": "SHOPIFY_HYDROGEN_FLAG_SHORTCUT" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-setup.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-f, --force", + "value": "''", + "description": "Overwrites the destination directory and files if they already exist.", + "isOptional": true, + "environmentValue": "SHOPIFY_HYDROGEN_FLAG_FORCE" + } + ], + "value": "export interface hydrogensetup {\n /**\n * Overwrites the destination directory and files if they already exist.\n * @environment SHOPIFY_HYDROGEN_FLAG_FORCE\n */\n '-f, --force'?: ''\n\n /**\n * Auto installs dependencies using the active package manager.\n * @environment SHOPIFY_HYDROGEN_FLAG_INSTALL_DEPS\n */\n '--install-deps'?: ''\n\n /**\n * Sets the URL structure to support multiple markets. Must be one of: `subfolders`, `domains`, `subdomains`, `none`. Example: `--markets subfolders`.\n * @environment SHOPIFY_HYDROGEN_FLAG_I18N\n */\n '--markets '?: string\n\n /**\n * The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.\n * @environment SHOPIFY_HYDROGEN_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Creates a global h2 shortcut for Shopify CLI using shell aliases. Deactivate with `--no-shortcut`.\n * @environment SHOPIFY_HYDROGEN_FLAG_SHORTCUT\n */\n '--shortcut'?: ''\n}" + } + }, + "hydrogenshortcut": { + "docs-shopify.dev/commands/interfaces/hydrogen-shortcut.interface.ts": { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-shortcut.interface.ts", + "name": "hydrogenshortcut", + "description": "", + "isPublicDocs": true, + "members": [], + "value": "export interface hydrogenshortcut {\n\n}" + } + }, + "hydrogenunlink": { + "docs-shopify.dev/commands/interfaces/hydrogen-unlink.interface.ts": { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-unlink.interface.ts", + "name": "hydrogenunlink", + "description": "The following flags are available for the `hydrogen unlink` command:", + "isPublicDocs": true, + "members": [ + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-unlink.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--path ", + "value": "string", + "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.", + "isOptional": true, + "environmentValue": "SHOPIFY_HYDROGEN_FLAG_PATH" + } + ], + "value": "export interface hydrogenunlink {\n /**\n * The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.\n * @environment SHOPIFY_HYDROGEN_FLAG_PATH\n */\n '--path '?: string\n}" + } + }, + "hydrogenupgrade": { + "docs-shopify.dev/commands/interfaces/hydrogen-upgrade.interface.ts": { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-upgrade.interface.ts", + "name": "hydrogenupgrade", + "description": "The following flags are available for the `hydrogen upgrade` command:", + "isPublicDocs": true, + "members": [ + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-upgrade.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--path ", + "value": "string", + "description": "The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.", + "isOptional": true, + "environmentValue": "SHOPIFY_HYDROGEN_FLAG_PATH" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-upgrade.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-f, --force", + "value": "''", + "description": "Ignore warnings and force the upgrade to the target version", + "isOptional": true, + "environmentValue": "SHOPIFY_HYDROGEN_FLAG_FORCE" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/hydrogen-upgrade.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-v, --version ", + "value": "string", + "description": "A target hydrogen version to update to", + "isOptional": true + } + ], + "value": "export interface hydrogenupgrade {\n /**\n * Ignore warnings and force the upgrade to the target version\n * @environment SHOPIFY_HYDROGEN_FLAG_FORCE\n */\n '-f, --force'?: ''\n\n /**\n * The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.\n * @environment SHOPIFY_HYDROGEN_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * A target hydrogen version to update to\n *\n */\n '-v, --version '?: string\n}" + } + }, + "organizationlist": { + "docs-shopify.dev/commands/interfaces/organization-list.interface.ts": { + "filePath": "docs-shopify.dev/commands/interfaces/organization-list.interface.ts", + "name": "organizationlist", + "description": "The following flags are available for the `organization list` command:", + "isPublicDocs": true, + "members": [ + { + "filePath": "docs-shopify.dev/commands/interfaces/organization-list.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--no-color", + "value": "''", + "description": "Disable color output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_NO_COLOR" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/organization-list.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--verbose", + "value": "''", + "description": "Increase the verbosity of the output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_VERBOSE" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/organization-list.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-j, --json", + "value": "''", + "description": "Output the result as JSON. Automatically disables color output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON" + } + ], + "value": "export interface organizationlist {\n /**\n * Output the result as JSON. Automatically disables color output.\n * @environment SHOPIFY_FLAG_JSON\n */\n '-j, --json'?: ''\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * Increase the verbosity of the output.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" + } + }, + "search": { + "docs-shopify.dev/commands/interfaces/search.interface.ts": { + "filePath": "docs-shopify.dev/commands/interfaces/search.interface.ts", + "name": "search", + "description": "", + "isPublicDocs": true, + "members": [], + "value": "export interface search {\n\n}" + } + }, + "storeauth": { + "docs-shopify.dev/commands/interfaces/store-auth.interface.ts": { + "filePath": "docs-shopify.dev/commands/interfaces/store-auth.interface.ts", + "name": "storeauth", + "description": "The following flags are available for the `store auth` command:", + "isPublicDocs": true, + "members": [ + { + "filePath": "docs-shopify.dev/commands/interfaces/store-auth.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--no-color", + "value": "''", + "description": "Disable color output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_NO_COLOR" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/store-auth.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--scopes ", + "value": "string", + "description": "Comma-separated Admin API scopes to request for the app.", + "environmentValue": "SHOPIFY_FLAG_SCOPES" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/store-auth.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--verbose", + "value": "''", + "description": "Increase the verbosity of the output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_VERBOSE" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/store-auth.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-s, --store ", + "value": "string", + "description": "The myshopify.com domain of the store to authenticate against.", + "environmentValue": "SHOPIFY_FLAG_STORE" + } + ], + "value": "export interface storeauth {\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * Comma-separated Admin API scopes to request for the app.\n * @environment SHOPIFY_FLAG_SCOPES\n */\n '--scopes ': string\n\n /**\n * The myshopify.com domain of the store to authenticate against.\n * @environment SHOPIFY_FLAG_STORE\n */\n '-s, --store ': string\n\n /**\n * Increase the verbosity of the output.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" + } + }, + "storeexecute": { + "docs-shopify.dev/commands/interfaces/store-execute.interface.ts": { + "filePath": "docs-shopify.dev/commands/interfaces/store-execute.interface.ts", + "name": "storeexecute", + "description": "The following flags are available for the `store execute` command:", + "isPublicDocs": true, + "members": [ + { + "filePath": "docs-shopify.dev/commands/interfaces/store-execute.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--allow-mutations", + "value": "''", + "description": "Allow GraphQL mutations to run against the target store.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_ALLOW_MUTATIONS" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/store-execute.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--no-color", + "value": "''", + "description": "Disable color output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_NO_COLOR" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/store-execute.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--output-file ", + "value": "string", + "description": "The file name where results should be written, instead of STDOUT.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_OUTPUT_FILE" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/store-execute.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--query-file ", + "value": "string", + "description": "Path to a file containing the GraphQL query or mutation. Can't be used with --query.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_QUERY_FILE" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/store-execute.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--variable-file ", + "value": "string", + "description": "Path to a file containing GraphQL variables in JSON format. Can't be used with --variables.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_VARIABLE_FILE" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/store-execute.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--verbose", + "value": "''", + "description": "Increase the verbosity of the output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_VERBOSE" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/store-execute.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--version ", + "value": "string", + "description": "The API version to use for the query or mutation. Defaults to the latest stable version.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_VERSION" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/store-execute.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-q, --query ", + "value": "string", + "description": "The GraphQL query or mutation, as a string.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_QUERY" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/store-execute.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-s, --store ", + "value": "string", + "description": "The myshopify.com domain of the store to execute against.", + "environmentValue": "SHOPIFY_FLAG_STORE" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/store-execute.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-v, --variables ", + "value": "string", + "description": "The values for any GraphQL variables in your query or mutation, in JSON format.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_VARIABLES" + } + ], + "value": "export interface storeexecute {\n /**\n * Allow GraphQL mutations to run against the target store.\n * @environment SHOPIFY_FLAG_ALLOW_MUTATIONS\n */\n '--allow-mutations'?: ''\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * The file name where results should be written, instead of STDOUT.\n * @environment SHOPIFY_FLAG_OUTPUT_FILE\n */\n '--output-file '?: string\n\n /**\n * The GraphQL query or mutation, as a string.\n * @environment SHOPIFY_FLAG_QUERY\n */\n '-q, --query '?: string\n\n /**\n * Path to a file containing the GraphQL query or mutation. Can't be used with --query.\n * @environment SHOPIFY_FLAG_QUERY_FILE\n */\n '--query-file '?: string\n\n /**\n * The myshopify.com domain of the store to execute against.\n * @environment SHOPIFY_FLAG_STORE\n */\n '-s, --store ': string\n\n /**\n * Path to a file containing GraphQL variables in JSON format. Can't be used with --variables.\n * @environment SHOPIFY_FLAG_VARIABLE_FILE\n */\n '--variable-file '?: string\n\n /**\n * The values for any GraphQL variables in your query or mutation, in JSON format.\n * @environment SHOPIFY_FLAG_VARIABLES\n */\n '-v, --variables '?: string\n\n /**\n * Increase the verbosity of the output.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n\n /**\n * The API version to use for the query or mutation. Defaults to the latest stable version.\n * @environment SHOPIFY_FLAG_VERSION\n */\n '--version '?: string\n}" + } + }, + "themecheck": { + "docs-shopify.dev/commands/interfaces/theme-check.interface.ts": { + "filePath": "docs-shopify.dev/commands/interfaces/theme-check.interface.ts", + "name": "themecheck", + "description": "The following flags are available for the `theme check` command:", + "isPublicDocs": true, + "members": [ + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-check.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--fail-level ", + "value": "string", + "description": "Minimum severity for exit with error code", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_FAIL_LEVEL" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-check.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--init", + "value": "''", + "description": "Generate a .theme-check.yml file", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_INIT" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-check.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--list", + "value": "''", + "description": "List enabled checks", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_LIST" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-check.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--no-color", + "value": "''", + "description": "Disable color output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_NO_COLOR" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-check.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--path ", + "value": "string", + "description": "The path where you want to run the command. Defaults to the current working directory.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_PATH" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-check.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--print", + "value": "''", + "description": "Output active config to STDOUT", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_PRINT" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-check.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--verbose", + "value": "''", + "description": "Increase the verbosity of the output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_VERBOSE" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-check.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-a, --auto-correct", + "value": "''", + "description": "Automatically fix offenses", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_AUTO_CORRECT" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-check.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-C, --config ", + "value": "string", + "description": "Use the config provided, overriding .theme-check.yml if present Supports all theme-check: config values, e.g., theme-check:theme-app-extension,\n theme-check:recommended, theme-check:all\n For backwards compatibility, :theme_app_extension is also supported", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_CONFIG" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-check.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-e, --environment ", + "value": "string", + "description": "The environment to apply to the current command.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_ENVIRONMENT" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-check.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-o, --output ", + "value": "string", + "description": "The output format to use", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_OUTPUT" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-check.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-v, --version", + "value": "''", + "description": "Print Theme Check version", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_VERSION" + } + ], + "value": "export interface themecheck {\n /**\n * Automatically fix offenses\n * @environment SHOPIFY_FLAG_AUTO_CORRECT\n */\n '-a, --auto-correct'?: ''\n\n /**\n * Use the config provided, overriding .theme-check.yml if present\n Supports all theme-check: config values, e.g., theme-check:theme-app-extension,\n theme-check:recommended, theme-check:all\n For backwards compatibility, :theme_app_extension is also supported \n * @environment SHOPIFY_FLAG_CONFIG\n */\n '-C, --config '?: string\n\n /**\n * The environment to apply to the current command.\n * @environment SHOPIFY_FLAG_ENVIRONMENT\n */\n '-e, --environment '?: string\n\n /**\n * Minimum severity for exit with error code\n * @environment SHOPIFY_FLAG_FAIL_LEVEL\n */\n '--fail-level '?: string\n\n /**\n * Generate a .theme-check.yml file\n * @environment SHOPIFY_FLAG_INIT\n */\n '--init'?: ''\n\n /**\n * List enabled checks\n * @environment SHOPIFY_FLAG_LIST\n */\n '--list'?: ''\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * The output format to use\n * @environment SHOPIFY_FLAG_OUTPUT\n */\n '-o, --output '?: string\n\n /**\n * The path where you want to run the command. Defaults to the current working directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Output active config to STDOUT\n * @environment SHOPIFY_FLAG_PRINT\n */\n '--print'?: ''\n\n /**\n * Increase the verbosity of the output.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n\n /**\n * Print Theme Check version\n * @environment SHOPIFY_FLAG_VERSION\n */\n '-v, --version'?: ''\n}" + } + }, + "themeconsole": { + "docs-shopify.dev/commands/interfaces/theme-console.interface.ts": { + "filePath": "docs-shopify.dev/commands/interfaces/theme-console.interface.ts", + "name": "themeconsole", + "description": "The following flags are available for the `theme console` command:", + "isPublicDocs": true, + "members": [ + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-console.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--no-color", + "value": "''", + "description": "Disable color output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_NO_COLOR" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-console.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--password ", + "value": "string", + "description": "Password generated from the Theme Access app or an Admin API token.", + "isOptional": true, + "environmentValue": "SHOPIFY_CLI_THEME_TOKEN" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-console.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--path ", + "value": "string", + "description": "The path where you want to run the command. Defaults to the current working directory.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_PATH" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-console.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--store-password ", + "value": "string", + "description": "The password for storefronts with password protection.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_STORE_PASSWORD" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-console.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--url ", + "value": "string", + "description": "The url to be used as context", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_URL" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-console.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--verbose", + "value": "''", + "description": "Increase the verbosity of the output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_VERBOSE" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-console.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-e, --environment ", + "value": "string", + "description": "The environment to apply to the current command.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_ENVIRONMENT" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-console.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-s, --store ", + "value": "string", + "description": "Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_STORE" + } + ], + "value": "export interface themeconsole {\n /**\n * The environment to apply to the current command.\n * @environment SHOPIFY_FLAG_ENVIRONMENT\n */\n '-e, --environment '?: string\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * Password generated from the Theme Access app or an Admin API token.\n * @environment SHOPIFY_CLI_THEME_TOKEN\n */\n '--password '?: string\n\n /**\n * The path where you want to run the command. Defaults to the current working directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).\n * @environment SHOPIFY_FLAG_STORE\n */\n '-s, --store '?: string\n\n /**\n * The password for storefronts with password protection.\n * @environment SHOPIFY_FLAG_STORE_PASSWORD\n */\n '--store-password '?: string\n\n /**\n * The url to be used as context\n * @environment SHOPIFY_FLAG_URL\n */\n '--url '?: string\n\n /**\n * Increase the verbosity of the output.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" + } + }, + "themedelete": { + "docs-shopify.dev/commands/interfaces/theme-delete.interface.ts": { + "filePath": "docs-shopify.dev/commands/interfaces/theme-delete.interface.ts", + "name": "themedelete", + "description": "The following flags are available for the `theme delete` command:", + "isPublicDocs": true, + "members": [ + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-delete.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--no-color", + "value": "''", + "description": "Disable color output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_NO_COLOR" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-delete.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--password ", + "value": "string", + "description": "Password generated from the Theme Access app or an Admin API token.", + "isOptional": true, + "environmentValue": "SHOPIFY_CLI_THEME_TOKEN" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-delete.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--path ", + "value": "string", + "description": "The path where you want to run the command. Defaults to the current working directory.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_PATH" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-delete.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--verbose", + "value": "''", + "description": "Increase the verbosity of the output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_VERBOSE" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-delete.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-a, --show-all", + "value": "''", + "description": "Include others development themes in theme list.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_SHOW_ALL" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-delete.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-d, --development", + "value": "''", + "description": "Delete your development theme.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_DEVELOPMENT" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-delete.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-e, --environment ", + "value": "string", + "description": "The environment to apply to the current command.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_ENVIRONMENT" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-delete.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-f, --force", + "value": "''", + "description": "Skip confirmation.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_FORCE" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-delete.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-s, --store ", + "value": "string", + "description": "Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_STORE" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-delete.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-t, --theme ", + "value": "string", + "description": "Theme ID or name of the remote theme.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_THEME_ID" + } + ], + "value": "export interface themedelete {\n /**\n * Delete your development theme.\n * @environment SHOPIFY_FLAG_DEVELOPMENT\n */\n '-d, --development'?: ''\n\n /**\n * The environment to apply to the current command.\n * @environment SHOPIFY_FLAG_ENVIRONMENT\n */\n '-e, --environment '?: string\n\n /**\n * Skip confirmation.\n * @environment SHOPIFY_FLAG_FORCE\n */\n '-f, --force'?: ''\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * Password generated from the Theme Access app or an Admin API token.\n * @environment SHOPIFY_CLI_THEME_TOKEN\n */\n '--password '?: string\n\n /**\n * The path where you want to run the command. Defaults to the current working directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Include others development themes in theme list.\n * @environment SHOPIFY_FLAG_SHOW_ALL\n */\n '-a, --show-all'?: ''\n\n /**\n * Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).\n * @environment SHOPIFY_FLAG_STORE\n */\n '-s, --store '?: string\n\n /**\n * Theme ID or name of the remote theme.\n * @environment SHOPIFY_FLAG_THEME_ID\n */\n '-t, --theme '?: string\n\n /**\n * Increase the verbosity of the output.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" + } + }, + "themedev": { + "docs-shopify.dev/commands/interfaces/theme-dev.interface.ts": { + "filePath": "docs-shopify.dev/commands/interfaces/theme-dev.interface.ts", + "name": "themedev", + "description": "The following flags are available for the `theme dev` command:", + "isPublicDocs": true, + "members": [ + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-dev.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--error-overlay ", + "value": "string", + "description": "Controls the visibility of the error overlay when an theme asset upload fails:\n- silent Prevents the error overlay from appearing.\n- default Displays the error overlay.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_ERROR_OVERLAY" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-dev.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--host ", + "value": "string", + "description": "Set which network interface the web server listens on. The default value is 127.0.0.1.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_HOST" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-dev.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--listing ", + "value": "string", + "description": "The listing preset to use for multi-preset themes. Applies preset files from listings/[preset-name] directory.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_LISTING" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-dev.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--live-reload ", + "value": "string", + "description": "The live reload mode switches the server behavior when a file is modified:\n- hot-reload Hot reloads local changes to CSS and sections (default)\n- full-page Always refreshes the entire page\n- off Deactivate live reload", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_LIVE_RELOAD" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-dev.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--no-color", + "value": "''", + "description": "Disable color output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_NO_COLOR" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-dev.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--notify ", + "value": "string", + "description": "The file path or URL. The file path is to a file that you want updated on idle. The URL path is where you want a webhook posted to report on file changes.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_NOTIFY" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-dev.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--open", + "value": "''", + "description": "Automatically launch the theme preview in your default web browser.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_OPEN" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-dev.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--password ", + "value": "string", + "description": "Password generated from the Theme Access app or an Admin API token.", + "isOptional": true, + "environmentValue": "SHOPIFY_CLI_THEME_TOKEN" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-dev.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--path ", + "value": "string", + "description": "The path where you want to run the command. Defaults to the current working directory.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_PATH" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-dev.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--port ", + "value": "string", + "description": "Local port to serve theme preview from.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_PORT" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-dev.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--store-password ", + "value": "string", + "description": "The password for storefronts with password protection.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_STORE_PASSWORD" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-dev.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--theme-editor-sync", + "value": "''", + "description": "Synchronize Theme Editor updates in the local theme files.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_THEME_EDITOR_SYNC" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-dev.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--verbose", + "value": "''", + "description": "Increase the verbosity of the output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_VERBOSE" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-dev.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-a, --allow-live", + "value": "''", + "description": "Allow development on a live theme.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_ALLOW_LIVE" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-dev.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-e, --environment ", + "value": "string", + "description": "The environment to apply to the current command.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_ENVIRONMENT" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-dev.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-n, --nodelete", + "value": "''", + "description": "Prevents files from being deleted in the remote theme when a file has been deleted locally. This applies to files that are deleted while the command is running, and files that have been deleted locally before the command is run.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_NODELETE" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-dev.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-o, --only ", + "value": "string", + "description": "Hot reload only files that match the specified pattern.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_ONLY" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-dev.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-s, --store ", + "value": "string", + "description": "Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_STORE" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-dev.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-t, --theme ", + "value": "string", + "description": "Theme ID or name of the remote theme.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_THEME_ID" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-dev.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-x, --ignore ", + "value": "string", + "description": "Skip hot reloading any files that match the specified pattern.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_IGNORE" + } + ], + "value": "export interface themedev {\n /**\n * Allow development on a live theme.\n * @environment SHOPIFY_FLAG_ALLOW_LIVE\n */\n '-a, --allow-live'?: ''\n\n /**\n * The environment to apply to the current command.\n * @environment SHOPIFY_FLAG_ENVIRONMENT\n */\n '-e, --environment '?: string\n\n /**\n * Controls the visibility of the error overlay when an theme asset upload fails:\n- silent Prevents the error overlay from appearing.\n- default Displays the error overlay.\n \n * @environment SHOPIFY_FLAG_ERROR_OVERLAY\n */\n '--error-overlay '?: string\n\n /**\n * Set which network interface the web server listens on. The default value is 127.0.0.1.\n * @environment SHOPIFY_FLAG_HOST\n */\n '--host '?: string\n\n /**\n * Skip hot reloading any files that match the specified pattern.\n * @environment SHOPIFY_FLAG_IGNORE\n */\n '-x, --ignore '?: string\n\n /**\n * The listing preset to use for multi-preset themes. Applies preset files from listings/[preset-name] directory.\n * @environment SHOPIFY_FLAG_LISTING\n */\n '--listing '?: string\n\n /**\n * The live reload mode switches the server behavior when a file is modified:\n- hot-reload Hot reloads local changes to CSS and sections (default)\n- full-page Always refreshes the entire page\n- off Deactivate live reload\n * @environment SHOPIFY_FLAG_LIVE_RELOAD\n */\n '--live-reload '?: string\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * Prevents files from being deleted in the remote theme when a file has been deleted locally. This applies to files that are deleted while the command is running, and files that have been deleted locally before the command is run.\n * @environment SHOPIFY_FLAG_NODELETE\n */\n '-n, --nodelete'?: ''\n\n /**\n * The file path or URL. The file path is to a file that you want updated on idle. The URL path is where you want a webhook posted to report on file changes.\n * @environment SHOPIFY_FLAG_NOTIFY\n */\n '--notify '?: string\n\n /**\n * Hot reload only files that match the specified pattern.\n * @environment SHOPIFY_FLAG_ONLY\n */\n '-o, --only '?: string\n\n /**\n * Automatically launch the theme preview in your default web browser.\n * @environment SHOPIFY_FLAG_OPEN\n */\n '--open'?: ''\n\n /**\n * Password generated from the Theme Access app or an Admin API token.\n * @environment SHOPIFY_CLI_THEME_TOKEN\n */\n '--password '?: string\n\n /**\n * The path where you want to run the command. Defaults to the current working directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Local port to serve theme preview from.\n * @environment SHOPIFY_FLAG_PORT\n */\n '--port '?: string\n\n /**\n * Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).\n * @environment SHOPIFY_FLAG_STORE\n */\n '-s, --store '?: string\n\n /**\n * The password for storefronts with password protection.\n * @environment SHOPIFY_FLAG_STORE_PASSWORD\n */\n '--store-password '?: string\n\n /**\n * Theme ID or name of the remote theme.\n * @environment SHOPIFY_FLAG_THEME_ID\n */\n '-t, --theme '?: string\n\n /**\n * Synchronize Theme Editor updates in the local theme files.\n * @environment SHOPIFY_FLAG_THEME_EDITOR_SYNC\n */\n '--theme-editor-sync'?: ''\n\n /**\n * Increase the verbosity of the output.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" + } + }, + "themeduplicate": { + "docs-shopify.dev/commands/interfaces/theme-duplicate.interface.ts": { + "filePath": "docs-shopify.dev/commands/interfaces/theme-duplicate.interface.ts", + "name": "themeduplicate", + "description": "The following flags are available for the `theme duplicate` command:", + "isPublicDocs": true, + "members": [ + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-duplicate.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--no-color", + "value": "''", + "description": "Disable color output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_NO_COLOR" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-duplicate.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--password ", + "value": "string", + "description": "Password generated from the Theme Access app or an Admin API token.", + "isOptional": true, + "environmentValue": "SHOPIFY_CLI_THEME_TOKEN" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-duplicate.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--verbose", + "value": "''", + "description": "Increase the verbosity of the output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_VERBOSE" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-duplicate.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-e, --environment ", + "value": "string", + "description": "The environment to apply to the current command.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_ENVIRONMENT" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-duplicate.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-f, --force", + "value": "''", + "description": "Force the duplicate operation to run without prompts or confirmations.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_FORCE" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-duplicate.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-j, --json", + "value": "''", + "description": "Output the result as JSON. Automatically disables color output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-duplicate.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-n, --name ", + "value": "string", + "description": "Name of the newly duplicated theme.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_NAME" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-duplicate.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-s, --store ", + "value": "string", + "description": "Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_STORE" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-duplicate.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-t, --theme ", + "value": "string", + "description": "Theme ID or name of the remote theme.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_THEME_ID" + } + ], + "value": "export interface themeduplicate {\n /**\n * The environment to apply to the current command.\n * @environment SHOPIFY_FLAG_ENVIRONMENT\n */\n '-e, --environment '?: string\n\n /**\n * Force the duplicate operation to run without prompts or confirmations.\n * @environment SHOPIFY_FLAG_FORCE\n */\n '-f, --force'?: ''\n\n /**\n * Output the result as JSON. Automatically disables color output.\n * @environment SHOPIFY_FLAG_JSON\n */\n '-j, --json'?: ''\n\n /**\n * Name of the newly duplicated theme.\n * @environment SHOPIFY_FLAG_NAME\n */\n '-n, --name '?: string\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * Password generated from the Theme Access app or an Admin API token.\n * @environment SHOPIFY_CLI_THEME_TOKEN\n */\n '--password '?: string\n\n /**\n * Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).\n * @environment SHOPIFY_FLAG_STORE\n */\n '-s, --store '?: string\n\n /**\n * Theme ID or name of the remote theme.\n * @environment SHOPIFY_FLAG_THEME_ID\n */\n '-t, --theme '?: string\n\n /**\n * Increase the verbosity of the output.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" + } + }, + "themeinfo": { + "docs-shopify.dev/commands/interfaces/theme-info.interface.ts": { + "filePath": "docs-shopify.dev/commands/interfaces/theme-info.interface.ts", + "name": "themeinfo", + "description": "The following flags are available for the `theme info` command:", + "isPublicDocs": true, + "members": [ + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-info.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--no-color", + "value": "''", + "description": "Disable color output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_NO_COLOR" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-info.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--password ", + "value": "string", + "description": "Password generated from the Theme Access app or an Admin API token.", + "isOptional": true, + "environmentValue": "SHOPIFY_CLI_THEME_TOKEN" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-info.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--path ", + "value": "string", + "description": "The path where you want to run the command. Defaults to the current working directory.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_PATH" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-info.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--verbose", + "value": "''", + "description": "Increase the verbosity of the output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_VERBOSE" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-info.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-d, --development", + "value": "''", + "description": "Retrieve info from your development theme.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_DEVELOPMENT" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-info.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-e, --environment ", + "value": "string", + "description": "The environment to apply to the current command.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_ENVIRONMENT" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-info.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-j, --json", + "value": "''", + "description": "Output the result as JSON. Automatically disables color output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-info.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-s, --store ", + "value": "string", + "description": "Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_STORE" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-info.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-t, --theme ", + "value": "string", + "description": "Theme ID or name of the remote theme.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_THEME_ID" + } + ], + "value": "export interface themeinfo {\n /**\n * Retrieve info from your development theme.\n * @environment SHOPIFY_FLAG_DEVELOPMENT\n */\n '-d, --development'?: ''\n\n /**\n * The environment to apply to the current command.\n * @environment SHOPIFY_FLAG_ENVIRONMENT\n */\n '-e, --environment '?: string\n\n /**\n * Output the result as JSON. Automatically disables color output.\n * @environment SHOPIFY_FLAG_JSON\n */\n '-j, --json'?: ''\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * Password generated from the Theme Access app or an Admin API token.\n * @environment SHOPIFY_CLI_THEME_TOKEN\n */\n '--password '?: string\n\n /**\n * The path where you want to run the command. Defaults to the current working directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).\n * @environment SHOPIFY_FLAG_STORE\n */\n '-s, --store '?: string\n\n /**\n * Theme ID or name of the remote theme.\n * @environment SHOPIFY_FLAG_THEME_ID\n */\n '-t, --theme '?: string\n\n /**\n * Increase the verbosity of the output.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" + } + }, + "themeinit": { + "docs-shopify.dev/commands/interfaces/theme-init.interface.ts": { + "filePath": "docs-shopify.dev/commands/interfaces/theme-init.interface.ts", + "name": "themeinit", + "description": "The following flags are available for the `theme init` command:", + "isPublicDocs": true, + "members": [ + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-init.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--no-color", + "value": "''", + "description": "Disable color output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_NO_COLOR" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-init.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--path ", + "value": "string", + "description": "The path where you want to run the command. Defaults to the current working directory.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_PATH" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-init.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--verbose", + "value": "''", + "description": "Increase the verbosity of the output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_VERBOSE" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-init.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-l, --latest", + "value": "''", + "description": "Downloads the latest release of the `clone-url`", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_LATEST" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-init.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-u, --clone-url ", + "value": "string", + "description": "The Git URL to clone from. Defaults to Shopify's Skeleton theme.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_CLONE_URL" + } + ], + "value": "export interface themeinit {\n /**\n * The Git URL to clone from. Defaults to Shopify's Skeleton theme.\n * @environment SHOPIFY_FLAG_CLONE_URL\n */\n '-u, --clone-url '?: string\n\n /**\n * Downloads the latest release of the `clone-url`\n * @environment SHOPIFY_FLAG_LATEST\n */\n '-l, --latest'?: ''\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * The path where you want to run the command. Defaults to the current working directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Increase the verbosity of the output.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" + } + }, + "themelanguageserver": { + "docs-shopify.dev/commands/interfaces/theme-language-server.interface.ts": { + "filePath": "docs-shopify.dev/commands/interfaces/theme-language-server.interface.ts", + "name": "themelanguageserver", + "description": "The following flags are available for the `theme language-server` command:", + "isPublicDocs": true, + "members": [ + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-language-server.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--no-color", + "value": "''", + "description": "Disable color output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_NO_COLOR" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-language-server.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--verbose", + "value": "''", + "description": "Increase the verbosity of the output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_VERBOSE" + } + ], + "value": "export interface themelanguageserver {\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * Increase the verbosity of the output.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" + } + }, + "themelist": { + "docs-shopify.dev/commands/interfaces/theme-list.interface.ts": { + "filePath": "docs-shopify.dev/commands/interfaces/theme-list.interface.ts", + "name": "themelist", + "description": "The following flags are available for the `theme list` command:", + "isPublicDocs": true, + "members": [ + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-list.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--id ", + "value": "string", + "description": "Only list theme with the given ID.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_ID" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-list.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--name ", + "value": "string", + "description": "Only list themes that contain the given name.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_NAME" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-list.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--no-color", + "value": "''", + "description": "Disable color output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_NO_COLOR" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-list.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--password ", + "value": "string", + "description": "Password generated from the Theme Access app or an Admin API token.", + "isOptional": true, + "environmentValue": "SHOPIFY_CLI_THEME_TOKEN" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-list.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--path ", + "value": "string", + "description": "The path where you want to run the command. Defaults to the current working directory.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_PATH" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-list.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--role ", + "value": "string", + "description": "Only list themes with the given role.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_ROLE" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-list.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--verbose", + "value": "''", + "description": "Increase the verbosity of the output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_VERBOSE" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-list.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-e, --environment ", + "value": "string", + "description": "The environment to apply to the current command.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_ENVIRONMENT" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-list.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-j, --json", + "value": "''", + "description": "Output the result as JSON. Automatically disables color output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-list.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-s, --store ", + "value": "string", + "description": "Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_STORE" + } + ], + "value": "export interface themelist {\n /**\n * The environment to apply to the current command.\n * @environment SHOPIFY_FLAG_ENVIRONMENT\n */\n '-e, --environment '?: string\n\n /**\n * Only list theme with the given ID.\n * @environment SHOPIFY_FLAG_ID\n */\n '--id '?: string\n\n /**\n * Output the result as JSON. Automatically disables color output.\n * @environment SHOPIFY_FLAG_JSON\n */\n '-j, --json'?: ''\n\n /**\n * Only list themes that contain the given name.\n * @environment SHOPIFY_FLAG_NAME\n */\n '--name '?: string\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * Password generated from the Theme Access app or an Admin API token.\n * @environment SHOPIFY_CLI_THEME_TOKEN\n */\n '--password '?: string\n\n /**\n * The path where you want to run the command. Defaults to the current working directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Only list themes with the given role.\n * @environment SHOPIFY_FLAG_ROLE\n */\n '--role '?: string\n\n /**\n * Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).\n * @environment SHOPIFY_FLAG_STORE\n */\n '-s, --store '?: string\n\n /**\n * Increase the verbosity of the output.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" + } + }, + "thememetafieldspull": { + "docs-shopify.dev/commands/interfaces/theme-metafields-pull.interface.ts": { + "filePath": "docs-shopify.dev/commands/interfaces/theme-metafields-pull.interface.ts", + "name": "thememetafieldspull", + "description": "The following flags are available for the `theme metafields pull` command:", + "isPublicDocs": true, + "members": [ + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-metafields-pull.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--no-color", + "value": "''", + "description": "Disable color output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_NO_COLOR" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-metafields-pull.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--password ", + "value": "string", + "description": "Password generated from the Theme Access app or an Admin API token.", + "isOptional": true, + "environmentValue": "SHOPIFY_CLI_THEME_TOKEN" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-metafields-pull.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--path ", + "value": "string", + "description": "The path where you want to run the command. Defaults to the current working directory.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_PATH" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-metafields-pull.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--verbose", + "value": "''", + "description": "Increase the verbosity of the output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_VERBOSE" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-metafields-pull.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-e, --environment ", + "value": "string", + "description": "The environment to apply to the current command.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_ENVIRONMENT" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-metafields-pull.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-s, --store ", + "value": "string", + "description": "Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_STORE" + } + ], + "value": "export interface thememetafieldspull {\n /**\n * The environment to apply to the current command.\n * @environment SHOPIFY_FLAG_ENVIRONMENT\n */\n '-e, --environment '?: string\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * Password generated from the Theme Access app or an Admin API token.\n * @environment SHOPIFY_CLI_THEME_TOKEN\n */\n '--password '?: string\n\n /**\n * The path where you want to run the command. Defaults to the current working directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).\n * @environment SHOPIFY_FLAG_STORE\n */\n '-s, --store '?: string\n\n /**\n * Increase the verbosity of the output.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" + } + }, + "themeopen": { + "docs-shopify.dev/commands/interfaces/theme-open.interface.ts": { + "filePath": "docs-shopify.dev/commands/interfaces/theme-open.interface.ts", + "name": "themeopen", + "description": "The following flags are available for the `theme open` command:", + "isPublicDocs": true, + "members": [ + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-open.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--no-color", + "value": "''", + "description": "Disable color output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_NO_COLOR" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-open.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--password ", + "value": "string", + "description": "Password generated from the Theme Access app or an Admin API token.", + "isOptional": true, + "environmentValue": "SHOPIFY_CLI_THEME_TOKEN" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-open.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--path ", + "value": "string", + "description": "The path where you want to run the command. Defaults to the current working directory.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_PATH" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-open.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--verbose", + "value": "''", + "description": "Increase the verbosity of the output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_VERBOSE" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-open.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-d, --development", + "value": "''", + "description": "Open your development theme.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_DEVELOPMENT" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-open.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-E, --editor", + "value": "''", + "description": "Open the theme editor for the specified theme in the browser.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_EDITOR" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-open.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-e, --environment ", + "value": "string", + "description": "The environment to apply to the current command.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_ENVIRONMENT" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-open.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-l, --live", + "value": "''", + "description": "Open your live (published) theme.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_LIVE" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-open.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-s, --store ", + "value": "string", + "description": "Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_STORE" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-open.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-t, --theme ", + "value": "string", + "description": "Theme ID or name of the remote theme.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_THEME_ID" + } + ], + "value": "export interface themeopen {\n /**\n * Open your development theme.\n * @environment SHOPIFY_FLAG_DEVELOPMENT\n */\n '-d, --development'?: ''\n\n /**\n * Open the theme editor for the specified theme in the browser.\n * @environment SHOPIFY_FLAG_EDITOR\n */\n '-E, --editor'?: ''\n\n /**\n * The environment to apply to the current command.\n * @environment SHOPIFY_FLAG_ENVIRONMENT\n */\n '-e, --environment '?: string\n\n /**\n * Open your live (published) theme.\n * @environment SHOPIFY_FLAG_LIVE\n */\n '-l, --live'?: ''\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * Password generated from the Theme Access app or an Admin API token.\n * @environment SHOPIFY_CLI_THEME_TOKEN\n */\n '--password '?: string\n\n /**\n * The path where you want to run the command. Defaults to the current working directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).\n * @environment SHOPIFY_FLAG_STORE\n */\n '-s, --store '?: string\n\n /**\n * Theme ID or name of the remote theme.\n * @environment SHOPIFY_FLAG_THEME_ID\n */\n '-t, --theme '?: string\n\n /**\n * Increase the verbosity of the output.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" + } + }, + "themepackage": { + "docs-shopify.dev/commands/interfaces/theme-package.interface.ts": { + "filePath": "docs-shopify.dev/commands/interfaces/theme-package.interface.ts", + "name": "themepackage", + "description": "The following flags are available for the `theme package` command:", + "isPublicDocs": true, + "members": [ + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-package.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--no-color", + "value": "''", + "description": "Disable color output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_NO_COLOR" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-package.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--path ", + "value": "string", + "description": "The path where you want to run the command. Defaults to the current working directory.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_PATH" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-package.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--verbose", + "value": "''", + "description": "Increase the verbosity of the output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_VERBOSE" + } + ], + "value": "export interface themepackage {\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * The path where you want to run the command. Defaults to the current working directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Increase the verbosity of the output.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" + } + }, + "themepreview": { + "docs-shopify.dev/commands/interfaces/theme-preview.interface.ts": { + "filePath": "docs-shopify.dev/commands/interfaces/theme-preview.interface.ts", + "name": "themepreview", + "description": "The following flags are available for the `theme preview` command:", + "isPublicDocs": true, + "members": [ + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-preview.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--json", + "value": "''", + "description": "Output the preview URL and identifier as JSON.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-preview.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--no-color", + "value": "''", + "description": "Disable color output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_NO_COLOR" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-preview.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--open", + "value": "''", + "description": "Automatically launch the theme preview in your default web browser.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_OPEN" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-preview.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--overrides ", + "value": "string", + "description": "Path to a JSON overrides file.", + "environmentValue": "SHOPIFY_FLAG_OVERRIDES" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-preview.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--password ", + "value": "string", + "description": "Password generated from the Theme Access app or an Admin API token.", + "isOptional": true, + "environmentValue": "SHOPIFY_CLI_THEME_TOKEN" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-preview.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--path ", + "value": "string", + "description": "The path where you want to run the command. Defaults to the current working directory.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_PATH" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-preview.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--preview-id ", + "value": "string", + "description": "An existing preview identifier to update instead of creating a new preview.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_PREVIEW_ID" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-preview.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--verbose", + "value": "''", + "description": "Increase the verbosity of the output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_VERBOSE" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-preview.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-e, --environment ", + "value": "string", + "description": "The environment to apply to the current command.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_ENVIRONMENT" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-preview.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-s, --store ", + "value": "string", + "description": "Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_STORE" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-preview.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-t, --theme ", + "value": "string", + "description": "Theme ID or name of the remote theme.", + "environmentValue": "SHOPIFY_FLAG_THEME_ID" + } + ], + "value": "export interface themepreview {\n /**\n * The environment to apply to the current command.\n * @environment SHOPIFY_FLAG_ENVIRONMENT\n */\n '-e, --environment '?: string\n\n /**\n * Output the preview URL and identifier as JSON.\n * @environment SHOPIFY_FLAG_JSON\n */\n '--json'?: ''\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * Automatically launch the theme preview in your default web browser.\n * @environment SHOPIFY_FLAG_OPEN\n */\n '--open'?: ''\n\n /**\n * Path to a JSON overrides file.\n * @environment SHOPIFY_FLAG_OVERRIDES\n */\n '--overrides ': string\n\n /**\n * Password generated from the Theme Access app or an Admin API token.\n * @environment SHOPIFY_CLI_THEME_TOKEN\n */\n '--password '?: string\n\n /**\n * The path where you want to run the command. Defaults to the current working directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * An existing preview identifier to update instead of creating a new preview.\n * @environment SHOPIFY_FLAG_PREVIEW_ID\n */\n '--preview-id '?: string\n\n /**\n * Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).\n * @environment SHOPIFY_FLAG_STORE\n */\n '-s, --store '?: string\n\n /**\n * Theme ID or name of the remote theme.\n * @environment SHOPIFY_FLAG_THEME_ID\n */\n '-t, --theme ': string\n\n /**\n * Increase the verbosity of the output.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" + } + }, + "themeprofile": { + "docs-shopify.dev/commands/interfaces/theme-profile.interface.ts": { + "filePath": "docs-shopify.dev/commands/interfaces/theme-profile.interface.ts", + "name": "themeprofile", + "description": "The following flags are available for the `theme profile` command:", + "isPublicDocs": true, + "members": [ + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-profile.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--no-color", + "value": "''", + "description": "Disable color output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_NO_COLOR" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-profile.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--password ", + "value": "string", + "description": "Password generated from the Theme Access app or an Admin API token.", + "isOptional": true, + "environmentValue": "SHOPIFY_CLI_THEME_TOKEN" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-profile.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--path ", + "value": "string", + "description": "The path where you want to run the command. Defaults to the current working directory.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_PATH" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-profile.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--store-password ", + "value": "string", + "description": "The password for storefronts with password protection.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_STORE_PASSWORD" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-profile.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--url ", + "value": "string", + "description": "The url to be used as context", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_URL" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-profile.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--verbose", + "value": "''", + "description": "Increase the verbosity of the output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_VERBOSE" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-profile.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-e, --environment ", + "value": "string", + "description": "The environment to apply to the current command.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_ENVIRONMENT" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-profile.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-j, --json", + "value": "''", + "description": "Output the result as JSON. Automatically disables color output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-profile.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-s, --store ", + "value": "string", + "description": "Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_STORE" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-profile.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-t, --theme ", + "value": "string", + "description": "Theme ID or name of the remote theme.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_THEME_ID" + } + ], + "value": "export interface themeprofile {\n /**\n * The environment to apply to the current command.\n * @environment SHOPIFY_FLAG_ENVIRONMENT\n */\n '-e, --environment '?: string\n\n /**\n * Output the result as JSON. Automatically disables color output.\n * @environment SHOPIFY_FLAG_JSON\n */\n '-j, --json'?: ''\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * Password generated from the Theme Access app or an Admin API token.\n * @environment SHOPIFY_CLI_THEME_TOKEN\n */\n '--password '?: string\n\n /**\n * The path where you want to run the command. Defaults to the current working directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).\n * @environment SHOPIFY_FLAG_STORE\n */\n '-s, --store '?: string\n\n /**\n * The password for storefronts with password protection.\n * @environment SHOPIFY_FLAG_STORE_PASSWORD\n */\n '--store-password '?: string\n\n /**\n * Theme ID or name of the remote theme.\n * @environment SHOPIFY_FLAG_THEME_ID\n */\n '-t, --theme '?: string\n\n /**\n * The url to be used as context\n * @environment SHOPIFY_FLAG_URL\n */\n '--url '?: string\n\n /**\n * Increase the verbosity of the output.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" + } + }, + "themepublish": { + "docs-shopify.dev/commands/interfaces/theme-publish.interface.ts": { + "filePath": "docs-shopify.dev/commands/interfaces/theme-publish.interface.ts", + "name": "themepublish", + "description": "The following flags are available for the `theme publish` command:", + "isPublicDocs": true, + "members": [ + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-publish.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--no-color", + "value": "''", + "description": "Disable color output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_NO_COLOR" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-publish.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--password ", + "value": "string", + "description": "Password generated from the Theme Access app or an Admin API token.", + "isOptional": true, + "environmentValue": "SHOPIFY_CLI_THEME_TOKEN" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-publish.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--path ", + "value": "string", + "description": "The path where you want to run the command. Defaults to the current working directory.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_PATH" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-publish.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--verbose", + "value": "''", + "description": "Increase the verbosity of the output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_VERBOSE" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-publish.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-e, --environment ", + "value": "string", + "description": "The environment to apply to the current command.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_ENVIRONMENT" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-publish.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-f, --force", + "value": "''", + "description": "Skip confirmation.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_FORCE" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-publish.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-s, --store ", + "value": "string", + "description": "Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_STORE" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-publish.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-t, --theme ", + "value": "string", + "description": "Theme ID or name of the remote theme.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_THEME_ID" + } + ], + "value": "export interface themepublish {\n /**\n * The environment to apply to the current command.\n * @environment SHOPIFY_FLAG_ENVIRONMENT\n */\n '-e, --environment '?: string\n\n /**\n * Skip confirmation.\n * @environment SHOPIFY_FLAG_FORCE\n */\n '-f, --force'?: ''\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * Password generated from the Theme Access app or an Admin API token.\n * @environment SHOPIFY_CLI_THEME_TOKEN\n */\n '--password '?: string\n\n /**\n * The path where you want to run the command. Defaults to the current working directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).\n * @environment SHOPIFY_FLAG_STORE\n */\n '-s, --store '?: string\n\n /**\n * Theme ID or name of the remote theme.\n * @environment SHOPIFY_FLAG_THEME_ID\n */\n '-t, --theme '?: string\n\n /**\n * Increase the verbosity of the output.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" + } + }, + "themepull": { + "docs-shopify.dev/commands/interfaces/theme-pull.interface.ts": { + "filePath": "docs-shopify.dev/commands/interfaces/theme-pull.interface.ts", + "name": "themepull", + "description": "The following flags are available for the `theme pull` command:", + "isPublicDocs": true, + "members": [ + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-pull.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--no-color", + "value": "''", + "description": "Disable color output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_NO_COLOR" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-pull.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--password ", + "value": "string", + "description": "Password generated from the Theme Access app or an Admin API token.", + "isOptional": true, + "environmentValue": "SHOPIFY_CLI_THEME_TOKEN" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-pull.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--path ", + "value": "string", + "description": "The path where you want to run the command. Defaults to the current working directory.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_PATH" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-pull.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--verbose", + "value": "''", + "description": "Increase the verbosity of the output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_VERBOSE" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-pull.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-d, --development", + "value": "''", + "description": "Pull theme files from your remote development theme.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_DEVELOPMENT" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-pull.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-e, --environment ", + "value": "string", + "description": "The environment to apply to the current command.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_ENVIRONMENT" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-pull.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-l, --live", + "value": "''", + "description": "Pull theme files from your remote live theme.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_LIVE" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-pull.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-n, --nodelete", + "value": "''", + "description": "Prevent deleting local files that don't exist remotely.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_NODELETE" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-pull.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-o, --only ", + "value": "string", + "description": "Download only the specified files (Multiple flags allowed). Wrap the value in double quotes if you're using wildcards.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_ONLY" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-pull.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-s, --store ", + "value": "string", + "description": "Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_STORE" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-pull.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-t, --theme ", + "value": "string", + "description": "Theme ID or name of the remote theme.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_THEME_ID" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-pull.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-x, --ignore ", + "value": "string", + "description": "Skip downloading the specified files (Multiple flags allowed). Wrap the value in double quotes if you're using wildcards.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_IGNORE" + } + ], + "value": "export interface themepull {\n /**\n * Pull theme files from your remote development theme.\n * @environment SHOPIFY_FLAG_DEVELOPMENT\n */\n '-d, --development'?: ''\n\n /**\n * The environment to apply to the current command.\n * @environment SHOPIFY_FLAG_ENVIRONMENT\n */\n '-e, --environment '?: string\n\n /**\n * Skip downloading the specified files (Multiple flags allowed). Wrap the value in double quotes if you're using wildcards.\n * @environment SHOPIFY_FLAG_IGNORE\n */\n '-x, --ignore '?: string\n\n /**\n * Pull theme files from your remote live theme.\n * @environment SHOPIFY_FLAG_LIVE\n */\n '-l, --live'?: ''\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * Prevent deleting local files that don't exist remotely.\n * @environment SHOPIFY_FLAG_NODELETE\n */\n '-n, --nodelete'?: ''\n\n /**\n * Download only the specified files (Multiple flags allowed). Wrap the value in double quotes if you're using wildcards.\n * @environment SHOPIFY_FLAG_ONLY\n */\n '-o, --only '?: string\n\n /**\n * Password generated from the Theme Access app or an Admin API token.\n * @environment SHOPIFY_CLI_THEME_TOKEN\n */\n '--password '?: string\n\n /**\n * The path where you want to run the command. Defaults to the current working directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).\n * @environment SHOPIFY_FLAG_STORE\n */\n '-s, --store '?: string\n\n /**\n * Theme ID or name of the remote theme.\n * @environment SHOPIFY_FLAG_THEME_ID\n */\n '-t, --theme '?: string\n\n /**\n * Increase the verbosity of the output.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" + } + }, + "themepush": { + "docs-shopify.dev/commands/interfaces/theme-push.interface.ts": { + "filePath": "docs-shopify.dev/commands/interfaces/theme-push.interface.ts", + "name": "themepush", + "description": "The following flags are available for the `theme push` command:", + "isPublicDocs": true, + "members": [ + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-push.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--listing ", + "value": "string", + "description": "The listing preset to use for multi-preset themes. Applies preset files from listings/[preset-name] directory.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_LISTING" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-push.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--no-color", + "value": "''", + "description": "Disable color output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_NO_COLOR" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-push.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--password ", + "value": "string", + "description": "Password generated from the Theme Access app or an Admin API token.", + "isOptional": true, + "environmentValue": "SHOPIFY_CLI_THEME_TOKEN" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-push.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--path ", + "value": "string", + "description": "The path where you want to run the command. Defaults to the current working directory.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_PATH" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-push.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--strict", + "value": "''", + "description": "Require theme check to pass without errors before pushing. Warnings are allowed.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_STRICT_PUSH" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-push.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--verbose", + "value": "''", + "description": "Increase the verbosity of the output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_VERBOSE" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-push.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-a, --allow-live", + "value": "''", + "description": "Allow push to a live theme.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_ALLOW_LIVE" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-push.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-c, --development-context ", + "value": "string", + "description": "Unique identifier for a development theme context (e.g., PR number, branch name). Reuses an existing development theme with this context name, or creates one if none exists.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_DEVELOPMENT_CONTEXT" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-push.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-d, --development", + "value": "''", + "description": "Push theme files from your remote development theme.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_DEVELOPMENT" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-push.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-e, --environment ", + "value": "string", + "description": "The environment to apply to the current command.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_ENVIRONMENT" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-push.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-j, --json", + "value": "''", + "description": "Output the result as JSON. Automatically disables color output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_JSON" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-push.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-l, --live", + "value": "''", + "description": "Push theme files from your remote live theme.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_LIVE" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-push.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-n, --nodelete", + "value": "''", + "description": "Prevent deleting remote files that don't exist locally.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_NODELETE" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-push.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-o, --only ", + "value": "string", + "description": "Upload only the specified files (Multiple flags allowed). Wrap the value in double quotes if you're using wildcards.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_ONLY" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-push.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-p, --publish", + "value": "''", + "description": "Publish as the live theme after uploading.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_PUBLISH" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-push.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-s, --store ", + "value": "string", + "description": "Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_STORE" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-push.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-t, --theme ", + "value": "string", + "description": "Theme ID or name of the remote theme.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_THEME_ID" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-push.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-u, --unpublished", + "value": "''", + "description": "Create a new unpublished theme and push to it.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_UNPUBLISHED" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-push.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-x, --ignore ", + "value": "string", + "description": "Skip uploading the specified files (Multiple flags allowed). Wrap the value in double quotes if you're using wildcards.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_IGNORE" + } + ], + "value": "export interface themepush {\n /**\n * Allow push to a live theme.\n * @environment SHOPIFY_FLAG_ALLOW_LIVE\n */\n '-a, --allow-live'?: ''\n\n /**\n * Push theme files from your remote development theme.\n * @environment SHOPIFY_FLAG_DEVELOPMENT\n */\n '-d, --development'?: ''\n\n /**\n * Unique identifier for a development theme context (e.g., PR number, branch name). Reuses an existing development theme with this context name, or creates one if none exists.\n * @environment SHOPIFY_FLAG_DEVELOPMENT_CONTEXT\n */\n '-c, --development-context '?: string\n\n /**\n * The environment to apply to the current command.\n * @environment SHOPIFY_FLAG_ENVIRONMENT\n */\n '-e, --environment '?: string\n\n /**\n * Skip uploading the specified files (Multiple flags allowed). Wrap the value in double quotes if you're using wildcards.\n * @environment SHOPIFY_FLAG_IGNORE\n */\n '-x, --ignore '?: string\n\n /**\n * Output the result as JSON. Automatically disables color output.\n * @environment SHOPIFY_FLAG_JSON\n */\n '-j, --json'?: ''\n\n /**\n * The listing preset to use for multi-preset themes. Applies preset files from listings/[preset-name] directory.\n * @environment SHOPIFY_FLAG_LISTING\n */\n '--listing '?: string\n\n /**\n * Push theme files from your remote live theme.\n * @environment SHOPIFY_FLAG_LIVE\n */\n '-l, --live'?: ''\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * Prevent deleting remote files that don't exist locally.\n * @environment SHOPIFY_FLAG_NODELETE\n */\n '-n, --nodelete'?: ''\n\n /**\n * Upload only the specified files (Multiple flags allowed). Wrap the value in double quotes if you're using wildcards.\n * @environment SHOPIFY_FLAG_ONLY\n */\n '-o, --only '?: string\n\n /**\n * Password generated from the Theme Access app or an Admin API token.\n * @environment SHOPIFY_CLI_THEME_TOKEN\n */\n '--password '?: string\n\n /**\n * The path where you want to run the command. Defaults to the current working directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Publish as the live theme after uploading.\n * @environment SHOPIFY_FLAG_PUBLISH\n */\n '-p, --publish'?: ''\n\n /**\n * Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).\n * @environment SHOPIFY_FLAG_STORE\n */\n '-s, --store '?: string\n\n /**\n * Require theme check to pass without errors before pushing. Warnings are allowed.\n * @environment SHOPIFY_FLAG_STRICT_PUSH\n */\n '--strict'?: ''\n\n /**\n * Theme ID or name of the remote theme.\n * @environment SHOPIFY_FLAG_THEME_ID\n */\n '-t, --theme '?: string\n\n /**\n * Create a new unpublished theme and push to it.\n * @environment SHOPIFY_FLAG_UNPUBLISHED\n */\n '-u, --unpublished'?: ''\n\n /**\n * Increase the verbosity of the output.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" + } + }, + "themerename": { + "docs-shopify.dev/commands/interfaces/theme-rename.interface.ts": { + "filePath": "docs-shopify.dev/commands/interfaces/theme-rename.interface.ts", + "name": "themerename", + "description": "The following flags are available for the `theme rename` command:", + "isPublicDocs": true, + "members": [ + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-rename.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--no-color", + "value": "''", + "description": "Disable color output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_NO_COLOR" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-rename.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--password ", + "value": "string", + "description": "Password generated from the Theme Access app or an Admin API token.", + "isOptional": true, + "environmentValue": "SHOPIFY_CLI_THEME_TOKEN" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-rename.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--path ", + "value": "string", + "description": "The path where you want to run the command. Defaults to the current working directory.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_PATH" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-rename.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--verbose", + "value": "''", + "description": "Increase the verbosity of the output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_VERBOSE" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-rename.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-d, --development", + "value": "''", + "description": "Rename your development theme.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_DEVELOPMENT" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-rename.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-e, --environment ", + "value": "string", + "description": "The environment to apply to the current command.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_ENVIRONMENT" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-rename.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-l, --live", + "value": "''", + "description": "Rename your remote live theme.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_LIVE" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-rename.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-n, --name ", + "value": "string", + "description": "The new name for the theme.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_NEW_NAME" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-rename.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-s, --store ", + "value": "string", + "description": "Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_STORE" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-rename.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-t, --theme ", + "value": "string", + "description": "Theme ID or name of the remote theme.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_THEME_ID" + } + ], + "value": "export interface themerename {\n /**\n * Rename your development theme.\n * @environment SHOPIFY_FLAG_DEVELOPMENT\n */\n '-d, --development'?: ''\n\n /**\n * The environment to apply to the current command.\n * @environment SHOPIFY_FLAG_ENVIRONMENT\n */\n '-e, --environment '?: string\n\n /**\n * Rename your remote live theme.\n * @environment SHOPIFY_FLAG_LIVE\n */\n '-l, --live'?: ''\n\n /**\n * The new name for the theme.\n * @environment SHOPIFY_FLAG_NEW_NAME\n */\n '-n, --name '?: string\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * Password generated from the Theme Access app or an Admin API token.\n * @environment SHOPIFY_CLI_THEME_TOKEN\n */\n '--password '?: string\n\n /**\n * The path where you want to run the command. Defaults to the current working directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).\n * @environment SHOPIFY_FLAG_STORE\n */\n '-s, --store '?: string\n\n /**\n * Theme ID or name of the remote theme.\n * @environment SHOPIFY_FLAG_THEME_ID\n */\n '-t, --theme '?: string\n\n /**\n * Increase the verbosity of the output.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" + } + }, + "themeshare": { + "docs-shopify.dev/commands/interfaces/theme-share.interface.ts": { + "filePath": "docs-shopify.dev/commands/interfaces/theme-share.interface.ts", + "name": "themeshare", + "description": "The following flags are available for the `theme share` command:", + "isPublicDocs": true, + "members": [ + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-share.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--listing ", + "value": "string", + "description": "The listing preset to use for multi-preset themes. Applies preset files from listings/[preset-name] directory.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_LISTING" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-share.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--no-color", + "value": "''", + "description": "Disable color output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_NO_COLOR" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-share.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--password ", + "value": "string", + "description": "Password generated from the Theme Access app or an Admin API token.", + "isOptional": true, + "environmentValue": "SHOPIFY_CLI_THEME_TOKEN" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-share.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--path ", + "value": "string", + "description": "The path where you want to run the command. Defaults to the current working directory.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_PATH" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-share.interface.ts", + "syntaxKind": "PropertySignature", + "name": "--verbose", + "value": "''", + "description": "Increase the verbosity of the output.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_VERBOSE" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-share.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-e, --environment ", + "value": "string", + "description": "The environment to apply to the current command.", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_ENVIRONMENT" + }, + { + "filePath": "docs-shopify.dev/commands/interfaces/theme-share.interface.ts", + "syntaxKind": "PropertySignature", + "name": "-s, --store ", + "value": "string", + "description": "Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).", + "isOptional": true, + "environmentValue": "SHOPIFY_FLAG_STORE" + } + ], + "value": "export interface themeshare {\n /**\n * The environment to apply to the current command.\n * @environment SHOPIFY_FLAG_ENVIRONMENT\n */\n '-e, --environment '?: string\n\n /**\n * The listing preset to use for multi-preset themes. Applies preset files from listings/[preset-name] directory.\n * @environment SHOPIFY_FLAG_LISTING\n */\n '--listing '?: string\n\n /**\n * Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n */\n '--no-color'?: ''\n\n /**\n * Password generated from the Theme Access app or an Admin API token.\n * @environment SHOPIFY_CLI_THEME_TOKEN\n */\n '--password '?: string\n\n /**\n * The path where you want to run the command. Defaults to the current working directory.\n * @environment SHOPIFY_FLAG_PATH\n */\n '--path '?: string\n\n /**\n * Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).\n * @environment SHOPIFY_FLAG_STORE\n */\n '-s, --store '?: string\n\n /**\n * Increase the verbosity of the output.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}" + } + }, + "upgrade": { + "docs-shopify.dev/commands/interfaces/upgrade.interface.ts": { + "filePath": "docs-shopify.dev/commands/interfaces/upgrade.interface.ts", + "name": "upgrade", + "description": "", + "isPublicDocs": true, + "members": [], + "value": "export interface upgrade {\n\n}" + } + }, + "version": { + "docs-shopify.dev/commands/interfaces/version.interface.ts": { + "filePath": "docs-shopify.dev/commands/interfaces/version.interface.ts", + "name": "version", + "description": "", + "isPublicDocs": true, + "members": [], + "value": "export interface version {\n\n}" + } + } +} \ No newline at end of file diff --git a/docs-shopify.dev/type-descriptions.json b/docs-shopify.dev/type-descriptions.json new file mode 100644 index 00000000000..8495e91bc00 --- /dev/null +++ b/docs-shopify.dev/type-descriptions.json @@ -0,0 +1,81 @@ +{ + "appbuild": "The following flags are available for the `app build` command:", + "appbulkcancel": "The following flags are available for the `app bulk cancel` command:", + "appbulkexecute": "The following flags are available for the `app bulk execute` command:", + "appbulkstatus": "The following flags are available for the `app bulk status` command:", + "appconfiglink": "The following flags are available for the `app config link` command:", + "appconfigpull": "The following flags are available for the `app config pull` command:", + "appconfiguse": "The following flags are available for the `app config use` command:", + "appconfigvalidate": "The following flags are available for the `app config validate` command:", + "appdeploy": "The following flags are available for the `app deploy` command:", + "appdevclean": "The following flags are available for the `app dev clean` command:", + "appdev": "The following flags are available for the `app dev` command:", + "appenvpull": "The following flags are available for the `app env pull` command:", + "appenvshow": "The following flags are available for the `app env show` command:", + "appexecute": "The following flags are available for the `app execute` command:", + "appfunctionbuild": "The following flags are available for the `app function build` command:", + "appfunctioninfo": "The following flags are available for the `app function info` command:", + "appfunctionreplay": "The following flags are available for the `app function replay` command:", + "appfunctionrun": "The following flags are available for the `app function run` command:", + "appfunctionschema": "The following flags are available for the `app function schema` command:", + "appfunctiontypegen": "The following flags are available for the `app function typegen` command:", + "appgenerateextension": "The following flags are available for the `app generate extension` command:", + "appimportcustomdatadefinitions": "The following flags are available for the `app import-custom-data-definitions` command:", + "appimportextensions": "The following flags are available for the `app import-extensions` command:", + "appinfo": "The following flags are available for the `app info` command:", + "appinit": "The following flags are available for the `app init` command:", + "applogssources": "The following flags are available for the `app logs sources` command:", + "applogs": "The following flags are available for the `app logs` command:", + "apprelease": "The following flags are available for the `app release` command:", + "appversionslist": "The following flags are available for the `app versions list` command:", + "appwebhooktrigger": "The following flags are available for the `app webhook trigger` command:", + "authlogin": "The following flags are available for the `auth login` command:", + "commands": "The following flags are available for the `commands` command:", + "help": "The following flags are available for the `help` command:", + "hydrogenbuild": "The following flags are available for the `hydrogen build` command:", + "hydrogencheck": "The following flags are available for the `hydrogen check` command:", + "hydrogencodegen": "The following flags are available for the `hydrogen codegen` command:", + "hydrogencustomeraccountpush": "The following flags are available for the `hydrogen customer-account-push` command:", + "hydrogendebugcpu": "The following flags are available for the `hydrogen debug cpu` command:", + "hydrogendeploy": "The following flags are available for the `hydrogen deploy` command:", + "hydrogendev": "The following flags are available for the `hydrogen dev` command:", + "hydrogenenvlist": "The following flags are available for the `hydrogen env list` command:", + "hydrogenenvpull": "The following flags are available for the `hydrogen env pull` command:", + "hydrogenenvpush": "The following flags are available for the `hydrogen env push` command:", + "hydrogengenerateroute": "The following flags are available for the `hydrogen generate route` command:", + "hydrogengenerateroutes": "The following flags are available for the `hydrogen generate routes` command:", + "hydrogeninit": "The following flags are available for the `hydrogen init` command:", + "hydrogenlink": "The following flags are available for the `hydrogen link` command:", + "hydrogenlist": "The following flags are available for the `hydrogen list` command:", + "hydrogenlogin": "The following flags are available for the `hydrogen login` command:", + "hydrogenlogout": "The following flags are available for the `hydrogen logout` command:", + "hydrogenpreview": "The following flags are available for the `hydrogen preview` command:", + "hydrogensetupcss": "The following flags are available for the `hydrogen setup css` command:", + "hydrogensetupmarkets": "The following flags are available for the `hydrogen setup markets` command:", + "hydrogensetupvite": "The following flags are available for the `hydrogen setup vite` command:", + "hydrogensetup": "The following flags are available for the `hydrogen setup` command:", + "hydrogenunlink": "The following flags are available for the `hydrogen unlink` command:", + "hydrogenupgrade": "The following flags are available for the `hydrogen upgrade` command:", + "organizationlist": "The following flags are available for the `organization list` command:", + "storeauth": "The following flags are available for the `store auth` command:", + "storeexecute": "The following flags are available for the `store execute` command:", + "themecheck": "The following flags are available for the `theme check` command:", + "themeconsole": "The following flags are available for the `theme console` command:", + "themedelete": "The following flags are available for the `theme delete` command:", + "themedev": "The following flags are available for the `theme dev` command:", + "themeduplicate": "The following flags are available for the `theme duplicate` command:", + "themeinfo": "The following flags are available for the `theme info` command:", + "themeinit": "The following flags are available for the `theme init` command:", + "themelanguageserver": "The following flags are available for the `theme language-server` command:", + "themelist": "The following flags are available for the `theme list` command:", + "thememetafieldspull": "The following flags are available for the `theme metafields pull` command:", + "themeopen": "The following flags are available for the `theme open` command:", + "themepackage": "The following flags are available for the `theme package` command:", + "themepreview": "The following flags are available for the `theme preview` command:", + "themeprofile": "The following flags are available for the `theme profile` command:", + "themepublish": "The following flags are available for the `theme publish` command:", + "themepull": "The following flags are available for the `theme pull` command:", + "themepush": "The following flags are available for the `theme push` command:", + "themerename": "The following flags are available for the `theme rename` command:", + "themeshare": "The following flags are available for the `theme share` command:" +} diff --git a/package.json b/package.json index cd81b6826d4..73932c4bc82 100644 --- a/package.json +++ b/package.json @@ -47,7 +47,7 @@ "@nx/workspace": "22.0.2", "@octokit/rest": "22.0.0", "@shopify/eslint-plugin-cli": "file:packages/eslint-plugin-cli", - "@shopify/generate-docs": "0.15.6", + "@shopify/generate-docs": "1.1.1", "@types/node": "18.19.70", "@types/tmp": "^0.2.5", "@typescript-eslint/parser": "8.56.1", diff --git a/packages/cli/src/cli/commands/docs/generate.test.ts b/packages/cli/src/cli/commands/docs/generate.test.ts index ea56dec56d9..ca56248ee24 100644 --- a/packages/cli/src/cli/commands/docs/generate.test.ts +++ b/packages/cli/src/cli/commands/docs/generate.test.ts @@ -6,11 +6,19 @@ import { writeCommandFlagInterface, writeCommandUsageExampleFile, } from './generate.js' -import {writeFile} from '@shopify/cli-kit/node/fs' -import {describe, test, vi, expect} from 'vitest' +import {readFile, writeFile} from '@shopify/cli-kit/node/fs' +import {beforeEach, describe, test, vi, expect} from 'vitest' vi.mock('@shopify/cli-kit/node/fs') +const typeDescriptions: Record = { + topictestcommand: 'The following flags are available for the `topic test-command` command:', +} + +beforeEach(() => { + vi.mocked(readFile).mockResolvedValue(JSON.stringify(typeDescriptions) as any) +}) + const testCommand: CommandWithMarkdown = { aliases: [], args: {}, @@ -61,6 +69,10 @@ describe('writeCommandFlagInterface', () => { expect(writeFile).toHaveBeenCalledWith( expect.stringContaining('docs-shopify.dev/commands/interfaces/topic-test-command.interface.ts'), `// This is an autogenerated file. Don't edit this file manually. +/** + * The following flags are available for the \`topic test-command\` command: + * @publicDocs + */ export interface topictestcommand { /** * flag description @@ -84,6 +96,10 @@ export interface topictestcommand { expect(writeFile).toHaveBeenCalledWith( expect.stringContaining('docs-shopify.dev/commands/interfaces/topic-test-command.interface.ts'), `// This is an autogenerated file. Don't edit this file manually. +/** + * The following flags are available for the \`topic test-command\` command: + * @publicDocs + */ export interface topictestcommand { } @@ -103,7 +119,7 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs' const data: ReferenceEntityTemplateSchema = { name: 'topic test-command', - description: \`command markdown description\`, + description: \`The following flags are available for the \\\`topic test-command\\\` command:\`, overviewPreviewDescription: \`command summary\`, type: 'command', isVisualComponent: false, diff --git a/packages/cli/src/cli/commands/docs/generate.ts b/packages/cli/src/cli/commands/docs/generate.ts index 8e57e7782b3..feb71417811 100644 --- a/packages/cli/src/cli/commands/docs/generate.ts +++ b/packages/cli/src/cli/commands/docs/generate.ts @@ -1,6 +1,6 @@ import Command from '@shopify/cli-kit/node/base-command' import {Command as oclifCommand} from '@oclif/core' -import {mkdir, rmdir, writeFile} from '@shopify/cli-kit/node/fs' +import {mkdir, readFile, rmdir, writeFile} from '@shopify/cli-kit/node/fs' import {cwd, joinPath} from '@shopify/cli-kit/node/path' import {outputInfo} from '@shopify/cli-kit/node/output' @@ -85,12 +85,17 @@ export async function writeCommandDocumentation( type: '${interfaceName}', },` - const description = command.descriptionWithMarkdown ?? command.description ?? command.summary ?? '' - const cleanDescription = description?.replace(/`/g, '\\`').replace(/https:\/\/shopify\.dev/g, '') + const typeDescriptionsPath = joinPath(cwd(), 'docs-shopify.dev', 'type-descriptions.json') + const typeDescriptions = JSON.parse(await readFile(typeDescriptionsPath)) as Record + const description = + typeDescriptions[interfaceName] ?? command.descriptionWithMarkdown ?? command.description ?? command.summary ?? '' + const cleanDescription = description.replace(/\\/g, '\\\\').replace(/`/g, '\\`') const previewDescription = command.summary ?? description ?? '' - const cleanPreview = previewDescription.replace(/`/g, '\\`').replace(/https:\/\/shopify\.dev/g, '') + const cleanPreview = previewDescription + .replace(/\\/g, '\\\\') + .replace(/`/g, '\\`') + .replace(/https:\/\/shopify\.dev/g, '') - // eslint-disable-next-line @typescript-eslint/no-non-null-assertion const category = hasTopic && !generalTopics.includes(topic!) ? topic : 'general commands' const docString = `// This is an autogenerated file. Don't edit this file manually. @@ -139,7 +144,7 @@ export async function writeCommandFlagInterface( const flag = command.flags[flagName] if (!flag) return if (flag.hidden) return - const flagDescription = flag.description || '' + const flagDescription = flag.description ?? '' const char = flag.char ? `-${flag.char}, ` : '' const type = flag.type === 'option' ? 'string' : "''" const value = flag.type === 'option' ? ' ' : '' @@ -157,7 +162,19 @@ export async function writeCommandFlagInterface( .filter((str) => str && str?.length > 0) .join('\n\n') + const typeDescriptionsPath = joinPath(cwd(), 'docs-shopify.dev', 'type-descriptions.json') + const typeDescriptions = JSON.parse(await readFile(typeDescriptionsPath)) as Record + const description = typeDescriptions[interfaceName] ?? '' + const jsDocDescription = description + .split('\n') + .map((line) => ` * ${line}`) + .join('\n') + const commandContent = `// This is an autogenerated file. Don't edit this file manually. +/** +${jsDocDescription} + * @publicDocs + */ export interface ${interfaceName} { ${flagsDetails} } diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 342c198900b..7ca93736c4f 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -53,8 +53,8 @@ importers: specifier: file:packages/eslint-plugin-cli version: file:packages/eslint-plugin-cli(@typescript-eslint/utils@8.56.1(eslint@9.39.3(jiti@2.6.1))(typescript@5.9.3))(eslint@9.39.3(jiti@2.6.1))(prettier@3.8.1)(typescript@5.9.3)(vitest@3.2.4(@types/node@18.19.70)(jiti@2.6.1)(jsdom@28.1.0)(msw@2.12.10(@types/node@18.19.70)(typescript@5.9.3))(sass@1.97.3)(yaml@2.8.3)) '@shopify/generate-docs': - specifier: 0.15.6 - version: 0.15.6 + specifier: 1.1.1 + version: 1.1.1 '@types/node': specifier: 18.19.70 version: 18.19.70 @@ -3540,8 +3540,8 @@ packages: peerDependencies: eslint: ^9.27.0 - '@shopify/generate-docs@0.15.6': - resolution: {integrity: sha512-4p6c2Xlt5TVAACM/YD6dcEioKeCpHwv5n65TOIGQaFhRUsA3yRFrbD+8G2TSfeW60QIZchzvRQ7xwYjljGajlA==} + '@shopify/generate-docs@1.1.1': + resolution: {integrity: sha512-HbvKMoN7Yr8MAbmJEhBlL6G8rqACVhz7MW1H/GeG7aS9rlcaf4NqDF1SVj8RIq76R7dkQEneajKdo5wMfV0oKg==} hasBin: true '@shopify/liquid-html-parser@2.9.2': @@ -12697,7 +12697,7 @@ snapshots: - supports-color - typescript - '@shopify/generate-docs@0.15.6': + '@shopify/generate-docs@1.1.1': dependencies: '@types/react': 18.3.12 globby: 11.1.0